inet::ieee80211::AarfRateControl Class Reference

Implements the ARF and AARF rate control algorithms. More...

#include <AarfRateControl.h>

Inheritance diagram for inet::ieee80211::AarfRateControl:

Public Member Functions
virtual const physicallayer::IIeee80211Mode *	getRate () override
virtual void	frameTransmitted (Packet *frame, int retryCount, bool isSuccessful, bool isGivenUp) override
virtual void	frameReceived (Packet *frame) override
Public Member Functions inherited from inet::ieee80211::IRateControl
virtual	~IRateControl ()

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	handleMessage (cMessage *msg) override
virtual void	multiplyIncreaseThreshold (double factor)
virtual void	resetIncreaseThreshdold ()
virtual void	resetTimer ()
virtual void	increaseRateIfTimerIsExpired ()
virtual void	updateDisplayString () const
Protected Member Functions inherited from inet::ieee80211::RateControlBase
virtual void	receiveSignal (cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override
virtual void	emitDatarateChangedSignal ()
const physicallayer::IIeee80211Mode *	increaseRateIfPossible (const physicallayer::IIeee80211Mode *currentMode)
const physicallayer::IIeee80211Mode *	decreaseRateIfPossible (const physicallayer::IIeee80211Mode *currentMode)

Protected Attributes
simtime_t	timer = SIMTIME_ZERO
simtime_t	interval = SIMTIME_ZERO
bool	probing = false
int	increaseThreshold = -1
int	maxIncreaseThreshold = -1
int	decreaseThreshold = -1
double	factor = -1
int	numberOfConsSuccTransmissions = 0
Protected Attributes inherited from inet::ieee80211::RateControlBase
const physicallayer::IIeee80211Mode *	currentMode = nullptr
Protected Attributes inherited from inet::ieee80211::ModeSetListener
physicallayer::Ieee80211ModeSet *	modeSet = nullptr

Additional Inherited Members
Static Public Attributes inherited from inet::ieee80211::RateControlBase
static simsignal_t	datarateChangedSignal = cComponent::registerSignal("datarateChanged")

Detailed Description

Implements the ARF and AARF rate control algorithms.

Member Function Documentation

frameReceived()

void inet::ieee80211::AarfRateControl::frameReceived ( Packet *  frame )

overridevirtual

Implements inet::ieee80211::IRateControl.

{
}

frameTransmitted()

void inet::ieee80211::AarfRateControl::frameTransmitted ( Packet *  frame, int  retryCount, bool  isSuccessful, bool  isGivenUp  )

overridevirtual

Implements inet::ieee80211::IRateControl.

{
    increaseRateIfTimerIsExpired();
 
    if (!isSuccessful && probing) { // probing packet failed
        numberOfConsSuccTransmissions = 0;
        currentMode = decreaseRateIfPossible(currentMode);
        emitDatarateChangedSignal();
        updateDisplayString();
        EV_DETAIL << "Decreased rate to " << *currentMode << endl;
        multiplyIncreaseThreshold(factor);
        resetTimer();
    }
    else if (!isSuccessful && retryCount >= decreaseThreshold - 1) { // decreaseThreshold consecutive failed transmissions
        numberOfConsSuccTransmissions = 0;
        currentMode = decreaseRateIfPossible(currentMode);
        emitDatarateChangedSignal();
        updateDisplayString();
        EV_DETAIL << "Decreased rate to " << *currentMode << endl;
        resetIncreaseThreshdold();
        resetTimer();
    }
    else if (isSuccessful && retryCount == 0)
        numberOfConsSuccTransmissions++;
 
    if (numberOfConsSuccTransmissions == increaseThreshold) {
        numberOfConsSuccTransmissions = 0;
        currentMode = increaseRateIfPossible(currentMode);
        emitDatarateChangedSignal();
        updateDisplayString();
        EV_DETAIL << "Increased rate to " << *currentMode << endl;
        resetTimer();
        probing = true;
    }
    else
        probing = false;
 
}

getRate()

const IIeee80211Mode * inet::ieee80211::AarfRateControl::getRate ( )

overridevirtual

Implements inet::ieee80211::IRateControl.

{
    Enter_Method("getRate");
    increaseRateIfTimerIsExpired();
    EV_INFO << "The current mode is " << currentMode << " the net bitrate is " << currentMode->getDataMode()->getNetBitrate() << std::endl;
    return currentMode;
}

handleMessage()

void inet::ieee80211::AarfRateControl::handleMessage ( cMessage *  msg )

overrideprotectedvirtual

{
    throw cRuntimeError("This module doesn't handle self messages");
}

increaseRateIfTimerIsExpired()

void inet::ieee80211::AarfRateControl::increaseRateIfTimerIsExpired ( )

protectedvirtual

{
    if (simTime() - timer >= interval) {
        currentMode = increaseRateIfPossible(currentMode);
        emitDatarateChangedSignal();
        updateDisplayString();
        EV_DETAIL << "Increased rate to " << *currentMode << endl;
        resetTimer();
    }
}

initialize()

void inet::ieee80211::AarfRateControl::initialize ( int  stage )

overrideprotectedvirtual

Reimplemented from inet::ieee80211::RateControlBase.

{
    RateControlBase::initialize(stage);
    if (stage == INITSTAGE_LOCAL) {
        factor = par("increaseThresholdFactor");
        increaseThreshold = par("increaseThreshold");
        maxIncreaseThreshold = par("maxIncreaseThreshold");
        decreaseThreshold = par("decreaseThreshold");
        interval = par("interval");
        WATCH(factor);
        WATCH(increaseThreshold);
        WATCH(maxIncreaseThreshold);
        WATCH(decreaseThreshold);
        WATCH(interval);
        WATCH(probing);
        WATCH(numberOfConsSuccTransmissions);
    }
    else if (stage == INITSTAGE_LINK_LAYER) {
        updateDisplayString();
    }
}

multiplyIncreaseThreshold()

void inet::ieee80211::AarfRateControl::multiplyIncreaseThreshold ( double  factor )

protectedvirtual

{
    if (increaseThreshold * factor <= maxIncreaseThreshold)
        increaseThreshold *= factor;
}

numInitStages()

virtual int inet::ieee80211::AarfRateControl::numInitStages ( ) const

inlineoverrideprotectedvirtual

Reimplemented from inet::ieee80211::RateControlBase.

{ return NUM_INIT_STAGES; }

resetIncreaseThreshdold()

void inet::ieee80211::AarfRateControl::resetIncreaseThreshdold ( )

protectedvirtual

{
    increaseThreshold = par("increaseThreshold");
}

resetTimer()

void inet::ieee80211::AarfRateControl::resetTimer ( )

protectedvirtual

{
    timer = simTime();
}

updateDisplayString()

void inet::ieee80211::AarfRateControl::updateDisplayString ( ) const

protectedvirtual

{
    getDisplayString().setTagArg("t", 0, currentMode->getName());
}

Member Data Documentation

decreaseThreshold

int inet::ieee80211::AarfRateControl::decreaseThreshold = -1

protected

factor

double inet::ieee80211::AarfRateControl::factor = -1

protected

increaseThreshold

int inet::ieee80211::AarfRateControl::increaseThreshold = -1

protected

interval

simtime_t inet::ieee80211::AarfRateControl::interval = SIMTIME_ZERO

protected

maxIncreaseThreshold

int inet::ieee80211::AarfRateControl::maxIncreaseThreshold = -1

protected

numberOfConsSuccTransmissions

int inet::ieee80211::AarfRateControl::numberOfConsSuccTransmissions = 0

protected

probing

bool inet::ieee80211::AarfRateControl::probing = false

protected

timer

simtime_t inet::ieee80211::AarfRateControl::timer = SIMTIME_ZERO

protected

---

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

• AarfRateControl.h
• AarfRateControl.cc