inet::ieee80211::Edcaf Class Reference

Implements IEEE 802.11 Enhanced Distributed Channel Access Function. More...

#include <Edcaf.h>

Inheritance diagram for inet::ieee80211::Edcaf:

Public Member Functions
virtual void	requestChannel (IChannelAccess::ICallback *callback) override
virtual void	releaseChannel (IChannelAccess::ICallback *callback) override
virtual void	channelAccessGranted () override
virtual void	expectedChannelAccess (simtime_t time) override
virtual void	incrementCw () override
virtual void	resetCw () override
virtual bool	isOwning ()
virtual bool	isInternalCollision ()
virtual AccessCategory	getAccessCategory ()
virtual int	getCw ()
Public Member Functions inherited from inet::ieee80211::IChannelAccess
virtual	~IChannelAccess ()
Public Member Functions inherited from inet::ieee80211::IContention::ICallback
	~ICallback ()

Protected Member Functions
virtual int	numInitStages () const override
virtual void	initialize (int stage) override
virtual void	updateDisplayString ()
virtual void	receiveSignal (cComponent *source, simsignal_t signalID, cObject *obj, cObject *details) override
virtual AccessCategory	getAccessCategory (const char *ac)
virtual int	getAifsNumber (AccessCategory ac)
virtual int	getCwMax (AccessCategory ac, int aCwMax, int aCwMin)
virtual int	getCwMin (AccessCategory ac, int aCwMin)
virtual void	calculateTimingParameters ()

Protected Attributes
IContention *	contention = nullptr
IChannelAccess::ICallback *	callback = nullptr
IEdcaCollisionController *	collisionController = nullptr
bool	owning = false
simtime_t	slotTime = -1
simtime_t	sifs = -1
simtime_t	ifs = -1
simtime_t	eifs = -1
AccessCategory	ac = AccessCategory(-1)
int	cw = -1
int	cwMin = -1
int	cwMax = -1
Protected Attributes inherited from inet::ieee80211::ModeSetListener
Ieee80211ModeSet *	modeSet = nullptr

Detailed Description

Implements IEEE 802.11 Enhanced Distributed Channel Access Function.

Member Function Documentation

void inet::ieee80211::Edcaf::calculateTimingParameters ( )

protectedvirtual

Referenced by initialize(), and receiveSignal().

{
    slotTime = modeSet->getSlotTime();
    sifs = modeSet->getSifsTime();
    int aifsn = par("aifsn");
    simtime_t aifs = sifs + fallback(getAifsNumber(ac), aifsn) * slotTime;
    ifs = aifs;
    eifs = sifs + aifs + modeSet->getSlowestMandatoryMode()->getDuration(LENGTH_ACK);
    ASSERT(ifs > sifs);
    cwMin = par("cwMin");
    cwMax = par("cwMax");
    if (cwMin == -1)
        cwMin = getCwMin(ac, modeSet->getCwMin());
    if (cwMax == -1)
        cwMax = getCwMax(ac, modeSet->getCwMax(), modeSet->getCwMin());
    cw = cwMin;
}

void inet::ieee80211::Edcaf::channelAccessGranted ( )

overridevirtual

Implements inet::ieee80211::IContention::ICallback.

{
    ASSERT(callback != nullptr);
    if (!collisionController->isInternalCollision(this)) {
        owning = true;
        callback->channelGranted(this);
    }
    if (hasGUI())
        updateDisplayString();
}

void inet::ieee80211::Edcaf::expectedChannelAccess ( simtime_t  time )

overridevirtual

Implements inet::ieee80211::IContention::ICallback.

{
    collisionController->expectedChannelAccess(this, time);
}

AccessCategory inet::ieee80211::Edcaf::getAccessCategory ( const char *  ac )

protectedvirtual

