inet::ieee80211::RecipientBlockAckAgreementHandler Class Reference

#include <RecipientBlockAckAgreementHandler.h>

Inheritance diagram for inet::ieee80211::RecipientBlockAckAgreementHandler:

Public Member Functions
virtual	~RecipientBlockAckAgreementHandler ()
virtual void	processTransmittedAddbaResp (Ieee80211AddbaResponse *addbaResp, IBlockAckAgreementHandlerCallback *callback) override
virtual void	processReceivedAddbaRequest (Ieee80211AddbaRequest *addbaRequest, IRecipientBlockAckAgreementPolicy *blockAckAgreementPolicy, IProcedureCallback *callback) override
virtual void	processReceivedDelba (Ieee80211Delba *delba, IRecipientBlockAckAgreementPolicy *blockAckAgreementPolicy) override
virtual void	qosFrameReceived (Ieee80211DataFrame *qosFrame, IBlockAckAgreementHandlerCallback *callback) override
virtual void	processTransmittedDelba (Ieee80211Delba *delba) override
virtual void	blockAckAgreementExpired (IProcedureCallback *procedureCallback, IBlockAckAgreementHandlerCallback *agreementHandlerCallback) override
virtual RecipientBlockAckAgreement *	getAgreement (Tid tid, MACAddress originatorAddr) override
Public Member Functions inherited from inet::ieee80211::IRecipientBlockAckAgreementHandler
virtual	~IRecipientBlockAckAgreementHandler ()

Protected Member Functions
virtual void	terminateAgreement (MACAddress originatorAddr, Tid tid)
virtual RecipientBlockAckAgreement *	addAgreement (Ieee80211AddbaRequest *addbaReq)
virtual void	updateAgreement (Ieee80211AddbaResponse *frame)
virtual Ieee80211AddbaResponse *	buildAddbaResponse (Ieee80211AddbaRequest *frame, IRecipientBlockAckAgreementPolicy *blockAckAgreementPolicy)
virtual Ieee80211Delba *	buildDelba (MACAddress receiverAddr, Tid tid, int reasonCode)
virtual simtime_t	computeEarliestExpirationTime ()
virtual void	scheduleInactivityTimer (IBlockAckAgreementHandlerCallback *callback)

Protected Attributes
std::map< std::pair< MACAddress, Tid >, RecipientBlockAckAgreement * >	blockAckAgreements

Constructor & Destructor Documentation

inet::ieee80211::RecipientBlockAckAgreementHandler::~RecipientBlockAckAgreementHandler ( )

virtual

{
    for (auto it : blockAckAgreements)
        delete it.second;
}

Member Function Documentation

RecipientBlockAckAgreement * inet::ieee80211::RecipientBlockAckAgreementHandler::addAgreement ( Ieee80211AddbaRequest *  addbaReq )

protectedvirtual

Referenced by processReceivedAddbaRequest().

{
    MACAddress originatorAddr = addbaReq->getTransmitterAddress();
    auto id = std::make_pair(originatorAddr, addbaReq->getTid());
    auto it = blockAckAgreements.find(id);
    if (it == blockAckAgreements.end()) {
        RecipientBlockAckAgreement *agreement = new RecipientBlockAckAgreement(originatorAddr, addbaReq->getTid(), addbaReq->getStartingSequenceNumber(), addbaReq->getBufferSize(), addbaReq->getBlockAckTimeoutValue());
        blockAckAgreements[id] = agreement;
        EV_DETAIL << "Block Ack Agreement is added with the following parameters: " << *agreement << endl;
        return agreement;
    }
    else
        throw cRuntimeError("TODO"); // TODO: update?
}

void inet::ieee80211::RecipientBlockAckAgreementHandler::blockAckAgreementExpired ( IProcedureCallback *  procedureCallback, IBlockAckAgreementHandlerCallback *  agreementHandlerCallback  )

overridevirtual

Implements inet::ieee80211::IRecipientBlockAckAgreementHandler.

