This module is a packet meter which measures the packet flow that is passing through and optionally attaches an EligibilityTimeTag to the packets. The tag contains the calculated simulation time when the packet becomes eligibile for transmission according to the asynchronous shaper algorithm.

This module is part of the asynchronous shaper infrastructure.

See also: EligibilityTimeGate, EligibilityTimeFilter, EligibilityTimeQueue, EligibilityTimeTag

Inheritance diagram

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

Extends

Name	Type	Description
PacketMeterBase	simple module	This is a base module for various packet meter modules. Derived modules must implement a single meterPacket() function which meters the flow of and attaches the required tags.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"metered %p pk (%l)"	determines the text that is written on top of the submodule
clockModule	string	""	relative path of a module that implements IClock; optional
packetOverheadLength	int	0b	extra packet length taken into account, can be used to represent overhead added by lower layers
committedInformationRate	double		committed information rate of the packet flow
committedBurstSize	int		committed burst size of the packet flow
maxResidenceTime	double	-1s	maximum packet residence time measured from the packet arrival time to the meter module to the transmission eligiblity time, not used by default

Properties

Name	Value	Description
display	i=block/star
class	EligibilityTimeMeter

Gates

Name	Direction	Size	Description
in	input
out	output

Signals

Name	Type	Unit
tokensChanged	double

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
numTokens	number of tokens	tokensChanged	vector	tk	linear

Direct method calls (observed)

call to	function	info
EligibilityTimeFilter	inet::EligibilityTimeFilter::pushPacket	pushPacket
PacketMultiplexer	inet::queueing::PacketMultiplexer::pushPacket	pushPacket
ActivePacketSource	inet::queueing::ActivePacketSource::handleCanPushPacketChanged	handleCanPushPacketChanged

Called methods (observed)

function	info	call from
inet::EligibilityTimeMeter::handleCanPushPacketChanged	handleCanPushPacketChanged	PacketMultiplexer
inet::EligibilityTimeMeter::pushPacket	pushPacket	InteractiveGate, ActivePacketSource

Pushed in messages (observed)

gate	msg	kind	ctrl	srcModule	tags
in	Packet	0		InteractiveGate	DirectionTag, DispatchProtocolReq, DropEligibleInd, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, StreamInd, UserPriorityInd, VlanInd
in	Packet	0		ActivePacketSource	DirectionTag, PacketProtocolTag

Push out messages (observed)

gate	msg	kind	ctrl	destModule	tags
out	Packet	0		EligibilityTimeFilter	DirectionTag, DispatchProtocolReq, DropEligibleInd, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, StreamInd, UserPriorityInd, VlanInd, EligibilityTimeTag?
out	Packet	0		PacketMultiplexer	DirectionTag, PacketProtocolTag, EligibilityTimeTag?

Shared Tagging operations (observed)

tagType	tagAction
EligibilityTimeTag	addTagIfAbsent

Region Tagging operations (observed)

tagType	tagAction
FlowTag	mapAllTags

Source code

//
// This module is a packet meter which measures the packet flow that is passing
// through and optionally attaches an ~EligibilityTimeTag to the packets. The
// tag contains the calculated simulation time when the packet becomes eligibile
// for transmission according to the asynchronous shaper algorithm.
//
// This module is part of the asynchronous shaper infrastructure.
//
// @see ~EligibilityTimeGate, ~EligibilityTimeFilter, ~EligibilityTimeQueue, ~EligibilityTimeTag
//
simple EligibilityTimeMeter extends PacketMeterBase like IPacketMeter
{
    parameters:
        string clockModule = default(""); // relative path of a module that implements IClock; optional
        int packetOverheadLength @unit(b) = default(0b); // extra packet length taken into account, can be used to represent overhead added by lower layers
        double committedInformationRate @unit(bps); // committed information rate of the packet flow
        int committedBurstSize @unit(b); // committed burst size of the packet flow
        double maxResidenceTime @unit(s) = default(-1s); // maximum packet residence time measured from the packet arrival time to the meter module to the transmission eligiblity time, not used by default
        @class(EligibilityTimeMeter);
        @signal[tokensChanged](type=double);
        @statistic[numTokens](title="number of tokens"; source=tokensChanged; record=vector; unit=tk; interpolationmode=linear);
}

File: src/inet/protocolelement/shaper/EligibilityTimeMeter.ned

---

This documentation is released under the Creative Commons license