inet::PassiveQueueBase Class Reference

Abstract base class for passive queues. More...

#include <PassiveQueueBase.h>

Inheritance diagram for inet::PassiveQueueBase:

Public Member Functions
virtual void	requestPacket () override
	The queue should send a packet whenever this method is invoked. More...
virtual int	getNumPendingRequests () override
	Returns number of pending requests. More...
virtual void	clear () override
	Clear all queued packets and stored requests. More...
virtual cMessage *	pop () override
	Return a packet from the queue directly. More...
virtual void	addListener (IPassiveQueueListener *listener) override
	Implementation of IPassiveQueue::addListener(). More...
virtual void	removeListener (IPassiveQueueListener *listener) override
	Implementation of IPassiveQueue::removeListener(). More...
Public Member Functions inherited from inet::IPassiveQueue
virtual	~IPassiveQueue ()
virtual bool	isEmpty ()=0
	Return true when queue is empty, otherwise return false. More...

Static Public Attributes
static simsignal_t	rcvdPkSignal = registerSignal("rcvdPk")
	Signal with packet when received it. More...
static simsignal_t	enqueuePkSignal = registerSignal("enqueuePk")
	Signal with packet when enqueued it. More...
static simsignal_t	dequeuePkSignal = registerSignal("dequeuePk")
	Signal with packet when sent out it. More...
static simsignal_t	dropPkByQueueSignal = registerSignal("dropPkByQueue")
	Signal with packet when dropped it. More...
static simsignal_t	queueingTimeSignal = registerSignal("queueingTime")
	Signal with value of delaying time when sent out a packet. More...

Protected Member Functions
virtual void	initialize () override
virtual void	handleMessage (cMessage *msg) override
virtual void	finish () override
virtual void	refreshDisplay () const override
virtual void	notifyListeners ()
virtual cMessage *	enqueue (cMessage *msg)=0
	Inserts packet into the queue or the priority queue, or drops it (or another packet). More...
virtual cMessage *	dequeue ()=0
	Returns a packet from the queue, or nullptr if the queue is empty. More...
virtual void	sendOut (cMessage *msg)=0
	Should be redefined to send out the packet; e.g. More...

Protected Attributes
std::list< IPassiveQueueListener * >	listeners
int	packetRequested
int	numQueueReceived
int	numQueueDropped

Detailed Description

Abstract base class for passive queues.

Implements IPassiveQueue. Enqueue/dequeue have to be implemented in virtual functions in subclasses; the actual queue or piority queue data structure also goes into subclasses.

Member Function Documentation

void inet::PassiveQueueBase::addListener ( IPassiveQueueListener *  listener )

overridevirtual

Implementation of IPassiveQueue::addListener().

Implements inet::IPassiveQueue.

{
    auto it = find(listeners.begin(), listeners.end(), listener);
    if (it == listeners.end())
        listeners.push_back(listener);
}

void inet::PassiveQueueBase::clear ( )

overridevirtual

Clear all queued packets and stored requests.

Implements inet::IPassiveQueue.

{
    cMessage *msg;

    while (nullptr != (msg = dequeue()))
        delete msg;

    packetRequested = 0;
}

virtual cMessage* inet::PassiveQueueBase::dequeue ( )

protectedpure virtual

Returns a packet from the queue, or nullptr if the queue is empty.

Implemented in inet::DropTailQueue, and inet::FIFOQueue.

Referenced by clear(), pop(), and requestPacket().

virtual cMessage* inet::PassiveQueueBase::enqueue ( cMessage *  msg )

protectedpure virtual

Inserts packet into the queue or the priority queue, or drops it (or another packet).

Returns nullptr if successful, or the pointer of the dropped packet.

Implemented in inet::DropTailQueue, and inet::FIFOQueue.

Referenced by handleMessage().

void inet::PassiveQueueBase::finish ( )

overrideprotectedvirtual

{
}

virtual int inet::PassiveQueueBase::getNumPendingRequests ( )

inlineoverridevirtual

Returns number of pending requests.

Implements inet::IPassiveQueue.

{ return packetRequested; }

void inet::PassiveQueueBase::handleMessage ( cMessage *  msg )

overrideprotectedvirtual

