This 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	(no description)
EthernetPreemptingMacLayer	compound module	(no description)
EthernetPreemptingPhyLayer	compound module	(no description)
MultiDomainGptp	compound module	This 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 in to this module.

Known subclasses

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

Extends

Name	Type	Description
PacketClassifierBase	simple module	This is a 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
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
display	i=block/classifier
class	PacketClassifier

Gates

Name	Direction	Size	Description
in	input
out [ ]	output

Signals

Name	Type	Unit
packetPushed	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
packetLengths	packet lengths	packetLength(packetPushed)	sum, histogram, vector	b	none
dataRate	data rate	throughput(packetPushed)	vector	bps	linear
packets	packets	packetPushed	count	pk

Direct method calls (observed)

call to	function	info
MessageDispatcher	inet::MessageDispatcher::handleRegisterProtocol	handleRegisterProtocol
PcapRecorder	inet::PcapRecorder::receiveSignal	packetReceivedFromLower
EthernetFragmentPhyHeaderChecker	inet::physicallayer::EthernetFragmentPhyHeaderChecker::pushPacket	pushPacket
EthernetFragmentPhyHeaderInserter	inet::physicallayer::EthernetFragmentPhyHeaderInserter::pushPacketEnd	pushPacketEnd
EthernetFragmentPhyHeaderInserter	inet::physicallayer::EthernetFragmentPhyHeaderInserter::pushPacketStart	pushPacketStart
EthernetPhyHeaderChecker	inet::physicallayer::EthernetPhyHeaderChecker::pushPacket	pushPacket
EthernetPhyHeaderInserter	inet::physicallayer::EthernetPhyHeaderInserter::pushPacketEnd	pushPacketEnd
EthernetPhyHeaderInserter	inet::physicallayer::EthernetPhyHeaderInserter::pushPacketStart	pushPacketStart
PacketEmitter	inet::PacketEmitter::pushPacket	pushPacket
PacketCloner	inet::queueing::PacketCloner::handleCanPushPacketChanged	handleCanPushPacketChanged
DropTailQueue	inet::queueing::PacketQueue::pushPacket	pushPacket
PreemptingServer	inet::queueing::PreemptingServer::handleCanPushPacketChanged	handleCanPushPacketChanged
TokenBasedServer	inet::queueing::TokenBasedServer::handleCanPushPacketChanged	handleCanPushPacketChanged
PassivePacketSink	inet::queueing::PassivePacketSink::pushPacket	pushPacket
ActivePacketSource	inet::queueing::ActivePacketSource::handleCanPushPacketChanged	handleCanPushPacketChanged
PacketBasedTokenGenerator	inet::queueing::PacketBasedTokenGenerator::pushPacket	pushPacket

Called methods (observed)

function	info	call from
inet::queueing::PacketClassifier::handleCanPushPacketChanged	handleCanPushPacketChanged	EthernetFragmentPhyHeaderInserter, EthernetPhyHeaderInserter, DropTailQueue, PassivePacketSink, PacketBasedTokenGenerator
inet::queueing::PacketClassifier::pushPacket	pushPacket	MessageDispatcher, LayeredEthernetInterface, PacketEmitter, PacketCloner, PacketMultiplexer, PriorityQueue, TokenBasedServer, ActivePacketSource
inet::queueing::PacketClassifier::pushPacketEnd	pushPacketEnd	PreemptingServer
inet::queueing::PacketClassifier::pushPacketStart	pushPacketStart	PreemptingServer

Outgoing messages (observed)

gate	msg	kind	ctrl	destModule	tags
out[]	Packet	0		Gptp	DirectionTag, DispatchProtocolReq, EncapsulationProtocolInd, GptpIngressTimeInd, InterfaceInd, MacAddressInd, PacketProtocolTag

Pushed in messages (observed)

