RedDropperQueue¶

compound module RedDropperQueue

Combines a packet queue with random early detection (RED) dropper.

Usage diagram¶

Inheritance diagram¶

Extends¶

Name	Type	Description
CompoundPacketQueueBase	compound module	This compound module serves as a base module for complex packet queues formed by combining several queueing components.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“contains %p pk (%l) pushed %u created %c\n pulled %o removed %r dropped %d”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
packetCapacity	int	-1	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	“”	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

Properties¶

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

Gates¶

Name	Direction	Size	Description
in	input
out	output

Signals¶

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

Statistics¶

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

Unassigned submodule parameters¶

Name	Type	Default value	Description
red.displayStringTextFormat	string	“dropped {numDroppedPackets}/{numProcessedPackets} pk ({droppedTotalLength}/{processedTotalLength})”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
red.backpressure	bool	false
red.collectionModule	string	“”
red.wq	double	0.002	Weight of the current queue length in the averaged queue length, in range [0.0, 1.0]
red.minth	double	5	Minimum threshold for average queue length
red.maxth	double	50	Maximum threshold for average queue length (=buffer capacity), in range (minth,packetCapacity]
red.maxp	double	0.02	Maximum value for pbs, in range [0.0, 1.0]
red.pkrate	double	150	Average packet rate for calculations when queue is empty
red.useEcn	bool	false	If enabled, packets are marked with ECN if applicable
red.packetCapacity	int	int(maxth)	Packets are dropped if queue length is greater
fifo.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, supports displaying pars, watches, and module-specific information
fifo.packetCapacity	int	-1	Maximum number of packets in the queue, no limit by default
fifo.dataCapacity	int	-1b	Maximum total length of packets in the queue, no limit by default
fifo.dropperClass	string	“”	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
fifo.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
fifo.bufferModule	string	“”	Relative module path to the IPacketBuffer module used by this queue, implicit buffer by default

Source code¶

//
// Combines a packet queue with random early detection (RED) dropper.
//
module RedDropperQueue extends CompoundPacketQueueBase
{
    submodules:
        red: RedDropper {
            @display("p=100,100");
        }
        fifo: <default("PacketQueue")> like IPacketQueue {
            @display("p=100,200");
        }
    connections:
        in --> { @display("m=n"); } --> red.in;
        red.out --> fifo.in;
        fifo.out --> { @display("m=s"); } --> out;
}

File: src/inet/queueing/queue/RedMarkerQueue.ned