Package: inet.queueing.queue


simple module

This is a limited packet queue which drops packets at the head of the queue.


Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the diagram.


Name Type Description
PacketQueue simple module

This module implements a widely configurable packet queue, which is suitable among others, to be used in MAC protocols, traffic conditioning, and quality of services. This module can be used on its own, but it's also often supplemented by additional queueing components such as servers, classifiers, schedulers, multiplexers, etc. This kind of composition allows to form a larger module which can act as a packet queue with more complex behavior.


Name Type Default value Description
displayStringTextFormat string "contains %p pk (%l) pushed %u\npulled %o removed %r dropped %d"

determines the text that is written on top of the submodule

packetCapacity int 100

maximum number of packets in the queue, no limit by default

dataCapacity int -1b

maximum total length of packets in the queue, no limit by default

dropperClass string "inet::queueing::PacketAtCollectionBeginDropper"

determines which packets are dropped when the queue is overloaded, packets are not dropped by default; the parameter must be the name of a C++ class which implements the IPacketDropperFunction C++ interface and is registered via Register_Class

comparatorClass string ""

determines the order of packets in the queue, insertion order by default; the parameter must be the name of a C++ class which implements the IPacketComparatorFunction C++ interface and is registered via Register_Class

bufferModule string ""

relative module path to the IPacketBuffer module used by this queue, implicit buffer by default


Name Value Description
display i=block/queue
class PacketQueue
defaultStatistic queueLength:vector


Name Direction Size Description
in input
out output


Name Type Unit
packetRemoved inet::Packet
packetPushStarted inet::Packet
packetDropped inet::Packet
packetPushEnded inet::Packet?
packetPulled inet::Packet


Name Title Source Record Unit Interpolation Mode
queueBitLength queue bit length warmup(atomic(constant0(packetPushEnded) + sum(packetLength(packetPushStarted)) - sum(packetLength(packetPulled)) - sum(packetLength(packetRemoved)) - sum(packetLength(packetDropped)))) last, max, timeavg, vector b sample-hold
queueLength queue length warmup(atomic(constant0(packetPushEnded) + count(packetPushStarted) - count(packetPulled) - count(packetRemoved) - count(packetDropped))) last, max, timeavg, vector pk sample-hold
droppedPacketsQueueOverflow dropped packets: queue overflow packetDropReasonIsQueueOverflow(packetDropped) count pk none
queueingTime queueing times queueingTime(packetPulled) histogram, vector s none
incomingDataRate incoming datarate throughput(packetPushStarted) vector bps linear
flowQueueingTime flow queueing times queueingTime(demuxFlow(packetPulled)) histogram, vector s none
incomingPacketLengths incoming packet lengths packetLength(packetPushStarted) sum, histogram, vector b none
flowIncomingDataRate flow specific incoming data rate throughput(flowPacketLength(demuxFlow(packetPushStarted))) vector bps linear
outgoingDataRate outgoing datarate throughput(packetPulled) vector bps linear
outgoingPacketLengths outgoing packet lengths packetLength(packetPulled) sum, histogram, vector b none
droppedPacketLengthsQueueOverflow dropped packet lengths: queue overflow packetLength(packetDropReasonIsQueueOverflow(packetDropped)) sum, vector b none
flowOutgoingDataRate flow specific outgoing data rate throughput(flowPacketLength(demuxFlow(packetPulled))) vector bps linear
incomingPackets incoming packets packetPushStarted count pk
outgoingPackets outgoing packets packetPulled count pk

Source code

// This is a limited packet queue which drops packets at the head of the queue.
simple DropHeadQueue extends PacketQueue
        packetCapacity = default(100);
        dropperClass = default("inet::queueing::PacketAtCollectionBeginDropper");
File: src/inet/queueing/queue/DropHeadQueue.ned