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

#include <RMTMaxQBase.h>

Inheritance diagram for RMTMaxQBase:
DumbMaxQ ECNMarker ECNMarkerLG ReadRateReducer REDDropper REDUpstreamNotifier TailDrop UpstreamNotifier

Public Member Functions

virtual bool run (RMTQueue *queue)
 
virtual void onQueueLengthDrop (RMTQueue *queue)
 

Protected Member Functions

virtual void onPolicyInit ()
 
virtual void handleMessage (cMessage *msg)
 
void notifySenderOfCongestion (const cPacket *pdu)
 

Protected Attributes

RMTQMonitorBase * qMonPolicy
 
AddressComparatorBase * addrComparator
 
RMTModuleAllocator * rmtAllocator
 

Private Member Functions

void initialize ()
 

Private Attributes

simsignal_t sigRMTSDReq
 

Detailed Description

Noop base class for the RMT max queue policy. This policy decides what to do when a queue is overflowing its threshold.

Definition at line 39 of file RMTMaxQBase.h.

Member Function Documentation

void RMTMaxQBase::handleMessage ( cMessage *  msg)
protectedvirtual

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

Definition at line 47 of file RMTMaxQBase.cc.

void RMTMaxQBase::initialize ( )
private

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

Definition at line 28 of file RMTMaxQBase.cc.

void RMTMaxQBase::notifySenderOfCongestion ( const cPacket *  pdu)
protected

Send CDAP congestion notification to the PDU sender via RIBd.

Parameters
pdupointer to PDU

Definition at line 61 of file RMTMaxQBase.cc.

Referenced by REDUpstreamNotifier::run(), and UpstreamNotifier::run().

void RMTMaxQBase::onPolicyInit ( )
protectedvirtual

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

Reimplemented in ReadRateReducer, REDDropper, DumbMaxQ, ECNMarkerLG, UpstreamNotifier, and REDUpstreamNotifier.

Definition at line 43 of file RMTMaxQBase.cc.

Referenced by initialize().

void RMTMaxQBase::onQueueLengthDrop ( RMTQueue *  queue)
virtual

A hook method invoked when a queue length drops back under its threshold.

Parameters
queuepointer to the queue

Reimplemented in ReadRateReducer.

Definition at line 57 of file RMTMaxQBase.cc.

Referenced by RMT::postQueueDeparture().

bool RMTMaxQBase::run ( RMTQueue *  queue)
virtual

A hook method invoked when a queue length is greater or equal to its threshold. Makes a decision about whether to drop the arrived PDU.

Parameters
queuepointer to the queue
Returns
true if the PDU should be dropped, false otherwise

Reimplemented in DumbMaxQ, ECNMarkerLG, REDDropper, ReadRateReducer, TailDrop, ECNMarker, UpstreamNotifier, and REDUpstreamNotifier.

Definition at line 52 of file RMTMaxQBase.cc.

Referenced by RMT::postQueueArrival().

Member Data Documentation

AddressComparatorBase* RMTMaxQBase::addrComparator
protected

Pointer to an address comparator module.

Definition at line 85 of file RMTMaxQBase.h.

Referenced by initialize().

RMTQMonitorBase* RMTMaxQBase::qMonPolicy
protected

Pointer to the monitoring policy module.

Definition at line 80 of file RMTMaxQBase.h.

Referenced by initialize(), DumbMaxQ::onPolicyInit(), and REDDropper::onPolicyInit().

RMTModuleAllocator* RMTMaxQBase::rmtAllocator
protected

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

Definition at line 90 of file RMTMaxQBase.h.

Referenced by initialize().

simsignal_t RMTMaxQBase::sigRMTSDReq
private

Congestion notifier.

Definition at line 103 of file RMTMaxQBase.h.

Referenced by initialize(), and notifySenderOfCongestion().

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