{
    numQueueReceived++;

    emit(rcvdPkSignal, msg);

    if (packetRequested > 0) {
        packetRequested--;
        emit(enqueuePkSignal, msg);
        emit(dequeuePkSignal, msg);
        emit(queueingTimeSignal, SIMTIME_ZERO);
        sendOut(msg);
    }
    else {
        msg->setArrivalTime(simTime());
        cMessage *droppedMsg = enqueue(msg);
        if (msg != droppedMsg)
            emit(enqueuePkSignal, msg);

        if (droppedMsg) {
            numQueueDropped++;
            emit(dropPkByQueueSignal, droppedMsg);
            delete droppedMsg;
        }
        else
            notifyListeners();
    }
}

void inet::PassiveQueueBase::initialize ( )

overrideprotectedvirtual

Reimplemented in inet::FIFOQueue, and inet::DropTailQueue.

Referenced by inet::DropTailQueue::initialize(), and inet::FIFOQueue::initialize().

{
    // state
    packetRequested = 0;
    WATCH(packetRequested);

    // statistics
    numQueueReceived = 0;
    numQueueDropped = 0;
    WATCH(numQueueReceived);
    WATCH(numQueueDropped);
}

void inet::PassiveQueueBase::notifyListeners ( )

protectedvirtual

Referenced by handleMessage().

{
    for (auto & elem : listeners)
        (elem)->packetEnqueued(this);
}

cMessage * inet::PassiveQueueBase::pop ( )

overridevirtual

Return a packet from the queue directly.

Implements inet::IPassiveQueue.

{
    return dequeue();
}

void inet::PassiveQueueBase::refreshDisplay ( ) const

overrideprotectedvirtual

{
    char buf[100];
    sprintf(buf, "q rcvd: %d\nq dropped: %d", numQueueReceived, numQueueDropped);
    getDisplayString().setTagArg("t", 0, buf);
}

void inet::PassiveQueueBase::removeListener ( IPassiveQueueListener *  listener )

overridevirtual

Implementation of IPassiveQueue::removeListener().

Implements inet::IPassiveQueue.

{
    auto it = find(listeners.begin(), listeners.end(), listener);
    if (it != listeners.end())
        listeners.erase(it);
}

void inet::PassiveQueueBase::requestPacket ( )

overridevirtual

The queue should send a packet whenever this method is invoked.

If the queue is currently empty, it should send a packet when when one becomes available.

Implements inet::IPassiveQueue.

{
    Enter_Method("requestPacket()");

    cMessage *msg = dequeue();
    if (msg == nullptr) {
        packetRequested++;
    }
    else {
        emit(dequeuePkSignal, msg);
        emit(queueingTimeSignal, simTime() - msg->getArrivalTime());
        sendOut(msg);
    }
}

virtual void inet::PassiveQueueBase::sendOut ( cMessage *  msg )

protectedpure virtual

Should be redefined to send out the packet; e.g.

send(msg,"out").

Implemented in inet::DropTailQueue, and inet::FIFOQueue.

Referenced by handleMessage(), and requestPacket().

Member Data Documentation

simsignal_t inet::PassiveQueueBase::dequeuePkSignal = registerSignal("dequeuePk")

static

Signal with packet when sent out it.

Referenced by handleMessage(), and requestPacket().

simsignal_t inet::PassiveQueueBase::dropPkByQueueSignal = registerSignal("dropPkByQueue")

static

Signal with packet when dropped it.

Referenced by handleMessage(), inet::visualizer::PacketDropVisualizerBase::receiveSignal(), inet::visualizer::PacketDropVisualizerBase::subscribe(), and inet::visualizer::PacketDropVisualizerBase::unsubscribe().

simsignal_t inet::PassiveQueueBase::enqueuePkSignal = registerSignal("enqueuePk")

static

Signal with packet when enqueued it.

Referenced by handleMessage().

std::list<IPassiveQueueListener *> inet::PassiveQueueBase::listeners

protected

Referenced by addListener(), notifyListeners(), and removeListener().

int inet::PassiveQueueBase::numQueueDropped

protected

Referenced by handleMessage(), initialize(), and refreshDisplay().

int inet::PassiveQueueBase::numQueueReceived

protected

Referenced by handleMessage(), initialize(), and refreshDisplay().

int inet::PassiveQueueBase::packetRequested

protected

Referenced by clear(), handleMessage(), initialize(), and requestPacket().

simsignal_t inet::PassiveQueueBase::queueingTimeSignal = registerSignal("queueingTime")

static

Signal with value of delaying time when sent out a packet.

Referenced by handleMessage(), and requestPacket().

simsignal_t inet::PassiveQueueBase::rcvdPkSignal = registerSignal("rcvdPk")

static

Signal with packet when received it.

Referenced by handleMessage().

---

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

• PassiveQueueBase.h
• PassiveQueueBase.cc