StreamMerger¶

Package: inet.protocolelement.redundancy

simple module StreamMerger

Merges the packets of the same stream by removing duplicates. In addition, it also replaces the stream name on the packet based on the mapping parameter. For merging, it maintains a separate finite buffer per stream with the last seen sequence numbers.

Usage diagram¶

Inheritance diagram¶

Used in compound modules¶

Name	Type	Description
StreamRelayLayer	compound module	Combines a stream merger and a stream splitter module into a stream relay layer. For incoming packets, the identified streams are merged by the stream merger. For outgoing packets, the requested streams are split by the stream splitter.

Extends¶

Name	Type	Description
PacketFilterBase	simple module	Base module for various packet filter modules. Derived modules must implement a single packet matcher function which determines if a packet is to be passed through or filtered out.

Parameters¶

Name	Type	Default value	Description
displayStringTextFormat	string	“dropped {numDroppedPackets}/{numProcessedPackets} pk ({droppedTotalLength}/{processedTotalLength})”	Determines the text that is written on top of the submodule, supports displaying pars, watches, and module-specific information
backpressure	bool	false
mapping	object	{}	Map of input streams to output streams. An empty string means no stream. For example, {s0: “s1”, …}
bufferSize	int	10	Window size for sequence numbers per stream.

Properties¶

Name	Value	Description
class	StreamMerger
display	i=block/join

Gates¶

Name	Direction	Size	Description
in	input
out	output

Signals¶

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

Statistics¶

Name	Title	Source	Record	Unit	Interpolation Mode	Description
droppedDataRate	dropped data rate	throughput(packetDropped)	vector	bps	linear	the statistical value is the data rate of the dropped packets
droppedPacketLengths	dropped packet lengths	packetLength(packetDropped)	sum,histogram,vector	b	none	the statistical value is the length of the dropped packet
droppedPackets	dropped packets	packetDropped	count	pk		the statistical value is the dropped packet
flowDroppedDataRate	flow specific dropped data rate	throughput(demuxFlow(packetDropped))	vector	bps	linear	the statistical value is the flow specific data rate of the dropped packets
flowDroppedPacketLengths	flow specific dropped packet lengths	packetLength(demuxFlow(packetDropped))	sum,histogram,vector	b	none	the statistical value is the flow specific length of the dropped packet
flowIncomingDataRate	flow specific incoming data rate	throughput(demuxFlow(merge(packetPushedIn, packetPulledIn)))	vector	bps	linear	the statistical value is the flow specific data rate of the incoming packets
flowIncomingPacketLengths	flow specific incoming packet lengths	packetLength(demuxFlow(merge(packetPushedIn, packetPulledIn)))	sum,histogram,vector	b	none	the statistical value is the flow specific length of the incoming packet
flowOutgoingDataRate	flow specific outgoing data rate	throughput(demuxFlow(merge(packetPushedOut, packetPulledOut)))	vector	bps	linear	the statistical value is the flow specific data rate of the outgoing packets
flowOutgoingPacketLengths	flow specific outgoing packet lengths	packetLength(demuxFlow(merge(packetPushedOut, packetPulledOut)))	sum,histogram,vector	b	none	the statistical value is the flow specific length of the outgoing packet
incomingDataRate	incoming data rate	throughput(merge(packetPushedIn, packetPulledIn))	vector	bps	linear	the statistical value is the data rate of the incoming packets
incomingPacketLengths	incoming packet lengths	packetLength(merge(packetPushedIn, packetPulledIn))	sum,histogram,vector	b	none	the statistical value is the length of the incoming packet
incomingPackets	incoming packets	merge(packetPushedIn, packetPulledIn)	count	pk		the statistical value is the incoming packet
outgoingDataRate	outgoing data rate	throughput(merge(packetPushedOut, packetPulledOut))	vector	bps	linear	the statistical value is the data rate of the outgoing packets
outgoingPacketLengths	outgoing packet lengths	packetLength(merge(packetPushedOut, packetPulledOut))	sum,histogram,vector	b	none	the statistical value is the length of the outgoing packet
outgoingPackets	outgoing packets	merge(packetPushedOut, packetPulledOut)	count	pk		the statistical value is the outgoing packet

Source code¶

//
// Merges the packets of the same stream by removing duplicates. In
// addition, it also replaces the stream name on the packet based on the mapping
// parameter. For merging, it maintains a separate finite buffer per stream with
// the last seen sequence numbers.
//
simple StreamMerger extends PacketFilterBase like IPacketFilter
{
    parameters:
        object mapping @mutable = default({}); // Map of input streams to output streams. An empty string means no stream. For example, {s0: "s1", ...}
        int bufferSize = default(10); // Window size for sequence numbers per stream.
        @class(StreamMerger);
        @display("i=block/join");
}

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