#include <PacketBufferBase.h>

Inheritance diagram for inet::queueing::PacketBufferBase:

Protected Member Functions
virtual void	initialize (int stage) 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	numAddedPackets = -1

int	numRemovedPackets = -1

int	numDroppedPackets = -1

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

int	numProcessedPackets = -1

b	processedTotalLength = b(-1)

Additional Inherited Members
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...

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

Member Function Documentation

◆ emit()

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

overrideprotectedvirtual

 {
     if (signal == packetAddedSignal)
         numAddedPackets++;
     else if (signal == packetRemovedSignal)
         numRemovedPackets++;
     else if (signal == packetDroppedSignal)
         numDroppedPackets++;
     cSimpleModule::emit(signal, object, details);
 }

Referenced by inet::queueing::PacketBuffer::addPacket(), inet::queueing::PacketBuffer::removeAllPackets(), and inet::queueing::PacketBuffer::removePacket().

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::queueing::PacketProcessorBase.

Reimplemented in inet::queueing::PacketBuffer.

 {
     PacketProcessorBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         displayStringTextFormat = par("displayStringTextFormat");
         numAddedPackets = 0;
         numRemovedPackets = 0;
         numDroppedPackets = 0;
         WATCH(numAddedPackets);
         WATCH(numRemovedPackets);
         WATCH(numDroppedPackets);
     }
 }

Referenced by inet::queueing::PacketBuffer::initialize().

◆ resolveDirective()

const char * inet::queueing::PacketBufferBase::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 'a':
             result = std::to_string(numAddedPackets);
             break;
         case 'r':
             result = std::to_string(numRemovedPackets);
             break;
         case 'd':
             result = std::to_string(numDroppedPackets);
             break;
         default:
             return PacketProcessorBase::resolveDirective(directive);
     }
     return result.c_str();
 }

Member Data Documentation

◆ numAddedPackets

int inet::queueing::PacketBufferBase::numAddedPackets = -1

protected

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

◆ numDroppedPackets

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

protected

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

◆ numRemovedPackets

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

protected

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

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

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ emit()

◆ initialize()

◆ resolveDirective()

Member Data Documentation

◆ numAddedPackets

◆ numDroppedPackets

◆ numRemovedPackets