PacketClassifier

simple module

Connects one packet producer to multiple packet consumers. It can be pushed with packets from the connected packet producer. When this happens, the classifier pushes the packet to one of its connected packet consumers based on the configured packet classifier function. The packet classifier function takes a packet and returns an integer which in turn is used for determining the output gate.

Inheritance diagram

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

Used in compound modules

Name	Type	Description
CompoundPendingQueue	compound module	Implements a prioritized queue system for IEEE 802.11 MAC frames. Uses a classifier to separate incoming packets into three queues: management frames (highest priority), multicast frames (medium priority), and unicast frames (lowest priority). A priority scheduler then selects packets from these queues in order of priority.
EthernetPreemptingPhyLayer	compound module	(no description)
MultiDomainGptp	compound module	Combines multiple ~Gptp modules, one per time domain into a multi time domain time synchronization module. Each gPTP time domain is automatically configured to use the corresponding subclock of the clock passed into this module.

Used in

Name	Type	Description
GenericClassifierTutorialStep	network	(no description)

Known subclasses

Name	Type	Description
DynamicClassifier	simple module	(no description)
UserPriorityClassifier	simple module	Classifies packets based on the attached ~UserPriority tag.

Extends

Name	Type	Description
PacketClassifierBase	simple module	Base module for various packet classifier modules. Derived modules must implement a single packet classifier function which determines the index of the output gate for the next pushed packet.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"classified %p pk (%l)"	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
reverseOrder	bool	false
classifierClass	string		Determines the output queue of packets, the parameter must be the name of a C++ class which implements the IPacketClassifierFunction interface and is registered via Register_Class

Properties

Name	Value	Description
class	PacketClassifier
display	i=block/classifier

Gates

Name	Direction	Size	Description
in	input
out [ ]	output

Signals

Name	Type	Unit	Description
packetPushed	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode	Description
packetLengths	packet lengths	packetLength(packetPushed)	sum, histogram, vector	b	none	the statistical value is the length of the classified packet
dataRate	data rate	throughput(packetPushed)	vector	bps	linear	the statistical value is the data rate of the classified packets
packets	packets	packetPushed	count	pk		the statistical value is the classified packet

Source code

//
// Connects one packet producer to multiple packet consumers. It
// can be pushed with packets from the connected packet producer. When this
// happens, the classifier pushes the packet to one of its connected packet
// consumers based on the configured packet classifier function. The packet
// classifier function takes a packet and returns an integer which in turn
// is used for determining the output gate.
//
simple PacketClassifier extends PacketClassifierBase like IPacketClassifier
{
    parameters:
        string classifierClass; // Determines the output queue of packets, the parameter must be the name of a C++ class which implements the IPacketClassifierFunction interface and is registered via Register_Class
        @class(PacketClassifier);
}

File: src/inet/queueing/classifier/PacketClassifier.ned