#include <PacketQueue.h>

Inheritance diagram for inet::queueing::PacketQueue:

Public Member Functions
virtual	~PacketQueue ()

virtual int	getMaxNumPackets () const override
	Returns maximum allowed number of packets in the collection. More...

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

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

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

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

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

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

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

virtual bool	supportsPacketPushing (cGate *gate) const override
	Returns true if the processor supports pushing 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 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 void	handlePacketRemoved (Packet *packet) override
	Notifies the packet owner about the packet being removed from the buffer. More...

Public Member Functions inherited from inet::queueing::PacketQueueBase
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 ()

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

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

Protected Member Functions
virtual void	initialize (int stage) override

virtual IPacketDropperFunction *	createDropperFunction (const char *dropperClass) const

virtual IPacketComparatorFunction *	createComparatorFunction (const char *comparatorClass) const

virtual bool	isOverloaded () const

Protected Member Functions inherited from inet::queueing::PacketQueueBase
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	packetCapacity = -1

b	dataCapacity = b(-1)

IActivePacketSource *	producer = nullptr

IActivePacketSink *	collector = nullptr

cPacketQueue	queue

IPacketBuffer *	buffer = nullptr

IPacketDropperFunction *	packetDropperFunction = nullptr

IPacketComparatorFunction *	packetComparatorFunction = nullptr

Protected Attributes inherited from inet::queueing::PacketQueueBase
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 }

Constructor & Destructor Documentation

◆ ~PacketQueue()

virtual inet::queueing::PacketQueue::~PacketQueue ( )

inlinevirtual

45 { delete packetDropperFunction; }

Member Function Documentation

◆ canPullPacket()

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

65 { return !isEmpty() ? getPacket(0) : nullptr; }

◆ canPullSomePacket()

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

Reimplemented from inet::queueing::PacketQueueBase.

64 { return !isEmpty(); }

◆ canPushPacket()

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

overridevirtual

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.

Reimplemented in inet::queueing::InProgressQueue.

 {
     if (packetDropperFunction)
         return true;
     if (getMaxNumPackets() != -1 && getNumPackets() >= getMaxNumPackets())
         return false;
     if (getMaxTotalLength() != b(-1) && getMaxTotalLength() - getTotalLength() < packet->getDataLength())
         return false;
     return true;
 }

◆ canPushSomePacket()

bool inet::queueing::PacketQueue::canPushSomePacket ( cGate * gate ) const

overridevirtual

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.

Reimplemented from inet::queueing::PacketQueueBase.

Reimplemented in inet::queueing::InProgressQueue.

 {
     if (packetDropperFunction)
         return true;
     if (getMaxNumPackets() != -1 && getNumPackets() >= getMaxNumPackets())
         return false;
     if (getMaxTotalLength() != b(-1) && getTotalLength() >= getMaxTotalLength())
         return false;
     return true;
 }

◆ createComparatorFunction()

IPacketComparatorFunction * inet::queueing::PacketQueue::createComparatorFunction ( const char * comparatorClass ) const

protectedvirtual

 {
     if (strlen(comparatorClass) == 0)
         return nullptr;
     else
         return check_and_cast<IPacketComparatorFunction *>(createOne(comparatorClass));
 }

Referenced by initialize().

◆ createDropperFunction()

IPacketDropperFunction * inet::queueing::PacketQueue::createDropperFunction ( const char * dropperClass ) const

protectedvirtual

 {
     if (strlen(dropperClass) == 0)
         return nullptr;
     else
         return check_and_cast<IPacketDropperFunction *>(createOne(dropperClass));
 }

Referenced by initialize().

◆ getMaxNumPackets()

virtual int inet::queueing::PacketQueue::getMaxNumPackets ( ) const

inlineoverridevirtual

Returns maximum allowed number of packets in the collection.

The value -1 means no such limit.

Implements inet::queueing::IPacketCollection.

47 { return packetCapacity; }

Referenced by canPushPacket(), and canPushSomePacket().

◆ getMaxTotalLength()

virtual b inet::queueing::PacketQueue::getMaxTotalLength ( ) const

inlineoverridevirtual

Returns maximum allowed total length of all packets in the collection.

The value -1 means no such limit.

Implements inet::queueing::IPacketCollection.

50 { return dataCapacity; }

Referenced by canPushPacket(), and canPushSomePacket().

◆ getNumPackets()

int inet::queueing::PacketQueue::getNumPackets ( ) const

overridevirtual

Returns the number of available packets in the collection in the range [0, inf).