gate	msg	kind	ctrl	srcModule	tags
in	Packet	0		MessageDispatcher	DirectionTag, PacketProtocolTag, DispatchProtocolInd?, DispatchProtocolReq?, EncapsulationProtocolInd?, EncapsulationProtocolReq?, GptpIngressTimeInd?, InterfaceInd?, InterfaceReq?, MacAddressInd?, MacAddressReq?, MulticastReq?, NetworkProtocolInd?, TransportProtocolInd?, VlanReq?
in	Packet	0		LayeredEthernetInterface	DirectionTag, DispatchProtocolInd, EncapsulationProtocolReq, InterfaceReq, MacAddressReq, MulticastReq, NetworkProtocolInd, PacketProtocolTag, TransportProtocolInd, VlanReq
in	Packet	0		PacketEmitter	DirectionTag, InterfaceInd, PacketProtocolTag
in	Packet	0		PacketCloner	DirectionTag, PacketProtocolTag
in	Packet	0		PacketMultiplexer	DirectionTag, DispatchProtocolReq, InterfaceInd, PacketProtocolTag, FragmentTag?
in	Packet	0		PreemptingServer	DirectionTag, DispatchProtocolInd, EncapsulationProtocolReq, InterfaceReq, MacAddressReq, MulticastReq, NetworkProtocolInd, TransportProtocolInd, VlanReq, FragmentTag?, PacketProtocolTag?
in	Packet	0		TokenBasedServer	DscpInd, EcnInd, HopLimitInd, InterfaceInd, L3AddressInd, L4PortInd, NetworkProtocolInd, TosInd, TransportProtocolInd
in	Packet	0		ActivePacketSource	DirectionTag, PacketProtocolTag
in	Packet	1		TokenBasedServer

Push out messages (observed)

gate	msg	kind	ctrl	destModule	tags
out[]	Packet	0		EthernetFragmentPhyHeaderChecker	DirectionTag, InterfaceInd, PacketProtocolTag
out[]	Packet	0		EthernetFragmentPhyHeaderInserter	DirectionTag, DispatchProtocolInd, EncapsulationProtocolReq, FragmentTag, InterfaceReq, MacAddressReq, MulticastReq, NetworkProtocolInd, TransportProtocolInd, VlanReq, PacketProtocolTag?
out[]	Packet	0		EthernetPhyHeaderChecker	DirectionTag, InterfaceInd, PacketProtocolTag
out[]	Packet	0		EthernetPhyHeaderInserter	DirectionTag, DispatchProtocolInd, EncapsulationProtocolReq, InterfaceReq, MacAddressReq, MulticastReq, NetworkProtocolInd, PacketProtocolTag, TransportProtocolInd, VlanReq
out[]	Packet	0		PacketEmitter	DirectionTag, DispatchProtocolReq, InterfaceInd, PacketProtocolTag, FragmentTag?
out[]	Packet	0		DropTailQueue	DirectionTag, DispatchProtocolInd, EncapsulationProtocolReq, InterfaceReq, MacAddressReq, MulticastReq, NetworkProtocolInd, PacketProtocolTag, TransportProtocolInd, VlanReq
out[]	Packet	0		PassivePacketSink	DirectionTag, PacketProtocolTag
out[]	Packet	0		PacketBasedTokenGenerator	DirectionTag?, DscpInd?, EcnInd?, HopLimitInd?, InterfaceInd?, L3AddressInd?, L4PortInd?, NetworkProtocolInd?, PacketProtocolTag?, TosInd?, TransportProtocolInd?
out[]	Packet	1		PacketBasedTokenGenerator

Packet operations (observed)

chunkType	packetAction
BytesChunk	peekDataAt
GptpBase	peekAtFront
EthernetPhyHeaderBase	peekAtFront

Shared Tagging operations (observed)

tagType	tagAction
FragmentTag	findTag
VlanReq	findTag

Source code

//
// This 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.
//
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

---

This documentation is released under the Creative Commons license