Subqueue Object
The queue module is composed of a bank of subqueues, each of which can hold a list of packets. This structure provides a convenient mechanism for processes implementing queue management algorithms to separate packets according to various criteria such as priority or type. The subqueues are named "subqueue [0]" through "subqueue [n]-1]", for queue modules with n subqueues. Subqueues are manipulated by processes within the queue module using Kernel Procedures. The fundamental operations done on subqueues include inserting and removing packets, and sorting.
For more information about subqueues, see Node Reference.
Subqueue Object Attributes
The following table lists the built-in attributes of a subqueue object.
Table 27: Subqueue Object Built-In Attributes
| Name | Data Type |
|---|---|
| bit capacity | double |
| pk capacity | double |
Subqueue Object Statistics
The following table lists the statistics available for the subqueue object.
Table 28: Subqueue Object Statistics
| Name | Units |
|---|---|
| queue size (bits) | bits |
| queuing delay | seconds |
| free size (bits) | bits |
| free size (packets) | packets |
| queue size (incoming bits) | bits |
| queue size (incoming packets) | packets |
| overflows | N/A |
| queue size (packets) | packets |
The following table lists the events that update the indicated statistics of a subqueue.
Table 29: Subqueue Object Statistic Events
| Event | Statistics Updated |
|---|---|
| packet insertion | queue size (bits), free size (bits), free size (packets), queue size (incoming bits), queue size (incoming packets), overflows, queue size (packets) |
| packet removal (or queue flushing) | queue size (bits), queuing delay, free size (bits), free size (packets), queue size (packets) |
Each subqueue object statistic is presented below. An initial value of "undef" means that a statistic is initially undefined. An initial value as appropriate.
queue size (bits)
This statistic represents the current number of bits stored in the subqueue. A new sample of queue size (bits) is generated at each packet insertion or removal or, by queue flushing. Insertions and removals occur when the Kernel Procedures op_subq_pk_insert(), and op_subq_pk_remove() are called, respectively.
| Units | bits |
| Initial Value | 0.0 |
queuing delay
This statistic represents the subqueue delay for a packet. It is computed by subtracting the arrival time of a packet from the simulation time at its removal. New samples of delay are generated each time a packet is removed from the subqueue.
| Units | seconds |
| Initial Value | undef |
free size (bits)
This statistic represents the available space in the subqueue measured in bits. This is the maximum number of bits which could be added to the subqueue without causing an overflow. It is computed by subtracting queue size (bits) from the subqueue's bit capacity.
| Units | bits |
| Initial Value | cap size |
free size (packets)
This statistic represents the available space in the subqueue measured in packets. This is the number of packets which could be added to the subqueue without causing an overflow. It is computed by subtracting queue size (packets) from the subqueue's packet capacity.
| Units | packets |
| Initial Value | cap |
queue size (incoming bits)
This statistic represents the current subqueue size (measured in bits) when the packet arrives at the queue. Insertions occur when the Kernel Procedure op_subq_pk_insert() is called.
| Units | bits |
| Initial Value | undef |
queue size (incoming packets)
This statistic represents the current subqueue size (measured in packets) when the packet arrives at the queue. Insertions occur when the Kernel Procedure op_subq_pk_insert() is called.
| Units | packets |
| Initial Value | undef |
overflows
This statistic represents a running count of the number of times the subqueue has had to reject packet insertions due to lack of capacity. overflows is monotonically increasing and is updated whenever a packet insertion fails. The subqueue's process model can detect a failed insertion by testing the value returned by the Kernel Procedure op_subq_pk_insert() against the symbolic constant OPC_QINS_FAIL.
| Units | not applicable |
| Initial Value | 0.0 |
queue size (packets)
This statistic represents the current number of packets stored in the subqueue. A new sample of queue size (packets) is generated at each packet insertion or removal. Insertions and removals occur when the Kernel Procedures op_subq_pk_insert() and op_subq_pk_remove() are called, respectively.
| Units | packets |
| Initial Value | 0.0 |