#include <AggregatorBase.h>

Inheritance diagram for inet::AggregatorBase:

Public Member Functions
virtual	~AggregatorBase ()

virtual void	pushPacket (Packet packet, cGate gate) override
	Pushes the packet into the packet sink at the given gate. More...

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

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

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

Protected Member Functions
virtual void	initialize (int stage) override

virtual IAggregatorPolicy *	createAggregatorPolicy (const char *aggregatorPolicyClass) const

virtual bool	isAggregating ()

virtual void	startAggregation (Packet *packet)

virtual void	continueAggregation (Packet *packet)

virtual void	endAggregation (Packet *packet)

Protected Member Functions inherited from inet::queueing::PacketPusherBase
virtual void	handleMessage (cMessage *message) 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
bool	deleteSelf = false

IAggregatorPolicy *	aggregatorPolicy = nullptr

std::vector< Packet * >	aggregatedSubpackets

Packet *	aggregatedPacket = nullptr

Protected Attributes inherited from inet::queueing::PacketPusherBase
cGate *	inputGate = nullptr

IActivePacketSource *	producer = nullptr

cGate *	outputGate = nullptr

IPassivePacketSink *	consumer = 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

◆ ~AggregatorBase()

virtual inet::AggregatorBase::~AggregatorBase ( )

inlinevirtual

38 { delete aggregatedPacket; }

Member Function Documentation

◆ continueAggregation()

void inet::AggregatorBase::continueAggregation ( Packet * packet )

protectedvirtual

Reimplemented in inet::SubpacketLengthHeaderBasedAggregator.

 {
     std::string aggregatedName = aggregatedPacket->getName();
     if (aggregatedName.length() != 0)
         aggregatedName += "+";
     aggregatedName += packet->getName();
     aggregatedPacket->setName(aggregatedName.c_str());
     aggregatedSubpackets.push_back(packet);
     numProcessedPackets++;
     processedTotalLength += packet->getDataLength();
 }

Referenced by inet::SubpacketLengthHeaderBasedAggregator::continueAggregation(), and pushPacket().

◆ createAggregatorPolicy()

IAggregatorPolicy * inet::AggregatorBase::createAggregatorPolicy ( const char * aggregatorPolicyClass ) const

protectedvirtual

 {
     return check_and_cast<IAggregatorPolicy *>(createOne(aggregatorPolicyClass));
 }

Referenced by initialize().

◆ endAggregation()

void inet::AggregatorBase::endAggregation ( Packet * packet )

protectedvirtual

 {
     aggregatedSubpackets.clear();
     aggregatedPacket = nullptr;
     if (deleteSelf)
         deleteModule();
 }

Referenced by pushPacket().

◆ initialize()

void inet::AggregatorBase::initialize ( int stage )

overrideprotectedvirtual

Reimplemented from inet::queueing::PacketPusherBase.

 {
     PacketPusherBase::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         deleteSelf = par("deleteSelf");
         const char *aggregatorPolicyClass = par("aggregatorPolicyClass");
         if (*aggregatorPolicyClass != '\0')
             aggregatorPolicy = createAggregatorPolicy(aggregatorPolicyClass);
         else
             aggregatorPolicy = findModuleFromPar<IAggregatorPolicy>(par("aggregatorPolicyModule"), this);
     }
 }

◆ isAggregating()

virtual bool inet::AggregatorBase::isAggregating ( )

inlineprotectedvirtual

32 { return aggregatedPacket != nullptr; }

Referenced by pushPacket().

◆ pushPacket()

void inet::AggregatorBase::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.

Reimplemented from inet::queueing::PacketPusherBase.

 {
     Enter_Method("pushPacket");
     take(subpacket);
     if (!isAggregating())
         startAggregation(subpacket);
     else if (!aggregatorPolicy->isAggregatablePacket(aggregatedPacket, aggregatedSubpackets, subpacket)) {
         pushOrSendPacket(aggregatedPacket, outputGate, consumer);
         endAggregation(subpacket);
         startAggregation(subpacket);
     }
     continueAggregation(subpacket);
     EV_INFO << "Aggregating packet" << EV_FIELD(subpacket) << EV_FIELD(packet, *aggregatedPacket) << EV_ENDL;
     delete subpacket;
     updateDisplayString();
 }

◆ startAggregation()

void inet::AggregatorBase::startAggregation ( Packet * packet )

protectedvirtual

 {
     ASSERT(aggregatedPacket == nullptr);
     ASSERT(aggregatedSubpackets.size() == 0);
     aggregatedPacket = new Packet("");
     aggregatedPacket->copyTags(*packet); // TODO more complicated?
 }

Referenced by pushPacket().

Member Data Documentation

◆ aggregatedPacket

Packet* inet::AggregatorBase::aggregatedPacket = nullptr

protected

Referenced by inet::SubpacketLengthHeaderBasedAggregator::continueAggregation(), continueAggregation(), endAggregation(), pushPacket(), and startAggregation().

◆ aggregatedSubpackets

std::vector<Packet *> inet::AggregatorBase::aggregatedSubpackets

protected

Referenced by continueAggregation(), endAggregation(), pushPacket(), and startAggregation().

◆ aggregatorPolicy

IAggregatorPolicy* inet::AggregatorBase::aggregatorPolicy = nullptr

protected

Referenced by initialize(), and pushPacket().

◆ deleteSelf

bool inet::AggregatorBase::deleteSelf = false

protected

Referenced by endAggregation(), and initialize().

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

◆ ~AggregatorBase()

Member Function Documentation

◆ continueAggregation()

◆ createAggregatorPolicy()

◆ endAggregation()

◆ initialize()

◆ isAggregating()

◆ pushPacket()

◆ startAggregation()

Member Data Documentation

◆ aggregatedPacket

◆ aggregatedSubpackets

◆ aggregatorPolicy

◆ deleteSelf