AsynchronousShaper¶

compound module AsynchronousShaper

Implements an asynchronous shaper. The queue sorts packets based on the transmission eligibility time (EligibilityTimeTag) attached to each packet. The gate prevents packets from being transmitted earlier than the attached transmission eligibility time.

Inheritance diagram¶

Extends¶

Name	Type	Description
PacketShaper	compound module	Combines a packet queue and a packet gate into a packet shaper module. The queue stores the packets sorted according to its ordering and the gate decides when the first packet can be pulled from the queue.

Properties¶

Name	Value	Description
display	i=block/bucket

Gates¶

Name	Direction	Size	Description
in	input
out	output

Unassigned submodule parameters¶

Name	Type	Default value	Description
queue.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
queue.packetCapacity	int	-1	Maximum number of packets in the queue, no limit by default
queue.dataCapacity	int	-1b	Maximum total length of packets in the queue, no limit by default
queue.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
queue.comparatorClass	string	“inet::PacketEligibilityTimeComparator”	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
queue.bufferModule	string	“”	Relative module path to the IPacketBuffer module used by this queue, implicit buffer by default
gate.displayStringTextFormat	string	“eligible in {remainingEligibilityTime}\npassed %p pk (%l)”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
gate.bitrate	double	nan bps
gate.extraLength	int	0b
gate.extraDuration	double	0s
gate.clockModule	string	“”	Relative path of the module that implements IClock(1,:ref:2 <neddoc-msg-inet-iclock>); optional

Source code¶

//
// Implements an asynchronous shaper. The queue sorts packets based
// on the transmission eligibility time (~EligibilityTimeTag) attached to each
// packet. The gate prevents packets from being transmitted earlier than the attached
// transmission eligibility time.
//
// @see ~EligibilityTimeMeter, ~EligibilityTimeFilter, ~EligibilityTimeQueue, ~EligibilityTimeGate
//
module AsynchronousShaper extends PacketShaper
{
    parameters:
        queue.typename = default("EligibilityTimeQueue");
        gate.typename = default("EligibilityTimeGate");
}

File: src/inet/queueing/shaper/AsynchronousShaper.ned