Implements inet::queueing::IPacketCollection.

 {
     return queue.getLength();
 }

Referenced by canPushPacket(), canPushSomePacket(), isOverloaded(), pullPacket(), pushPacket(), and removeAllPackets().

◆ getPacket()

Packet * inet::queueing::PacketQueue::getPacket ( int index ) const

overridevirtual

Returns the packet at the given index.

Throws error when the index is out of range.

Implements inet::queueing::IPacketCollection.

 {
     if (index < 0 || index >= queue.getLength())
         throw cRuntimeError("index %i out of range", index);
     return check_and_cast<Packet *>(queue.get(index));
 }

Referenced by inet::queueing::InProgressQueue::canPushPacket().

◆ getTotalLength()

virtual b inet::queueing::PacketQueue::getTotalLength ( ) const

inlineoverridevirtual

Returns the total length of all packets in the collection in the range [0, inf).

Implements inet::queueing::IPacketCollection.

51 { return b(queue.getBitLength()); }

Referenced by canPushPacket(), canPushSomePacket(), isOverloaded(), and pullPacket().

◆ handlePacketRemoved()

void inet::queueing::PacketQueue::handlePacketRemoved ( Packet * packet )

overridevirtual

Notifies the packet owner about the packet being removed from the buffer.

The packet is never nullptr.

Implements inet::queueing::IPacketBuffer::ICallback.

 {
     Enter_Method("handlePacketRemoved");
     if (queue.contains(packet)) {
         EV_INFO << "Removing packet" << EV_FIELD(packet) << EV_ENDL;
         queue.remove(packet);
         emit(packetRemovedSignal, packet);
         updateDisplayString();
     }
 }

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::queueing::PacketQueueBase.

 {
     PacketQueueBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         queue.setName("storage");
         producer = findConnectedModule<IActivePacketSource>(inputGate);
         collector = findConnectedModule<IActivePacketSink>(outputGate);
         packetCapacity = par("packetCapacity");
         dataCapacity = b(par("dataCapacity"));
         buffer = findModuleFromPar<IPacketBuffer>(par("bufferModule"), this);
         packetComparatorFunction = createComparatorFunction(par("comparatorClass"));
         if (packetComparatorFunction != nullptr)
             queue.setup(packetComparatorFunction);
         packetDropperFunction = createDropperFunction(par("dropperClass"));
     }
     else if (stage == INITSTAGE_QUEUEING) {
         checkPacketOperationSupport(inputGate);
         checkPacketOperationSupport(outputGate);
         if (producer != nullptr)
             producer->handleCanPushPacketChanged(inputGate->getPathStartGate());
     }
     else if (stage == INITSTAGE_LAST)
         updateDisplayString();
 }

◆ isEmpty()

virtual bool inet::queueing::PacketQueue::isEmpty ( ) const

inlineoverridevirtual

Returns true if there are no packets available in the collection.

Implements inet::queueing::IPacketCollection.

53 { return getNumPackets() == 0; }

◆ isOverloaded()

bool inet::queueing::PacketQueue::isOverloaded ( ) const

protectedvirtual

 {
     return (packetCapacity != -1 && getNumPackets() > packetCapacity) ||
            (dataCapacity != b(-1) && getTotalLength() > dataCapacity);
 }

Referenced by pushPacket().

◆ pullPacket()

Packet * inet::queueing::PacketQueue::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 = check_and_cast<Packet *>(queue.front());
     EV_INFO << "Pulling packet" << EV_FIELD(packet) << EV_ENDL;
     if (buffer != nullptr) {
         queue.remove(packet);
         buffer->removePacket(packet);
     }
     else
         queue.pop();
     auto queueingTime = simTime() - packet->getArrivalTime();
     auto packetEvent = new PacketQueuedEvent();
     packetEvent->setQueuePacketLength(getNumPackets());
     packetEvent->setQueueDataLength(getTotalLength());
     insertPacketEvent(this, packet, PEK_QUEUED, queueingTime, packetEvent);
     increaseTimeTag<QueueingTimeTag>(packet, queueingTime, queueingTime);
     emit(packetPulledSignal, packet);
     animatePullPacket(packet, outputGate);
     updateDisplayString();
     return packet;
 }

◆ pushPacket()

