EthernetQosQueue

Package: inet.linklayer.ethernet.common

compound module EthernetQosQueue

Queue module that gives the PAUSE frames a higher priority, and can be parametrized with an IPacketQueue for serving the data frames.

EthernetQosQueuein --> classifier.inclassifier.out++ --> pauseQueue.inclassifier.out++ --> dataQueue.inpauseQueue.out --> scheduler.in++dataQueue.out --> scheduler.in++scheduler.out --> outclassifier: inet.linklayer.ethernet.common.EthernetFrameClassifier (like IPacketClassifier) EthernetFrameClassifier: Classifier that forwards Ethernet PAUSE frames to the `pauseOut` gate, and other frames to the `d... IPacketClassifier: Interface for packet classifier modules. Source: classifier: <default("EthernetFrameClassifier")> like IPacketClassifier { parameters: @display("p=100,200"); }classifierpauseQueue: inet.queueing.queue.DropTailQueue (like IPacketQueue) DropTailQueue: A limited packet queue that drops packets at the tail of the queue. IPacketQueue: Interface for packet queue modules. Source: pauseQueue: <default("DropTailQueue")> like IPacketQueue { parameters: @display("p=250,100"); }pauseQueuedataQueue: inet.queueing.queue.DropTailQueue (like IPacketQueue) DropTailQueue: A limited packet queue that drops packets at the tail of the queue. IPacketQueue: Interface for packet queue modules. Source: dataQueue: <default("DropTailQueue")> like IPacketQueue { parameters: @display("p=250,300;q=l2queue"); }#dataQueuescheduler: inet.queueing.scheduler.PriorityScheduler (like IPacketScheduler) PriorityScheduler: This scheduler pulls packets from the first non-empty among its connected packet providers. IPacketScheduler: Interface for packet scheduler modules. Source: scheduler: <default("PriorityScheduler")> like IPacketScheduler { parameters: @display("p=400,200"); }scheduler

Usage diagram

compound module EthernetQosQueueEthernetQosQueuesimple module EthernetFrameClassifierEthernetFrameClassifiersimple module DropTailQueueDropTailQueuesimple module PrioritySchedulerPriorityScheduler

Inheritance diagram

compound module EthernetQosQueueEthernetQosQueuecompound module CompoundPacketQueueBaseCompoundPacketQueueBasemodule interface IPacketQueueIPacketQueue

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

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

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

pauseQueue.packetCapacity

int

100

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

pauseQueue.dataCapacity

int

-1b

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

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

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

pauseQueue.bufferModule

string

“”

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

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

dataQueue.packetCapacity

int

100

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

dataQueue.dataCapacity

int

-1b

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

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

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

dataQueue.bufferModule

string

“”

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

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

scheduler.reverseOrder

bool

false

Source code

//
// Queue module that gives the PAUSE frames a higher priority,
// and can be parametrized with an ~IPacketQueue for serving the
// data frames.
//
//# TODO rename to `CompoundEtherQueue`? or `CompoundEtherQosQueue`?
module EthernetQosQueue extends CompoundPacketQueueBase like IPacketQueue
{
    parameters:
        @display("i=block/queue");
    submodules:
        classifier: <default("EthernetFrameClassifier")> like IPacketClassifier {
            parameters:
                @display("p=100,200");
        }
        pauseQueue: <default("DropTailQueue")> like IPacketQueue {
            parameters:
                @display("p=250,100");
        }
        dataQueue: <default("DropTailQueue")> like IPacketQueue {
            parameters:
                @display("p=250,300;q=l2queue");
        }
        scheduler: <default("PriorityScheduler")> like IPacketScheduler {
            parameters:
                @display("p=400,200");
        }
    connections:
        in --> classifier.in;
        classifier.out++ --> pauseQueue.in;
        classifier.out++ --> dataQueue.in;
        pauseQueue.out --> scheduler.in++;
        dataQueue.out --> scheduler.in++;
        scheduler.out --> out;
}

File: src/inet/linklayer/ethernet/common/EthernetQosQueue.ned