A Discrete-Event Network Simulator
API
block-ack-manager.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2009, 2010 MIRKO BANCHI
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Author: Mirko Banchi <mk.banchi@gmail.com>
19 */
20
21#ifndef BLOCK_ACK_MANAGER_H
22#define BLOCK_ACK_MANAGER_H
23
24#include <map>
25#include "ns3/nstime.h"
26#include "ns3/traced-callback.h"
27#include "wifi-mac-header.h"
29#include "block-ack-type.h"
30#include "wifi-mpdu.h"
31#include "wifi-tx-vector.h"
32
33namespace ns3 {
34
35class MgtAddBaResponseHeader;
36class MgtAddBaRequestHeader;
37class CtrlBAckResponseHeader;
38class CtrlBAckRequestHeader;
39class WifiMacQueue;
40class WifiMode;
41class Packet;
42
48struct Bar
49{
50 Bar ();
58 Bar (Ptr<const WifiMpdu> bar, uint8_t tid, bool skipIfNoDataQueued = false);
60 uint8_t tid;
62};
63
64
69class BlockAckManager : public Object
70{
71private:
75 enum MpduStatus : uint8_t
76 {
80 };
81
82public:
87 static TypeId GetTypeId (void);
88
91
92 // Delete copy constructor and assignment operator to avoid misuse
93 BlockAckManager (const BlockAckManager &) = delete;
95
101 void SetBlockAckManagerMap (const std::map<AcIndex, Ptr<BlockAckManager>>& bamMap);
111 bool ExistsAgreement (Mac48Address recipient, uint8_t tid) const;
122 bool ExistsAgreementInState (Mac48Address recipient, uint8_t tid,
132 void CreateAgreement (const MgtAddBaRequestHeader *reqHdr, Mac48Address recipient, bool htSupported = true);
140 void DestroyAgreement (Mac48Address recipient, uint8_t tid);
148 void UpdateAgreement (const MgtAddBaResponseHeader *respHdr, Mac48Address recipient,
149 uint16_t startingSeq);
156 void StorePacket (Ptr<WifiMpdu> mpdu);
169 Ptr<const WifiMpdu> GetBar (bool remove = true, uint8_t tid = 8,
188 void NotifyMissedAck (Ptr<WifiMpdu> mpdu);
205 std::pair<uint16_t,uint16_t> NotifyGotBlockAck (const CtrlBAckResponseHeader& blockAck,
206 Mac48Address recipient, const std::set<uint8_t>& tids,
207 size_t index = 0);
216 void NotifyMissedBlockAck (Mac48Address recipient, uint8_t tid);
226 uint32_t GetNBufferedPackets (Mac48Address recipient, uint8_t tid) const;
235 void NotifyAgreementEstablished (Mac48Address recipient, uint8_t tid, uint16_t startingSeq);
244 void NotifyAgreementRejected (Mac48Address recipient, uint8_t tid);
253 void NotifyAgreementNoReply (Mac48Address recipient, uint8_t tid);
260 void NotifyAgreementReset (Mac48Address recipient, uint8_t tid);
267 void SetBlockAckThreshold (uint8_t nPackets);
268
272 void SetQueue (const Ptr<WifiMacQueue> queue);
273
289
303 bool SwitchToBlockAckIfNeeded (Mac48Address recipient, uint8_t tid, uint16_t startingSeq);
314 bool NeedBarRetransmission (uint8_t tid, Mac48Address recipient);
323 uint16_t GetRecipientBufferSize (Mac48Address recipient, uint8_t tid) const;
332 BlockAckReqType GetBlockAckReqType (Mac48Address recipient, uint8_t tid) const;
341 BlockAckType GetBlockAckType (Mac48Address recipient, uint8_t tid) const;
350 uint16_t GetOriginatorStartingSequence (Mac48Address recipient, uint8_t tid) const;
351
364
369 void SetTxOkCallback (TxOk callback);
374 void SetTxFailedCallback (TxFailed callback);
379
388 typedef void (* AgreementStateTracedCallback)(Time now, Mac48Address recipient, uint8_t tid, OriginatorBlockAckAgreement::State state);
389
401
410 CtrlBAckRequestHeader GetBlockAckReqHeader (Mac48Address recipient, uint8_t tid) const;
411
421 void ScheduleBar (Ptr<const WifiMpdu> bar, bool skipIfNoDataQueued = false);
422
423protected:
424 void DoDispose () override;
425
426private:
432 void InactivityTimeout (Mac48Address recipient, uint8_t tid);
433
437 typedef std::list<Ptr<WifiMpdu>> PacketQueue;
441 typedef std::list<Ptr<WifiMpdu>>::iterator PacketQueueI;
445 typedef std::list<Ptr<WifiMpdu>>::const_iterator PacketQueueCI;
449 typedef std::map<std::pair<Mac48Address, uint8_t>,
450 std::pair<OriginatorBlockAckAgreement, PacketQueue> > Agreements;
454 typedef std::map<std::pair<Mac48Address, uint8_t>,
455 std::pair<OriginatorBlockAckAgreement, PacketQueue> >::iterator AgreementsI;
459 typedef std::map<std::pair<Mac48Address, uint8_t>,
460 std::pair<OriginatorBlockAckAgreement, PacketQueue> >::const_iterator AgreementsCI;
461
477 const AgreementsI& it, const Time& now);
478
486
487 std::list<Bar> m_bars;
488
489 std::map<AcIndex, Ptr<BlockAckManager>> m_bamMap;
498
503};
504
505} //namespace ns3
506
507#endif /* BLOCK_ACK_MANAGER_H */
Manages all block ack agreements for an originator station.
void SetTxFailedCallback(TxFailed callback)
void NotifyAgreementRejected(Mac48Address recipient, uint8_t tid)
std::map< AcIndex, Ptr< BlockAckManager > > m_bamMap
AC-indexed map of all Block Ack Managers.
CtrlBAckRequestHeader GetBlockAckReqHeader(Mac48Address recipient, uint8_t tid) const
Callback< void, Mac48Address, uint8_t > m_unblockPackets
unblock packets callback
void SetQueue(const Ptr< WifiMacQueue > queue)
void SetTxOkCallback(TxOk callback)
bool SwitchToBlockAckIfNeeded(Mac48Address recipient, uint8_t tid, uint16_t startingSeq)
uint8_t m_blockAckThreshold
block ack threshold
std::list< Ptr< WifiMpdu > > PacketQueue
typedef for a list of WifiMpdu.
void SetBlockAckThreshold(uint8_t nPackets)
DroppedOldMpdu m_droppedOldMpduCallback
the dropped MPDU callback
void NotifyAgreementEstablished(Mac48Address recipient, uint8_t tid, uint16_t startingSeq)
void SetDroppedOldMpduCallback(DroppedOldMpdu callback)
void DestroyAgreement(Mac48Address recipient, uint8_t tid)
void NotifyGotAck(Ptr< const WifiMpdu > mpdu)
Invoked upon receipt of an Ack frame after the transmission of a QoS data frame sent under an establi...
TxFailed m_txFailedCallback
transmit failed callback
void SetUnblockDestinationCallback(Callback< void, Mac48Address, uint8_t > callback)
Set unblock destination callback.
Ptr< WifiMacQueue > m_queue
queue
std::pair< uint16_t, uint16_t > NotifyGotBlockAck(const CtrlBAckResponseHeader &blockAck, Mac48Address recipient, const std::set< uint8_t > &tids, size_t index=0)
BlockAckReqType GetBlockAckReqType(Mac48Address recipient, uint8_t tid) const
This function returns the type of Block Acks sent to the recipient.
void NotifyAgreementReset(Mac48Address recipient, uint8_t tid)
TracedCallback< Time, Mac48Address, uint8_t, OriginatorBlockAckAgreement::State > m_agreementState
The trace source fired when a state transition occurred.
void UpdateAgreement(const MgtAddBaResponseHeader *respHdr, Mac48Address recipient, uint16_t startingSeq)
uint16_t GetRecipientBufferSize(Mac48Address recipient, uint8_t tid) const
This function returns the buffer size negotiated with the recipient.
void(* AgreementStateTracedCallback)(Time now, Mac48Address recipient, uint8_t tid, OriginatorBlockAckAgreement::State state)
TracedCallback signature for state changes.
void InactivityTimeout(Mac48Address recipient, uint8_t tid)
Inactivity timeout function.
void SetBlockAckManagerMap(const std::map< AcIndex, Ptr< BlockAckManager > > &bamMap)
Provide information about all the Block Ack Managers installed on this device.
bool ExistsAgreement(Mac48Address recipient, uint8_t tid) const
void NotifyAgreementNoReply(Mac48Address recipient, uint8_t tid)
bool NeedBarRetransmission(uint8_t tid, Mac48Address recipient)
This function returns true if a block ack agreement is established with the given recipient for the g...
BlockAckType GetBlockAckType(Mac48Address recipient, uint8_t tid) const
This function returns the type of Block Acks sent by the recipient.
std::list< Ptr< WifiMpdu > >::const_iterator PacketQueueCI
typedef for a const iterator for PacketQueue.
void StorePacket(Ptr< WifiMpdu > mpdu)
BlockAckManager & operator=(const BlockAckManager &)=delete
void NotifyDiscardedMpdu(Ptr< const WifiMpdu > mpdu)
static TypeId GetTypeId(void)
Get the type ID.
Agreements m_agreements
This data structure contains, for each block ack agreement (recipient, TID), a set of packets for whi...
void ScheduleBar(Ptr< const WifiMpdu > bar, bool skipIfNoDataQueued=false)
void CreateAgreement(const MgtAddBaRequestHeader *reqHdr, Mac48Address recipient, bool htSupported=true)
Callback< void, Ptr< const WifiMpdu > > TxFailed
typedef for a callback to invoke when an MPDU is negatively ack'ed.
Callback< void, Ptr< const WifiMpdu > > TxOk
typedef for a callback to invoke when an MPDU is successfully ack'ed.
void SetBlockDestinationCallback(Callback< void, Mac48Address, uint8_t > callback)
Set block destination callback.
std::map< std::pair< Mac48Address, uint8_t >, std::pair< OriginatorBlockAckAgreement, PacketQueue > > Agreements
typedef for a map between MAC address and block ack agreement.
std::list< Ptr< WifiMpdu > >::iterator PacketQueueI
typedef for an iterator for PacketQueue.
void SetBlockAckInactivityCallback(Callback< void, Mac48Address, uint8_t, bool > callback)
Set block ack inactivity callback.
BlockAckManager(const BlockAckManager &)=delete
bool ExistsAgreementInState(Mac48Address recipient, uint8_t tid, OriginatorBlockAckAgreement::State state) const
Callback< void, Mac48Address, uint8_t, bool > m_blockAckInactivityTimeout
BlockAck inactivity timeout callback.
Callback< void, Ptr< const WifiMpdu > > DroppedOldMpdu
typedef for a callback to invoke when an MPDU is dropped.
Ptr< const WifiMpdu > 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.
TxOk m_txOkCallback
transmit OK callback
MpduStatus
Enumeration for the statuses of a buffered MPDU.
void NotifyMissedBlockAck(Mac48Address recipient, uint8_t tid)
std::map< std::pair< Mac48Address, uint8_t >, std::pair< OriginatorBlockAckAgreement, PacketQueue > >::const_iterator AgreementsCI
typedef for a const iterator for Agreements.
std::map< std::pair< Mac48Address, uint8_t >, std::pair< OriginatorBlockAckAgreement, PacketQueue > >::iterator AgreementsI
typedef for an iterator for Agreements.
void DoDispose() override
Destructor implementation.
uint32_t GetNBufferedPackets(Mac48Address recipient, uint8_t tid) const
void NotifyMissedAck(Ptr< WifiMpdu > mpdu)
Invoked upon missed reception of an Ack frame after the transmission of a QoS data frame sent under a...
Callback< void, Mac48Address, uint8_t > m_blockPackets
block packets callback
uint16_t GetOriginatorStartingSequence(Mac48Address recipient, uint8_t tid) const
This function returns the starting sequence number of the transmit window.
std::list< Bar > m_bars
list of BARs
PacketQueueI HandleInFlightMpdu(PacketQueueI mpduIt, MpduStatus status, const AgreementsI &it, const Time &now)
Handle the given in flight MPDU based on its given status.
Callback template class.
Definition: callback.h:422
Headers for BlockAckRequest.
Definition: ctrl-headers.h:49
Headers for BlockAck response.
Definition: ctrl-headers.h:202
an EUI-48 address
Definition: mac48-address.h:44
static Mac48Address GetBroadcast(void)
Implement the header for management frames of type Add Block Ack request.
Definition: mgt-headers.h:1484
Implement the header for management frames of type Add Block Ack response.
Definition: mgt-headers.h:1616
A base class which provides memory management and object aggregation.
Definition: object.h:88
State
Represents the state for this agreement.
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:78
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
Forward calls to a chain of Callback.
a unique identifier for an interface.
Definition: type-id.h:59
AcIndex
This enumeration defines the Access Categories as an enumeration with values corresponding to the AC ...
Definition: qos-utils.h:73
Every class exported by the ns3 library is enclosed in the ns3 namespace.
BlockAckRequest frame information.
Ptr< const WifiMpdu > bar
BlockAckRequest or MU-BAR Trigger Frame.
uint8_t tid
TID (unused if MU-BAR)
bool skipIfNoDataQueued
do not send if there is no data queued (unused if MU-BAR)
The different BlockAckRequest variants.
The different BlockAck variants.