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

#include <RMTQMonitorBase.h>

Inheritance diagram for RMTQMonitorBase:
DummyMonitor FWQ::WeightedFairQMonitor IterativeScheduling::IterativeMonitor IterativeScheduling::IterativeStopMonitor PortsLoadMonitor REDMonitor SmartMonitor BEMonitor::BEMonitor DLMonitor::DLMonitor DQMonitor::DQMonitor eDLMonitor::eDLMonitor ModularMonitor::ModularMonitor TKMonitor::TKMonitor

Public Member Functions

virtual void prePDUInsertion (RMTQueue *queue)
 
virtual void postPDUInsertion (RMTQueue *queue)
 
virtual void prePDURelease (RMTQueue *queue)
 
virtual void postPDURelease (RMTQueue *queue)
 
virtual void onMessageDrop (RMTQueue *queue, const cPacket *pdu)
 
virtual void postQueueCreation (RMTQueue *queue)
 
virtual void preQueueRemoval (RMTQueue *queue)
 

Protected Member Functions

virtual void onPolicyInit ()
 
virtual void handleMessage (cMessage *msg)
 

Protected Attributes

RMTModuleAllocator * rmtAllocator
 
RMTSchedulingBase * schedPolicy
 
AddressComparatorBase * addrComparator
 

Private Member Functions

virtual void initialize ()
 

Detailed Description

Noop base class for the RMT monitoring policy. This policy responds to various events happening inside RMT, usually by modifying values used by the scheduling policy.

Definition at line 42 of file RMTQMonitorBase.h.

Member Function Documentation

void RMTQMonitorBase::handleMessage ( cMessage *  msg)
protectedvirtual

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

Reimplemented in PortsLoadMonitor.

Definition at line 36 of file RMTQMonitorBase.cc.

void RMTQMonitorBase::initialize ( )
privatevirtual

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

Definition at line 27 of file RMTQMonitorBase.cc.

void RMTQMonitorBase::onMessageDrop ( RMTQueue *  queue,
const cPacket *  pdu 
)
virtual

A hook method invoked after a PDU gets dropped from a queue. Note: the PDU object is discarded after invocation of this method.

Parameters
queuepointer to the queue
pduPDU being dropped

Reimplemented in TKMonitor::TKMonitor, eDLMonitor::eDLMonitor, DLMonitor::DLMonitor, DQMonitor::DQMonitor, BEMonitor::BEMonitor, FWQ::WeightedFairQMonitor, and ModularMonitor::ModularMonitor.

Definition at line 60 of file RMTQMonitorBase.cc.

Referenced by RMT::postQueueArrival().

void RMTQMonitorBase::onPolicyInit ( )
protectedvirtual

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

Reimplemented in TKMonitor::TKMonitor, eDLMonitor::eDLMonitor, DLMonitor::DLMonitor, DQMonitor::DQMonitor, PortsLoadMonitor, BEMonitor::BEMonitor, IterativeScheduling::IterativeMonitor, IterativeScheduling::IterativeStopMonitor, FWQ::WeightedFairQMonitor, and ModularMonitor::ModularMonitor.

Definition at line 40 of file RMTQMonitorBase.cc.

Referenced by initialize().

void RMTQMonitorBase::postPDUInsertion ( RMTQueue *  queue)
virtual

A hook method invoked after a PDU arrives into a queue.

Parameters
queuepointer to the queue

Reimplemented in TKMonitor::TKMonitor, eDLMonitor::eDLMonitor, DLMonitor::DLMonitor, PortsLoadMonitor, DQMonitor::DQMonitor, BEMonitor::BEMonitor, IterativeScheduling::IterativeStopMonitor, FWQ::WeightedFairQMonitor, REDMonitor, DummyMonitor, and ModularMonitor::ModularMonitor.

Definition at line 48 of file RMTQMonitorBase.cc.

Referenced by RMT::postQueueArrival().

void RMTQMonitorBase::postPDURelease ( RMTQueue *  queue)
virtual

A hook method invoked after a PDU gets released from a queue & sent.

Parameters
queuepointer to the queue

Reimplemented in IterativeScheduling::IterativeStopMonitor, and FWQ::WeightedFairQMonitor.

Definition at line 56 of file RMTQMonitorBase.cc.

Referenced by RMT::postQueueDeparture().

void RMTQMonitorBase::postQueueCreation ( RMTQueue *  queue)
virtual

A hook method invoked after a queue is created.

Parameters
queuepointer to the queue

Reimplemented in TKMonitor::TKMonitor, eDLMonitor::eDLMonitor, DLMonitor::DLMonitor, DQMonitor::DQMonitor, IterativeScheduling::IterativeMonitor, IterativeScheduling::IterativeStopMonitor, FWQ::WeightedFairQMonitor, REDMonitor, and ModularMonitor::ModularMonitor.

Definition at line 64 of file RMTQMonitorBase.cc.

Referenced by RMTModuleAllocator::addQueue().

void RMTQMonitorBase::prePDUInsertion ( RMTQueue *  queue)
virtual

A hook method invoked after a PDU arrives into a queue.

Parameters
queuepointer to the queue

Definition at line 44 of file RMTQMonitorBase.cc.

Referenced by RMT::preQueueArrival().

void RMTQMonitorBase::prePDURelease ( RMTQueue *  queue)
virtual

A hook method invoked before a PDU gets released from a queue & sent.

Parameters
queuepointer to the queue

Reimplemented in PortsLoadMonitor, and ModularMonitor::ModularMonitor.

Definition at line 52 of file RMTQMonitorBase.cc.

Referenced by RMT::preQueueDeparture().

void RMTQMonitorBase::preQueueRemoval ( RMTQueue *  queue)
virtual

A hook method invoked before a queue is removed.

Parameters
queuepointer to the queue

Reimplemented in IterativeScheduling::IterativeMonitor, IterativeScheduling::IterativeStopMonitor, FWQ::WeightedFairQMonitor, and REDMonitor.

Definition at line 68 of file RMTQMonitorBase.cc.

Referenced by RMTModuleAllocator::removeQueue().

Member Data Documentation

AddressComparatorBase* RMTQMonitorBase::addrComparator
protected

Pointer to an address comparator module.

Definition at line 122 of file RMTQMonitorBase.h.

Referenced by initialize().

RMTModuleAllocator* RMTQMonitorBase::rmtAllocator
protected

Pointer to the RMT allocator module (also providing queue<->port mappings).

Definition at line 112 of file RMTQMonitorBase.h.

Referenced by initialize().

RMTSchedulingBase* RMTQMonitorBase::schedPolicy
protected

Pointer to a scheduling policy module.

Definition at line 117 of file RMTQMonitorBase.h.

Referenced by initialize().

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