#include <PacketQueueBase.h>

Inheritance diagram for inet::queueing::PacketQueueBase:

Public Member Functions
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 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 void	enqueuePacket (Packet *packet) override
	Enqueues the packet into the packet queue. More...

virtual Packet *	dequeuePacket () override
	Dequeues the packet from the packet queue. 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	pushPacketEnd (Packet packet, cGate gate) override
	Ends 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 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...

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...

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

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

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

Public Member Functions inherited from inet::queueing::IPacketCollection
virtual int	getMaxNumPackets () const =0
	Returns maximum allowed number of packets in the collection. More...

virtual int	getNumPackets () const =0
	Returns the number of available packets in the collection in the range [0, inf). More...

virtual b	getMaxTotalLength () const =0
	Returns maximum allowed total length of all packets in the collection. More...

virtual b	getTotalLength () const =0
	Returns the total length of all packets in the collection in the range [0, inf). More...

virtual Packet *	getPacket (int index) const =0
	Returns the packet at the given index. More...

virtual bool	isEmpty () const =0
	Returns true if there are no packets available in the collection. More...

virtual void	removePacket (Packet *packet)=0
	Removes a packet from the collection. More...

virtual void	removeAllPackets ()=0
	Removes all packets from the collection. More...

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

virtual bool	canPushPacket (Packet packet, cGate gate) const =0
	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)=0
	Pushes the packet into the packet sink at the given gate. More...

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

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

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

Protected Member Functions
virtual void	initialize (int stage) override

virtual void	handleMessage (cMessage *message) override

virtual void	emit (simsignal_t signal, cObject object, cObject details=nullptr) override

virtual const char *	resolveDirective (char directive) const 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
int	numPushedPackets = -1

int	numPulledPackets = -1

int	numRemovedPackets = -1

int	numDroppedPackets = -1

int	numCreatedPackets = -1

cGate *	inputGate = nullptr

cGate *	outputGate = nullptr

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

◆ canPullSomePacket()

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

Reimplemented in inet::queueing::PacketQueue, and inet::queueing::CompoundPacketQueueBase.

38 { return getNumPackets() > 0; }

◆ canPushSomePacket()

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

Reimplemented in inet::queueing::PacketQueue, inet::queueing::CompoundPacketQueueBase, and inet::queueing::InProgressQueue.

39 { return true; }

◆ dequeuePacket()

Packet * inet::queueing::PacketQueueBase::dequeuePacket ( )

overridevirtual

Dequeues the packet from the packet queue.

The onwership of the packet is transferred from the queue to the caller.

The queue must not be empty. The returned packet must not be nullptr.

Implements inet::queueing::IPacketQueue.

 {
     auto packet = pullPacket(outputGate);
     drop(packet);
     return packet;
 }

◆ emit()

void inet::queueing::PacketQueueBase::emit	(	simsignal_t	signal,
		cObject *	object,
		cObject *	details = `nullptr`
	)

overrideprotectedvirtual

 {
     if (signal == packetPushedSignal)
         numPushedPackets++;
     else if (signal == packetPulledSignal)
         numPulledPackets++;
     else if (signal == packetRemovedSignal)
         numRemovedPackets++;
     else if (signal == packetDroppedSignal)
         numDroppedPackets++;
     cSimpleModule::emit(signal, object, details);
 }

Referenced by inet::queueing::PacketQueue::handlePacketRemoved(), inet::queueing::CompoundPacketQueueBase::pullPacket(), inet::queueing::PacketQueue::pullPacket(), inet::queueing::CompoundPacketQueueBase::pushPacket(), inet::queueing::PacketQueue::pushPacket(), inet::queueing::PacketQueue::removeAllPackets(), inet::queueing::CompoundPacketQueueBase::removePacket(), and inet::queueing::PacketQueue::removePacket().

◆ enqueuePacket()

void inet::queueing::PacketQueueBase::enqueuePacket ( Packet * packet )

overridevirtual

Enqueues the packet into the packet queue.

The onwership of the packet is transferred from the caller to the queue.

The queue must not be full. The packet must not be nullptr.

Implements inet::queueing::IPacketQueue.

 {
     pushPacket(packet, inputGate);
 }

◆ handleMessage()

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

overrideprotectedvirtual

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

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::queueing::PacketProcessorBase.