Referenced by inet::ieee80211::Hcf::channelGranted(), inet::ieee80211::EdcaCollisionController::expectedChannelAccess(), inet::ieee80211::Hcf::hasFrameToTransmit(), inet::ieee80211::EdcaCollisionController::isInternalCollision(), inet::ieee80211::Hcf::originatorProcessFailedFrame(), inet::ieee80211::Hcf::originatorProcessReceivedFrame(), inet::ieee80211::Hcf::originatorProcessRtsProtectionFailed(), inet::ieee80211::Hcf::originatorProcessTransmittedFrame(), and inet::ieee80211::Hcf::transmitFrame().

{
    if (strcmp("AC_BK", ac) == 0)
        return AC_BK;
    if (strcmp("AC_VI", ac) == 0)
        return AC_VI;
    if (strcmp("AC_VO", ac) == 0)
        return AC_VO;
    if (strcmp("AC_BE", ac) == 0)
        return AC_BE;
    throw cRuntimeError("Unknown Access Category = %s", ac);
}

virtual AccessCategory inet::ieee80211::Edcaf::getAccessCategory ( )

inlinevirtual

Referenced by initialize().

{ return ac; }

int inet::ieee80211::Edcaf::getAifsNumber ( AccessCategory  ac )

protectedvirtual

Referenced by calculateTimingParameters().

{
    switch (ac)
    {
        case AC_BK: return 7;
        case AC_BE: return 3;
        case AC_VI: return 2;
        case AC_VO: return 2;
        default: throw cRuntimeError("Unknown access category = %d", ac);
    }
}

virtual int inet::ieee80211::Edcaf::getCw ( )

inlinevirtual

{ return cw; }

int inet::ieee80211::Edcaf::getCwMax ( AccessCategory  ac, int  aCwMax, int  aCwMin  )

protectedvirtual

Referenced by calculateTimingParameters().

{
    switch (ac)
    {
        case AC_BK: return aCwMax;
        case AC_BE: return aCwMax;
        case AC_VI: return aCwMin;
        case AC_VO: return (aCwMin + 1) / 2 - 1;
        default: throw cRuntimeError("Unknown access category = %d", ac);
    }
}

int inet::ieee80211::Edcaf::getCwMin ( AccessCategory  ac, int  aCwMin  )

protectedvirtual

Referenced by calculateTimingParameters().

{
    switch (ac)
    {
        case AC_BK: return aCwMin;
        case AC_BE: return aCwMin;
        case AC_VI: return (aCwMin + 1) / 2 - 1;
        case AC_VO: return (aCwMin + 1) / 4 - 1;
        default: throw cRuntimeError("Unknown access category = %d", ac);
    }
}

void inet::ieee80211::Edcaf::incrementCw ( )

overridevirtual

Implements inet::ieee80211::IRecoveryProcedure::ICwCalculator.

{
    int newCw = 2 * cw + 1;
    if (newCw > cwMax)
        cw = cwMax;
    else
        cw = newCw;
}

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

overrideprotectedvirtual

Reimplemented from inet::ieee80211::ModeSetListener.

{
    if (stage == INITSTAGE_LOCAL) {
        getContainingNicModule(this)->subscribe(NF_MODESET_CHANGED, this);
        ac = getAccessCategory(par("accessCategory"));
        contention = check_and_cast<IContention *>(getSubmodule("contention"));
        collisionController = check_and_cast<IEdcaCollisionController *>(getModuleByPath(par("collisionControllerModule")));
    }
    else if (stage == INITSTAGE_LINK_LAYER_2) {
        auto rx = check_and_cast<IRx *>(getModuleByPath(par("rxModule")));
        rx->registerContention(contention);
        calculateTimingParameters();
        if (hasGUI())
            updateDisplayString();
    }
}

bool inet::ieee80211::Edcaf::isInternalCollision ( )

virtual

{
    return collisionController->isInternalCollision(this);
}

virtual bool inet::ieee80211::Edcaf::isOwning ( )

inlinevirtual

{ return owning; }

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

inlineoverrideprotectedvirtual

Reimplemented from inet::ieee80211::ModeSetListener.

{ return NUM_INIT_STAGES; }

void inet::ieee80211::Edcaf::receiveSignal ( cComponent *  source, simsignal_t  signalID, cObject *  obj, cObject *  details  )

