Package: inet.protocolelement.redundancy

StreamClassifier

simple module

Classifies packets based on the stream they are part of. The stream is determined by a StreamReq or a StreamInd or both.

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	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
mode	string	"both"
mapping	object	{}	Maps stream name to gate index
gateIndexOffset	int	0	Specify the value to be added to the mapping output gate index
defaultGateIndex	int	0	Default gate index if no matching streams are found

Properties

Name	Value	Description
class	StreamClassifier
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

//
// Classifies packets based on the stream they are part of. The stream
// is determined by a `StreamReq` or a `StreamInd` or both.
//
simple StreamClassifier extends PacketClassifierBase like IPacketClassifier
{
    parameters:
        string mode @enum("req","ind","both") = default("both");
        object mapping = default({}); // Maps stream name to gate index
        int gateIndexOffset = default(0); // Specify the value to be added to the mapping output gate index
        int defaultGateIndex = default(0); // Default gate index if no matching streams are found
        @class(StreamClassifier);
}

File: src/inet/protocolelement/redundancy/StreamClassifier.ned