Package: inet.protocolelement.redundancy

StreamDecoder

simple module

This module decodes the stream of a packet by matching various tags on the packet against the mapping. It can check for network interface, source address, destination address, VLAN id, and PCP. If a match was found then the stream is attached to the packet in a StreamInd tag.

See also: StreamEncoder

Inheritance diagram

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

Extends

Name	Type	Description
PacketFlowBase	simple module	This is a base module for various packet flow modules. A packet flow module passes or streams all pushed or pulled packets after processing them from its input to its output.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"processed %p pk (%l)"	determines the text that is written on top of the submodule
interfaceTableModule	string		relative module path of the interface table
mapping	object	[]	array of objects, where each object maps a network interface name pattern, a source address, a destination address, a VLAN id and a PCP value to a stream name, for example [{stream: "s1", interface: "eth0", destination: "dest1", pcp: 3}, ...]

Properties

Name	Value	Description
display	i=block/blackboard
class	StreamDecoder

Gates

Name	Direction	Size	Description
in	input
out	output

Signals

Name	Type	Unit
packetPushedIn	inet::Packet
packetPulledIn	inet::Packet
packetPushedOut	inet::Packet
packetPulledOut	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
flowIncomingDataRate	flow specific incoming data rate	throughput(demuxFlow(merge(packetPushedIn, packetPulledIn)))	vector	bps	linear
outgoingDataRate	outgoing data rate	throughput(merge(packetPushedOut, packetPulledOut))	vector	bps	linear
incomingDataRate	incoming data rate	throughput(merge(packetPushedIn, packetPulledIn))	vector	bps	linear
outgoingPacketLengths	outgoing packet lengths	packetLength(merge(packetPushedOut, packetPulledOut))	sum, histogram, vector	b	none
flowIncomingPacketLengths	flow specific incoming packet lengths	packetLength(demuxFlow(merge(packetPushedIn, packetPulledIn)))	sum, histogram, vector	b	none
flowOutgoingDataRate	flow specific outgoing data rate	throughput(demuxFlow(merge(packetPushedOut, packetPulledOut)))	vector	bps	linear
incomingPacketLengths	incoming packet lengths	packetLength(merge(packetPushedIn, packetPulledIn))	sum, histogram, vector	b	none
flowOutgoingPacketLengths	flow specific outgoing packet lengths	packetLength(demuxFlow(merge(packetPushedOut, packetPulledOut)))	sum, histogram, vector	b	none
incomingPackets	incoming packets	merge(packetPushedIn, packetPulledIn)	count	pk
outgoingPackets	outgoing packets	merge(packetPushedOut, packetPulledOut)	count	pk

Direct method calls (observed)

call to	function	info
MessageDispatcher	inet::MessageDispatcher::handleRegisterAnyProtocol	handleRegisterAnyProtocol
MessageDispatcher	inet::MessageDispatcher::handleRegisterProtocol	handleRegisterProtocol
MessageDispatcher	inet::MessageDispatcher::handleRegisterService	handleRegisterService
MessageDispatcher	inet::MessageDispatcher::pushPacket	pushPacket
StreamClassifier	inet::StreamClassifier::pushPacket	pushPacket
StreamMerger	inet::StreamMerger::pushPacket	pushPacket

Called methods (observed)

function	info	call from
inet::StreamDecoder::pushPacket	pushPacket	MessageDispatcher, RelayInterfaceLearner

Pushed in messages (observed)

gate	msg	kind	ctrl	srcModule	tags
in	Packet	0		MessageDispatcher	DirectionTag, DispatchProtocolReq, DropEligibleInd, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, UserPriorityInd, VlanInd, SequenceNumberInd?
in	Packet	0		RelayInterfaceLearner	DirectionTag, DispatchProtocolReq, DropEligibleInd, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, UserPriorityInd, VlanInd, SequenceNumberInd?

Push out messages (observed)

gate	msg	destModule	tags
out	Packet	MessageDispatcher	DirectionTag, DispatchProtocolReq, DropEligibleInd, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, UserPriorityInd, VlanInd, StreamInd?
out	Packet	StreamClassifier	DirectionTag, DispatchProtocolReq, DropEligibleInd, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, StreamInd, UserPriorityInd, VlanInd
out	Packet	StreamMerger	DirectionTag, DispatchProtocolReq, DropEligibleInd, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, SequenceNumberInd, StreamInd, UserPriorityInd, VlanInd

Shared Tagging operations (observed)

tagType	tagAction
InterfaceInd	findTag
MacAddressInd	findTag
PcpInd	findTag
StreamInd	addTag
VlanInd	findTag

Region Tagging operations (observed)

tagType	tagAction
FlowTag	mapAllTags

Source code

//
// This module decodes the stream of a packet by matching various tags on the
// packet against the mapping. It can check for network interface, source address,
// destination address, VLAN id, and PCP. If a match was found then the stream
// is attached to the packet in a ~StreamInd tag.
//
// @see ~StreamEncoder
//
simple StreamDecoder extends PacketFlowBase like IPacketFlow
{
    parameters:
        string interfaceTableModule; // relative module path of the interface table
        object mapping @mutable = default([]); // array of objects, where each object maps a network interface name pattern, a source address, a destination address, a VLAN id and a PCP value to a stream name, for example [{stream: "s1", interface: "eth0", destination: "dest1", pcp: 3}, ...]
        @class(StreamDecoder);
        @display("i=block/blackboard");
}

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