inet::ieee80211::NonQoSRecoveryProcedure Class Reference

#include <NonQoSRecoveryProcedure.h>

Inheritance diagram for inet::ieee80211::NonQoSRecoveryProcedure:

Public Member Functions
virtual void	multicastFrameTransmitted (StationRetryCounters *stationCounters)
virtual void	ctsFrameReceived (StationRetryCounters *stationCounters)
virtual void	ackFrameReceived (Ieee80211DataOrMgmtFrame *ackedFrame, StationRetryCounters *stationCounters)
virtual void	rtsFrameTransmissionFailed (Ieee80211DataOrMgmtFrame *protectedFrame, StationRetryCounters *stationCounters)
virtual void	dataOrMgmtFrameTransmissionFailed (Ieee80211DataOrMgmtFrame *failedFrame, StationRetryCounters *stationCounters)
virtual int	getRetryCount (Ieee80211DataOrMgmtFrame *frame)
virtual int	getShortRetryCount (Ieee80211DataOrMgmtFrame *frame)
virtual int	getLongRetryCount (Ieee80211DataOrMgmtFrame *frame)
virtual bool	isRetryLimitReached (Ieee80211DataOrMgmtFrame *failedFrame)
virtual bool	isRtsFrameRetryLimitReached (Ieee80211DataOrMgmtFrame *protectedFrame)
virtual void	retryLimitReached (Ieee80211DataOrMgmtFrame *frame)
virtual int	getLongRetryLimit ()
virtual int	getShortRetryLimit ()
Public Member Functions inherited from inet::ieee80211::IRecoveryProcedure
virtual	~IRecoveryProcedure ()

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	incrementCounter (Ieee80211DataOrMgmtFrame *frame, std::map< SequenceControlField, int > &retryCounter)
virtual void	resetContentionWindow ()
virtual int	getRc (Ieee80211DataOrMgmtFrame *frame, std::map< SequenceControlField, int > &retryCounter)
virtual bool	isMulticastFrame (Ieee80211Frame *frame)
virtual void	incrementStationSrc (StationRetryCounters *stationCounters)
virtual void	incrementStationLrc (StationRetryCounters *stationCounters)

Protected Attributes
ICwCalculator *	cwCalculator = nullptr
std::map< SequenceControlField, int >	shortRetryCounter
std::map< SequenceControlField, int >	longRetryCounter
int	shortRetryLimit = -1
int	longRetryLimit = -1
int	rtsThreshold = -1

Member Function Documentation

void inet::ieee80211::NonQoSRecoveryProcedure::ackFrameReceived ( Ieee80211DataOrMgmtFrame *  ackedFrame, StationRetryCounters *  stationCounters  )

virtual

Referenced by inet::ieee80211::Hcf::originatorProcessReceivedControlFrame(), and inet::ieee80211::Dcf::originatorProcessReceivedFrame().

{
    auto id = SequenceControlField(ackedFrame->getSequenceNumber(), ackedFrame->getFragmentNumber());
    if (ackedFrame->getByteLength() >= rtsThreshold) {
        stationCounters->resetStationLongRetryCount();
        auto it = longRetryCounter.find(id);
        if (it != longRetryCounter.end())
            longRetryCounter.erase(it);
    }
    else {
        stationCounters->resetStationShortRetryCount();
        auto it = shortRetryCounter.find(id);
        if (it != shortRetryCounter.end())
            shortRetryCounter.erase(it);
    }

//
// The CW shall be reset to aCWmin after every successful attempt to transmit a frame containing
// all or part of an MSDU or MMPDU
//
    resetContentionWindow();
}

void inet::ieee80211::NonQoSRecoveryProcedure::ctsFrameReceived ( StationRetryCounters *  stationCounters )

virtual

Referenced by inet::ieee80211::Dcf::originatorProcessReceivedFrame().

{
    stationCounters->resetStationShortRetryCount();
}

void inet::ieee80211::NonQoSRecoveryProcedure::dataOrMgmtFrameTransmissionFailed ( Ieee80211DataOrMgmtFrame *  failedFrame, StationRetryCounters *  stationCounters  )

virtual

Referenced by inet::ieee80211::Hcf::handleInternalCollision(), inet::ieee80211::Dcf::originatorProcessFailedFrame(), and inet::ieee80211::Hcf::originatorProcessFailedFrame().

{
    if (failedFrame->getByteLength() >= rtsThreshold) {
        incrementStationLrc(stationCounters);
        incrementCounter(failedFrame, longRetryCounter);
    }
    else {
        incrementStationSrc(stationCounters);
        incrementCounter(failedFrame, shortRetryCounter);
    }
}

int inet::ieee80211::NonQoSRecoveryProcedure::getLongRetryCount ( Ieee80211DataOrMgmtFrame *  frame )

