Manages all block ack agreements for an originator station. More...
#include "block-ack-manager.h"
Public Types | |
typedef void(* | AgreementStateTracedCallback) (Time now, Mac48Address recipient, uint8_t tid, OriginatorBlockAckAgreement::State state) |
TracedCallback signature for state changes. More... | |
typedef Callback< void, Ptr< const WifiMacQueueItem > > | TxFailed |
typedef for a callback to invoke when an MPDU is negatively ack'ed. More... | |
typedef Callback< void, Ptr< const WifiMacQueueItem > > | TxOk |
typedef for a callback to invoke when an MPDU is successfully ack'ed. More... | |
Public Member Functions | |
BlockAckManager () | |
~BlockAckManager () | |
void | CreateAgreement (const MgtAddBaRequestHeader *reqHdr, Mac48Address recipient) |
void | DestroyAgreement (Mac48Address recipient, uint8_t tid) |
void | DiscardOutstandingMpdus (Mac48Address recipient, uint8_t tid) |
bool | ExistsAgreement (Mac48Address recipient, uint8_t tid) const |
bool | ExistsAgreementInState (Mac48Address recipient, uint8_t tid, OriginatorBlockAckAgreement::State state) const |
Ptr< const WifiMacQueueItem > | GetBar (bool remove=true, uint8_t tid=8, Mac48Address recipient=Mac48Address::GetBroadcast()) |
Returns the next BlockAckRequest or MU-BAR Trigger Frame to send, if any. More... | |
CtrlBAckRequestHeader | GetBlockAckReqHeader (Mac48Address recipient, uint8_t tid) const |
BlockAckReqType | GetBlockAckReqType (Mac48Address recipient, uint8_t tid) const |
This function returns the type of Block Acks sent to the recipient. More... | |
BlockAckType | GetBlockAckType (Mac48Address recipient, uint8_t tid) const |
This function returns the type of Block Acks sent by the recipient. More... | |
uint32_t | GetNBufferedPackets (Mac48Address recipient, uint8_t tid) const |
uint16_t | GetOriginatorStartingSequence (Mac48Address recipient, uint8_t tid) const |
This function returns the starting sequence number of the transmit window. More... | |
uint16_t | GetRecipientBufferSize (Mac48Address recipient, uint8_t tid) const |
This function returns the buffer size negotiated with the recipient. More... | |
Ptr< WifiMacQueue > | GetRetransmitQueue (void) |
bool | HasPackets (void) |
Returns true if there are packets that need of retransmission or at least a BAR is scheduled. More... | |
bool | NeedBarRetransmission (uint8_t tid, Mac48Address recipient) |
This function returns true if a block ack agreement is established with the given recipient for the given TID and there is at least an outstanding MPDU for such agreement whose lifetime is not expired. More... | |
void | NotifyAgreementEstablished (Mac48Address recipient, uint8_t tid, uint16_t startingSeq) |
void | NotifyAgreementNoReply (Mac48Address recipient, uint8_t tid) |
void | NotifyAgreementRejected (Mac48Address recipient, uint8_t tid) |
void | NotifyAgreementReset (Mac48Address recipient, uint8_t tid) |
void | NotifyDiscardedMpdu (Ptr< const WifiMacQueueItem > mpdu) |
void | NotifyGotAck (Ptr< const WifiMacQueueItem > mpdu) |
Invoked upon receipt of an Ack frame after the transmission of a QoS data frame sent under an established block ack agreement. More... | |
void | NotifyGotBlockAck (const CtrlBAckResponseHeader &blockAck, Mac48Address recipient, const std::set< uint8_t > &tids, double rxSnr, double dataSnr, const WifiTxVector &dataTxVector, size_t index=0) |
void | NotifyMissedAck (Ptr< WifiMacQueueItem > mpdu) |
Invoked upon missed reception of an Ack frame after the transmission of a QoS data frame sent under an established block ack agreement. More... | |
void | NotifyMissedBlockAck (Mac48Address recipient, uint8_t tid) |
void | ScheduleBar (Ptr< const WifiMacQueueItem > bar, bool skipIfNoDataQueued=false) |
void | SetBlockAckInactivityCallback (Callback< void, Mac48Address, uint8_t, bool > callback) |
Set block ack inactivity callback. More... | |
void | SetBlockAckThreshold (uint8_t nPackets) |
void | SetBlockDestinationCallback (Callback< void, Mac48Address, uint8_t > callback) |
Set block destination callback. More... | |
void | SetQueue (const Ptr< WifiMacQueue > queue) |
void | SetTxFailedCallback (TxFailed callback) |
void | SetTxOkCallback (TxOk callback) |
void | SetUnblockDestinationCallback (Callback< void, Mac48Address, uint8_t > callback) |
Set unblock destination callback. More... | |
void | SetWifiRemoteStationManager (const Ptr< WifiRemoteStationManager > manager) |
Set up WifiRemoteStationManager associated with this BlockAckManager. More... | |
void | StorePacket (Ptr< WifiMacQueueItem > mpdu) |
bool | SwitchToBlockAckIfNeeded (Mac48Address recipient, uint8_t tid, uint16_t startingSeq) |
void | UpdateAgreement (const MgtAddBaResponseHeader *respHdr, Mac48Address recipient, uint16_t startingSeq) |
![]() | |
Object () | |
Constructor. More... | |
virtual | ~Object () |
Destructor. More... | |
void | AggregateObject (Ptr< Object > other) |
Aggregate two Objects together. More... | |
void | Dispose (void) |
Dispose of this Object. More... | |
AggregateIterator | GetAggregateIterator (void) const |
Get an iterator to the Objects aggregated to this one. More... | |
virtual TypeId | GetInstanceTypeId (void) const |
Get the most derived TypeId for this Object. More... | |
template<> | |
Ptr< Object > | GetObject () const |
Specialization of () for objects of type ns3::Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (TypeId tid) const |
Get a pointer to the requested aggregated Object by TypeId. More... | |
template<> | |
Ptr< Object > | GetObject (TypeId tid) const |
Specialization of (TypeId tid) for objects of type ns3::Object. More... | |
template<typename T > | |
Ptr< T > | GetObject (void) const |
Get a pointer to the requested aggregated Object. More... | |
void | Initialize (void) |
Invoke DoInitialize on all Objects aggregated to this one. More... | |
bool | IsInitialized (void) const |
Check if the object has been initialized. More... | |
![]() | |
SimpleRefCount () | |
Default constructor. More... | |
SimpleRefCount (const SimpleRefCount &o) | |
Copy constructor. More... | |
uint32_t | GetReferenceCount (void) const |
Get the reference count of the object. More... | |
SimpleRefCount & | operator= (const SimpleRefCount &o) |
Assignment operator. More... | |
void | Ref (void) const |
Increment the reference count. More... | |
void | Unref (void) const |
Decrement the reference count. More... | |
![]() | |
virtual | ~ObjectBase () |
Virtual destructor. More... | |
void | GetAttribute (std::string name, AttributeValue &value) const |
Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
Get the value of an attribute without raising erros. More... | |
void | SetAttribute (std::string name, const AttributeValue &value) |
Set a single attribute, raising fatal errors if unsuccessful. More... | |
bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
Set a single attribute without raising errors. More... | |
bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
Connect a TraceSource to a Callback with a context. More... | |
bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
Connect a TraceSource to a Callback without a context. More... | |
bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected with a context. More... | |
bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Register this type. More... | |
![]() | |
static TypeId | GetTypeId (void) |
Get the type ID. More... | |
Private Types | |
typedef std::map< std::pair< Mac48Address, uint8_t >, std::pair< OriginatorBlockAckAgreement, PacketQueue > > | Agreements |
typedef for a map between MAC address and block ack agreement. More... | |
typedef std::map< std::pair< Mac48Address, uint8_t >, std::pair< OriginatorBlockAckAgreement, PacketQueue > >::const_iterator | AgreementsCI |
typedef for a const iterator for Agreements. More... | |
typedef std::map< std::pair< Mac48Address, uint8_t >, std::pair< OriginatorBlockAckAgreement, PacketQueue > >::iterator | AgreementsI |
typedef for an iterator for Agreements. More... | |
typedef std::list< Ptr< WifiMacQueueItem > > | PacketQueue |
typedef for a list of WifiMacQueueItem. More... | |
typedef std::list< Ptr< WifiMacQueueItem > >::const_iterator | PacketQueueCI |
typedef for a const iterator for PacketQueue. More... | |
typedef std::list< Ptr< WifiMacQueueItem > >::iterator | PacketQueueI |
typedef for an iterator for PacketQueue. More... | |
Private Member Functions | |
BlockAckManager (const BlockAckManager &) | |
type conversion operator More... | |
void | InactivityTimeout (Mac48Address recipient, uint8_t tid) |
Inactivity timeout function. More... | |
void | InsertInRetryQueue (Ptr< WifiMacQueueItem > mpdu) |
BlockAckManager & | operator= (const BlockAckManager &block) |
assignment operator More... | |
void | RemoveFromRetryQueue (Mac48Address address, uint8_t tid, uint16_t seq) |
Remove an item from retransmission queue. More... | |
void | RemoveFromRetryQueue (Mac48Address address, uint8_t tid, uint16_t startSeq, uint16_t endSeq) |
Remove a range of items from retransmission queue. More... | |
void | RemoveOldPackets (Mac48Address recipient, uint8_t tid, uint16_t startingSeq) |
Remove packets from the retransmit queue and from the queue of outstanding packets that become old after setting the starting sequence number for the agreement with recipient equal to recipient and TID equal to tid to the given startingSeq. More... | |
Private Attributes | |
Agreements | m_agreements |
This data structure contains, for each block ack agreement (recipient, TID), a set of packets for which an ack by block ack is requested. More... | |
TracedCallback< Time, Mac48Address, uint8_t, OriginatorBlockAckAgreement::State > | m_agreementState |
The trace source fired when a state transition occurred. More... | |
std::list< Bar > | m_bars |
list of BARs More... | |
Callback< void, Mac48Address, uint8_t, bool > | m_blockAckInactivityTimeout |
BlockAck inactivity timeout callback. More... | |
uint8_t | m_blockAckThreshold |
block ack threshold More... | |
Callback< void, Mac48Address, uint8_t > | m_blockPackets |
block packets callback More... | |
Ptr< WifiMacQueue > | m_queue |
queue More... | |
Ptr< WifiMacQueue > | m_retryPackets |
This list contains all iterators to stored packets that need to be retransmitted. More... | |
Ptr< WifiRemoteStationManager > | m_stationManager |
the station manager More... | |
TxFailed | m_txFailedCallback |
transmit failed callback More... | |
TxOk | m_txOkCallback |
transmit OK callback More... | |
Callback< void, Mac48Address, uint8_t > | m_unblockPackets |
unblock packets callback More... | |
Additional Inherited Members | |
![]() | |
Object (const Object &o) | |
Copy an Object. More... | |
virtual void | DoDispose (void) |
Destructor implementation. More... | |
virtual void | DoInitialize (void) |
Initialize() implementation. More... | |
virtual void | NotifyNewAggregate (void) |
Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
![]() | |
void | ConstructSelf (const AttributeConstructionList &attributes) |
Complete construction of ObjectBase; invoked by derived classes. More... | |
virtual void | NotifyConstructionCompleted (void) |
Notifier called once the ObjectBase is fully constructed. More... | |
![]() | |
static TypeId | GetObjectIid (void) |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Manages all block ack agreements for an originator station.
ns3::BlockAckManager is accessible through the following paths with Config::Set and Config::Connect:
No Attributes are defined for this type.
Size of this type is 200 bytes (on a 64-bit architecture).
Definition at line 70 of file block-ack-manager.h.
|
private |
typedef for a map between MAC address and block ack agreement.
Definition at line 470 of file block-ack-manager.h.
|
private |
typedef for a const iterator for Agreements.
Definition at line 480 of file block-ack-manager.h.
|
private |
typedef for an iterator for Agreements.
Definition at line 475 of file block-ack-manager.h.
typedef void(* ns3::BlockAckManager::AgreementStateTracedCallback) (Time now, Mac48Address recipient, uint8_t tid, OriginatorBlockAckAgreement::State state) |
TracedCallback signature for state changes.
[in] | now | Time when the state changed. |
[in] | recipient | MAC address of the recipient. |
[in] | tid | the TID. |
[in] | state | The state. |
Definition at line 399 of file block-ack-manager.h.
|
private |
typedef for a list of WifiMacQueueItem.
Definition at line 457 of file block-ack-manager.h.
|
private |
typedef for a const iterator for PacketQueue.
Definition at line 465 of file block-ack-manager.h.
|
private |
typedef for an iterator for PacketQueue.
Definition at line 461 of file block-ack-manager.h.
typedef Callback<void, Ptr<const WifiMacQueueItem> > ns3::BlockAckManager::TxFailed |
typedef for a callback to invoke when an MPDU is negatively ack'ed.
Definition at line 379 of file block-ack-manager.h.
typedef Callback<void, Ptr<const WifiMacQueueItem> > ns3::BlockAckManager::TxOk |
typedef for a callback to invoke when an MPDU is successfully ack'ed.
Definition at line 375 of file block-ack-manager.h.
|
private |
type conversion operator
ns3::BlockAckManager::BlockAckManager | ( | ) |
Definition at line 65 of file block-ack-manager.cc.
References m_retryPackets, ns3::MakeCallback(), NotifyDiscardedMpdu(), and NS_LOG_FUNCTION.
ns3::BlockAckManager::~BlockAckManager | ( | ) |
Definition at line 72 of file block-ack-manager.cc.
References m_agreements, m_queue, m_retryPackets, and NS_LOG_FUNCTION.
void ns3::BlockAckManager::CreateAgreement | ( | const MgtAddBaRequestHeader * | reqHdr, |
Mac48Address | recipient | ||
) |
reqHdr | Relative Add block ack request (action frame). |
recipient | Address of peer station involved in block ack mechanism. |
Creates a new block ack agreement in pending state. When a ADDBA response with a successful status code is received, the relative agreement becomes established.
Definition at line 115 of file block-ack-manager.cc.
References ExistsAgreement(), ExistsAgreementInState(), ns3::MgtAddBaRequestHeader::GetBufferSize(), ns3::WifiRemoteStationManager::GetHtSupported(), ns3::MgtAddBaRequestHeader::GetStartingSequence(), ns3::MgtAddBaRequestHeader::GetTid(), ns3::MgtAddBaRequestHeader::GetTimeout(), ns3::MgtAddBaRequestHeader::IsAmsduSupported(), ns3::MgtAddBaRequestHeader::IsImmediateBlockAck(), m_agreements, m_agreementState, m_blockPackets, m_stationManager, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, ns3::OriginatorBlockAckAgreement::PENDING, ns3::OriginatorBlockAckAgreement::RESET, ns3::BlockAckAgreement::SetAmsduSupport(), ns3::BlockAckAgreement::SetBufferSize(), ns3::BlockAckAgreement::SetDelayedBlockAck(), ns3::BlockAckAgreement::SetHtSupported(), ns3::BlockAckAgreement::SetImmediateBlockAck(), ns3::BlockAckAgreement::SetStartingSequence(), ns3::OriginatorBlockAckAgreement::SetState(), and ns3::BlockAckAgreement::SetTimeout().
void ns3::BlockAckManager::DestroyAgreement | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) |
recipient | Address of peer station involved in block ack mechanism. |
tid | traffic ID of transmitted packet. |
Invoked when a recipient reject a block ack agreement or when a DELBA frame is Received/Transmitted.
Definition at line 151 of file block-ack-manager.cc.
References m_agreements, m_bars, m_retryPackets, and NS_LOG_FUNCTION.
void ns3::BlockAckManager::DiscardOutstandingMpdus | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) |
recipient | outstanding frames' receiver. |
tid | Traffic ID. |
Discard all the outstanding MPDUs destined to the given receiver and belonging to the given TID. Typically, this function is called by ns3::QosTxop object when it gives up retransmitting either a BlockAckRequest or the Data frames.
Definition at line 582 of file block-ack-manager.cc.
References ns3::OriginatorBlockAckAgreement::ESTABLISHED, ExistsAgreementInState(), ns3::WifiMacQueueItem::GetHeader(), ns3::WifiMacHeader::GetSequenceNumber(), m_agreements, NotifyDiscardedMpdu(), NS_LOG_FUNCTION, and ns3::SEQNO_SPACE_HALF_SIZE.
bool ns3::BlockAckManager::ExistsAgreement | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) | const |
recipient | Address of peer station involved in block ack mechanism. |
tid | Traffic ID. |
Checks if a block ack agreement exists with station addressed by recipient for TID tid.
Definition at line 81 of file block-ack-manager.cc.
References m_agreements, and NS_LOG_FUNCTION.
Referenced by CreateAgreement(), and SwitchToBlockAckIfNeeded().
bool ns3::BlockAckManager::ExistsAgreementInState | ( | Mac48Address | recipient, |
uint8_t | tid, | ||
OriginatorBlockAckAgreement::State | state | ||
) | const |
recipient | Address of peer station involved in block ack mechanism. |
tid | Traffic ID. |
state | The state for block ack agreement |
Checks if a block ack agreement with a state equals to state exists with station addressed by recipient for TID tid.
Definition at line 88 of file block-ack-manager.cc.
References ns3::OriginatorBlockAckAgreement::ESTABLISHED, m_agreements, ns3::OriginatorBlockAckAgreement::NO_REPLY, NS_FATAL_ERROR, ns3::OriginatorBlockAckAgreement::PENDING, ns3::OriginatorBlockAckAgreement::REJECTED, and ns3::OriginatorBlockAckAgreement::RESET.
Referenced by CreateAgreement(), DiscardOutstandingMpdus(), NeedBarRetransmission(), NotifyDiscardedMpdu(), NotifyGotAck(), NotifyGotBlockAck(), NotifyMissedAck(), NotifyMissedBlockAck(), and SwitchToBlockAckIfNeeded().
Ptr< const WifiMacQueueItem > ns3::BlockAckManager::GetBar | ( | bool | remove = true , |
uint8_t | tid = 8 , |
||
Mac48Address | recipient = Mac48Address::GetBroadcast () |
||
) |
Returns the next BlockAckRequest or MU-BAR Trigger Frame to send, if any.
If the given recipient is not the broadcast address and the given TID is less than 8, then only return a BlockAckRequest, if any, addressed to that recipient and for the given TID.
remove | true if the BAR has to be removed from the queue |
tid | the TID |
recipient | the recipient of the BAR |
Definition at line 276 of file block-ack-manager.cc.
References ns3::Packet::AddHeader(), first::address, ns3::WifiMacQueue::EMPTY, ns3::Mac48Address::GetBroadcast(), ns3::CtrlBAckRequestHeader::GetStartingSequence(), m_agreements, m_bars, m_queue, m_retryPackets, ns3::Simulator::Now(), and ns3::CtrlBAckRequestHeader::SetStartingSequence().
Referenced by HasPackets().
CtrlBAckRequestHeader ns3::BlockAckManager::GetBlockAckReqHeader | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) | const |
recipient | the recipient |
tid | the TID |
Get the BlockAckRequest header for the established BA agreement (recipient,tid).
Definition at line 656 of file block-ack-manager.cc.
References m_agreements, NS_ASSERT, NS_LOG_FUNCTION, ns3::CtrlBAckRequestHeader::SetStartingSequence(), ns3::CtrlBAckRequestHeader::SetTidInfo(), and ns3::CtrlBAckRequestHeader::SetType().
Referenced by NotifyDiscardedMpdu().
BlockAckReqType ns3::BlockAckManager::GetBlockAckReqType | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) | const |
This function returns the type of Block Acks sent to the recipient.
recipient | MAC address of recipient |
tid | Traffic ID |
Definition at line 990 of file block-ack-manager.cc.
References m_agreements, and NS_ABORT_MSG_IF.
BlockAckType ns3::BlockAckManager::GetBlockAckType | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) | const |
This function returns the type of Block Acks sent by the recipient.
recipient | MAC address |
tid | Traffic ID |
Definition at line 998 of file block-ack-manager.cc.
References m_agreements, and NS_ABORT_MSG_IF.
uint32_t ns3::BlockAckManager::GetNBufferedPackets | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) | const |
recipient | Address of peer station involved in block ack mechanism. |
tid | Traffic ID. |
Returns the number of packets buffered for a specified agreement. This methods doesn't return the number of buffered MPDUs but the number of buffered MSDUs.
Definition at line 358 of file block-ack-manager.cc.
References m_agreements, and NS_LOG_FUNCTION.
Referenced by SwitchToBlockAckIfNeeded().
uint16_t ns3::BlockAckManager::GetOriginatorStartingSequence | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) | const |
This function returns the starting sequence number of the transmit window.
tid | Traffic ID |
recipient | MAC address of the recipient |
Definition at line 1006 of file block-ack-manager.cc.
References m_agreements.
uint16_t ns3::BlockAckManager::GetRecipientBufferSize | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) | const |
This function returns the buffer size negotiated with the recipient.
tid | Traffic ID |
recipient | MAC address of the recipient |
Definition at line 978 of file block-ack-manager.cc.
References m_agreements.
Ptr< WifiMacQueue > ns3::BlockAckManager::GetRetransmitQueue | ( | void | ) |
Return the retransmit queue.
Definition at line 225 of file block-ack-manager.cc.
References m_retryPackets.
|
static |
Get the type ID.
Definition at line 51 of file block-ack-manager.cc.
References m_agreementState, ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().
bool ns3::BlockAckManager::HasPackets | ( | void | ) |
Returns true if there are packets that need of retransmission or at least a BAR is scheduled.
Returns false otherwise.
Definition at line 351 of file block-ack-manager.cc.
References GetBar(), m_retryPackets, and NS_LOG_FUNCTION.
|
private |
Inactivity timeout function.
recipient | the recipient MAC address |
tid | Traffic ID |
Definition at line 719 of file block-ack-manager.cc.
References m_blockAckInactivityTimeout, and NS_LOG_FUNCTION.
Referenced by NotifyGotBlockAck(), and UpdateAgreement().
|
private |
mpdu | the packet to insert in the retransmission queue |
Insert mpdu in retransmission queue. This method ensures packets are retransmitted in the correct order.
Definition at line 934 of file block-ack-manager.cc.
References ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetFragmentNumber(), ns3::WifiMacQueueItem::GetHeader(), ns3::WifiMacHeader::GetQosTid(), ns3::WifiMacHeader::GetSequenceControl(), ns3::WifiMacHeader::GetSequenceNumber(), ns3::WifiMacHeader::IsQosData(), m_agreements, m_retryPackets, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_INFO, ns3::SEQNO_SPACE_HALF_SIZE, and ns3::WifiMacHeader::SetRetry().
Referenced by NotifyGotBlockAck(), NotifyMissedAck(), and NotifyMissedBlockAck().
bool ns3::BlockAckManager::NeedBarRetransmission | ( | uint8_t | tid, |
Mac48Address | recipient | ||
) |
This function returns true if a block ack agreement is established with the given recipient for the given TID and there is at least an outstanding MPDU for such agreement whose lifetime is not expired.
tid | Traffic ID |
recipient | MAC address of the recipient |
Definition at line 804 of file block-ack-manager.cc.
References ns3::OriginatorBlockAckAgreement::ESTABLISHED, ExistsAgreementInState(), m_agreements, m_queue, ns3::Simulator::Now(), and NS_ASSERT.
void ns3::BlockAckManager::NotifyAgreementEstablished | ( | Mac48Address | recipient, |
uint8_t | tid, | ||
uint16_t | startingSeq | ||
) |
recipient | Address of peer station involved in block ack mechanism. |
tid | Traffic ID of transmitted packet. |
startingSeq | starting sequence field |
Puts corresponding agreement in established state and updates number of packets and starting sequence field. Invoked typically after a block ack refresh.
Definition at line 726 of file block-ack-manager.cc.
References ns3::OriginatorBlockAckAgreement::ESTABLISHED, m_agreements, m_agreementState, ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by SwitchToBlockAckIfNeeded().
void ns3::BlockAckManager::NotifyAgreementNoReply | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) |
recipient | Address of peer station involved in block ack mechanism. |
tid | Traffic ID of transmitted packet. |
Marks an agreement after not receiving response to ADDBA request. During this state any packets in queue will be transmitted using normal MPDU. This also unblock recipient address.
Definition at line 753 of file block-ack-manager.cc.
References m_agreements, m_agreementState, m_unblockPackets, ns3::OriginatorBlockAckAgreement::NO_REPLY, ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.
void ns3::BlockAckManager::NotifyAgreementRejected | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) |
recipient | Address of peer station involved in block ack mechanism. |
tid | Traffic ID of transmitted packet. |
Marks an agreement as rejected. This happens if recipient station reject block ack setup by an ADDBA Response frame with a failure status code. For now we assume that every QoS station accepts a block ack setup.
Definition at line 740 of file block-ack-manager.cc.
References m_agreements, m_agreementState, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::OriginatorBlockAckAgreement::REJECTED.
void ns3::BlockAckManager::NotifyAgreementReset | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) |
recipient | Address of peer station involved in block ack mechanism. |
tid | Traffic ID of transmitted packet. |
Set BA agreement to a transitory state to reset it after not receiving response to ADDBA request.
Definition at line 767 of file block-ack-manager.cc.
References m_agreements, m_agreementState, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::OriginatorBlockAckAgreement::RESET.
void ns3::BlockAckManager::NotifyDiscardedMpdu | ( | Ptr< const WifiMacQueueItem > | mpdu | ) |
mpdu | the discarded frame |
Notify the block ack manager that an MPDU has been discarded, e.g., because the MSDU lifetime expired. If there is an established block ack agreement, make the transmit window advance beyond the discarded frame. This also involves (i) the removal of frames that consequently become old from the retransmit queue and from the queue of the block ack agreement, and (ii) the scheduling of a BlockAckRequest.
Definition at line 605 of file block-ack-manager.cc.
References ns3::Packet::AddHeader(), ns3::OriginatorBlockAckAgreement::ESTABLISHED, ExistsAgreementInState(), GetBlockAckReqHeader(), m_agreements, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::QosUtilsIsOldPacket(), RemoveOldPackets(), ScheduleBar(), ns3::SEQNO_SPACE_SIZE, ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetAddr3(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), ns3::WifiMacHeader::SetNoMoreFragments(), ns3::WifiMacHeader::SetNoRetry(), ns3::WifiMacHeader::SetType(), and ns3::WIFI_MAC_CTL_BACKREQ.
Referenced by BlockAckManager(), and DiscardOutstandingMpdus().
void ns3::BlockAckManager::NotifyGotAck | ( | Ptr< const WifiMacQueueItem > | mpdu | ) |
Invoked upon receipt of an Ack frame after the transmission of a QoS data frame sent under an established block ack agreement.
Remove the acknowledged frame from the outstanding packets and update the starting sequence number of the transmit window, if needed.
mpdu | The acknowledged MPDU. |
Definition at line 396 of file block-ack-manager.cc.
References ns3::OriginatorBlockAckAgreement::ESTABLISHED, ExistsAgreementInState(), m_agreements, NS_ASSERT, and NS_LOG_FUNCTION.
void ns3::BlockAckManager::NotifyGotBlockAck | ( | const CtrlBAckResponseHeader & | blockAck, |
Mac48Address | recipient, | ||
const std::set< uint8_t > & | tids, | ||
double | rxSnr, | ||
double | dataSnr, | ||
const WifiTxVector & | dataTxVector, | ||
size_t | index = 0 |
||
) |
blockAck | The received BlockAck frame. |
recipient | Sender of BlockAck frame. |
tids | the set of TIDs the acknowledged MPDUs belong to |
rxSnr | received SNR of the BlockAck frame itself |
dataSnr | data SNR reported by remote station |
dataTxVector | the TXVECTOR used to send the Data |
index | the index of the Per AID TID Info subfield, in case of Multi-STA Block Ack, or 0, otherwise |
Invoked upon receipt of a BlockAck frame. Typically, this function, is called by ns3::QosTxop object. Performs a check on which MPDUs, previously sent with Ack Policy set to Block Ack, were correctly received by the recipient. An acknowledged MPDU is removed from the buffer, retransmitted otherwise. Note that tids is only used if blockAck is a Multi-STA Block Ack using All-ack context.
Definition at line 458 of file block-ack-manager.cc.
References ns3::OriginatorBlockAckAgreement::ESTABLISHED, ExistsAgreementInState(), ns3::CtrlBAckResponseHeader::GetAckType(), ns3::CtrlBAckResponseHeader::GetTidInfo(), InactivityTimeout(), InsertInRetryQueue(), ns3::CtrlBAckResponseHeader::IsBasic(), ns3::CtrlBAckResponseHeader::IsCompressed(), ns3::CtrlBAckResponseHeader::IsExtendedCompressed(), ns3::CtrlBAckResponseHeader::IsFragmentReceived(), ns3::CtrlBAckResponseHeader::IsMultiSta(), ns3::CtrlBAckResponseHeader::IsMultiTid(), ns3::Callback< R, T1, T2, T3, T4, T5, T6, T7, T8, T9 >::IsNull(), ns3::CtrlBAckResponseHeader::IsPacketReceived(), m_agreements, m_stationManager, m_txFailedCallback, m_txOkCallback, ns3::MicroSeconds(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_FUNCTION, ns3::QosUtilsIsOldPacket(), RemoveOldPackets(), ns3::WifiRemoteStationManager::ReportAmpduTxStatus(), ns3::Simulator::Schedule(), ns3::SEQNO_SPACE_SIZE, and timeout.
void ns3::BlockAckManager::NotifyMissedAck | ( | Ptr< WifiMacQueueItem > | mpdu | ) |
Invoked upon missed reception of an Ack frame after the transmission of a QoS data frame sent under an established block ack agreement.
Remove the acknowledged frame from the outstanding packets and insert it in the retransmission queue.
mpdu | The unacknowledged MPDU. |
Definition at line 426 of file block-ack-manager.cc.
References ns3::OriginatorBlockAckAgreement::ESTABLISHED, ExistsAgreementInState(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacQueueItem::GetHeader(), ns3::WifiMacHeader::GetQosTid(), ns3::WifiMacHeader::GetSequenceNumber(), InsertInRetryQueue(), ns3::WifiMacHeader::IsQosData(), m_agreements, NS_ASSERT, and NS_LOG_FUNCTION.
void ns3::BlockAckManager::NotifyMissedBlockAck | ( | Mac48Address | recipient, |
uint8_t | tid | ||
) |
recipient | Sender of the expected BlockAck frame. |
tid | Traffic ID. |
Invoked upon missed reception of a block ack frame. Typically, this function, is called by ns3::QosTxop object. Performs a check on which MPDUs, previously sent with ack policy set to Block Ack, should be placed in the retransmission queue.
Definition at line 564 of file block-ack-manager.cc.
References ns3::OriginatorBlockAckAgreement::ESTABLISHED, ExistsAgreementInState(), InsertInRetryQueue(), m_agreements, and NS_LOG_FUNCTION.
|
private |
|
private |
Remove an item from retransmission queue.
This method should be called when packets are acknowledged.
address | recipient MAC address of the packet to be removed |
tid | Traffic ID of the packet to be removed |
seq | sequence number of the packet to be removed |
Definition at line 827 of file block-ack-manager.cc.
References first::address.
Referenced by RemoveOldPackets().
|
private |
Remove a range of items from retransmission queue.
This method should be called when packets are acknowledged.
address | recipient MAC address of the packet to be removed |
tid | Traffic ID of the packet to be removed |
startSeq | sequence number of the first packet to be removed |
endSeq | sequence number of the last packet to be removed |
Definition at line 833 of file block-ack-manager.cc.
References first::address, m_agreements, m_retryPackets, NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
|
private |
Remove packets from the retransmit queue and from the queue of outstanding packets that become old after setting the starting sequence number for the agreement with recipient equal to recipient and TID equal to tid to the given startingSeq.
recipient | the recipient MAC address |
tid | Traffic ID |
startingSeq | the new starting sequence number |
Definition at line 862 of file block-ack-manager.cc.
References m_agreements, NS_ABORT_MSG_IF, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, RemoveFromRetryQueue(), ns3::SEQNO_SPACE_HALF_SIZE, and ns3::SEQNO_SPACE_SIZE.
Referenced by NotifyDiscardedMpdu(), and NotifyGotBlockAck().
void ns3::BlockAckManager::ScheduleBar | ( | Ptr< const WifiMacQueueItem > | bar, |
bool | skipIfNoDataQueued = false |
||
) |
bar | the BlockAckRequest to enqueue |
skipIfNoDataQueued | do not send if there is no data queued |
Enqueue the given BlockAckRequest into the queue storing the next BAR frames to transmit. If a BAR for the same recipient and TID is already present in the queue, it is replaced by the new one. If the given BAR is retransmitted, it is placed at the head of the queue, otherwise at the tail.
Definition at line 670 of file block-ack-manager.cc.
References ns3::CtrlBAckRequestHeader::GetTidInfo(), ns3::CtrlTriggerHeader::IsMuBar(), m_bars, NS_ASSERT, and NS_LOG_FUNCTION.
Referenced by NotifyDiscardedMpdu().
void ns3::BlockAckManager::SetBlockAckInactivityCallback | ( | Callback< void, Mac48Address, uint8_t, bool > | callback | ) |
Set block ack inactivity callback.
callback | the block ack inactivity callback function |
Definition at line 901 of file block-ack-manager.cc.
References m_blockAckInactivityTimeout, and NS_LOG_FUNCTION.
void ns3::BlockAckManager::SetBlockAckThreshold | ( | uint8_t | nPackets | ) |
nPackets | Minimum number of packets for use of block ack. |
Upon receipt of a BlockAck frame, if total number of packets (packets in WifiMacQueue and buffered packets) is greater of nPackets, they are transmitted using block ack mechanism.
Definition at line 382 of file block-ack-manager.cc.
References m_blockAckThreshold, and NS_LOG_FUNCTION.
void ns3::BlockAckManager::SetBlockDestinationCallback | ( | Callback< void, Mac48Address, uint8_t > | callback | ) |
Set block destination callback.
callback | the block destination callback |
Definition at line 908 of file block-ack-manager.cc.
References m_blockPackets, and NS_LOG_FUNCTION.
void ns3::BlockAckManager::SetQueue | ( | const Ptr< WifiMacQueue > | queue | ) |
queue | The WifiMacQueue object. |
Definition at line 780 of file block-ack-manager.cc.
References m_queue, and NS_LOG_FUNCTION.
void ns3::BlockAckManager::SetTxFailedCallback | ( | TxFailed | callback | ) |
callback | the callback to invoke when a packet transmission was completed unsuccessfully. |
Definition at line 928 of file block-ack-manager.cc.
References m_txFailedCallback.
void ns3::BlockAckManager::SetTxOkCallback | ( | TxOk | callback | ) |
callback | the callback to invoke when a packet transmission was completed successfully. |
Definition at line 922 of file block-ack-manager.cc.
References m_txOkCallback.
void ns3::BlockAckManager::SetUnblockDestinationCallback | ( | Callback< void, Mac48Address, uint8_t > | callback | ) |
Set unblock destination callback.
callback | the unblock destination callback |
Definition at line 915 of file block-ack-manager.cc.
References m_unblockPackets, and NS_LOG_FUNCTION.
void ns3::BlockAckManager::SetWifiRemoteStationManager | ( | const Ptr< WifiRemoteStationManager > | manager | ) |
Set up WifiRemoteStationManager associated with this BlockAckManager.
manager | WifiRemoteStationManager associated with this BlockAckManager |
Definition at line 389 of file block-ack-manager.cc.
References m_stationManager, and NS_LOG_FUNCTION.
void ns3::BlockAckManager::StorePacket | ( | Ptr< WifiMacQueueItem > | mpdu | ) |
mpdu | MPDU to store. |
Stores mpdu for a possible future retransmission. Retransmission occurs if the packet, in a BlockAck frame, is indicated by recipient as not received.
Definition at line 231 of file block-ack-manager.cc.
References ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacHeader::GetFragmentNumber(), ns3::WifiMacQueueItem::GetHeader(), ns3::WifiMacHeader::GetQosTid(), ns3::WifiMacHeader::GetSequenceControl(), ns3::WifiMacHeader::GetSequenceNumber(), ns3::WifiMacHeader::IsQosData(), m_agreements, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::SEQNO_SPACE_HALF_SIZE.
bool ns3::BlockAckManager::SwitchToBlockAckIfNeeded | ( | Mac48Address | recipient, |
uint8_t | tid, | ||
uint16_t | startingSeq | ||
) |
recipient | the destination address |
tid | the Traffic ID |
startingSeq | the starting sequence number |
Checks if there are in the queue other packets that could be send under block ack. If yes adds these packets in current block ack exchange. However, number of packets exchanged in the current block ack, will not exceed the value of BufferSize in the corresponding OriginatorBlockAckAgreement object.
Definition at line 787 of file block-ack-manager.cc.
References ExistsAgreement(), ExistsAgreementInState(), GetNBufferedPackets(), m_blockAckThreshold, m_queue, NotifyAgreementEstablished(), NS_ASSERT, NS_LOG_FUNCTION, ns3::OriginatorBlockAckAgreement::PENDING, and ns3::OriginatorBlockAckAgreement::REJECTED.
void ns3::BlockAckManager::UpdateAgreement | ( | const MgtAddBaResponseHeader * | respHdr, |
Mac48Address | recipient, | ||
uint16_t | startingSeq | ||
) |
respHdr | Relative Add block ack response (action frame). |
recipient | Address of peer station involved in block ack mechanism. |
startingSeq | the updated starting sequence number |
Invoked upon receipt of a ADDBA response frame from recipient.
Definition at line 185 of file block-ack-manager.cc.
References ns3::OriginatorBlockAckAgreement::ESTABLISHED, ns3::MgtAddBaResponseHeader::GetBufferSize(), ns3::MgtAddBaResponseHeader::GetTid(), ns3::BlockAckAgreement::GetTimeout(), ns3::MgtAddBaResponseHeader::GetTimeout(), InactivityTimeout(), ns3::OriginatorBlockAckAgreement::InitTxWindow(), ns3::MgtAddBaResponseHeader::IsAmsduSupported(), ns3::MgtAddBaResponseHeader::IsImmediateBlockAck(), m_agreements, m_agreementState, ns3::BlockAckAgreement::m_inactivityEvent, m_unblockPackets, ns3::MicroSeconds(), ns3::Simulator::Now(), NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::BlockAckAgreement::SetAmsduSupport(), ns3::BlockAckAgreement::SetBufferSize(), ns3::BlockAckAgreement::SetDelayedBlockAck(), ns3::BlockAckAgreement::SetImmediateBlockAck(), ns3::BlockAckAgreement::SetStartingSequence(), ns3::OriginatorBlockAckAgreement::SetState(), ns3::BlockAckAgreement::SetTimeout(), and timeout.
|
private |
This data structure contains, for each block ack agreement (recipient, TID), a set of packets for which an ack by block ack is requested.
Every packet or fragment indicated as correctly received in BlockAck frame is erased from this data structure. Pushed back in retransmission queue otherwise.
Definition at line 517 of file block-ack-manager.h.
Referenced by ~BlockAckManager(), CreateAgreement(), DestroyAgreement(), DiscardOutstandingMpdus(), ExistsAgreement(), ExistsAgreementInState(), GetBar(), GetBlockAckReqHeader(), GetBlockAckReqType(), GetBlockAckType(), GetNBufferedPackets(), GetOriginatorStartingSequence(), GetRecipientBufferSize(), InsertInRetryQueue(), NeedBarRetransmission(), NotifyAgreementEstablished(), NotifyAgreementNoReply(), NotifyAgreementRejected(), NotifyAgreementReset(), NotifyDiscardedMpdu(), NotifyGotAck(), NotifyGotBlockAck(), NotifyMissedAck(), NotifyMissedBlockAck(), RemoveFromRetryQueue(), RemoveOldPackets(), StorePacket(), and UpdateAgreement().
|
private |
The trace source fired when a state transition occurred.
Definition at line 539 of file block-ack-manager.h.
Referenced by CreateAgreement(), GetTypeId(), NotifyAgreementEstablished(), NotifyAgreementNoReply(), NotifyAgreementRejected(), NotifyAgreementReset(), and UpdateAgreement().
list of BARs
Definition at line 525 of file block-ack-manager.h.
Referenced by DestroyAgreement(), GetBar(), and ScheduleBar().
|
private |
BlockAck inactivity timeout callback.
Definition at line 529 of file block-ack-manager.h.
Referenced by InactivityTimeout(), and SetBlockAckInactivityCallback().
|
private |
block ack threshold
Definition at line 527 of file block-ack-manager.h.
Referenced by SetBlockAckThreshold(), and SwitchToBlockAckIfNeeded().
|
private |
block packets callback
Definition at line 530 of file block-ack-manager.h.
Referenced by CreateAgreement(), and SetBlockDestinationCallback().
|
private |
queue
Definition at line 528 of file block-ack-manager.h.
Referenced by ~BlockAckManager(), GetBar(), NeedBarRetransmission(), SetQueue(), and SwitchToBlockAckIfNeeded().
|
private |
This list contains all iterators to stored packets that need to be retransmitted.
A packet needs retransmission if it's indicated as not correctly received in a BlockAck frame.
Definition at line 524 of file block-ack-manager.h.
Referenced by BlockAckManager(), ~BlockAckManager(), DestroyAgreement(), GetBar(), GetRetransmitQueue(), HasPackets(), InsertInRetryQueue(), and RemoveFromRetryQueue().
|
private |
the station manager
Definition at line 534 of file block-ack-manager.h.
Referenced by CreateAgreement(), NotifyGotBlockAck(), and SetWifiRemoteStationManager().
|
private |
transmit failed callback
Definition at line 533 of file block-ack-manager.h.
Referenced by NotifyGotBlockAck(), and SetTxFailedCallback().
|
private |
transmit OK callback
Definition at line 532 of file block-ack-manager.h.
Referenced by NotifyGotBlockAck(), and SetTxOkCallback().
|
private |
unblock packets callback
Definition at line 531 of file block-ack-manager.h.
Referenced by NotifyAgreementNoReply(), SetUnblockDestinationCallback(), and UpdateAgreement().