Ordinal Based Dropper module. More...

#include <OrdinalBasedDropper.h>

Inheritance diagram for inet::queueing::OrdinalBasedDropper:

Public Member Functions
virtual bool	matchesPacket (const Packet *packet) const override
	Returns true if the filter matches the given packet. More...

Public Member Functions inherited from inet::queueing::PacketFilterBase
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 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	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	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 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	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...

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::IActivePacketSink
virtual	~IActivePacketSink ()

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

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

Protected Member Functions
virtual void	initialize (int stage) override

virtual void	parseVector (const char *vector)

virtual void	processPacket (Packet *packet) override

virtual void	dropPacket (Packet *packet) override

Protected Member Functions inherited from inet::queueing::PacketFilterBase
virtual void	handleMessage (cMessage *message) override

virtual bool	isStreamingPacket () const

virtual void	startPacketStreaming (Packet *packet)

virtual void	endPacketStreaming (Packet *packet)

virtual void	checkPacketStreaming (Packet *packet)

virtual void	dropPacket (Packet *packet, PacketDropReason reason, int limit=-1) 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	updateDisplayString () const

Protected Attributes
unsigned int	numPackets

unsigned int	numDropped

bool	generateFurtherDrops

std::vector< unsigned int >	dropsVector

Protected Attributes inherited from inet::queueing::PacketFilterBase
bool	backpressure = false

cGate *	inputGate = nullptr

ModuleRef< IActivePacketSource >	producer

ModuleRef< IPassivePacketSource >	provider

cGate *	outputGate = nullptr

ModuleRef< IPassivePacketSink >	consumer

ModuleRef< IActivePacketSink >	collector

int	inProgressStreamId = -1

int	numDroppedPackets = 0

b	droppedTotalLength = b(-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 }

Detailed Description

Ordinal Based Dropper module.

Member Function Documentation

◆ dropPacket()

void inet::queueing::OrdinalBasedDropper::dropPacket ( Packet * packet )

overrideprotectedvirtual

Reimplemented from inet::queueing::PacketFilterBase.

 {
     EV_DEBUG << "Dropping packet" << EV_FIELD(ordinalNumber, numPackets) << EV_FIELD(packet) << EV_ENDL;
     numPackets++;
     numDropped++;
     dropsVector.erase(dropsVector.begin());
     if (dropsVector.size() == 0) {
         EV_DEBUG << "End of dropsVector reached" << EV_ENDL;
         generateFurtherDrops = false;
     }
 }

◆ initialize()

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

overrideprotectedvirtual

Reimplemented from inet::queueing::PacketFilterBase.

 {
     PacketFilterBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         numPackets = 0;
         numDropped = 0;
         generateFurtherDrops = false;
  
         WATCH(numPackets);
         WATCH(numDropped);
         WATCH(generateFurtherDrops);
  
         const char *vector = par("dropsVector");
         parseVector(vector);
  
         if (dropsVector.size() == 0)
             EV_WARN << "Empty dropsVector" << EV_ENDL;
         else {
             EV_DEBUG << EV_FIELD(dropsVector, vector) << EV_ENDL;
             generateFurtherDrops = true;
         }
     }
 }

◆ matchesPacket()

bool inet::queueing::OrdinalBasedDropper::matchesPacket ( const Packet * packet ) const

overridevirtual

Returns true if the filter matches the given packet.

Implements inet::queueing::IPacketFilter.

 {
     return !generateFurtherDrops || numPackets != dropsVector[0];
 }

◆ parseVector()

void inet::queueing::OrdinalBasedDropper::parseVector ( const char * vector )

protectedvirtual

 {
     const char *v = vector;
     while (*v) {
         // parse packet numbers
         while (isspace(*v))
             v++;
         if (!*v || *v == ';')
             break;
         if (!isdigit(*v))
             throw cRuntimeError("Syntax error in dropsVector: packet number expected");
         if (dropsVector.size() > 0 && dropsVector.back() >= (unsigned int)atoi(v))
             throw cRuntimeError("Syntax error in dropsVector: packet numbers in ascending order expected");
  
         dropsVector.push_back(atoi(v));
         while (isdigit(*v))
             v++;
  
         // skip delimiter
         while (isspace(*v))
             v++;
         if (!*v)
             break;
         if (*v != ';')
             throw cRuntimeError("Syntax error in dropsVector: separator ';' missing");
         v++;
         while (isspace(*v))
             v++;
     }
 }

Referenced by initialize().

◆ processPacket()

void inet::queueing::OrdinalBasedDropper::processPacket ( Packet * packet )

overrideprotectedvirtual

Reimplemented from inet::queueing::PacketFilterBase.

 {
     numPackets++;
 }

Member Data Documentation

◆ dropsVector

std::vector<unsigned int> inet::queueing::OrdinalBasedDropper::dropsVector

protected

Referenced by dropPacket(), initialize(), matchesPacket(), and parseVector().

◆ generateFurtherDrops

bool inet::queueing::OrdinalBasedDropper::generateFurtherDrops

protected

Referenced by dropPacket(), initialize(), and matchesPacket().

◆ numDropped

unsigned int inet::queueing::OrdinalBasedDropper::numDropped

protected

Referenced by dropPacket(), and initialize().

◆ numPackets

unsigned int inet::queueing::OrdinalBasedDropper::numPackets

protected

Referenced by dropPacket(), initialize(), matchesPacket(), and processPacket().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ dropPacket()

◆ initialize()

◆ matchesPacket()

◆ parseVector()

◆ processPacket()

Member Data Documentation

◆ dropsVector

◆ generateFurtherDrops

◆ numDropped

◆ numPackets