#include <PacketMultiplexer.h>

Inheritance diagram for inet::queueing::PacketMultiplexer:

Public Member Functions
virtual IPassivePacketSink *	getConsumer (cGate *gate) override
	Returns the passive packet sink where packets are pushed or nullptr if the connected module doesn't implement the interface. More...

virtual bool	supportsPacketPulling (cGate *gate) const override
	Returns true if the processor supports pulling packets at the given gate. More...

virtual bool	supportsPacketPushing (cGate *gate) const override
	Returns true if the processor supports pushing packets at the given gate. More...

virtual bool	supportsPacketStreaming (cGate *gate) const override
	Returns true if the processor supports streaming packets at the given gate. More...

virtual bool	canPushSomePacket (cGate *gate) const override
	Returns false if the packet sink is full at the given gate and no more packets can be pushed into it without raising an error. More...

virtual bool	canPushPacket (Packet packet, cGate gate) const override
	Returns true if the given packet can be pushed at the given gate into the packet sink without raising an error. More...

virtual void	pushPacket (Packet packet, cGate gate) override
	Pushes the packet into the packet sink at the given gate. More...

virtual void	pushPacketStart (Packet packet, cGate gate, bps datarate) override
	Starts pushing the packet into the packet sink at the given gate. More...

virtual void	pushPacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength=b(0)) override
	Progresses pushing the packet into the packet sink at the given gate. More...

virtual void	pushPacketEnd (Packet packet, cGate gate) override
	Ends pushing the packet into the packet sink at the given gate. More...

virtual void	handleCanPushPacketChanged (cGate *gate) override
	Notifies about a change in the possibility of pushing some packet into the passive packet sink at the given gate. More...

virtual void	handlePushPacketProcessed (Packet packet, cGate gate, bool successful) override
	Notifies about the completion of the packet processing for a packet that was pushed earlier independently whether the packet is passed or streamed. More...

virtual bool	isForwardingService (cGate *gate, ServicePrimitive servicePrimitive) const override

virtual bool	isForwardingProtocol (cGate *gate, ServicePrimitive servicePrimitive) const override

Public Member Functions inherited from inet::queueing::PacketProcessorBase
virtual bool	supportsPacketSending (cGate *gate) const override
	Returns true if the processor supports sending packets at the given gate. More...

virtual bool	supportsPacketPassing (cGate *gate) const override
	Returns true if the processor supports passing packets as a whole at the given gate. More...

virtual const char *	resolveDirective (char directive) const override

Public Member Functions inherited from inet::queueing::IPacketProcessor
virtual	~IPacketProcessor ()

Public Member Functions inherited from inet::queueing::IPassivePacketSink
virtual	~IPassivePacketSink ()

Public Member Functions inherited from inet::queueing::IActivePacketSource
virtual	~IActivePacketSource ()

Public Member Functions inherited from inet::TransparentProtocolRegistrationListener
virtual cGate *	getRegistrationForwardingGate (cGate *gate)

virtual bool	isForwardingProtocol (const Protocol &protocol, cGate *gate, ServicePrimitive servicePrimitive) const

virtual bool	isForwardingProtocolGroup (const ProtocolGroup &protocolGroup, cGate *gate, ServicePrimitive servicePrimitive) const

virtual bool	isForwardingAnyProtocol (cGate *gate, ServicePrimitive servicePrimitive) const

virtual bool	isForwardingService (const Protocol &protocol, cGate *gate, ServicePrimitive servicePrimitive) const

virtual bool	isForwardingServiceGroup (const ProtocolGroup &protocolGroup, cGate *gate, ServicePrimitive servicePrimitive) const

virtual bool	isForwardingAnyService (cGate *gate, ServicePrimitive servicePrimitive) const

