PacketTaggerBase

simple module

Base module for various packet tagger modules.

Inheritance diagram

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

Known subclasses

Name	Type	Description
ContentBasedTagger	simple module	Attaches various request tags to packets.
PacketTagger	simple module	Attaches various request tags to packets.

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	"tagged %p pk (%l)"	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
dscp	int	-1	Specifies differentiated services code point
ecn	int	-1	Specifies explicit congestion notification
tos	int	-1	If not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value
interfaceName	string	""	Specifies outgoing interface, unused by default
hopLimit	int	-1	Specifies network layer TTL, unused by default
vlanId	int	-1	Specifies VLAN, unused by default
pcp	int	-1	Specifies PCP, unused by default
userPriority	int	-1	Specifies user priority, unused by default
transmissionPower	double	nan W	Specifies signal transmission power, unused by default
encapsulationProtocols	object	[]

Properties

Name	Value	Description
class	PacketTaggerBase
display	i=block/star

Gates

Name	Direction	Size	Description
in	input
out	output

Signals

Name	Type	Unit	Description
packetPushedIn	inet::Packet
packetPulledIn	inet::Packet
packetPushedOut	inet::Packet
packetPulledOut	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
outgoingDataRate	outgoing data rate	throughput(merge(packetPushedOut, packetPulledOut))	vector	bps	linear	the statistical value is the data rate of the outgoing packets
incomingDataRate	incoming data rate	throughput(merge(packetPushedIn, packetPulledIn))	vector	bps	linear	the statistical value is the data rate of the incoming packets
outgoingPacketLengths	outgoing packet lengths	packetLength(merge(packetPushedOut, packetPulledOut))	sum, histogram, vector	b	none	the statistical value is the length of the outgoing packet
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
incomingPacketLengths	incoming packet lengths	packetLength(merge(packetPushedIn, packetPulledIn))	sum, histogram, vector	b	none	the statistical value is the length of the incoming packet
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
incomingPackets	incoming packets	merge(packetPushedIn, packetPulledIn)	count	pk		the statistical value is the incoming packet
outgoingPackets	outgoing packets	merge(packetPushedOut, packetPulledOut)	count	pk		the statistical value is the outgoing packet

Source code

//
// Base module for various packet tagger modules.
//
simple PacketTaggerBase extends PacketMarkerBase
{
    parameters:
        int dscp = default(-1); // Specifies differentiated services code point
        int ecn = default(-1); // Specifies explicit congestion notification
        int tos = default(-1); // If not -1, set the Type Of Service (IPv4) / Traffic Class (IPv6) field of sent packets to this value
        string interfaceName = default(""); // Specifies outgoing interface, unused by default
        int hopLimit = default(-1); // Specifies network layer TTL, unused by default
        int vlanId = default(-1); // Specifies VLAN, unused by default
        int pcp = default(-1); // Specifies PCP, unused by default
        int userPriority = default(-1); // Specifies user priority, unused by default
        double transmissionPower @unit(W) = default(nan W); // Specifies signal transmission power, unused by default
        object encapsulationProtocols = default([]);
        displayStringTextFormat = default("tagged %p pk (%l)");
        @class(PacketTaggerBase);
        @display("i=block/star");
}

File: src/inet/queueing/base/PacketTaggerBase.ned