Implements the IEEE 802.1Q time aware shaper.

Usage diagram

The following diagram shows usage relationships between types. Unresolved types are missing from the diagram.

Inheritance diagram

The following diagram shows inheritance relationships for this type. Unresolved types are missing from the 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
numTrafficClasses	int	8	Number of traffic categories
bitrate	double
hasGcl	bool	false

Properties

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

Gates

Name	Direction	Size	Description
in	input
out	output

Signals

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

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode	Description
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
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
droppedPacketsQueueOverflow	dropped packets: queue overflow	packetDropReasonIsQueueOverflow(localSignal(packetDropped))	count	pk	none	the statistical value is the packet that is dropped due to queue overflow
queueingTime	queueing times	queueingTime(localSignal(packetPulled))	histogram, vector	s	none	the statistical value is the queueing time of packets
incomingDataRate	incoming datarate	throughput(localSignal(packetPushStarted))	vector	bps	linear	the statistical value is the data rate of the incoming packets
flowQueueingTime	flow queueing times	queueingTime(demuxFlow(localSignal(packetPulled)))	histogram, vector	s	none	the statistical value is the flow specific queueing time of packets
incomingPacketLengths	incoming packet lengths	packetLength(localSignal(packetPushStarted))	sum, histogram, vector	b	none	the statistical value is the length of the incoming packet
flowIncomingDataRate	flow specific incoming data rate	throughput(flowPacketLength(demuxFlow(localSignal(packetPushStarted))))	vector	bps	linear	the statistical value is the flow specific data rate of the incoming packets
outgoingDataRate	outgoing datarate	throughput(localSignal(packetPulled))	vector	bps	linear	the statistical value is the data rate of the outgoing packets
outgoingPacketLengths	outgoing packet lengths	packetLength(localSignal(packetPulled))	sum, histogram, vector	b	none	the statistical value is the length of the outgoing packet
droppedPacketLengthsQueueOverflow	dropped packet lengths: queue overflow	packetLength(packetDropReasonIsQueueOverflow(localSignal(packetDropped)))	sum, vector	b	none	the statistical value is the length of the packet that is dropped due to queue overflow
flowOutgoingDataRate	flow specific outgoing data rate	throughput(flowPacketLength(demuxFlow(localSignal(packetPulled))))	vector	bps	linear	the statistical value is the flow specific data rate of the outgoing packets
incomingPackets	incoming packets	localSignal(packetPushStarted)	count	pk		the statistical value is the incoming packet
outgoingPackets	outgoing packets	localSignal(packetPulled)	count	pk		the statistical value is the outgoing packet

Unassigned submodule parameters

Name	Type	Default value	Description
gateControlList.displayStringTextFormat	string	""	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
gateControlList.durations	object	[]	List of entry durations, e.g. [4ms, 2ms, 2ms, 2ms]
gateControlList.gateStates	object	[]	List of gate states, e.g. ["10000000", "01111111", "10000000", "01111111"]
gateControlList.numGates	int	8	Number of configured PeriodicGate modules
gateControlList.mapping	string		String specifying the gate index for the ith gate state, e.g. "76543210" means reverse gate index order

Source code

//
// Implements the IEEE 802.1Q time aware shaper.
//
module Ieee8021qTimeAwareShaper extends CompoundPacketQueueBase
{
    parameters:
        int numTrafficClasses = default(8); // Number of traffic categories
        double bitrate @unit(bps);
        bool hasGcl = default(false);
        *.bitrate = default(this.bitrate);
        *.extraLength = default(64b); // Overhead for Ethernet PHY header
    submodules:
        buffer: <default("")> like IPacketBuffer if typename != "" {
            parameters:
                @display("p=100,225");
        }
        gateControlList: GateControlList if hasGcl {
            parameters:
                @display("p=100,350");
        }
        classifier: <default("PcpTrafficClassClassifier")> like IPacketClassifier {
            parameters:
                @display("p=100,100");
        }
        queue[numTrafficClasses]: <default("PacketQueue")> like IPacketQueue {
            parameters:
                bufferModule = default(exists(parent.buffer) ? "^.buffer" : "");
                @display("p=300,100,column,125");
        }
        transmissionSelectionAlgorithm[numTrafficClasses]: <default("")> like IPacketGate {
            parameters:
                @display("p=500,100,column,125");
        }
        transmissionGate[numTrafficClasses]: <default("PeriodicGate")> like IPacketGate {
            parameters:
                @display("p=700,100,column,125");
        }
        transmissionSelection: <default("PriorityScheduler")> like IPacketScheduler {
            parameters:
                reverseOrder = default(true);
                @display("p=900,100");
        }
    connections:
        in --> { @display("m=w"); } --> classifier.in;
        for i=0..numTrafficClasses - 1 {
            classifier.out++ --> queue[i].in;
            queue[i].out --> transmissionSelectionAlgorithm[i].in;
            transmissionSelectionAlgorithm[i].out --> transmissionGate[i].in;
            transmissionGate[i].out --> transmissionSelection.in++;
        }
        transmissionSelection.out --> { @display("m=e"); } --> out;
}

File: src/inet/linklayer/ieee8021q/Ieee8021qTimeAwareShaper.ned

---

This documentation is released under the Creative Commons license