virtual void	handleRegisterService (const Protocol &protocol, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterProtocol (const Protocol &protocol, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterServiceGroup (const ProtocolGroup &protocolGroup, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterProtocolGroup (const ProtocolGroup &protocolGroup, cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterAnyService (cGate *gate, ServicePrimitive servicePrimitive) override

virtual void	handleRegisterAnyProtocol (cGate *gate, ServicePrimitive servicePrimitive) override

Protected Member Functions
virtual void	initialize (int stage) override

virtual void	handleMessage (cMessage *message) override

virtual void	mapRegistrationForwardingGates (cGate gate, std::function< void(cGate )> f) override

virtual bool	isStreamingPacket () const

virtual void	startPacketStreaming (Packet *packet)

virtual void	endPacketStreaming (Packet *packet)

virtual void	checkPacketStreaming (Packet *packet)

Protected Member Functions inherited from inet::queueing::PacketProcessorBase
virtual int	numInitStages () const override

virtual void	refreshDisplay () const override

virtual void	handlePacketProcessed (Packet *packet)

virtual void	checkPacketOperationSupport (cGate *gate) const

virtual void	checkPacketOperationSupport (cGate startGate, cGate endGate) const

virtual void	animate (Packet packet, cGate gate, const SendOptions &sendOptions, Action action) const

virtual void	animatePacket (Packet packet, cGate gate, Action action) const

virtual void	animatePacketStart (Packet packet, cGate gate, bps datarate, long transmissionId, Action action) const

virtual void	animatePacketStart (Packet packet, cGate gate, bps datarate, const SendOptions &sendOptions, Action action) const

virtual void	animatePacketEnd (Packet packet, cGate gate, long transmissionId, Action action) const

virtual void	animatePacketEnd (Packet packet, cGate gate, const SendOptions &sendOptions, Action action) const

virtual void	animatePacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength, long transmissionId, Action action) const

virtual void	animatePacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength, const SendOptions &sendOptions, Action action) const

virtual void	pushOrSendPacket (Packet packet, cGate gate, IPassivePacketSink *consumer)

virtual void	pushOrSendPacketStart (Packet packet, cGate gate, IPassivePacketSink *consumer, bps datarate, int transmissionId)

virtual void	pushOrSendPacketEnd (Packet packet, cGate gate, IPassivePacketSink *consumer, int transmissionId)

virtual void	pushOrSendPacketProgress (Packet packet, cGate gate, IPassivePacketSink *consumer, bps datarate, b position, b extraProcessableLength, int transmissionId)

virtual void	animatePush (Packet packet, cGate gate, const SendOptions &sendOptions) const

virtual void	animatePushPacket (Packet packet, cGate gate) const

virtual void	animatePushPacketStart (Packet packet, cGate gate, bps datarate, long transmissionId) const

virtual void	animatePushPacketStart (Packet packet, cGate gate, bps datarate, const SendOptions &sendOptions) const

virtual void	animatePushPacketEnd (Packet packet, cGate gate, long transmissionId) const

virtual void	animatePushPacketEnd (Packet packet, cGate gate, const SendOptions &sendOptions) const

virtual void	animatePushPacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength, long transmissionId) const

virtual void	animatePushPacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength, const SendOptions &sendOptions) const

virtual void	animatePull (Packet packet, cGate gate, const SendOptions &sendOptions) const

virtual void	animatePullPacket (Packet packet, cGate gate) const

virtual void	animatePullPacketStart (Packet packet, cGate gate, bps datarate, long transmissionId) const

virtual void	animatePullPacketStart (Packet packet, cGate gate, bps datarate, const SendOptions &sendOptions) const

virtual void	animatePullPacketEnd (Packet packet, cGate gate, long transmissionId) const

virtual void	animatePullPacketEnd (Packet packet, cGate gate, const SendOptions &sendOptions) const

virtual void	animatePullPacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength, long transmissionId) const

virtual void	animatePullPacketProgress (Packet packet, cGate gate, bps datarate, b position, b extraProcessableLength, const SendOptions &sendOptions) const

virtual void	dropPacket (Packet *packet, PacketDropReason reason, int limit=-1)

virtual void	updateDisplayString () const

Protected Attributes
bool	forwardServiceRegistration

bool	forwardProtocolRegistration

std::vector< cGate * >	inputGates

std::vector< IActivePacketSource * >	producers

