PacketClassifier¶

simple module PacketClassifier

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.

Usage diagram¶

Inheritance diagram¶

Used in compound modules¶

Name	Type	Description
TelnetServerConnection	compound module	Contains a configurable pre-composed telnet traffic source and traffic sink as part of a telnet server application.
EthernetPreemptingMacLayer	compound module	(no 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.
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.
Ieee8022LlcLayer	compound module	(no description)
EthernetPreemptingPhyLayer	compound module	(no description)
MultiPacketPolicing	compound module	Combines multiple packet policing modules into one.
GatingPriorityQueue	compound module	Implements a priority queue with multiple inner queues each having its own periodic gate for packet selection and an optional shared memory buffer.
PriorityQueue	compound module	Implements a priority queue with multiple inner queues and an optional shared memory buffer.
PriorityShaper	compound module	Combines a classifier, a scheduler, and several traffic shapers into a single packet shaper. Packets are classified into one of the traffic shapers, and the scheduler prioritizes among them.
RequestConsumer	compound module	Processes incoming packets one by one in the order they arrive. First, it classifies a packet according to the configured classifier function, then it generates tokens for the selected category in the configured response producer.

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
dataRate	data rate	throughput(packetPushed)	vector	bps	linear	the statistical value is the data rate of the classified packets
packetLengths	packet lengths	packetLength(packetPushed)	sum,histogram,vector	b	none	the statistical value is the length of the classified packet
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