{
    // When a timeout of BlockAckTimeout is detected, the STA shall send a DELBA frame to the
    // peer STA with the Reason Code field set to TIMEOUT and shall issue a MLME-DELBA.indication
    // primitive with the ReasonCode parameter having a value of TIMEOUT.
    // The procedure is illustrated in Figure 10-14.
    simtime_t now = simTime();
    for (auto id : blockAckAgreements) {
        auto agreement = id.second;
        if (agreement->getExpirationTime() == now) {
            MACAddress receiverAddr = id.first.first;
            Tid tid = id.first.second;
            procedureCallback->processMgmtFrame(buildDelba(receiverAddr, tid, 39)); // 39 - TIMEOUT see: Table 8-36—Reason codes
        }
    }
    scheduleInactivityTimer(agreementHandlerCallback);
}

Ieee80211AddbaResponse * inet::ieee80211::RecipientBlockAckAgreementHandler::buildAddbaResponse ( Ieee80211AddbaRequest *  frame, IRecipientBlockAckAgreementPolicy *  blockAckAgreementPolicy  )

protectedvirtual

Referenced by processReceivedAddbaRequest().

{
    Ieee80211AddbaResponse *addbaResponse = new Ieee80211AddbaResponse("AddbaResponse");
    addbaResponse->setReceiverAddress(frame->getTransmitterAddress());
    // The Block Ack Policy subfield is set to 1 for immediate Block Ack and 0 for delayed Block Ack.
    Tid tid = frame->getTid();
    addbaResponse->setTid(tid);
    addbaResponse->setBlockAckPolicy(!frame->getBlockAckPolicy() && blockAckAgreementPolicy->delayedBlockAckPolicySupported() ? false : true);
    addbaResponse->setBufferSize(frame->getBufferSize() <= blockAckAgreementPolicy->getMaximumAllowedBufferSize() ? frame->getBufferSize() : blockAckAgreementPolicy->getMaximumAllowedBufferSize());
    addbaResponse->setBlockAckTimeoutValue(blockAckAgreementPolicy->getBlockAckTimeoutValue() == 0 ? blockAckAgreementPolicy->getBlockAckTimeoutValue() : frame->getBlockAckTimeoutValue());
    addbaResponse->setAMsduSupported(blockAckAgreementPolicy->aMsduSupported());
    return addbaResponse;
}

Ieee80211Delba * inet::ieee80211::RecipientBlockAckAgreementHandler::buildDelba ( MACAddress  receiverAddr, Tid  tid, int  reasonCode  )

protectedvirtual

Referenced by blockAckAgreementExpired().

{
    Ieee80211Delba *delba = new Ieee80211Delba("Delba");
    delba->setReceiverAddress(receiverAddr);
    delba->setInitiator(false);
    delba->setTid(tid);
    delba->setReasonCode(reasonCode);
    return delba;
}

simtime_t inet::ieee80211::RecipientBlockAckAgreementHandler::computeEarliestExpirationTime ( )

protectedvirtual

Referenced by scheduleInactivityTimer().

{
    simtime_t earliestTime = SIMTIME_MAX;
    for (auto id : blockAckAgreements) {
        auto agreement = id.second;
        earliestTime = std::min(earliestTime, agreement->getExpirationTime());
    }
    return earliestTime;
}

RecipientBlockAckAgreement * inet::ieee80211::RecipientBlockAckAgreementHandler::getAgreement ( Tid  tid, MACAddress  originatorAddr  )

overridevirtual

Implements inet::ieee80211::IRecipientBlockAckAgreementHandler.

Referenced by qosFrameReceived().

{
    auto agreementId = std::make_pair(originatorAddr, tid);
    auto it = blockAckAgreements.find(agreementId);
    return it != blockAckAgreements.end() ? it->second : nullptr;
}

void inet::ieee80211::RecipientBlockAckAgreementHandler::processReceivedAddbaRequest ( Ieee80211AddbaRequest *  addbaRequest, IRecipientBlockAckAgreementPolicy *  blockAckAgreementPolicy, IProcedureCallback *  callback  )

overridevirtual

Implements inet::ieee80211::IRecipientBlockAckAgreementHandler.

{
    EV_INFO << "Processing Addba Request from " << addbaRequest->getTransmitterAddress() << endl;
    if (blockAckAgreementPolicy->isAddbaReqAccepted(addbaRequest)) {
        EV_DETAIL << "Addba Request has been accepted. Creating a new Block Ack Agreement." << endl;
        auto agreement = addAgreement(addbaRequest);
        EV_DETAIL << "Agreement is added with the following parameters: " << *agreement << endl;
        EV_DETAIL << "Building Addba Response" << endl;
        auto addbaResponse = buildAddbaResponse(addbaRequest, blockAckAgreementPolicy);
        callback->processMgmtFrame(addbaResponse);
    }
}

