#include <PacketDemultiplexer.h>

Inheritance diagram for inet::queueing::PacketDemultiplexer:

Public Member Functions
virtual IPassivePacketSource *	getProvider (cGate *gate) override
	Returns the passive packet source from where packets are pulled or nullptr if the connected module doesn't implement the interface. More...

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

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

virtual bool	canPullSomePacket (cGate *gate) const override
	Returns false if the packet source is empty at the given gate and no more packets can be pulled from it without raising an error. More...

virtual Packet *	canPullPacket (cGate *gate) const override
	Returns the packet that can be pulled at the given gate. More...

virtual Packet *	pullPacket (cGate *gate) override
	Pulls the packet from the packet source at the given gate. More...

virtual Packet *	pullPacketStart (cGate *gate, bps datarate) override
	Starts pulling the packet from the packet source at the given gate. More...

virtual Packet *	pullPacketEnd (cGate *gate) override
	Ends pulling the packet from the packet source at the given gate. More...

virtual Packet *	pullPacketProgress (cGate *gate, bps datarate, b position, b extraProcessableLength) override
	Progresses pulling the packet from the packet source at the given gate. More...

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

virtual void	handleCanPullPacketChanged (cGate *gate) override
	Notifies about a change in the possibility of pulling some packet from the passive packet source at the given gate. More...

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 bool	supportsPacketStreaming (cGate *gate) const override
	Returns true if the processor supports streaming packets 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::IActivePacketSink
virtual	~IActivePacketSink ()

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

Protected Member Functions
virtual void	initialize (int stage) override

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
cGate *	inputGate = nullptr

IPassivePacketSource *	provider = nullptr

std::vector< cGate * >	outputGates

std::vector< IActivePacketSink * >	collectors

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

◆ canPullPacket()

virtual Packet* inet::queueing::PacketDemultiplexer::canPullPacket ( cGate * gate ) const

inlineoverridevirtual

Returns the packet that can be pulled at the given gate.

The returned value is nullptr if there is no such packet.

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

Implements inet::queueing::IPassivePacketSource.

37 { return provider->canPullPacket(inputGate->getPathStartGate()); }

◆ canPullSomePacket()

virtual bool inet::queueing::PacketDemultiplexer::canPullSomePacket ( cGate * gate ) const

inlineoverridevirtual

Returns false if the packet source is empty at the given gate and no more packets can be pulled from it without raising an error.

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

Implements inet::queueing::IPassivePacketSource.

36 { return provider->canPullSomePacket(inputGate->getPathStartGate()); }

◆ getProvider()

virtual IPassivePacketSource* inet::queueing::PacketDemultiplexer::getProvider ( cGate * gate )

inlineoverridevirtual

Returns the passive packet source from where packets are pulled 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::IActivePacketSink.

31 { return provider; }

◆ handleCanPullPacketChanged()

void inet::queueing::PacketDemultiplexer::handleCanPullPacketChanged ( cGate * gate )

overridevirtual

Notifies about a change in the possibility of pulling some packet from the passive packet source at the given gate.

This method is called, for example, when a new packet is inserted into a queue. It allows the sink to pull a new packet from the queue.

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

Implements inet::queueing::IActivePacketSink.

 {
     Enter_Method("handleCanPullPacketChanged");
     for (int i = 0; i < (int)outputGates.size(); i++)
         // NOTE: notifying a listener may prevent others from pulling
         if (collectors[i] != nullptr && provider->canPullSomePacket(inputGate->getPathStartGate()))
             collectors[i]->handleCanPullPacketChanged(outputGates[i]->getPathEndGate());
 }

◆ handlePullPacketProcessed()

void inet::queueing::PacketDemultiplexer::handlePullPacketProcessed	(	Packet *	packet,
		cGate *	gate,
		bool	successful
	)

overridevirtual

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

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

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

Implements inet::queueing::IActivePacketSink.

 {
     Enter_Method("handlePullPacketProcessed");
     throw cRuntimeError("Invalid operation");
 }

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::queueing::PacketProcessorBase.

 {
     PacketProcessorBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         inputGate = gate("in");
         for (int i = 0; i < gateSize("out"); i++) {
             auto outputGate = gate("out", i);
             auto output = getConnectedModule<IActivePacketSink>(outputGate);
             outputGates.push_back(outputGate);
             collectors.push_back(output);
         }
         provider = findConnectedModule<IPassivePacketSource>(inputGate);
     }
     else if (stage == INITSTAGE_QUEUEING) {
         checkPacketOperationSupport(inputGate);
         for (auto outputGate : outputGates)
             checkPacketOperationSupport(outputGate);
     }
 }

