EligibilityTimeFilter

simple module

This module is a packet filter that operates based on the EligibilityTimeTag attached to the packet that is passing through. Packets are dropped if the tag is missing. If the maxResidenceTime parameter is set, then the filter also drops the packets for which the eligibility time in the attached EligibilityTimeTag is greater than the current simulation time plus the maximum residence time.

This module is part of the asynchronous shaper architecture.

Inheritance diagram

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

Extends

Name	Type	Description
PacketFilterBase	simple module	This is a base module for various packet filter modules. Derived modules must implement a single packet matcher function which determines if a packet is to be passed through or filtered out.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"dropped %d/%p pk (%k/%l)"	determines the text that is written on top of the submodule
backpressure	bool	false
clockModule	string	""	relative path of a module that implements IClock; optional
maxResidenceTime	double	-1s	optional max residence time limit, not used by default

Properties

Name	Value	Description
display	i=block/downarrow
class	EligibilityTimeFilter

Gates

Name	Direction	Size	Description
in	input
out	output

Signals

Name	Type	Unit
packetPushedIn	inet::Packet
packetPulledIn	inet::Packet
packetDropped	inet::Packet
packetPushedOut	inet::Packet
packetPulledOut	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
flowDroppedPacketLengths	flow specific dropped packet lengths	packetLength(demuxFlow(packetDropped))	sum, histogram, vector	b	none
incomingDataRate	incoming data rate	throughput(merge(packetPushedIn, packetPulledIn))	vector	bps	linear
droppedPacketLengths	dropped packet lengths	packetLength(packetDropped)	sum, histogram, vector	b	none
incomingPacketLengths	incoming packet lengths	packetLength(merge(packetPushedIn, packetPulledIn))	sum, histogram, vector	b	none
droppedDataRate	dropped data rate	throughput(packetDropped)	vector	bps	linear
flowOutgoingPacketLengths	flow specific outgoing packet lengths	packetLength(demuxFlow(merge(packetPushedOut, packetPulledOut)))	sum, histogram, vector	b	none
flowDroppedDataRate	flow specific dropped data rate	throughput(demuxFlow(packetDropped))	vector	bps	linear
droppedPackets	dropped packets	packetDropped	count	pk
flowIncomingDataRate	flow specific incoming data rate	throughput(demuxFlow(merge(packetPushedIn, packetPulledIn)))	vector	bps	linear
outgoingDataRate	outgoing data rate	throughput(merge(packetPushedOut, packetPulledOut))	vector	bps	linear
outgoingPacketLengths	outgoing packet lengths	packetLength(merge(packetPushedOut, packetPulledOut))	sum, histogram, vector	b	none
flowIncomingPacketLengths	flow specific incoming packet lengths	packetLength(demuxFlow(merge(packetPushedIn, packetPulledIn)))	sum, histogram, vector	b	none
flowOutgoingDataRate	flow specific outgoing data rate	throughput(demuxFlow(merge(packetPushedOut, packetPulledOut)))	vector	bps	linear
incomingPackets	incoming packets	merge(packetPushedIn, packetPulledIn)	count	pk
outgoingPackets	outgoing packets	merge(packetPushedOut, packetPulledOut)	count	pk

Direct method calls (observed)

call to	function	info
EligibilityTimeQueue	inet::queueing::PacketQueue::pushPacket	pushPacket
PacketMultiplexer	inet::queueing::PacketMultiplexer::handleCanPushPacketChanged	handleCanPushPacketChanged
PacketMultiplexer	inet::queueing::PacketMultiplexer::pushPacket	pushPacket

Called methods (observed)

function	info	call from
inet::EligibilityTimeFilter::handleCanPushPacketChanged	handleCanPushPacketChanged	EligibilityTimeQueue
inet::EligibilityTimeFilter::pushPacket	pushPacket	EligibilityTimeMeter, PacketMultiplexer

Pushed in messages (observed)

gate	msg	kind	ctrl	srcModule	tags
in	Packet	0		EligibilityTimeMeter	DirectionTag, DispatchProtocolReq, DropEligibleInd, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, StreamInd, UserPriorityInd, VlanInd, EligibilityTimeTag?
in	Packet	0		PacketMultiplexer	DirectionTag, PacketProtocolTag, EligibilityTimeTag?

Push out messages (observed)

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

Shared Tagging operations (observed)

tagType	tagAction
EligibilityTimeTag	findTag

Region Tagging operations (observed)

tagType	tagAction
FlowTag	mapAllTags

Source code

//
// This module is a packet filter that operates based on the ~EligibilityTimeTag
// attached to the packet that is passing through. Packets are dropped if the tag
// is missing. If the maxResidenceTime parameter is set, then the filter also drops
// the packets for which the eligibility time in the attached ~EligibilityTimeTag
// is greater than the current simulation time plus the maximum residence time.
//
// This module is part of the asynchronous shaper architecture.
//
// @see ~EligibilityTimeGate, ~EligibilityTimeQueue, ~EligibilityTimeMeter, ~EligibilityTimeTag
//
simple EligibilityTimeFilter extends PacketFilterBase like IPacketFilter
{
    parameters:
        string clockModule = default(""); // relative path of a module that implements IClock; optional
        double maxResidenceTime @unit(s) = default(-1s); // optional max residence time limit, not used by default
        @class(EligibilityTimeFilter);
}

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