virtual

Referenced by inet::ieee80211::Dcf::originatorProcessRtsProtectionFailed(), and inet::ieee80211::Dcf::originatorProcessTransmittedFrame().

{
    return getRc(frame, longRetryCounter);
}

virtual int inet::ieee80211::NonQoSRecoveryProcedure::getLongRetryLimit ( )

inlinevirtual

{ return longRetryLimit; }

int inet::ieee80211::NonQoSRecoveryProcedure::getRc ( Ieee80211DataOrMgmtFrame *  frame, std::map< SequenceControlField, int > &  retryCounter  )

protectedvirtual

Referenced by getLongRetryCount(), getRetryCount(), getShortRetryCount(), isRetryLimitReached(), and isRtsFrameRetryLimitReached().

{
    auto count = retryCounter.find(SequenceControlField(frame->getSequenceNumber(), frame->getFragmentNumber()));
    if (count != retryCounter.end())
        return count->second;
    else
        return 0;
}

int inet::ieee80211::NonQoSRecoveryProcedure::getRetryCount ( Ieee80211DataOrMgmtFrame *  frame )

virtual

Referenced by inet::ieee80211::Dcf::originatorProcessFailedFrame(), inet::ieee80211::Hcf::originatorProcessFailedFrame(), inet::ieee80211::Hcf::originatorProcessReceivedControlFrame(), and inet::ieee80211::Dcf::originatorProcessReceivedFrame().

{
    if (frame->getByteLength() >= rtsThreshold)
        return getRc(frame, longRetryCounter);
    else
        return getRc(frame, shortRetryCounter);
}

int inet::ieee80211::NonQoSRecoveryProcedure::getShortRetryCount ( Ieee80211DataOrMgmtFrame *  frame )

virtual

Referenced by inet::ieee80211::Dcf::originatorProcessRtsProtectionFailed(), and inet::ieee80211::Dcf::originatorProcessTransmittedFrame().

{
    return getRc(frame, shortRetryCounter);
}

virtual int inet::ieee80211::NonQoSRecoveryProcedure::getShortRetryLimit ( )

inlinevirtual

{ return shortRetryLimit; }

void inet::ieee80211::NonQoSRecoveryProcedure::incrementCounter ( Ieee80211DataOrMgmtFrame *  frame, std::map< SequenceControlField, int > &  retryCounter  )

protectedvirtual

Referenced by dataOrMgmtFrameTransmissionFailed(), and rtsFrameTransmissionFailed().

{
    auto id = SequenceControlField(frame->getSequenceNumber(), frame->getFragmentNumber());
    if (retryCounter.find(id) != retryCounter.end())
        retryCounter[id]++;
    else
        retryCounter.insert(std::make_pair(id, 1));
}

void inet::ieee80211::NonQoSRecoveryProcedure::incrementStationLrc ( StationRetryCounters *  stationCounters )

protectedvirtual

Referenced by dataOrMgmtFrameTransmissionFailed().

{
    stationCounters->incrementStationLongRetryCount();
    if (stationCounters->getStationLongRetryCount() == longRetryLimit) // 9.3.3 Random backoff time
        resetContentionWindow();
    else
        cwCalculator->incrementCw();
}

void inet::ieee80211::NonQoSRecoveryProcedure::incrementStationSrc ( StationRetryCounters *  stationCounters )

protectedvirtual

Referenced by dataOrMgmtFrameTransmissionFailed(), and rtsFrameTransmissionFailed().

{
    stationCounters->incrementStationShortRetryCount();
    if (stationCounters->getStationShortRetryCount() == shortRetryLimit) // 9.3.3 Random backoff time
        resetContentionWindow();
    else
        cwCalculator->incrementCw();
}

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

overrideprotectedvirtual

{
    if (stage == INITSTAGE_LAST) {
        auto rtsPolicy = check_and_cast<IRtsPolicy *>(getModuleByPath(par("rtsPolicyModule")));
        cwCalculator = check_and_cast<ICwCalculator *>(getModuleByPath(par("cwCalculatorModule")));
        rtsThreshold = rtsPolicy->getRtsThreshold();
        shortRetryLimit = par("shortRetryLimit");
        longRetryLimit = par("longRetryLimit");
    }
}

bool inet::ieee80211::NonQoSRecoveryProcedure::isMulticastFrame ( Ieee80211Frame *  frame )

protectedvirtual

{
    if (Ieee80211OneAddressFrame *oneAddressFrame = dynamic_cast<Ieee80211OneAddressFrame*>(frame)) {
        return oneAddressFrame->getReceiverAddress().isMulticast();
    }
    return false;
}

bool inet::ieee80211::NonQoSRecoveryProcedure::isRetryLimitReached ( Ieee80211DataOrMgmtFrame *  failedFrame )

