RINASim  October 2016
Documentation of framework for OMNeT++
Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
QueueAllocBase Class Reference

#include <QueueAllocBase.h>

Inheritance diagram for QueueAllocBase:
QueuePerNCU QueuePerNFlow QueuePerNQoS QueuePerNQoSxPLen SingleQueue

Public Member Functions

virtual void onPolicyInit ()
 
virtual void onNM1PortInit (RMTPort *port)
 
virtual void onNFlowAlloc (RMTPort *port, Flow *flow)
 
virtual void onNFlowDealloc (RMTPort *port, Flow *flow)
 

Protected Member Functions

void handleMessage (cMessage *msg)
 

Protected Attributes

QueueIDGenBase * idGenerator
 
RMTModuleAllocator * rmtAllocator
 
RABase * ra
 

Private Member Functions

void initialize ()
 

Detailed Description

Noop base class for the RA queue allocation policy The policy manages allocation and deallocation of RMT queues via hook methods.

Definition at line 37 of file QueueAllocBase.h.

Member Function Documentation

void QueueAllocBase::handleMessage ( cMessage *  msg)
protected

Handler for OMNeT++ module messages (probably not of much use here).

Parameters
msgmessage

Definition at line 38 of file QueueAllocBase.cc.

void QueueAllocBase::initialize ( )
private

Module initialization routine setting up some parameters for GUI. Inherited policies should be using onPolicyInit() instead.

Definition at line 27 of file QueueAllocBase.cc.

void QueueAllocBase::onNFlowAlloc ( RMTPort *  port,
Flow *  flow 
)
virtual

A hook method invoked when a new (N)-flow is established.

Parameters
flow(N)-flow object
portpointer to a port of the (N-1)-flow used by the flow's PDUs

Reimplemented in QueuePerNFlow.

Definition at line 50 of file QueueAllocBase.cc.

Referenced by RA::postNFlowAllocation().

void QueueAllocBase::onNFlowDealloc ( RMTPort *  port,
Flow *  flow 
)
virtual

A hook method invoked when an (N)-flow is deallocated.

Parameters
flow(N)-flow object
portpointer to a port of the (N-1)-flow used by the flow's PDUs

Definition at line 54 of file QueueAllocBase.cc.

void QueueAllocBase::onNM1PortInit ( RMTPort *  port)
virtual

A hook method invoked when a new (N-1)-port is initiated.

Parameters
portpointer to the port

Reimplemented in QueuePerNCU, QueuePerNFlow, QueuePerNQoS, SingleQueue, and QueuePerNQoSxPLen.

Definition at line 46 of file QueueAllocBase.cc.

Referenced by RA::bindMediumToRMT(), and RA::bindNM1FlowToRMT().

void QueueAllocBase::onPolicyInit ( )
virtual

A hook method invoked after the initial setup of policy module.

Reimplemented in QueuePerNCU, and QueuePerNQoSxPLen.

Definition at line 42 of file QueueAllocBase.cc.

Referenced by initialize().

Member Data Documentation

QueueIDGenBase* QueueAllocBase::idGenerator
protected

Pointer to a policy module used for generating queue IDs from flow and message objects.

Definition at line 81 of file QueueAllocBase.h.

Referenced by initialize(), and QueuePerNFlow::onNFlowAlloc().

RABase* QueueAllocBase::ra
protected

Pointer to the Resource Allocator module.

Definition at line 91 of file QueueAllocBase.h.

Referenced by initialize(), and QueuePerNQoS::onNM1PortInit().

RMTModuleAllocator* QueueAllocBase::rmtAllocator
protected

Pointer to a module providing API for (de)allocation of ports and queues.

Definition at line 86 of file QueueAllocBase.h.

Referenced by initialize(), QueuePerNFlow::onNFlowAlloc(), QueuePerNQoS::onNM1PortInit(), SingleQueue::onNM1PortInit(), QueuePerNFlow::onNM1PortInit(), and QueuePerNCU::onNM1PortInit().

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