PacketLabeler¶

simple module PacketLabeler

Attaches a LabelsTag to packets based on the configured filters. For each matching filter, a new label is attached.

Inheritance diagram¶

Extends¶

Name	Type	Description
PacketMarkerBase	simple module	Base module for various packet marker modules. Derived modules must implement a single `markPacket()` function which marks the individual packets by attaching tags.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“marked %p pk (%l)”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
filterClasses	string	“”	Determines the packets that are marked. The parameter must be the name of a C++ class that implements the IPacketFilterFunction interface and is registered via Register_Class.
labels	string	“”	A space-separated list of labels.

Properties¶

Name	Value	Description
class	PacketLabeler
display	i=block/star

Gates¶

Name	Direction	Size	Description
in	input
out	output

Signals¶

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

Statistics¶

Name	Title	Source	Record	Unit	Interpolation Mode	Description
flowIncomingDataRate	flow specific incoming data rate	throughput(demuxFlow(merge(packetPushedIn, packetPulledIn)))	vector	bps	linear	the statistical value is the flow specific data rate of the incoming packets
flowIncomingPacketLengths	flow specific incoming packet lengths	packetLength(demuxFlow(merge(packetPushedIn, packetPulledIn)))	sum,histogram,vector	b	none	the statistical value is the flow specific length of the incoming packet
flowOutgoingDataRate	flow specific outgoing data rate	throughput(demuxFlow(merge(packetPushedOut, packetPulledOut)))	vector	bps	linear	the statistical value is the flow specific data rate of the outgoing packets
flowOutgoingPacketLengths	flow specific outgoing packet lengths	packetLength(demuxFlow(merge(packetPushedOut, packetPulledOut)))	sum,histogram,vector	b	none	the statistical value is the flow specific length of the outgoing packet
incomingDataRate	incoming data rate	throughput(merge(packetPushedIn, packetPulledIn))	vector	bps	linear	the statistical value is the data rate of the incoming packets
incomingPacketLengths	incoming packet lengths	packetLength(merge(packetPushedIn, packetPulledIn))	sum,histogram,vector	b	none	the statistical value is the length of the incoming packet
incomingPackets	incoming packets	merge(packetPushedIn, packetPulledIn)	count	pk		the statistical value is the incoming packet
outgoingDataRate	outgoing data rate	throughput(merge(packetPushedOut, packetPulledOut))	vector	bps	linear	the statistical value is the data rate of the outgoing packets
outgoingPacketLengths	outgoing packet lengths	packetLength(merge(packetPushedOut, packetPulledOut))	sum,histogram,vector	b	none	the statistical value is the length of the outgoing packet
outgoingPackets	outgoing packets	merge(packetPushedOut, packetPulledOut)	count	pk		the statistical value is the outgoing packet

Source code¶

//
// Attaches a ~LabelsTag to packets based on the configured filters.
// For each matching filter, a new label is attached.
//
simple PacketLabeler extends PacketMarkerBase like IPacketMarker
{
    parameters:
        string filterClasses = default(""); // Determines the packets that are marked. The parameter must be the name of a C++ class that implements the IPacketFilterFunction interface and is registered via Register_Class.
        string labels = default(""); // A space-separated list of labels.
        @display("i=block/star");
        @class(PacketLabeler);
}

File: src/inet/queueing/marker/PacketLabeler.ned