cGate *	outputGate = nullptr

IPassivePacketSink *	consumer = nullptr

int	inProgressStreamId = -1

Protected Attributes inherited from inet::queueing::PacketProcessorBase
const char *	displayStringTextFormat = nullptr

int	numProcessedPackets = -1

b	processedTotalLength = b(-1)

Additional Inherited Members
Protected Types inherited from inet::queueing::PacketProcessorBase
enum	Action { PUSH, PULL }

Member Function Documentation

◆ canPushPacket()

virtual bool inet::queueing::PacketMultiplexer::canPushPacket	(	Packet *	packet,
		cGate *	gate
	)		const

inlineoverridevirtual

Returns true if the given packet can be pushed at the given gate into the packet sink without raising an error.

The packet must not be nullptr. The gate must be a valid gate of this module and it must support pushing packets.

Implements inet::queueing::IPassivePacketSink.

52 { return consumer->canPushPacket(packet, gate); }

◆ canPushSomePacket()

virtual bool inet::queueing::PacketMultiplexer::canPushSomePacket ( cGate * gate ) const

inlineoverridevirtual

Returns false if the packet sink is full at the given gate and no more packets can be pushed into it without raising an error.

The gate must be a valid gate of this module and it must support pushing packets.

Implements inet::queueing::IPassivePacketSink.

51 { return consumer->canPushSomePacket(outputGate); }

◆ checkPacketStreaming()

void inet::queueing::PacketMultiplexer::checkPacketStreaming ( Packet * packet )

protectedvirtual

 {
     if (inProgressStreamId != -1 && (packet == nullptr || packet->getTreeId() != inProgressStreamId))
         throw cRuntimeError("Another packet streaming operation is already in progress");
 }

Referenced by pushPacketEnd(), pushPacketProgress(), and pushPacketStart().

◆ endPacketStreaming()

void inet::queueing::PacketMultiplexer::endPacketStreaming ( Packet * packet )

protectedvirtual

 {
     emit(packetPushedSignal, packet);
     handlePacketProcessed(packet);
     inProgressStreamId = -1;
 }

Referenced by pushPacketEnd(), and pushPacketProgress().

◆ getConsumer()

virtual IPassivePacketSink* inet::queueing::PacketMultiplexer::getConsumer ( cGate * gate )

inlineoverridevirtual

Returns the passive packet sink where packets are pushed or nullptr if the connected module doesn't implement the interface.

The gate parameter must be a valid gate of this module.

Implements inet::queueing::IActivePacketSource.

45 { return consumer; }

◆ handleCanPushPacketChanged()

void inet::queueing::PacketMultiplexer::handleCanPushPacketChanged ( cGate * gate )

overridevirtual

Notifies about a change in the possibility of pushing some packet into the passive packet sink at the given gate.

This method is called, for example, when a new packet can be inserted into a queue. It allows the source to push a new packet into the queue.

The gate parameter must be a valid gate of this module.

Implements inet::queueing::IActivePacketSource.

 {
     Enter_Method("handleCanPushPacketChanged");
     for (int i = 0; i < (int)inputGates.size(); i++)
         // NOTE: notifying a listener may prevent others from pushing
         if (producers[i] != nullptr && consumer->canPushSomePacket(outputGate))
             producers[i]->handleCanPushPacketChanged(inputGates[i]->getPathStartGate());
 }

◆ handleMessage()

void inet::queueing::PacketMultiplexer::handleMessage ( cMessage * message )

overrideprotectedvirtual

 {
     auto packet = check_and_cast<Packet *>(message);
     pushPacket(packet, packet->getArrivalGate());
 }

◆ handlePushPacketProcessed()

void inet::queueing::PacketMultiplexer::handlePushPacketProcessed	(	Packet *	packet,
		cGate *	gate,
		bool	successful
	)

overridevirtual

Notifies about the completion of the packet processing for a packet that was pushed earlier independently whether the packet is passed or streamed.

This method is called, for example, when a previously pushed packet is failed to be processed successfully. It allows the source to retry the operation.