void inet::ieee80211::RecipientBlockAckAgreementHandler::processReceivedDelba ( Ieee80211Delba *  delba, IRecipientBlockAckAgreementPolicy *  blockAckAgreementPolicy  )

overridevirtual

Implements inet::ieee80211::IRecipientBlockAckAgreementHandler.

{
    if (blockAckAgreementPolicy->isDelbaAccepted(delba))
        terminateAgreement(delba->getReceiverAddress(), delba->getTid());
}

void inet::ieee80211::RecipientBlockAckAgreementHandler::processTransmittedAddbaResp ( Ieee80211AddbaResponse *  addbaResp, IBlockAckAgreementHandlerCallback *  callback  )

overridevirtual

Implements inet::ieee80211::IRecipientBlockAckAgreementHandler.

{
    updateAgreement(addbaResp);
    scheduleInactivityTimer(callback);
}

void inet::ieee80211::RecipientBlockAckAgreementHandler::processTransmittedDelba ( Ieee80211Delba *  delba )

overridevirtual

Implements inet::ieee80211::IRecipientBlockAckAgreementHandler.

{
    terminateAgreement(delba->getReceiverAddress(), delba->getTid());
}

void inet::ieee80211::RecipientBlockAckAgreementHandler::qosFrameReceived ( Ieee80211DataFrame *  qosFrame, IBlockAckAgreementHandlerCallback *  callback  )

overridevirtual

Implements inet::ieee80211::IRecipientBlockAckAgreementHandler.

{
    if (qosFrame->getAckPolicy() == AckPolicy::BLOCK_ACK) { // TODO: + Implicit Block Ack
        Tid tid = qosFrame->getTid();
        MACAddress originatorAddr = qosFrame->getTransmitterAddress();
        auto agreement = getAgreement(tid, originatorAddr);
        if (agreement)
            scheduleInactivityTimer(callback);
    }
}

void inet::ieee80211::RecipientBlockAckAgreementHandler::scheduleInactivityTimer ( IBlockAckAgreementHandlerCallback *  callback )

protectedvirtual

Referenced by blockAckAgreementExpired(), processTransmittedAddbaResp(), and qosFrameReceived().

{
    simtime_t earliestExpirationTime = computeEarliestExpirationTime();
    if (earliestExpirationTime != SIMTIME_MAX)
        callback->scheduleInactivityTimer(earliestExpirationTime);
}

void inet::ieee80211::RecipientBlockAckAgreementHandler::terminateAgreement ( MACAddress  originatorAddr, Tid  tid  )

protectedvirtual

Referenced by processReceivedDelba(), and processTransmittedDelba().

{
    auto agreementId = std::make_pair(originatorAddr, tid);
    auto it = blockAckAgreements.find(agreementId);
    if (it != blockAckAgreements.end()) {
        RecipientBlockAckAgreement *agreement = it->second;
        blockAckAgreements.erase(it);
        delete agreement;
    }
}

void inet::ieee80211::RecipientBlockAckAgreementHandler::updateAgreement ( Ieee80211AddbaResponse *  frame )

protectedvirtual

Referenced by processTransmittedAddbaResp().

{
    auto id = std::make_pair(frame->getReceiverAddress(), frame->getTid());
    auto it = blockAckAgreements.find(id);
    if (it != blockAckAgreements.end()) {
        RecipientBlockAckAgreement *agreement = it->second;
        agreement->addbaResposneSent();
    }
    else
        throw cRuntimeError("Agreement is not found");
}

Member Data Documentation

std::map<std::pair<MACAddress, Tid>, RecipientBlockAckAgreement *> inet::ieee80211::RecipientBlockAckAgreementHandler::blockAckAgreements

protected

Referenced by addAgreement(), blockAckAgreementExpired(), computeEarliestExpirationTime(), getAgreement(), terminateAgreement(), updateAgreement(), and ~RecipientBlockAckAgreementHandler().

---

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

• RecipientBlockAckAgreementHandler.h
• RecipientBlockAckAgreementHandler.cc