ContentBasedClassifier

simple module

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 filters. The first matching expression determines the index of the output gate.

Inheritance diagram

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

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
defaultGateIndex	int	0	default gate index if no matching labels are found
packetFilters	object		array of packet filter expressions

Properties

Name	Value	Description
display	i=block/classifier
class	ContentBasedClassifier

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
DropTailQueue	inet::queueing::PacketQueue::pushPacket	pushPacket
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::ContentBasedClassifier::handleCanPushPacketChanged	handleCanPushPacketChanged	DropTailQueue, PassivePacketSink, PacketBasedTokenGenerator
inet::queueing::ContentBasedClassifier::pushPacket	pushPacket	Ieee8021qTimeAwareShaper, GatingPriorityQueue, TokenBasedServer, ActivePacketSource

Pushed in messages (observed)

gate	msg	srcModule	tags
in	Packet	MessageDispatcher	DirectionTag, InterfaceReq, MacAddressReq, PacketProtocolTag, DispatchProtocolInd?, DropEligibleInd?, EncapsulationProtocolReq?, InterfaceInd?, MulticastReq?, NetworkProtocolInd?, PcpInd?, SequenceNumberInd?, StreamReq?, TransportProtocolInd?, UserPriorityInd?, VlanInd?
in	Packet	LayeredEthernetInterface	DirectionTag, InterfaceReq, MacAddressReq, PacketProtocolTag, DispatchProtocolInd?, DropEligibleInd?, EncapsulationProtocolReq?, InterfaceInd?, MulticastReq?, NetworkProtocolInd?, PcpInd?, SequenceNumberInd?, StreamReq?, TransportProtocolInd?, UserPriorityInd?, VlanInd?
in	Packet	TokenBasedServer	DirectionTag, PacketProtocolTag
in	Packet	ActivePacketSource	DirectionTag, PacketProtocolTag

Push out messages (observed)

gate	msg	destModule	tags
out[]	Packet	DropTailQueue	DirectionTag, InterfaceReq, MacAddressReq, PacketProtocolTag, DispatchProtocolInd?, DropEligibleInd?, EncapsulationProtocolReq?, InterfaceInd?, MulticastReq?, NetworkProtocolInd?, PcpInd?, SequenceNumberInd?, StreamReq?, TransportProtocolInd?, UserPriorityInd?, VlanInd?
out[]	Packet	PassivePacketSink	DirectionTag, PacketProtocolTag
out[]	Packet	PacketBasedTokenGenerator	DirectionTag, PacketProtocolTag

Packet operations (observed)

chunkType	packetAction
	peekData, setBackOffset, setFrontOffset

Shared Tagging operations (observed)

tagType	tagAction
PacketProtocolTag	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 filters. The first matching expression
// determines the index of the output gate.
//
simple ContentBasedClassifier extends PacketClassifierBase like IPacketClassifier
{
    parameters:
        int defaultGateIndex = default(0); // default gate index if no matching labels are found
        object packetFilters; // array of packet filter expressions
        @class(ContentBasedClassifier);
}

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