The gate parameter must be a valid gate of this module. The packet must not be nullptr.

Implements inet::queueing::IActivePacketSource.

 {
     Enter_Method("handlePushPacketProcessed");
 }

◆ initialize()

void inet::queueing::PacketMultiplexer::initialize ( int stage )

overrideprotectedvirtual

Reimplemented from inet::queueing::PacketProcessorBase.

 {
     PacketProcessorBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         forwardServiceRegistration = par("forwardServiceRegistration");
         forwardProtocolRegistration = par("forwardProtocolRegistration");
         for (int i = 0; i < gateSize("in"); i++) {
             auto inputGate = gate("in", i);
             auto input = findConnectedModule<IActivePacketSource>(inputGate);
             inputGates.push_back(inputGate);
             producers.push_back(input);
         }
         outputGate = gate("out");
         consumer = findConnectedModule<IPassivePacketSink>(outputGate);
     }
     else if (stage == INITSTAGE_QUEUEING) {
         for (auto& inputGate : inputGates)
             checkPacketOperationSupport(inputGate);
         checkPacketOperationSupport(outputGate);
     }
 }

◆ isForwardingProtocol()

virtual bool inet::queueing::PacketMultiplexer::isForwardingProtocol	(	cGate *	gate,
		ServicePrimitive	servicePrimitive
	)		const

inlineoverridevirtual

Reimplemented from inet::TransparentProtocolRegistrationListener.

64 { return forwardProtocolRegistration; }

◆ isForwardingService()

virtual bool inet::queueing::PacketMultiplexer::isForwardingService	(	cGate *	gate,
		ServicePrimitive	servicePrimitive
	)		const

inlineoverridevirtual

Reimplemented from inet::TransparentProtocolRegistrationListener.

63 { return forwardServiceRegistration; }

◆ isStreamingPacket()

virtual bool inet::queueing::PacketMultiplexer::isStreamingPacket ( ) const

inlineprotectedvirtual

39 { return inProgressStreamId != -1; }

Referenced by pushPacketEnd(), and pushPacketProgress().

◆ mapRegistrationForwardingGates()

void inet::queueing::PacketMultiplexer::mapRegistrationForwardingGates	(	cGate *	gate,
		std::function< void(cGate *)>	f
	)

overrideprotectedvirtual

Reimplemented from inet::TransparentProtocolRegistrationListener.

 {
     if (gate == outputGate) {
         for (auto inputGate : inputGates)
             f(inputGate);
     }
     else if (std::find(inputGates.begin(), inputGates.end(), gate) != inputGates.end())
         f(outputGate);
     else
         throw cRuntimeError("Unknown gate");
 }

◆ pushPacket()

void inet::queueing::PacketMultiplexer::pushPacket	(	Packet *	packet,
		cGate *	gate
	)

overridevirtual

Pushes the packet into the packet sink at the given gate.

This operation pushes the packet as a whole. The onwership of the packet is transferred to the sink.

This method is called, for example, when a packet source module pushes a packet into a queue module.

The sink must not be full at the gate. The packet must not be nullptr. The gate must be a valid gate of this module and it must support pushing and passing packets.

Implements inet::queueing::IPassivePacketSink.

 {
     Enter_Method("pushPacket");
     take(packet);
     EV_INFO << "Forwarding packet" << EV_FIELD(packet) << EV_ENDL;
     handlePacketProcessed(packet);
     pushOrSendPacket(packet, outputGate, consumer);
     updateDisplayString();
 }

Referenced by handleMessage().

◆ pushPacketEnd()

void inet::queueing::PacketMultiplexer::pushPacketEnd	(	Packet *	packet,
		cGate *	gate
	)

overridevirtual

Ends pushing the packet into the packet sink at the given gate.

This is a packet streaming operation. The onwership of the packet is transferred to the sink.

Packet streaming can be started with any of the streaming operations, and ends when the streaming position plus the extra processable packet length equals to the total packet length.

This method is called, for example, when a preemption supporting server module ends streaming a packet to the sink.

