This module connects multiple packet producers to one packet consumer. When a packet is pushed by one of the connected packet producers, then the multiplexer simply pushes the packet to the connected packet consumer.

Inheritance diagram

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

Used in compound modules

Name	Type	Description
AFxyQueue	compound module	This is an example queue, that implements one class of the Assured Forwarding PHB group (RFC 2597).
DirectionReverserLayer	compound module	This module provides a layer that combines the decision for local delivery with the service of reversing the direction of an incoming packet to outgoing for packet forwarding.
DualIeee8021qFilter	compound module	This module combines two meters and their corresponding filters per path. This is primarily useful for combining a token bucket based metering with an asynchronous packet shaper. Note that the asynchronous packet shaper also has parts in the network interface queue module.
EthernetPreemptingMacLayer	compound module	(no description)
EthernetPreemptingPhyLayer	compound module	(no description)
Ieee8021qFilter	compound module	This module implements the IEEE 802.1Q per-stream filtering and policing. The relationship between streams, gates and meters is not one-to-one. The number of streams, gates and meters can be different and the module will take care about the connections between the submodules based on the streamFilterTable parameter.
Ieee8022LlcLayer	compound module	(no description)
InterfaceService	compound module	(no description)
MacService	compound module	(no description)
MultiDomainGptp	compound module	This module combines multiple Gptp modules, one per time domain into a multi time domain time synchronization module. Each gPTP time domain is automatically configured to use the corresponding subclock of the clock passed in to this module.
MultiPacketPolicing	compound module	This module combines multiple packet policing modules into one.
PeerService	compound module	(no description)
ResponseProducer	compound module	This module is capable of generating several different streams of packets, one after the other. For each traffic category, the packets are produced by a separate token based server. The traffic stream can be started by adding tokens the corresponding server module. The packet data, packet length, and timing distributions can be configured in the corresponding packet provider.
SimpleIeee8021qFilter	compound module	This module implements a simplified version of the IEEE 802.1Q per-stream filtering and policing. Each filtered stream has its own path where metering and filtering happens independently of any other stream.
TelnetServerConnection	compound module	This module contains a configurable pre-composed telnet traffic source and traffic sink as part of a telnet server application.

Extends

Name	Type	Description
PacketProcessorBase	simple module	This is a base module for various packet processing modules which maintains a few statistics.

Parameters

Name	Type	Default value	Description
displayStringTextFormat	string	"passed %p pk (%l)"	determines the text that is written on top of the submodule
forwardServiceRegistration	bool	true
forwardProtocolRegistration	bool	true

Properties

Name	Value	Description
display	i=-;b=10,10,oval,grey,,1
class	PacketMultiplexer

Gates

Name	Direction	Size	Description
in [ ]	input
out	output

Signals

Name	Type	Unit
packetPushed	inet::Packet
packetPulled	inet::Packet

Statistics

Name	Title	Source	Record	Unit	Interpolation Mode
packetLengths	packet lengths	packetLength(merge(packetPushed, packetPulled))	sum, histogram, vector	b	none
dataRate	data rate	throughput(merge(packetPushed, packetPulled))	vector	bps	linear
packets	packets	merge(packetPushed, packetPulled)	count	pk

Direct method calls (observed)

