#include <OriginatorQoSAckPolicy.h>

Inheritance diagram for inet::ieee80211::OriginatorQoSAckPolicy:

Public Member Functions
virtual bool	isAckNeeded (Ieee80211ManagementFrame *frame) const override

virtual AckPolicy	computeAckPolicy (Ieee80211DataFrame frame, OriginatorBlockAckAgreement agreement) const override

virtual bool	isBlockAckPolicyEligibleFrame (Ieee80211DataFrame *frame) const override

virtual bool	isBlockAckReqNeeded (InProgressFrames inProgressFrames, TxopProcedure txopProcedure) const override

virtual std::tuple< MACAddress, SequenceNumber, Tid >	computeBlockAckReqParameters (InProgressFrames inProgressFrames, TxopProcedure txopProcedure) const override

virtual simtime_t	getAckTimeout (Ieee80211DataOrMgmtFrame *dataOrMgmtFrame) const override

virtual simtime_t	getBlockAckTimeout (Ieee80211BlockAckReq *blockAckReq) const override

Public Member Functions inherited from inet::ieee80211::IOriginatorQoSAckPolicy
virtual	~IOriginatorQoSAckPolicy ()

Protected Member Functions
virtual int	numInitStages () const override

virtual void	initialize (int stage) override

virtual bool	checkAgreementPolicy (Ieee80211DataFrame frame, OriginatorBlockAckAgreement agreement) const

virtual std::map< MACAddress, std::vector< Ieee80211DataFrame * > >	getOutstandingFramesPerReceiver (InProgressFrames *inProgressFrames) const

virtual int	computeStartingSequenceNumber (const std::vector< Ieee80211DataFrame * > &outstandingFrames) const

virtual bool	isCompressedBlockAckReq (const std::vector< Ieee80211DataFrame * > &outstandingFrames, int startingSequenceNumber) const

Protected Member Functions inherited from inet::ieee80211::ModeSetListener
virtual void	receiveSignal (cComponent source, simsignal_t signalID, cObject obj, cObject *details) override

Protected Attributes
IQoSRateSelection *	rateSelection = nullptr

int	maxBlockAckPolicyFrameLength = -1

int	blockAckReqTreshold = -1

simtime_t	blockAckTimeout = -1

simtime_t	ackTimeout = -1

Protected Attributes inherited from inet::ieee80211::ModeSetListener
Ieee80211ModeSet *	modeSet = nullptr

Member Function Documentation

bool inet::ieee80211::OriginatorQoSAckPolicy::checkAgreementPolicy	(	Ieee80211DataFrame *	frame,
		OriginatorBlockAckAgreement *	agreement
	)		const

protectedvirtual

Referenced by computeAckPolicy().

 {
     bool bufferFull = agreement->getBufferSize() == agreement->getNumSentBaPolicyFrames();
     bool aMsduOk = agreement->getIsAMsduSupported() || !frame->getAMsduPresent();
     // TODO: bool baPolicy = agreement->getIsDelayedBlockAckPolicySupported() || !frame->getAckPolicy();
     return !bufferFull && aMsduOk && (frame->getSequenceNumber() >= agreement->getStartingSequenceNumber()); // TODO: && baPolicy
 }

AckPolicy inet::ieee80211::OriginatorQoSAckPolicy::computeAckPolicy	(	Ieee80211DataFrame *	frame,
		OriginatorBlockAckAgreement *	agreement
	)		const

overridevirtual

Implements inet::ieee80211::IOriginatorQoSAckPolicy.

 {
     if (agreement == nullptr)
         return AckPolicy::NORMAL_ACK;
     if (agreement->getIsAddbaResponseReceived() && isBlockAckPolicyEligibleFrame(frame)) {
         if (checkAgreementPolicy(frame, agreement))
             return AckPolicy::BLOCK_ACK;
         else
             return AckPolicy::NORMAL_ACK;
     }
     else
         return AckPolicy::NORMAL_ACK;
 }

std::tuple< MACAddress, SequenceNumber, Tid > inet::ieee80211::OriginatorQoSAckPolicy::computeBlockAckReqParameters	(	InProgressFrames *	inProgressFrames,
		TxopProcedure *	txopProcedure
	)		const

overridevirtual

Implements inet::ieee80211::IOriginatorQoSAckPolicy.

 {
     auto outstandingFramesPerReceiver = getOutstandingFramesPerReceiver(inProgressFrames);
     for (auto outstandingFrames : outstandingFramesPerReceiver) {
         if ((int)outstandingFrames.second.size() >= blockAckReqTreshold) {
             auto largestOutstandingFrames = outstandingFramesPerReceiver.begin();
             for (auto it = outstandingFramesPerReceiver.begin(); it != outstandingFramesPerReceiver.end(); it++) {
                 if (it->second.size() > largestOutstandingFrames->second.size())
                     largestOutstandingFrames = it;
             }
             MACAddress receiverAddress = largestOutstandingFrames->first;
             SequenceNumber startingSequenceNumber = computeStartingSequenceNumber(largestOutstandingFrames->second);
             Tid tid = largestOutstandingFrames->second.at(0)->getTid();
             return std::make_tuple(receiverAddress, startingSequenceNumber, tid);
         }
     }
     return std::make_tuple(MACAddress::UNSPECIFIED_ADDRESS, -1, -1);
 }

