INET Framework for OMNeT++/OMNEST
QueueWithQoS Class Reference

#include <QueueWithQoS.h>

Inheritance diagram for QueueWithQoS:
AbstractQueue

List of all members.

Public Member Functions

 QueueWithQoS ()

Protected Member Functions

virtual void initialize ()
virtual void arrival (cPacket *msg)
virtual cPacket * arrivalWhenIdle (cPacket *msg)
virtual simtime_t startService (cPacket *msg)

Protected Attributes

simtime_t delay
EnqueueHookqosHook

Detailed Description

Queue with constant processing time, with integrated QoS behaviour. Processing time is taken from the "procDelay" module parameter, and QoS class from the "qosBehaviourClass" module parameter.

Leaves the endService(cMessage *msg) method of AbstractQueue undefined.


Constructor & Destructor Documentation

QueueWithQoS::QueueWithQoS ( ) [inline]
{}

Member Function Documentation

void QueueWithQoS::arrival ( cPacket *  msg) [protected, virtual]

Functions to (re)define behaviour Called when a message arrives at the module. The method should either enqueue this message (usual behaviour), or discard it. It may also wrap the it into another message, and insert that one in the queue.

Most straightforward implementation: queue.insert(msg);

Implements AbstractQueue.

{
    qosHook->enqueue(msg, queue);
}
cPacket * QueueWithQoS::arrivalWhenIdle ( cPacket *  msg) [protected, virtual]

Called when a message arrives at the module when the queue is empty. The message doesn't need to be enqueued in this case, it can start service immmediately. This method may:

  1. simply return the the same pointer (usual behaviour), or
  2. discard the message and return NULL pointer (the effect being this message being ignored)
  3. or modify the message, wrap in into another message etc, and return the (new) message's pointer.

Most straightforward implementation: return msg;

Implements AbstractQueue.

{
    return PK(qosHook->dropIfNotNeeded(msg));
}
void QueueWithQoS::initialize ( ) [protected, virtual]

Reimplemented from AbstractQueue.

{
    AbstractQueue::initialize();

    delay = par("procDelay");
    qosHook = check_and_cast<EnqueueHook *>(createOne(par("qosBehaviorClass")));
    qosHook->setModule(this);
}
simtime_t QueueWithQoS::startService ( cPacket *  msg) [protected, virtual]

Called when a message starts service, and should return the service time.

Example implementation: return 1.0;

Implements AbstractQueue.

{
    return delay;
}

Member Data Documentation

simtime_t QueueWithQoS::delay [protected]

Referenced by initialize(), and startService().


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