Package: inet.protocolelement.redundancy

StreamEncoder

simple module

This module encodes the stream name of a packet into several request tags attached to the packet. It looks up the stream in the mapping and attaches the necessary request tags to the packet based on the specified parameters.

See also: StreamDecoder

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
mapping	object	[]	array of objects, where each object maps a stream name to a VLAN id, and PCP value, for example [{stream: "s1", vlan: 12, pcp: 7}, ...]

Properties

Name	Value	Description
display	i=block/blackboard
class	StreamEncoder

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::handleRegisterService	handleRegisterService
MessageDispatcher	inet::MessageDispatcher::pushPacket	pushPacket
RelayInterfaceSelector	inet::RelayInterfaceSelector::pushPacket	pushPacket

Called methods (observed)

function	info	call from
inet::StreamEncoder::pushPacket	pushPacket	StreamIdentifier, StreamSplitter, PacketMultiplexer

Pushed in messages (observed)

gate	msg	srcModule	tags
in	Packet	StreamIdentifier	DirectionTag, EncapsulationProtocolReq, MacAddressReq, PacketProtocolTag, StreamReq, DispatchProtocolInd?, DispatchProtocolReq?, DropEligibleReq?, InterfaceInd?, InterfaceReq?, MulticastReq?, NetworkProtocolInd?, PcpReq?, TransportProtocolInd?, UserPriorityReq?, VlanReq?
in	Packet	StreamSplitter	DirectionTag, EncapsulationProtocolReq, MacAddressReq, PacketProtocolTag, SequenceNumberReq, StreamReq, DispatchProtocolInd?, DispatchProtocolReq?, DropEligibleReq?, InterfaceInd?, InterfaceReq?, MulticastReq?, NetworkProtocolInd?, PcpReq?, SocketReq?, TransportProtocolInd?, UserPriorityReq?, VlanReq?
in	Packet	PacketMultiplexer	DirectionTag, DropEligibleReq, EncapsulationProtocolReq, InterfaceInd, MacAddressReq, PacketProtocolTag, PcpReq, StreamReq, UserPriorityReq, VlanReq, EligibilityTimeTag?

Push out messages (observed)

gate	msg	kind	ctrl	destModule	tags
out	Packet	0		MessageDispatcher	DirectionTag, DispatchProtocolInd, DispatchProtocolReq, EncapsulationProtocolReq, InterfaceReq, MacAddressReq, MulticastReq, NetworkProtocolInd, PacketProtocolTag, StreamReq, TransportProtocolInd, PcpReq?, SequenceNumberReq?, VlanReq?
out	Packet	0		RelayInterfaceSelector	DirectionTag, EncapsulationProtocolReq, MacAddressReq, PacketProtocolTag, PcpReq, StreamReq, VlanReq, DispatchProtocolReq?, DropEligibleReq?, EligibilityTimeTag?, InterfaceInd?, SequenceNumberReq?, SocketReq?, UserPriorityReq?

Shared Tagging operations (observed)

tagType	tagAction
DispatchProtocolReq	addTagIfAbsent
EncapsulationProtocolReq	addTagIfAbsent, findTagForUpdate
PcpReq	addTagIfAbsent
SequenceNumberReq	findTag
StreamReq	findTag
VlanReq	addTagIfAbsent

Region Tagging operations (observed)

tagType	tagAction
FlowTag	mapAllTags

Source code

//
// This module encodes the stream name of a packet into several request tags
// attached to the packet. It looks up the stream in the mapping and attaches
// the necessary request tags to the packet based on the specified parameters.
//
// @see ~StreamDecoder
//
simple StreamEncoder extends PacketFlowBase like IPacketFlow
{
    parameters:
        object mapping @mutable = default([]); // array of objects, where each object maps a stream name to a VLAN id, and PCP value, for example [{stream: "s1", vlan: 12, pcp: 7}, ...]
        @class(StreamEncoder);
        @display("i=block/blackboard");
}

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