◆ pullPacket()

Packet * inet::queueing::PacketDemultiplexer::pullPacket ( cGate * gate )

overridevirtual

Pulls the packet from the packet source at the given gate.

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

The source must not be empty at the given gate. The returned packet must not be nullptr. The gate must be a valid gate of this module and it must support pulling and passing packets.

Implements inet::queueing::IPassivePacketSource.

 {
     Enter_Method("pullPacket");
     auto packet = provider->pullPacket(inputGate->getPathStartGate());
     take(packet);
     EV_INFO << "Forwarding packet" << EV_FIELD(packet) << EV_ENDL;
     animatePullPacket(packet, gate);
     numProcessedPackets++;
     processedTotalLength += packet->getDataLength();
     updateDisplayString();
     return packet;
 }

◆ pullPacketEnd()

virtual Packet* inet::queueing::PacketDemultiplexer::pullPacketEnd ( cGate * gate )

inlineoverridevirtual

Ends pulling the packet from the packet source 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 from the the source.

The source must not be empty at the gate and no other packet streaming can be in progress. The gate must be a valid gate of this module and it must support pulling and streaming packets. The returned packet must not be nullptr.

Implements inet::queueing::IPassivePacketSource.

42 { throw cRuntimeError("Invalid operation"); }

◆ pullPacketProgress()

virtual Packet* inet::queueing::PacketDemultiplexer::pullPacketProgress	(	cGate *	gate,
		bps	datarate,
		b	position,
		b	extraProcessableLength
	)

inlineoverridevirtual

Progresses pulling the packet from the packet source 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 source about a change in the packet data when a preemption occurs.

The source must not be empty at the gate and no other packet streaming can be in progress. The gate must be a valid gate of this module and it must support pulling and streaming packets. The returned packet must not be nullptr.

Implements inet::queueing::IPassivePacketSource.

43 { throw cRuntimeError("Invalid operation"); }

◆ pullPacketStart()

virtual Packet* inet::queueing::PacketDemultiplexer::pullPacketStart	(	cGate *	gate,
		bps	datarate
	)

inlineoverridevirtual

Starts pulling the packet from the packet source 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 from the source.

The source must not be empty at the gate and no other packet streaming can be in progress. The gate must be a valid gate of this module and it must support pulling and streaming packets. The returned packet must not be nullptr.

Implements inet::queueing::IPassivePacketSource.

41 { throw cRuntimeError("Invalid operation"); }

◆ supportsPacketPulling()

virtual bool inet::queueing::PacketDemultiplexer::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.

34 { return true; }

◆ supportsPacketPushing()

virtual bool inet::queueing::PacketDemultiplexer::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.

33 { return false; }

Member Data Documentation

◆ collectors

std::vector<IActivePacketSink *> inet::queueing::PacketDemultiplexer::collectors

protected

Referenced by handleCanPullPacketChanged(), and initialize().

◆ inputGate

cGate* inet::queueing::PacketDemultiplexer::inputGate = nullptr

protected

Referenced by handleCanPullPacketChanged(), initialize(), and pullPacket().

◆ outputGates

std::vector<cGate *> inet::queueing::PacketDemultiplexer::outputGates

protected

Referenced by handleCanPullPacketChanged(), and initialize().

◆ provider

IPassivePacketSource* inet::queueing::PacketDemultiplexer::provider = nullptr

protected

Referenced by handleCanPullPacketChanged(), initialize(), and pullPacket().

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

◆ canPullPacket()

◆ canPullSomePacket()

◆ getProvider()

◆ handleCanPullPacketChanged()

◆ handlePullPacketProcessed()

◆ initialize()

◆ pullPacket()

◆ pullPacketEnd()

◆ pullPacketProgress()

◆ pullPacketStart()

◆ supportsPacketPulling()

◆ supportsPacketPushing()

Member Data Documentation

◆ collectors

◆ inputGate

◆ outputGates

◆ provider