call to	function	info
MessageDispatcher	inet::MessageDispatcher::handleRegisterProtocol	handleRegisterProtocol
MessageDispatcher	inet::MessageDispatcher::handleRegisterService	handleRegisterService
MessageDispatcher	inet::MessageDispatcher::pushPacket	pushPacket
EthernetInterface	inet::NetworkInterface::pushPacket	pushPacket
LayeredEthernetInterface	inet::NetworkInterface::pushPacket	pushPacket
RelayInterfaceSelector	inet::RelayInterfaceSelector::pushPacket	pushPacket
BehaviorAggregateClassifier	inet::BehaviorAggregateClassifier::handleCanPushPacketChanged	handleCanPushPacketChanged
DiffservQueue	inet::queueing::CompoundPacketQueueBase::pushPacket	pushPacket
DscpMarker	inet::DscpMarker::pushPacket	pushPacket
EthernetFragmentPhyHeaderInserter	inet::physicallayer::EthernetFragmentPhyHeaderInserter::handleCanPushPacketChanged	handleCanPushPacketChanged
EthernetPhyHeaderInserter	inet::physicallayer::EthernetPhyHeaderInserter::handleCanPushPacketChanged	handleCanPushPacketChanged
InterpacketGapInserter	inet::InterpacketGapInserter::pushPacketEnd	pushPacketEnd
InterpacketGapInserter	inet::InterpacketGapInserter::pushPacketProgress	pushPacketProgress
StreamClassifier	inet::StreamClassifier::handleCanPushPacketChanged	handleCanPushPacketChanged
StreamEncoder	inet::StreamEncoder::pushPacket	pushPacket
StreamIdentifier	inet::StreamIdentifier::pushPacket	pushPacket
EligibilityTimeFilter	inet::EligibilityTimeFilter::pushPacket	pushPacket
EligibilityTimeMeter	inet::EligibilityTimeMeter::handleCanPushPacketChanged	handleCanPushPacketChanged
PacketClassifier	inet::queueing::PacketClassifier::pushPacket	pushPacket
BackPressureBarrier	inet::queueing::BackPressureBarrier::pushPacket	pushPacket
PacketCloner	inet::queueing::PacketCloner::handleCanPushPacketChanged	handleCanPushPacketChanged
PacketMultiplexer	inet::queueing::PacketMultiplexer::handleCanPushPacketChanged	handleCanPushPacketChanged
PacketMultiplexer	inet::queueing::PacketMultiplexer::pushPacket	pushPacket
LabelFilter	inet::queueing::LabelFilter::handleCanPushPacketChanged	handleCanPushPacketChanged
RedDropper	inet::queueing::RedDropper::handleCanPushPacketChanged	handleCanPushPacketChanged
DropTailQueue	inet::queueing::PacketQueue::pushPacket	pushPacket
PacketQueue	inet::queueing::PacketQueue::pushPacket	pushPacket
TokenBasedServer	inet::queueing::TokenBasedServer::handleCanPushPacketChanged	handleCanPushPacketChanged
PassivePacketSink	inet::queueing::PassivePacketSink::pushPacket	pushPacket
ActivePacketSource	inet::queueing::ActivePacketSource::handleCanPushPacketChanged	handleCanPushPacketChanged

Called methods (observed)

function	info	call from
inet::queueing::PacketMultiplexer::handleCanPushPacketChanged	handleCanPushPacketChanged	BehaviorAggregateClassifier, InterpacketGapInserter, StreamIdentifier, EligibilityTimeFilter, BackPressureBarrier, PacketMultiplexer, DropTailQueue, PacketQueue, PassivePacketSink
inet::queueing::PacketMultiplexer::handlePushPacketProcessed	handlePushPacketProcessed	PacketEmitter
inet::queueing::PacketMultiplexer::pushPacket	pushPacket	MessageDispatcher, PacketDirectionReverser, EthernetFcsChecker, EthernetFcsInserter, DscpMarker, MultiFieldClassifier, EthernetFragmentPhyHeaderChecker, EthernetPhyHeaderChecker, StreamClassifier, EligibilityTimeFilter, EligibilityTimeMeter, PacketCloner, PacketMultiplexer, LabelFilter, RedDropper, StatisticalRateLimiter, TokenBasedServer, ActivePacketSource
inet::queueing::PacketMultiplexer::pushPacketEnd	pushPacketEnd	EthernetFragmentPhyHeaderInserter, EthernetPhyHeaderInserter
inet::queueing::PacketMultiplexer::pushPacketProgress	pushPacketProgress	EthernetFragmentPhyHeaderInserter, EthernetPhyHeaderInserter

Incoming messages (observed)

gate	msg	kind	ctrl	srcModule	tags
in[]	Packet	0		EthernetSocketIo	DirectionTag, DispatchProtocolReq, EncapsulationProtocolReq, MacAddressReq, PacketProtocolTag, SocketReq
in[]	Packet	0		Gptp	DispatchProtocolInd, DispatchProtocolReq, InterfaceReq, MacAddressReq, PacketProtocolTag
in[]	Packet	0		Ipv4	DirectionTag, DispatchProtocolInd, DispatchProtocolReq, EncapsulationProtocolReq, InterfaceReq, MacAddressReq, MulticastReq, NetworkProtocolInd, PacketProtocolTag, TransportProtocolInd

Outgoing messages (observed)

gate	msg	kind	ctrl	destModule	tags
out	Packet	0		TcpServerSocketIo	DirectionTag, PacketProtocolTag
out	Packet	0		UdpSocketIo	DirectionTag, PacketProtocolTag

Pushed in messages (observed)

