inet::ieee80211::OriginatorBlockAckAgreementHandler Class Reference

#include <OriginatorBlockAckAgreementHandler.h>

Inheritance diagram for inet::ieee80211::OriginatorBlockAckAgreementHandler:

Public Member Functions
virtual	~OriginatorBlockAckAgreementHandler ()
virtual void	processTransmittedAddbaReq (Ieee80211AddbaRequest *addbaReq) override
virtual void	processTransmittedDataFrame (Ieee80211DataFrame *dataFrame, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy, IProcedureCallback *callback) override
virtual void	processReceivedBlockAck (Ieee80211BlockAck *blockAck, IBlockAckAgreementHandlerCallback *callback) override
virtual void	processReceivedAddbaResp (Ieee80211AddbaResponse *addbaResp, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy, IBlockAckAgreementHandlerCallback *callback) override
virtual void	processReceivedDelba (Ieee80211Delba *delba, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy) override
virtual void	processTransmittedDelba (Ieee80211Delba *delba) override
virtual void	blockAckAgreementExpired (IProcedureCallback *procedureCallback, IBlockAckAgreementHandlerCallback *agreementHandlerCallback) override
virtual OriginatorBlockAckAgreement *	getAgreement (MACAddress receiverAddr, Tid tid) override
Public Member Functions inherited from inet::ieee80211::IOriginatorBlockAckAgreementHandler
virtual	~IOriginatorBlockAckAgreementHandler ()

Protected Member Functions
virtual Ieee80211AddbaRequest *	buildAddbaRequest (MACAddress receiverAddr, Tid tid, int startingSequenceNumber, IOriginatorBlockAckAgreementPolicy *blockAckAgreementPolicy)
virtual void	createAgreement (Ieee80211AddbaRequest *addbaRequest)
virtual void	updateAgreement (OriginatorBlockAckAgreement *agreement, Ieee80211AddbaResponse *addbaResp)
virtual void	terminateAgreement (MACAddress originatorAddr, Tid tid)
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 >, OriginatorBlockAckAgreement * >	blockAckAgreements

Constructor & Destructor Documentation

inet::ieee80211::OriginatorBlockAckAgreementHandler::~OriginatorBlockAckAgreementHandler ( )

virtual

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

Member Function Documentation

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

overridevirtual

Implements inet::ieee80211::IOriginatorBlockAckAgreementHandler.

{
    // 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);
}

Ieee80211AddbaRequest * inet::ieee80211::OriginatorBlockAckAgreementHandler::buildAddbaRequest ( MACAddress  receiverAddr, Tid  tid, int  startingSequenceNumber, IOriginatorBlockAckAgreementPolicy *  blockAckAgreementPolicy  )

protectedvirtual

Referenced by processTransmittedDataFrame().

{
    Ieee80211AddbaRequest *addbaRequest = new Ieee80211AddbaRequest("AddbaReq");
    addbaRequest->setReceiverAddress(receiverAddr);
    addbaRequest->setTid(tid);
    addbaRequest->setAMsduSupported(blockAckAgreementPolicy->isMsduSupported());
    addbaRequest->setBlockAckTimeoutValue(blockAckAgreementPolicy->getBlockAckTimeoutValue());
    addbaRequest->setBufferSize(blockAckAgreementPolicy->getMaximumAllowedBufferSize());
    // The Block Ack Policy subfield is set to 1 for immediate Block Ack and 0 for delayed Block Ack.
    addbaRequest->setBlockAckPolicy(blockAckAgreementPolicy->isDelayedAckPolicySupported() ? 0 : 1);
    addbaRequest->setStartingSequenceNumber(startingSequenceNumber);
    return addbaRequest;
}

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

protectedvirtual

Referenced by blockAckAgreementExpired().

{
    Ieee80211Delba *delba = new Ieee80211Delba();
    delba->setReceiverAddress(receiverAddr);
    delba->setTid(tid);
    delba->setReasonCode(reasonCode);
    // The Initiator subfield indicates if the originator or the recipient of the data is sending this frame.
    delba->setInitiator(true);
    return delba;
}

simtime_t inet::ieee80211::OriginatorBlockAckAgreementHandler::computeEarliestExpirationTime ( )

protectedvirtual

Referenced by scheduleInactivityTimer().

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

void inet::ieee80211::OriginatorBlockAckAgreementHandler::createAgreement ( Ieee80211AddbaRequest *  addbaRequest )

protectedvirtual

Referenced by processTransmittedDataFrame().

{
    OriginatorBlockAckAgreement *blockAckAgreement = new OriginatorBlockAckAgreement(addbaRequest->getReceiverAddress(), addbaRequest->getTid(), addbaRequest->getStartingSequenceNumber(), addbaRequest->getBufferSize(), addbaRequest->getAMsduSupported(), addbaRequest->getBlockAckPolicy() == 0);
    auto agreementId = std::make_pair(addbaRequest->getReceiverAddress(), addbaRequest->getTid());
    blockAckAgreements[agreementId] = blockAckAgreement;
}