int inet::ieee80211::OriginatorQoSAckPolicy::computeStartingSequenceNumber ( const std::vector< Ieee80211DataFrame * > & outstandingFrames ) const

protectedvirtual

Referenced by computeBlockAckReqParameters().

 {
     ASSERT(outstandingFrames.size() > 0);
     int startingSequenceNumber = outstandingFrames[0]->getSequenceNumber();
     for (int i = 1; i < (int)outstandingFrames.size(); i++) {
         int seqNum = outstandingFrames[i]->getSequenceNumber();
         if (seqNum < startingSequenceNumber)
             startingSequenceNumber = seqNum;
     }
     return startingSequenceNumber;
 }

simtime_t inet::ieee80211::OriginatorQoSAckPolicy::getAckTimeout ( Ieee80211DataOrMgmtFrame * dataOrMgmtFrame ) const

overridevirtual

Implements inet::ieee80211::IOriginatorQoSAckPolicy.

 {
     return ackTimeout == -1 ? modeSet->getSifsTime() + modeSet->getSlotTime() + rateSelection->computeResponseAckFrameMode(dataOrMgmtFrame)->getPhyRxStartDelay() : ackTimeout;
 }

simtime_t inet::ieee80211::OriginatorQoSAckPolicy::getBlockAckTimeout ( Ieee80211BlockAckReq * blockAckReq ) const

overridevirtual

Implements inet::ieee80211::IOriginatorQoSAckPolicy.

 {
     return blockAckTimeout == -1 ? modeSet->getSifsTime() + modeSet->getSlotTime() + rateSelection->computeResponseBlockAckFrameMode(blockAckReq)->getPhyRxStartDelay() : blockAckTimeout;
 }

std::map< MACAddress, std::vector< Ieee80211DataFrame * > > inet::ieee80211::OriginatorQoSAckPolicy::getOutstandingFramesPerReceiver ( InProgressFrames * inProgressFrames ) const

protectedvirtual

Referenced by computeBlockAckReqParameters(), and isBlockAckReqNeeded().

 {
     auto outstandingFrames = inProgressFrames->getOutstandingFrames();
     std::map<MACAddress, std::vector<Ieee80211DataFrame*>> outstandingFramesPerReceiver;
     for (auto frame : outstandingFrames)
         outstandingFramesPerReceiver[frame->getReceiverAddress()].push_back(frame);
     return outstandingFramesPerReceiver;
 }

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

overrideprotectedvirtual

Reimplemented from inet::ieee80211::ModeSetListener.

 {
     ModeSetListener::initialize(stage);
     if (stage == INITSTAGE_LOCAL) {
         rateSelection = check_and_cast<IQoSRateSelection*>(getModuleByPath(par("rateSelectionModule")));
         maxBlockAckPolicyFrameLength = par("maxBlockAckPolicyFrameLength");
         blockAckReqTreshold = par("blockAckReqTreshold");
         blockAckTimeout = par("blockAckTimeout");
         ackTimeout = par("ackTimeout");
     }
 }

bool inet::ieee80211::OriginatorQoSAckPolicy::isAckNeeded ( Ieee80211ManagementFrame * frame ) const

overridevirtual

Implements inet::ieee80211::IOriginatorQoSAckPolicy.

 {
     return !frame->getReceiverAddress().isMulticast();
 }

bool inet::ieee80211::OriginatorQoSAckPolicy::isBlockAckPolicyEligibleFrame ( Ieee80211DataFrame * frame ) const

overridevirtual

Implements inet::ieee80211::IOriginatorQoSAckPolicy.

Referenced by computeAckPolicy().

 {
     return frame->getType() == ST_DATA_WITH_QOS && frame->getByteLength() < maxBlockAckPolicyFrameLength;
 }

bool inet::ieee80211::OriginatorQoSAckPolicy::isBlockAckReqNeeded	(	InProgressFrames *	inProgressFrames,
		TxopProcedure *	txopProcedure
	)		const

overridevirtual

Implements inet::ieee80211::IOriginatorQoSAckPolicy.

 {
     auto outstandingFramesPerReceiver = getOutstandingFramesPerReceiver(inProgressFrames);
     for (auto outstandingFrames : outstandingFramesPerReceiver) {
         if ((int)outstandingFrames.second.size() >= blockAckReqTreshold)
             return true;
     }
     return false;
 }

bool inet::ieee80211::OriginatorQoSAckPolicy::isCompressedBlockAckReq	(	const std::vector< Ieee80211DataFrame * > &	outstandingFrames,
		int	startingSequenceNumber
	)		const

protectedvirtual

 {
     // The Compressed Bitmap subfield of the BA Control field or BAR Control field shall be set to 1 in all
     // BlockAck and BlockAckReq frames sent from one HT STA to another HT STA and shall be set to 0 otherwise.
     return false; // non-HT STA
 //    for (auto frame : outstandingFrames)
 //        if (frame->getSequenceNumber() >= startingSequenceNumber && frame->getFragmentNumber() > 0)
 //            return false;
 //    return true;
 }