gate	msg	kind	ctrl	srcModule	tags
in[]	Packet	0		MessageDispatcher	DispatchProtocolInd, DispatchProtocolReq, InterfaceReq, MacAddressReq, PacketProtocolTag
in[]	Packet	0		PacketDirectionReverser	DirectionTag, EncapsulationProtocolReq, InterfaceInd, MacAddressReq, PacketProtocolTag, CutthroughTag?, DropEligibleReq?, EligibilityTimeTag?, PcpReq?, SequenceNumberReq?, StreamReq?, UserPriorityReq?, VlanReq?
in[]	Packet	0		EthernetFcsChecker	DirectionTag, DispatchProtocolReq, InterfaceInd, PacketProtocolTag
in[]	Packet	0		EthernetFcsInserter	DirectionTag, DispatchProtocolReq, FragmentTag, InterfaceInd, PacketProtocolTag
in[]	Packet	0		DscpMarker	InterfaceInd, MacAddressInd, NetworkProtocolInd, PacketProtocolTag, DispatchProtocolInd?, DispatchProtocolReq?, InterfaceReq?
in[]	Packet	0		MultiFieldClassifier	DispatchProtocolReq, InterfaceInd, MacAddressInd, PacketProtocolTag
in[]	Packet	0		SingleRateThreeColorMeter	DispatchProtocolInd, InterfaceInd, InterfaceReq, MacAddressInd, NetworkProtocolInd, PacketProtocolTag
in[]	Packet	0		TokenBucketMeter	InterfaceInd, MacAddressInd, PacketProtocolTag, DispatchProtocolInd?, DispatchProtocolReq?, InterfaceReq?, NetworkProtocolInd?
in[]	Packet	0		EthernetFragmentPhyHeaderChecker	DirectionTag, DispatchProtocolReq, FragmentTag, InterfaceInd, PacketProtocolTag
in[]	Packet	0		EthernetFragmentPhyHeaderInserter	DirectionTag, DispatchProtocolInd, EncapsulationProtocolReq, FragmentTag, InterfaceReq, MacAddressReq, MulticastReq, NetworkProtocolInd, PacketProtocolTag, TransportProtocolInd, VlanReq
in[]	Packet	0		EthernetPhyHeaderChecker	DirectionTag, DispatchProtocolReq, InterfaceInd, PacketProtocolTag
in[]	Packet	0		EthernetPhyHeaderInserter	DirectionTag, DispatchProtocolInd, EncapsulationProtocolReq, InterfaceReq, MacAddressReq, MulticastReq, NetworkProtocolInd, PacketProtocolTag, TransportProtocolInd, VlanReq
in[]	Packet	0		StreamClassifier	DirectionTag, DispatchProtocolReq, DropEligibleInd, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, StreamInd, UserPriorityInd, VlanInd
in[]	Packet	0		EligibilityTimeFilter	DirectionTag, DispatchProtocolReq, DropEligibleInd, EligibilityTimeTag, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, StreamInd, UserPriorityInd, VlanInd
in[]	Packet	0		EligibilityTimeMeter	DirectionTag, PacketProtocolTag, EligibilityTimeTag?
in[]	Packet	0		PacketCloner	DirectionTag, PacketProtocolTag
in[]	Packet	0		LabelFilter	DirectionTag, LabelsTag, PacketProtocolTag, DispatchProtocolReq?, DropEligibleInd?, EncapsulationProtocolInd?, InterfaceInd?, MacAddressInd?, PcpInd?, StreamInd?, StreamReq?, UserPriorityInd?, VlanInd?
in[]	Packet	0		RedDropper	DispatchProtocolInd, InterfaceInd, InterfaceReq, NetworkProtocolInd, PacketProtocolTag, MacAddressInd?
in[]	Packet	0		StatisticalRateLimiter	DirectionTag, DispatchProtocolReq, DropEligibleInd, EncapsulationProtocolInd, InterfaceInd, MacAddressInd, PacketProtocolTag, PcpInd, RateTag, StreamInd, UserPriorityInd, VlanInd
in[]	Packet	0		TokenBasedServer	DirectionTag, PacketProtocolTag
in[]	Packet	0		ActivePacketSource	DirectionTag, PacketProtocolTag

Push out messages (observed)

