EthernetQueue

compound module

Queue module that gives the PAUSE frames a higher priority.

Inheritance diagram

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

Extends

Name	Type	Description
DropTailQueue	simple module	This module is a limited packet queue which drops packets at the tail of the queue.

Parameters

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::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
comparatorClass	string	"inet::EthernetFrameTypeComparator"	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

Properties

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

Gates

Name	Direction	Size	Description
in	input
out	output

Signals

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

Statistics

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

Direct method calls (observed)

call to	function	info
EthernetCsmaMac	inet::EthernetCsmaMac::handleCanPullPacketChanged	handleCanPullPacketChanged
EthernetMac	inet::EthernetMac::handleCanPullPacketChanged	handleCanPullPacketChanged
EthernetQueue	inet::queueing::PacketQueue::pushPacket	pushPacket

Called methods (observed)

function	info	call from
inet::queueing::PacketQueue::pullPacket	pullPacket	EthernetCsmaMac, EthernetMac
inet::queueing::PacketQueue::pushPacket	pushPacket	EthernetQueue

Incoming messages (observed)

gate	msg	kind	ctrl	srcModule	tags
in	Packet	0		EthernetEncapsulation	InterfaceReq, MacAddressReq, PacketProtocolTag, DirectionTag?, DispatchProtocolInd?, DscpInd?, EcnInd?, ErrorRateInd?, HopLimitInd?, Ieee802SapInd?, Ieee802SapReq?, InterfaceInd?, L3AddressInd?, L3AddressReq?, MacAddressInd?, MulticastReq?, NetworkProtocolInd?, SignalPowerInd?, SignalTimeInd?, SnirInd?, SocketReq?, TosInd?, TransportProtocolInd?, Ieee80211ChannelInd?, Ieee80211ModeInd?
in	Packet	4		EthernetEncapsulation	DispatchProtocolInd, InterfaceInd, InterfaceReq, MacAddressReq, NetworkProtocolInd, PacketProtocolTag

Pulled out messages (observed)

gate	msg	kind	destModule	tags
out	Packet	0	EthernetCsmaMac	InterfaceReq, MacAddressReq, PacketProtocolTag, DirectionTag?, DispatchProtocolInd?, EcnInd?, Ieee802SapReq?, NetworkProtocolInd?, SocketReq?, TransportProtocolInd?
out	Packet	0	EthernetMac	InterfaceReq, MacAddressReq, PacketProtocolTag, DirectionTag?, DispatchProtocolInd?, DscpInd?, EcnInd?, ErrorRateInd?, HopLimitInd?, Ieee802SapInd?, Ieee802SapReq?, InterfaceInd?, L3AddressInd?, L3AddressReq?, MacAddressInd?, MulticastReq?, NetworkProtocolInd?, SignalPowerInd?, SignalTimeInd?, SnirInd?, SocketReq?, TosInd?, TransportProtocolInd?, Ieee80211ChannelInd?, Ieee80211ModeInd?
out	Packet	4	EthernetMac	DispatchProtocolInd, InterfaceInd, InterfaceReq, MacAddressReq, NetworkProtocolInd, PacketProtocolTag

Packet operations (observed)

chunkType	packetAction
EthernetMacHeader	peekAtFront

Region Tagging operations (observed)

tagType	tagAction
FlowTag	mapAllTags
PacketEventTag	mapAllTagsForUpdate
QueueingTimeTag	mapAllTagsForUpdate

Source code

//
// Queue module that gives the PAUSE frames a higher priority.
//
//# TODO rename to EthernetQosQueue or keep name as it is?
module EthernetQueue extends DropTailQueue
{
    parameters:
        comparatorClass = default("inet::EthernetFrameTypeComparator");
}

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