DSQueue1

Package: inet.examples.diffserv.onedomain

DSQueue1

compound module

Diffserv Queue used in Experiment 1.1 - 1.6 and 5.1.

classifier : BehaviorAggregateClassifier

Reads the DSCP (lower six bits of ToS/TrafficClass) from the received datagram, and forwards the...

Source:
classifier: BehaviorAggregateClassifier {
    dscps = "EF AF11 AF21 AF31 AF41";
    @display("p=100,350");
} efQueue : DropTailQueue

A limited packet queue that drops packets at the tail of the queue.

Source:
efQueue: DropTailQueue {
    @display("p=250,100");
} af1xQueue : DropTailQueue

A limited packet queue that drops packets at the tail of the queue.

Source:
af1xQueue: DropTailQueue {
    @display("p=250,200");
} af2xQueue : DropTailQueue

A limited packet queue that drops packets at the tail of the queue.

Source:
af2xQueue: DropTailQueue {
    @display("p=250,300");
} af3xQueue : DropTailQueue

A limited packet queue that drops packets at the tail of the queue.

Source:
af3xQueue: DropTailQueue {
    @display("p=250,400");
} af4xQueue : DropTailQueue

A limited packet queue that drops packets at the tail of the queue.

Source:
af4xQueue: DropTailQueue {
    @display("p=250,500");
} beQueue : DropTailQueue

A limited packet queue that drops packets at the tail of the queue.

Source:
beQueue: DropTailQueue {
    @display("p=250,600");
} wrr : WrrScheduler

Implements weighted round-robin scheduling.

Source:
wrr: WrrScheduler {
    @display("p=400,350");
} priority : PriorityScheduler

This scheduler pulls packets from the first non-empty among its connected packet providers.

Source:
priority: PriorityScheduler {
    @display("p=550,350");
}

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

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
classifier.displayStringTextFormat string "classified %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

classifier.reverseOrder bool false
efQueue.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

efQueue.packetCapacity int 100

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

efQueue.dataCapacity int -1b

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

efQueue.dropperClass string "inet::queueing::PacketAtCollectionEndDropper"

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

efQueue.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

efQueue.bufferModule string ""

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

af1xQueue.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

af1xQueue.packetCapacity int 100

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

af1xQueue.dataCapacity int -1b

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

af1xQueue.dropperClass string "inet::queueing::PacketAtCollectionEndDropper"

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

af1xQueue.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

af1xQueue.bufferModule string ""

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

af2xQueue.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

af2xQueue.packetCapacity int 100

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

af2xQueue.dataCapacity int -1b

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

af2xQueue.dropperClass string "inet::queueing::PacketAtCollectionEndDropper"

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

af2xQueue.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

af2xQueue.bufferModule string ""

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

af3xQueue.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

af3xQueue.packetCapacity int 100

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

af3xQueue.dataCapacity int -1b

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

af3xQueue.dropperClass string "inet::queueing::PacketAtCollectionEndDropper"

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

af3xQueue.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

af3xQueue.bufferModule string ""

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

af4xQueue.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

af4xQueue.packetCapacity int 100

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

af4xQueue.dataCapacity int -1b

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

af4xQueue.dropperClass string "inet::queueing::PacketAtCollectionEndDropper"

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

af4xQueue.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

af4xQueue.bufferModule string ""

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

beQueue.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

beQueue.packetCapacity int 100

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

beQueue.dataCapacity int -1b

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

beQueue.dropperClass string "inet::queueing::PacketAtCollectionEndDropper"

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

beQueue.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

beQueue.bufferModule string ""

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

wrr.displayStringTextFormat string "scheduled %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

wrr.reverseOrder bool false
wrr.weights string
priority.displayStringTextFormat string "scheduled %p pk (%l)"

Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information

priority.reverseOrder bool false

Source code

//
// Diffserv Queue used in Experiment 1.1 - 1.6 and 5.1.
//
module DSQueue1 extends CompoundPacketQueueBase
{
    submodules:
        classifier: BehaviorAggregateClassifier {
            dscps = "EF AF11 AF21 AF31 AF41";
            @display("p=100,350");
        }
        efQueue: DropTailQueue {
            @display("p=250,100");
        }
        af1xQueue: DropTailQueue {
            @display("p=250,200");
        }
        af2xQueue: DropTailQueue {
            @display("p=250,300");
        }
        af3xQueue: DropTailQueue {
            @display("p=250,400");
        }
        af4xQueue: DropTailQueue {
            @display("p=250,500");
        }
        beQueue: DropTailQueue {
            @display("p=250,600");
        }
        wrr: WrrScheduler {
            @display("p=400,350");
        }
        priority: PriorityScheduler {
            @display("p=550,350");
        }

    connections:
        in --> classifier.in;
        classifier.out++ --> efQueue.in;
        classifier.out++ --> af1xQueue.in;
        classifier.out++ --> af2xQueue.in;
        classifier.out++ --> af3xQueue.in;
        classifier.out++ --> af4xQueue.in;
        classifier.defaultOut --> beQueue.in;

        af1xQueue.out --> wrr.in++;
        af2xQueue.out --> wrr.in++;
        af3xQueue.out --> wrr.in++;
        af4xQueue.out --> wrr.in++;
        beQueue.out --> wrr.in++;
        efQueue.out --> priority.in++;
        wrr.out --> priority.in++;
        priority.out --> out;
}

File: examples/diffserv/onedomain/DSQueue1.ned