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.

<b>See also:</b> ~IPacketMarker, ~PacketLabeler

Inheritance diagram

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

Known subclasses

Name	Type	Description
EcnMarker	simple module	Sets Explicit Congestion Notification (ECN) bits in the IPv4 header based on the attached `EcnReq` tag on the packets.
PacketLabeler	simple module	Attaches a ~LabelsTag to packets based on the configured filters. For each matching filter, a new label is attached.
PacketLabelerBase	simple module	Base module for various packet labeler modules.
PacketTaggerBase	simple module	Base module for various packet tagger modules.

Extends

Name	Type	Description
PacketFlowBase	simple module	Base module for various packet flow modules. A packet flow module passes or streams all pushed or pulled packets after processing them from its input to its output.

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

Properties

Name	Value	Description
class	PacketMarkerBase
display	i=block/rightarrow

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 marker modules. Derived modules must
// implement a single `markPacket()` function which marks the individual packets
// by attaching tags.
//
// @see ~IPacketMarker, ~PacketLabeler
//
simple PacketMarkerBase extends PacketFlowBase
{
    parameters:
        displayStringTextFormat = default("marked %p pk (%l)");
        @class(PacketMarkerBase);
}

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