block-ack-manager.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2009, 2010 MIRKO BANCHI
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Mirko Banchi <mk.banchi@gmail.com>
 */

#ifndef BLOCK_ACK_MANAGER_H
#define BLOCK_ACK_MANAGER_H

#include <map>
#include "ns3/nstime.h"
#include "ns3/traced-callback.h"
#include "wifi-mac-header.h"
#include "originator-block-ack-agreement.h"
#include "block-ack-type.h"
#include "wifi-mac-queue-item.h"
#include "wifi-tx-vector.h"

namespace ns3 {

class WifiRemoteStationManager;
class MgtAddBaResponseHeader;
class MgtAddBaRequestHeader;
class CtrlBAckResponseHeader;
class CtrlBAckRequestHeader;
class WifiMacQueue;
class WifiMode;
class Packet;

struct Bar
{
  Bar ();
  Bar (Ptr<const WifiMacQueueItem> bar, uint8_t tid, bool skipIfNoDataQueued = false);
  Ptr<const WifiMacQueueItem> bar;  
  uint8_t tid;                      
  bool skipIfNoDataQueued;          
};


class BlockAckManager : public Object
{
private:
  BlockAckManager (const BlockAckManager&);
  BlockAckManager& operator= (const BlockAckManager& block);


public:
  static TypeId GetTypeId (void);

  BlockAckManager ();
  ~BlockAckManager ();

  void SetWifiRemoteStationManager (const Ptr<WifiRemoteStationManager> manager);
  bool ExistsAgreement (Mac48Address recipient, uint8_t tid) const;
  bool ExistsAgreementInState (Mac48Address recipient, uint8_t tid,
                               OriginatorBlockAckAgreement::State state) const;
  void CreateAgreement (const MgtAddBaRequestHeader *reqHdr, Mac48Address recipient);
  void DestroyAgreement (Mac48Address recipient, uint8_t tid);
  void UpdateAgreement (const MgtAddBaResponseHeader *respHdr, Mac48Address recipient,
                        uint16_t startingSeq);
  void StorePacket (Ptr<WifiMacQueueItem> mpdu);
  Ptr<const WifiMacQueueItem> GetBar (bool remove = true, uint8_t tid = 8,
                                      Mac48Address recipient = Mac48Address::GetBroadcast ());
  bool HasPackets (void);
  void NotifyGotAck (Ptr<const WifiMacQueueItem> mpdu);
  void NotifyMissedAck (Ptr<WifiMacQueueItem> mpdu);
  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 NotifyMissedBlockAck (Mac48Address recipient, uint8_t tid);
  void DiscardOutstandingMpdus (Mac48Address recipient, uint8_t tid);
  uint32_t GetNBufferedPackets (Mac48Address recipient, uint8_t tid) const;
  void NotifyAgreementEstablished (Mac48Address recipient, uint8_t tid, uint16_t startingSeq);
  void NotifyAgreementRejected (Mac48Address recipient, uint8_t tid);
  void NotifyAgreementNoReply (Mac48Address recipient, uint8_t tid);
  void NotifyAgreementReset (Mac48Address recipient, uint8_t tid);
  void SetBlockAckThreshold (uint8_t nPackets);
  Ptr<WifiMacQueue> GetRetransmitQueue (void);

  void SetQueue (const Ptr<WifiMacQueue> queue);

  void SetBlockAckInactivityCallback (Callback<void, Mac48Address, uint8_t, bool> callback);
  void SetBlockDestinationCallback (Callback<void, Mac48Address, uint8_t> callback);
  void SetUnblockDestinationCallback (Callback<void, Mac48Address, uint8_t> callback);

  bool SwitchToBlockAckIfNeeded (Mac48Address recipient, uint8_t tid, uint16_t startingSeq);
  bool NeedBarRetransmission (uint8_t tid, Mac48Address recipient);
  uint16_t GetRecipientBufferSize (Mac48Address recipient, uint8_t tid) const;
  BlockAckReqType GetBlockAckReqType (Mac48Address recipient, uint8_t tid) const;
  BlockAckType GetBlockAckType (Mac48Address recipient, uint8_t tid) const;
  uint16_t GetOriginatorStartingSequence (Mac48Address recipient, uint8_t tid) const;

  typedef Callback <void, Ptr<const WifiMacQueueItem>> TxOk;
  typedef Callback <void, Ptr<const WifiMacQueueItem>> TxFailed;
  void SetTxOkCallback (TxOk callback);
  void SetTxFailedCallback (TxFailed callback);

  typedef void (* AgreementStateTracedCallback)(Time now, Mac48Address recipient, uint8_t tid, OriginatorBlockAckAgreement::State state);

  void NotifyDiscardedMpdu (Ptr<const WifiMacQueueItem> mpdu);

  CtrlBAckRequestHeader GetBlockAckReqHeader (Mac48Address recipient, uint8_t tid) const;

  void ScheduleBar (Ptr<const WifiMacQueueItem> bar, bool skipIfNoDataQueued = false);

private:
  void InactivityTimeout (Mac48Address recipient, uint8_t tid);

  void RemoveOldPackets (Mac48Address recipient, uint8_t tid, uint16_t startingSeq);

  typedef std::list<Ptr<WifiMacQueueItem>> PacketQueue;
  typedef std::list<Ptr<WifiMacQueueItem>>::iterator PacketQueueI;
  typedef std::list<Ptr<WifiMacQueueItem>>::const_iterator PacketQueueCI;
  typedef std::map<std::pair<Mac48Address, uint8_t>,
                   std::pair<OriginatorBlockAckAgreement, PacketQueue> > Agreements;
  typedef std::map<std::pair<Mac48Address, uint8_t>,
                   std::pair<OriginatorBlockAckAgreement, PacketQueue> >::iterator AgreementsI;
  typedef std::map<std::pair<Mac48Address, uint8_t>,
                   std::pair<OriginatorBlockAckAgreement, PacketQueue> >::const_iterator AgreementsCI;

  void InsertInRetryQueue (Ptr<WifiMacQueueItem> mpdu);

  void RemoveFromRetryQueue (Mac48Address address, uint8_t tid, uint16_t seq);

  void RemoveFromRetryQueue (Mac48Address address, uint8_t tid, uint16_t startSeq, uint16_t endSeq);

  Agreements m_agreements;

  Ptr<WifiMacQueue> m_retryPackets;
  std::list<Bar> m_bars; 

  uint8_t m_blockAckThreshold; 
  Ptr<WifiMacQueue> m_queue;   
  Callback<void, Mac48Address, uint8_t, bool> m_blockAckInactivityTimeout; 
  Callback<void, Mac48Address, uint8_t> m_blockPackets;   
  Callback<void, Mac48Address, uint8_t> m_unblockPackets; 
  TxOk m_txOkCallback;                                    
  TxFailed m_txFailedCallback;                            
  Ptr<WifiRemoteStationManager> m_stationManager;         

  TracedCallback<Time, Mac48Address, uint8_t, OriginatorBlockAckAgreement::State> m_agreementState;
};

} //namespace ns3

#endif /* BLOCK_ACK_MANAGER_H */