OriginatorBlockAckAgreement * inet::ieee80211::OriginatorBlockAckAgreementHandler::getAgreement ( MACAddress  receiverAddr, Tid  tid  )

overridevirtual

Implements inet::ieee80211::IOriginatorBlockAckAgreementHandler.

Referenced by processReceivedAddbaResp(), processReceivedBlockAck(), processTransmittedAddbaReq(), and processTransmittedDataFrame().

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

void inet::ieee80211::OriginatorBlockAckAgreementHandler::processReceivedAddbaResp ( Ieee80211AddbaResponse *  addbaResp, IOriginatorBlockAckAgreementPolicy *  blockAckAgreementPolicy, IBlockAckAgreementHandlerCallback *  callback  )

overridevirtual

Implements inet::ieee80211::IOriginatorBlockAckAgreementHandler.

{
    auto agreement = getAgreement(addbaResp->getTransmitterAddress(), addbaResp->getTid());
    if (blockAckAgreementPolicy->isAddbaReqAccepted(addbaResp, agreement)) {
        updateAgreement(agreement, addbaResp);
        scheduleInactivityTimer(callback);
    }
    else {
        // TODO: send a new one?
    }
}

void inet::ieee80211::OriginatorBlockAckAgreementHandler::processReceivedBlockAck ( Ieee80211BlockAck *  blockAck, IBlockAckAgreementHandlerCallback *  callback  )

overridevirtual

Implements inet::ieee80211::IOriginatorBlockAckAgreementHandler.

{
    if (auto basicBlockAck = dynamic_cast<Ieee80211BasicBlockAck*>(blockAck)) {
        auto agreement = getAgreement(basicBlockAck->getTransmitterAddress(), basicBlockAck->getTidInfo());
        if (agreement) {
            agreement->calculateExpirationTime();
            scheduleInactivityTimer(callback);
        }
    }
    else
        throw cRuntimeError("Unsupported BlockAck");
}

void inet::ieee80211::OriginatorBlockAckAgreementHandler::processReceivedDelba ( Ieee80211Delba *  delba, IOriginatorBlockAckAgreementPolicy *  blockAckAgreementPolicy  )

overridevirtual

Implements inet::ieee80211::IOriginatorBlockAckAgreementHandler.

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

void inet::ieee80211::OriginatorBlockAckAgreementHandler::processTransmittedAddbaReq ( Ieee80211AddbaRequest *  addbaReq )

overridevirtual

Implements inet::ieee80211::IOriginatorBlockAckAgreementHandler.

{
    auto agreement = getAgreement(addbaReq->getReceiverAddress(), addbaReq->getTid());
    if (agreement)
        agreement->setIsAddbaRequestSent(true);
    else
        throw cRuntimeError("Block Ack Agreement should have already been added");
}

void inet::ieee80211::OriginatorBlockAckAgreementHandler::processTransmittedDataFrame ( Ieee80211DataFrame *  dataFrame, IOriginatorBlockAckAgreementPolicy *  blockAckAgreementPolicy, IProcedureCallback *  callback  )

overridevirtual

Implements inet::ieee80211::IOriginatorBlockAckAgreementHandler.

{
    auto agreement = getAgreement(dataFrame->getReceiverAddress(), dataFrame->getTid());
    if (blockAckAgreementPolicy->isAddbaReqNeeded(dataFrame) && agreement == nullptr) {
        auto addbaReq = buildAddbaRequest(dataFrame->getReceiverAddress(), dataFrame->getTid(), dataFrame->getSequenceNumber() + 1, blockAckAgreementPolicy);
        createAgreement(addbaReq);
        callback->processMgmtFrame(addbaReq);
    }
}

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

overridevirtual

Implements inet::ieee80211::IOriginatorBlockAckAgreementHandler.

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

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

protectedvirtual

Referenced by blockAckAgreementExpired(), processReceivedAddbaResp(), and processReceivedBlockAck().

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

void inet::ieee80211::OriginatorBlockAckAgreementHandler::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()) {
        OriginatorBlockAckAgreement *agreement = it->second;
        blockAckAgreements.erase(it);
        delete agreement;
    }
}

void inet::ieee80211::OriginatorBlockAckAgreementHandler::updateAgreement ( OriginatorBlockAckAgreement *  agreement, Ieee80211AddbaResponse *  addbaResp  )

protectedvirtual

Referenced by processReceivedAddbaResp().

{
    agreement->setIsAddbaResponseReceived(true);
    agreement->setBufferSize(addbaResp->getBufferSize());
    agreement->setBlockAckTimeoutValue(addbaResp->getBlockAckTimeoutValue());
    agreement->calculateExpirationTime();
}

Member Data Documentation

std::map<std::pair<MACAddress, Tid>, OriginatorBlockAckAgreement *> inet::ieee80211::OriginatorBlockAckAgreementHandler::blockAckAgreements

protected

Referenced by blockAckAgreementExpired(), computeEarliestExpirationTime(), createAgreement(), getAgreement(), terminateAgreement(), and ~OriginatorBlockAckAgreementHandler().

---

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

• OriginatorBlockAckAgreementHandler.h
• OriginatorBlockAckAgreementHandler.cc