virtual

Referenced by inet::ieee80211::Hcf::handleInternalCollision(), inet::ieee80211::Dcf::originatorProcessFailedFrame(), and inet::ieee80211::Hcf::originatorProcessFailedFrame().

{
    if (failedFrame->getByteLength() >= rtsThreshold)
        return getRc(failedFrame, longRetryCounter) >= longRetryLimit;
    else
        return getRc(failedFrame, shortRetryCounter) >= shortRetryLimit;
}

bool inet::ieee80211::NonQoSRecoveryProcedure::isRtsFrameRetryLimitReached ( Ieee80211DataOrMgmtFrame *  protectedFrame )

virtual

Referenced by inet::ieee80211::Dcf::originatorProcessRtsProtectionFailed(), and inet::ieee80211::Hcf::originatorProcessRtsProtectionFailed().

{
    return getRc(protectedFrame, shortRetryCounter) >= shortRetryLimit;
}

void inet::ieee80211::NonQoSRecoveryProcedure::multicastFrameTransmitted ( StationRetryCounters *  stationCounters )

virtual

Referenced by inet::ieee80211::Dcf::originatorProcessTransmittedFrame().

{
    stationCounters->resetStationShortRetryCount();
    stationCounters->resetStationLongRetryCount();
}

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

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

void inet::ieee80211::NonQoSRecoveryProcedure::resetContentionWindow ( )

protectedvirtual

Referenced by ackFrameReceived(), incrementStationLrc(), and incrementStationSrc().

{
    cwCalculator->resetCw();
}

void inet::ieee80211::NonQoSRecoveryProcedure::retryLimitReached ( Ieee80211DataOrMgmtFrame *  frame )

virtual

Referenced by inet::ieee80211::Hcf::handleInternalCollision(), inet::ieee80211::Dcf::originatorProcessFailedFrame(), inet::ieee80211::Hcf::originatorProcessFailedFrame(), inet::ieee80211::Dcf::originatorProcessRtsProtectionFailed(), and inet::ieee80211::Hcf::originatorProcessRtsProtectionFailed().

{
    auto id = SequenceControlField(frame->getSequenceNumber(), frame->getFragmentNumber());
    if (frame->getByteLength() >= rtsThreshold) {
        auto it = longRetryCounter.find(id);
        if (it != longRetryCounter.end())
            longRetryCounter.erase(it);
    }
    else {
        auto it = shortRetryCounter.find(id);
        if (it != shortRetryCounter.end())
            shortRetryCounter.erase(it);
    }
}

void inet::ieee80211::NonQoSRecoveryProcedure::rtsFrameTransmissionFailed ( Ieee80211DataOrMgmtFrame *  protectedFrame, StationRetryCounters *  stationCounters  )

virtual

Referenced by inet::ieee80211::Dcf::originatorProcessRtsProtectionFailed(), and inet::ieee80211::Hcf::originatorProcessRtsProtectionFailed().

{
    incrementStationSrc(stationCounters);
    incrementCounter(protectedFrame, shortRetryCounter);
}

Member Data Documentation

ICwCalculator* inet::ieee80211::NonQoSRecoveryProcedure::cwCalculator = nullptr

protected

Referenced by incrementStationLrc(), incrementStationSrc(), initialize(), and resetContentionWindow().

std::map<SequenceControlField, int> inet::ieee80211::NonQoSRecoveryProcedure::longRetryCounter

protected

Referenced by ackFrameReceived(), dataOrMgmtFrameTransmissionFailed(), getLongRetryCount(), getRetryCount(), isRetryLimitReached(), and retryLimitReached().

int inet::ieee80211::NonQoSRecoveryProcedure::longRetryLimit = -1

protected

Referenced by incrementStationLrc(), initialize(), and isRetryLimitReached().

int inet::ieee80211::NonQoSRecoveryProcedure::rtsThreshold = -1

protected

Referenced by ackFrameReceived(), dataOrMgmtFrameTransmissionFailed(), getRetryCount(), initialize(), isRetryLimitReached(), and retryLimitReached().

std::map<SequenceControlField, int> inet::ieee80211::NonQoSRecoveryProcedure::shortRetryCounter

protected

Referenced by ackFrameReceived(), dataOrMgmtFrameTransmissionFailed(), getRetryCount(), getShortRetryCount(), isRetryLimitReached(), isRtsFrameRetryLimitReached(), retryLimitReached(), and rtsFrameTransmissionFailed().

int inet::ieee80211::NonQoSRecoveryProcedure::shortRetryLimit = -1

protected

Referenced by incrementStationSrc(), initialize(), isRetryLimitReached(), and isRtsFrameRetryLimitReached().

---

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

• NonQoSRecoveryProcedure.h
• NonQoSRecoveryProcedure.cc