void inet::queueing::PacketQueue::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);
     cNamedObject packetPushStartedDetails("atomicOperationStarted");
     emit(packetPushStartedSignal, packet, &packetPushStartedDetails);
     EV_INFO << "Pushing packet" << EV_FIELD(packet) << EV_ENDL;
     queue.insert(packet);
     if (buffer != nullptr)
         buffer->addPacket(packet);
     else if (packetDropperFunction != nullptr) {
         while (isOverloaded()) {
             auto packet = packetDropperFunction->selectPacket(this);
             EV_INFO << "Dropping packet" << EV_FIELD(packet) << EV_ENDL;
             queue.remove(packet);
             dropPacket(packet, QUEUE_OVERFLOW);
         }
     }
     ASSERT(!isOverloaded());
     if (collector != nullptr && getNumPackets() != 0)
         collector->handleCanPullPacketChanged(outputGate->getPathEndGate());
     cNamedObject packetPushEndedDetails("atomicOperationEnded");
     emit(packetPushEndedSignal, nullptr, &packetPushEndedDetails);
     updateDisplayString();
 }

◆ removeAllPackets()

void inet::queueing::PacketQueue::removeAllPackets ( )

overridevirtual

Removes all packets from the collection.

Implements inet::queueing::IPacketCollection.

 {
     Enter_Method("removeAllPackets");
     EV_INFO << "Removing all packets" << EV_ENDL;
     std::vector<Packet *> packets;
     for (int i = 0; i < getNumPackets(); i++)
         packets.push_back(check_and_cast<Packet *>(queue.pop()));
     if (buffer != nullptr)
         buffer->removeAllPackets();
     for (auto packet : packets) {
         emit(packetRemovedSignal, packet);
         delete packet;
     }
     updateDisplayString();
 }

◆ removePacket()

void inet::queueing::PacketQueue::removePacket ( Packet * packet )

overridevirtual

Removes a packet from the collection.

The collection must contain the packet.

Implements inet::queueing::IPacketCollection.

 {
     Enter_Method("removePacket");
     EV_INFO << "Removing packet" << EV_FIELD(packet) << EV_ENDL;
     queue.remove(packet);
     if (buffer != nullptr)
         buffer->removePacket(packet);
     emit(packetRemovedSignal, packet);
     updateDisplayString();
 }

◆ supportsPacketPulling()

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

63 { return outputGate == gate; }

◆ supportsPacketPushing()

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

58 { return inputGate == gate; }

Member Data Documentation

◆ buffer

IPacketBuffer* inet::queueing::PacketQueue::buffer = nullptr

protected

Referenced by initialize(), pullPacket(), pushPacket(), removeAllPackets(), and removePacket().

◆ collector

IActivePacketSink* inet::queueing::PacketQueue::collector = nullptr

protected

Referenced by initialize(), and pushPacket().

◆ dataCapacity

b inet::queueing::PacketQueue::dataCapacity = b(-1)

protected

Referenced by initialize(), and isOverloaded().

◆ packetCapacity

int inet::queueing::PacketQueue::packetCapacity = -1

protected

Referenced by initialize(), and isOverloaded().

◆ packetComparatorFunction

IPacketComparatorFunction* inet::queueing::PacketQueue::packetComparatorFunction = nullptr

protected

Referenced by inet::queueing::InProgressQueue::canPushPacket(), and initialize().

◆ packetDropperFunction

IPacketDropperFunction* inet::queueing::PacketQueue::packetDropperFunction = nullptr

protected

Referenced by canPushPacket(), canPushSomePacket(), initialize(), and pushPacket().

◆ producer

IActivePacketSource* inet::queueing::PacketQueue::producer = nullptr

protected

Referenced by initialize().

◆ queue

cPacketQueue inet::queueing::PacketQueue::queue

protected

Referenced by inet::queueing::InProgressQueue::canPushPacket(), getNumPackets(), getPacket(), handlePacketRemoved(), initialize(), pullPacket(), pushPacket(), removeAllPackets(), and removePacket().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ ~PacketQueue()

Member Function Documentation

◆ canPullPacket()

◆ canPullSomePacket()

◆ canPushPacket()

◆ canPushSomePacket()

◆ createComparatorFunction()

◆ createDropperFunction()

◆ getMaxNumPackets()

◆ getMaxTotalLength()

◆ getNumPackets()

◆ getPacket()

◆ getTotalLength()

◆ handlePacketRemoved()

◆ initialize()

◆ isEmpty()

◆ isOverloaded()

◆ pullPacket()

◆ pushPacket()

◆ removeAllPackets()

◆ removePacket()

◆ supportsPacketPulling()

◆ supportsPacketPushing()

Member Data Documentation

◆ buffer

◆ collector

◆ dataCapacity

◆ packetCapacity

◆ packetComparatorFunction

◆ packetDropperFunction

◆ producer

◆ queue