Reimplemented in inet::queueing::PacketQueue, and inet::queueing::CompoundPacketQueueBase.

 {
     PacketProcessorBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         inputGate = gate("in");
         outputGate = gate("out");
         displayStringTextFormat = par("displayStringTextFormat");
         numPushedPackets = 0;
         numPulledPackets = 0;
         numRemovedPackets = 0;
         numDroppedPackets = 0;
         numCreatedPackets = 0;
         WATCH(numPushedPackets);
         WATCH(numPulledPackets);
         WATCH(numRemovedPackets);
         WATCH(numDroppedPackets);
     }
 }

Referenced by inet::queueing::CompoundPacketQueueBase::initialize(), and inet::queueing::PacketQueue::initialize().

◆ pullPacketEnd()

virtual Packet* inet::queueing::PacketQueueBase::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.

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

◆ pullPacketProgress()

virtual Packet* inet::queueing::PacketQueueBase::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.

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

◆ pullPacketStart()

virtual Packet* inet::queueing::PacketQueueBase::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.

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

◆ pushPacketEnd()

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

inlineoverridevirtual

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.

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

◆ pushPacketProgress()

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

inlineoverridevirtual

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.

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

◆ pushPacketStart()

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

inlineoverridevirtual

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.

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

◆ resolveDirective()

const char * inet::queueing::PacketQueueBase::resolveDirective ( char directive ) const

overrideprotectedvirtual

Reimplemented from inet::queueing::PacketProcessorBase.

 {
     static std::string result;
     switch (directive) {
         case 'p':
             result = std::to_string(getNumPackets());
             break;
         case 'l':
             result = getTotalLength().str();
             break;
         case 'u':
             result = std::to_string(numPushedPackets);
             break;
         case 'o':
             result = std::to_string(numPulledPackets);
             break;
         case 'r':
             result = std::to_string(numRemovedPackets);
             break;
         case 'd':
             result = std::to_string(numDroppedPackets);
             break;
         case 'c':
             result = std::to_string(numCreatedPackets);
             break;
         case 'n':
             result = !isEmpty() ? getPacket(0)->getFullName() : "";
             break;
         default:
             result = PacketProcessorBase::resolveDirective(directive);
             break;
     }
     return result.c_str();
 }

Member Data Documentation

◆ inputGate

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

protected

Referenced by enqueuePacket(), initialize(), inet::queueing::CompoundPacketQueueBase::initialize(), inet::queueing::PacketQueue::initialize(), and inet::queueing::CompoundPacketQueueBase::pushPacket().

◆ numCreatedPackets

int inet::queueing::PacketQueueBase::numCreatedPackets = -1

protected

Referenced by initialize(), inet::queueing::CompoundPacketQueueBase::initialize(), inet::queueing::CompoundPacketQueueBase::receiveSignal(), and resolveDirective().

◆ numDroppedPackets

int inet::queueing::PacketQueueBase::numDroppedPackets = -1

protected

Referenced by emit(), initialize(), inet::queueing::CompoundPacketQueueBase::receiveSignal(), and resolveDirective().

◆ numPulledPackets

int inet::queueing::PacketQueueBase::numPulledPackets = -1

protected

Referenced by emit(), initialize(), and resolveDirective().

◆ numPushedPackets

int inet::queueing::PacketQueueBase::numPushedPackets = -1

protected

Referenced by emit(), initialize(), and resolveDirective().

◆ numRemovedPackets

int inet::queueing::PacketQueueBase::numRemovedPackets = -1

protected

Referenced by emit(), initialize(), and resolveDirective().

◆ outputGate

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

protected

Referenced by dequeuePacket(), initialize(), inet::queueing::CompoundPacketQueueBase::initialize(), inet::queueing::PacketQueue::initialize(), inet::queueing::CompoundPacketQueueBase::pullPacket(), inet::queueing::PacketQueue::pullPacket(), and inet::queueing::PacketQueue::pushPacket().

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

◆ canPullSomePacket()

◆ canPushSomePacket()

◆ dequeuePacket()

◆ emit()

◆ enqueuePacket()

◆ handleMessage()

◆ initialize()

◆ pullPacketEnd()

◆ pullPacketProgress()

◆ pullPacketStart()

◆ pushPacketEnd()

◆ pushPacketProgress()

◆ pushPacketStart()

◆ resolveDirective()

Member Data Documentation

◆ inputGate

◆ numCreatedPackets

◆ numDroppedPackets

◆ numPulledPackets

◆ numPushedPackets

◆ numRemovedPackets

◆ outputGate