The sink must not be full at the gate and no other packet streaming can be in progress. The packet must not be nullptr. The gate must be a valid gate of this module and it must support pushing and streaming packets.

Implements inet::queueing::IPassivePacketSink.

 {
     Enter_Method("pushPacketEnd");
     take(packet);
     EV_INFO << "Forwarding packet" << EV_FIELD(packet) << EV_ENDL;
     if (!isStreamingPacket())
         startPacketStreaming(packet);
     else
         checkPacketStreaming(packet);
     endPacketStreaming(packet);
     pushOrSendPacketEnd(packet, outputGate, consumer, packet->getTransmissionId());
     updateDisplayString();
 }

◆ pushPacketProgress()

void inet::queueing::PacketMultiplexer::pushPacketProgress	(	Packet *	packet,
		cGate *	gate,
		bps	datarate,
		b	position,
		b	extraProcessableLength = `b(0)`
	)

overridevirtual

Progresses pushing the packet into the packet sink at the given gate.

This is a packet streaming operation. The position specifies where the packet streaming is at the moment. The extra length parameter partially fixes the future of the packet streaming operation. The onwership of the packet is transferred to the sink.

Packet streaming can be started with any of the streaming operations, and ends when the streaming position plus the extra processable packet length equals to the total packet length.

This method is called, for example, to notify the sink about a change in the packet data when a preemption occurs.

The sink must not be full at the gate and no other packet streaming can be in progress. The packet must not be nullptr. The gate must be a valid gate of this module and it must support pushing and streaming packets.

Implements inet::queueing::IPassivePacketSink.

 {
     Enter_Method("pushPacketProgress");
     take(packet);
     EV_INFO << "Forwarding packet" << EV_FIELD(packet) << EV_ENDL;
     if (!isStreamingPacket())
         startPacketStreaming(packet);
     else
         checkPacketStreaming(packet);
     if (packet->getTotalLength() == position + extraProcessableLength)
         endPacketStreaming(packet);
     pushOrSendPacketProgress(packet, outputGate, consumer, datarate, position, extraProcessableLength, packet->getTransmissionId());
     updateDisplayString();
 }

◆ pushPacketStart()

void inet::queueing::PacketMultiplexer::pushPacketStart	(	Packet *	packet,
		cGate *	gate,
		bps	datarate
	)

overridevirtual

Starts pushing the packet into the packet sink at the given gate.

This is a packet streaming operation. The onwership of the packet is transferred to the sink.

Packet streaming can be started with any of the streaming operations, and ends when the streaming position plus the extra processable packet length equals to the total packet length.

This method is called, for example, when a preemption supporting server module starts streaming a packet to the sink.

The sink must not be full at the gate and no other packet streaming can be in progress. The packet must not be nullptr. The gate must be a valid gate of this module and it must support pushing and streaming packets.

Implements inet::queueing::IPassivePacketSink.

 {
     Enter_Method("pushPacketStart");
     take(packet);
     EV_INFO << "Forwarding packet" << EV_FIELD(packet) << EV_ENDL;
     checkPacketStreaming(packet);
     startPacketStreaming(packet);
     pushOrSendPacketStart(packet, outputGate, consumer, datarate, packet->getTransmissionId());
     updateDisplayString();
 }

◆ startPacketStreaming()

void inet::queueing::PacketMultiplexer::startPacketStreaming ( Packet * packet )

protectedvirtual

 {
     inProgressStreamId = packet->getTreeId();
 }

Referenced by pushPacketEnd(), pushPacketProgress(), and pushPacketStart().

◆ supportsPacketPulling()

virtual bool inet::queueing::PacketMultiplexer::supportsPacketPulling ( cGate * gate ) const

inlineoverridevirtual

Returns true if the processor supports pulling packets at the given gate.

Pulling a packet is a synchronous operation that is initiated by the sink module. A pulled packet can be passed as a whole using pullPacket(), or it can be streamed from the source to the sink using pullPacketStart(), pullPacketEnd(), and pullPacketProgress().

For output gates, true means that the connected module can pull packets from this module. For input gates, true means that this module can pull packets from the connected module. For example, a packet server module can pull packets from a queue module.