overrideprotectedvirtual

Reimplemented from inet::ieee80211::ModeSetListener.

{
    Enter_Method("receiveModeSetChangeNotification");
    if (signalID == NF_MODESET_CHANGED) {
        modeSet = check_and_cast<Ieee80211ModeSet*>(obj);
        calculateTimingParameters();
    }
}

void inet::ieee80211::Edcaf::releaseChannel ( IChannelAccess::ICallback *  callback )

overridevirtual

Implements inet::ieee80211::IChannelAccess.

Referenced by inet::ieee80211::Edca::releaseChannelAccess().

{
    ASSERT(owning);
    owning = false;
    this->callback = nullptr;
    if (hasGUI())
        updateDisplayString();
}

void inet::ieee80211::Edcaf::requestChannel ( IChannelAccess::ICallback *  callback )

overridevirtual

Implements inet::ieee80211::IChannelAccess.

Referenced by inet::ieee80211::Edca::requestChannelAccess().

{
    this->callback = callback;
    ASSERT(!owning);
    if (contention->isContentionInProgress())
        EV_DETAIL << "Contention has already been started" << std::endl;
    else {
//        EV_DETAIL << "Starting contention with cw = " << cw << ", ifs = " << ifs << ", eifs = "
//                  << eifs << ", slotTime = " << slotTime << std::endl;
        contention->startContention(cw, ifs, eifs, slotTime, this);
    }
    if (hasGUI())
        updateDisplayString();
}

void inet::ieee80211::Edcaf::resetCw ( )

overridevirtual

Implements inet::ieee80211::IRecoveryProcedure::ICwCalculator.

{
    cw = cwMin;
}

void inet::ieee80211::Edcaf::updateDisplayString ( )

protectedvirtual

Referenced by channelAccessGranted(), initialize(), releaseChannel(), and requestChannel().

{
    std::string displayString(printAccessCategory(ac));
    if (owning)
        displayString += "\n(Channel owner)";
    else if (contention->isContentionInProgress())
        displayString += "\n(Contention in progress)";
    getDisplayString().setTagArg("t", 0, displayString.c_str());
}

Member Data Documentation

AccessCategory inet::ieee80211::Edcaf::ac = AccessCategory(-1)

protected

Referenced by calculateTimingParameters(), initialize(), and updateDisplayString().

IChannelAccess::ICallback* inet::ieee80211::Edcaf::callback = nullptr

protected

Referenced by channelAccessGranted(), and requestChannel().

IEdcaCollisionController* inet::ieee80211::Edcaf::collisionController = nullptr

protected

Referenced by channelAccessGranted(), expectedChannelAccess(), initialize(), and isInternalCollision().

IContention* inet::ieee80211::Edcaf::contention = nullptr

protected

Referenced by initialize(), requestChannel(), and updateDisplayString().

int inet::ieee80211::Edcaf::cw = -1

protected

Referenced by calculateTimingParameters(), incrementCw(), requestChannel(), and resetCw().

int inet::ieee80211::Edcaf::cwMax = -1

protected

Referenced by calculateTimingParameters(), and incrementCw().

int inet::ieee80211::Edcaf::cwMin = -1

protected

Referenced by calculateTimingParameters(), and resetCw().

simtime_t inet::ieee80211::Edcaf::eifs = -1

protected

Referenced by calculateTimingParameters(), and requestChannel().

simtime_t inet::ieee80211::Edcaf::ifs = -1

protected

Referenced by calculateTimingParameters(), and requestChannel().

bool inet::ieee80211::Edcaf::owning = false

protected

Referenced by channelAccessGranted(), releaseChannel(), requestChannel(), and updateDisplayString().

simtime_t inet::ieee80211::Edcaf::sifs = -1

protected

Referenced by calculateTimingParameters().

simtime_t inet::ieee80211::Edcaf::slotTime = -1

protected

Referenced by calculateTimingParameters(), and requestChannel().

---

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

• Edcaf.h
• Edcaf.cc