gate	msg	kind	ctrl	destModule	tags
out	Packet	0		MessageDispatcher	DispatchProtocolReq, PacketProtocolTag, DirectionTag?, DispatchProtocolInd?, FragmentTag?, InterfaceInd?, InterfaceReq?, MacAddressInd?, MacAddressReq?, NetworkProtocolInd?
out	Packet	0		RelayInterfaceSelector	MacAddressReq, PacketProtocolTag, CutthroughTag?, DirectionTag?, DispatchProtocolInd?, DispatchProtocolReq?, DropEligibleReq?, EncapsulationProtocolReq?, InterfaceInd?, InterfaceReq?, PcpReq?, UserPriorityReq?, VlanReq?
out	Packet	0		BehaviorAggregateClassifier	DispatchProtocolInd, InterfaceInd, InterfaceReq, MacAddressInd, NetworkProtocolInd, PacketProtocolTag
out	Packet	0		SingleRateThreeColorMeter	DispatchProtocolInd, InterfaceInd, InterfaceReq, MacAddressInd, NetworkProtocolInd, PacketProtocolTag
out	Packet	0		InterpacketGapInserter	DirectionTag, DispatchProtocolInd, EncapsulationProtocolReq, InterfaceReq, MacAddressReq, MulticastReq, NetworkProtocolInd, PacketProtocolTag, TransportProtocolInd, VlanReq, FragmentTag?
out	Packet	0		StreamEncoder	DirectionTag, DropEligibleReq, EncapsulationProtocolReq, InterfaceInd, MacAddressReq, PacketProtocolTag, PcpReq, StreamReq, UserPriorityReq, VlanReq, EligibilityTimeTag?
out	Packet	0		StreamIdentifier	DirectionTag, PacketProtocolTag, DispatchProtocolInd?, DispatchProtocolReq?, DropEligibleReq?, EncapsulationProtocolReq?, InterfaceInd?, InterfaceReq?, MacAddressReq?, MulticastReq?, NetworkProtocolInd?, PcpReq?, SequenceNumberReq?, SocketReq?, StreamReq?, TransportProtocolInd?, UserPriorityReq?, VlanReq?
out	Packet	0		EligibilityTimeFilter	DirectionTag, PacketProtocolTag, EligibilityTimeTag?
out	Packet	0		PacketClassifier	DirectionTag, DispatchProtocolReq, InterfaceInd, PacketProtocolTag, FragmentTag?
out	Packet	0		BackPressureBarrier	DirectionTag, PacketProtocolTag, DispatchProtocolReq?, DropEligibleInd?, EligibilityTimeTag?, EncapsulationProtocolInd?, InterfaceInd?, LabelsTag?, MacAddressInd?, PcpInd?, RateTag?, StreamInd?, StreamReq?, UserPriorityInd?, VlanInd?
out	Packet	0		DropTailQueue	DispatchProtocolInd, InterfaceInd, InterfaceReq, MacAddressInd, NetworkProtocolInd, PacketProtocolTag
out	Packet	0		PacketQueue	DispatchProtocolInd, InterfaceInd, InterfaceReq, NetworkProtocolInd, PacketProtocolTag, MacAddressInd?
out	Packet	0		PassivePacketSink	DirectionTag, PacketProtocolTag

Packet operations (observed)

chunkType	packetAction
	peekData, setBackOffset, setFrontOffset
Ipv4Header	popAtFront

Shared Tagging operations (observed)

tagType	tagAction
PacketProtocolTag	findTag

Source code

//
// This module connects multiple packet producers to one packet consumer. When
// a packet is pushed by one of the connected packet producers, then the multiplexer
// simply pushes the packet to the connected packet consumer.
//
simple PacketMultiplexer extends PacketProcessorBase like IActivePacketSource // TODO IPassivePacketSink // in gate is vector
{
    parameters:
        bool forwardServiceRegistration = default(true);
        bool forwardProtocolRegistration = default(true);
        displayStringTextFormat = default("passed %p pk (%l)"); // %p number of packet, %l total length
        @class(PacketMultiplexer);
        @display("i=-;b=10,10,oval,grey,,1");
        @signal[packetPushed](type=inet::Packet);
        @signal[packetPulled](type=inet::Packet);
        // the statistical value is the multiplexed packet
        @statistic[packets](title="packets"; source=merge(packetPushed, packetPulled); record=count; unit=pk);
        // the statistical value is the length of the multiplexed packet
        @statistic[packetLengths](title="packet lengths"; source=packetLength(merge(packetPushed, packetPulled)); record=sum,histogram,vector; unit=b; interpolationmode=none);
        // the statistical value is the data rate of the multiplexed packets
        @statistic[dataRate](title="data rate"; source=throughput(merge(packetPushed, packetPulled)); record=vector; unit=bps; interpolationmode=linear);
    gates:
        input in[] @labels(push);
        output out @labels(push);
}

File: src/inet/queueing/common/PacketMultiplexer.ned

---

This documentation is released under the Creative Commons license