Connecting incompatible gates raises an error during initialize. The gate parameter must be a valid gate of this module. The gate should be marked with @labels(pull) in the NED file.

Implements inet::queueing::IPacketProcessor.

47 { return false; }

◆ supportsPacketPushing()

virtual bool inet::queueing::PacketMultiplexer::supportsPacketPushing ( cGate * gate ) const

inlineoverridevirtual

Returns true if the processor supports pushing packets at the given gate.

Pushing a packet is a synchronous operation that is initiated by the source module. A pushed packet can be passed as a whole using pushPacket(), or it can be streamed from the source to the sink using pushPacketStart(), pushPacketEnd(), and pushPacketProgress().

For output gates, true means that this module can push packets into the connected module. For input gates, true means that the connected module can push packets into this module. For example, a packet generator module can push packets into a queue module.

Connecting incompatible gates raises an error during initialize. The gate parameter must be a valid gate of this module. The gate should be marked with @labels(push) in the NED file.

Implements inet::queueing::IPacketProcessor.

48 { return true; }

◆ supportsPacketStreaming()

virtual bool inet::queueing::PacketMultiplexer::supportsPacketStreaming ( cGate * gate ) const

inlineoverridevirtual

Returns true if the processor supports streaming packets at the given gate.

A streamed packet is handed over from one module to another using several method calls and potentially exending to a non-zero simulation duration.

For example, packets are streamed to a preemptable signal transmitter module.

Connecting incompatible gates raises an error during initialize. The gate parameter must be a valid gate of this module. The gate should be marked with @labels(stream) in the NED file.

Reimplemented from inet::queueing::PacketProcessorBase.

49 { return true; }

Member Data Documentation

◆ consumer

IPassivePacketSink* inet::queueing::PacketMultiplexer::consumer = nullptr

protected

Referenced by handleCanPushPacketChanged(), initialize(), pushPacket(), pushPacketEnd(), pushPacketProgress(), and pushPacketStart().

◆ forwardProtocolRegistration

bool inet::queueing::PacketMultiplexer::forwardProtocolRegistration

protected

Referenced by initialize().

◆ forwardServiceRegistration

bool inet::queueing::PacketMultiplexer::forwardServiceRegistration

protected

Referenced by initialize().

◆ inProgressStreamId

int inet::queueing::PacketMultiplexer::inProgressStreamId = -1

protected

Referenced by checkPacketStreaming(), endPacketStreaming(), and startPacketStreaming().

◆ inputGates

std::vector<cGate *> inet::queueing::PacketMultiplexer::inputGates

protected

Referenced by handleCanPushPacketChanged(), initialize(), and mapRegistrationForwardingGates().

◆ outputGate

cGate* inet::queueing::PacketMultiplexer::outputGate = nullptr

protected

Referenced by handleCanPushPacketChanged(), initialize(), mapRegistrationForwardingGates(), pushPacket(), pushPacketEnd(), pushPacketProgress(), and pushPacketStart().

◆ producers

std::vector<IActivePacketSource *> inet::queueing::PacketMultiplexer::producers

protected

Referenced by handleCanPushPacketChanged(), and initialize().

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ canPushPacket()

◆ canPushSomePacket()

◆ checkPacketStreaming()

◆ endPacketStreaming()

◆ getConsumer()

◆ handleCanPushPacketChanged()

◆ handleMessage()

◆ handlePushPacketProcessed()

◆ initialize()

◆ isForwardingProtocol()

◆ isForwardingService()

◆ isStreamingPacket()

◆ mapRegistrationForwardingGates()

◆ pushPacket()

◆ pushPacketEnd()

◆ pushPacketProgress()

◆ pushPacketStart()

◆ startPacketStreaming()

◆ supportsPacketPulling()

◆ supportsPacketPushing()

◆ supportsPacketStreaming()

Member Data Documentation

◆ consumer

◆ forwardProtocolRegistration

◆ forwardServiceRegistration

◆ inProgressStreamId

◆ inputGates

◆ outputGate

◆ producers