qos-txop.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2006, 2009 INRIA
 * Copyright (c) 2009 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
 *
 * Authors: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
 *          Mirko Banchi <mk.banchi@gmail.com>
 */

#ifndef QOS_TXOP_H
#define QOS_TXOP_H

#include "ns3/traced-value.h"
#include "block-ack-manager.h"
#include "txop.h"
#include "qos-utils.h"

class AmpduAggregationTest;
class TwoLevelAggregationTest;
class HeAggregationTest;

namespace ns3 {

class QosBlockedDestinations;
class MgtAddBaResponseHeader;
class MgtDelBaHeader;
class AggregationCapableTransmissionListener;
class WifiTxVector;
class WifiAckPolicySelector;

enum TypeOfStation
{
  STA,
  AP,
  ADHOC_STA,
  MESH,
  HT_STA,
  HT_AP,
  HT_ADHOC_STA,
  OCB
};

class QosTxop : public Txop
{
public:
  friend class ::AmpduAggregationTest;
  friend class ::TwoLevelAggregationTest;
  friend class ::HeAggregationTest;

  std::map<Mac48Address, bool> m_aMpduEnabled; 

  static TypeId GetTypeId (void);

  QosTxop ();
  virtual ~QosTxop ();

  // Overridden from Txop
  bool IsQosTxop (void) const;
  void SetWifiRemoteStationManager (const Ptr<WifiRemoteStationManager> remoteManager);
  virtual bool HasFramesToTransmit (void);
  void NotifyAccessGranted (void);
  void NotifyInternalCollision (void);
  void GotAck (void);
  void GotBlockAck (const CtrlBAckResponseHeader *blockAck, Mac48Address recipient,
                    double rxSnr, double dataSnr, WifiTxVector dataTxVector);
  void MissedBlockAck (uint8_t nMpdus);
  void MissedAck (void);
  void StartNextPacket (void);
  void EndTxNoAck (void);
  void RestartAccessIfNeeded (void);
  void StartAccessIfNeeded (void);
  Time GetTxopRemaining (void) const;
  bool NeedFragmentation (void) const;
  Ptr<Packet> GetFragmentPacket (WifiMacHeader *hdr);

  void SetAckPolicySelector (Ptr<WifiAckPolicySelector> ackSelector);
  Ptr<WifiAckPolicySelector> GetAckPolicySelector (void) const;
  void SetTypeOfStation (TypeOfStation type);
  TypeOfStation GetTypeOfStation (void) const;

  bool GetBaAgreementEstablished (Mac48Address address, uint8_t tid) const;
  uint16_t GetBaBufferSize (Mac48Address address, uint8_t tid) const;
  uint16_t GetBaStartingSequence (Mac48Address address, uint8_t tid) const;
  Ptr<const WifiMacQueueItem> PrepareBlockAckRequest (Mac48Address recipient, uint8_t tid) const;
  void ScheduleBar (Ptr<const WifiMacQueueItem> bar, bool skipIfNoDataQueued = false);

  /* Event handlers */
  void NotifyMissedCts (std::list<Ptr<WifiMacQueueItem>> mpduList);

  void GotAddBaResponse (const MgtAddBaResponseHeader *respHdr, Mac48Address recipient);
  void GotDelBaFrame (const MgtDelBaHeader *delBaHdr, Mac48Address recipient);

  bool NeedBarRetransmission (void);

  void SetAccessCategory (AcIndex ac);

  void PushFront (Ptr<const Packet> packet, const WifiMacHeader &hdr);

  void CompleteConfig (void);

  void SetBlockAckThreshold (uint8_t threshold);
  uint8_t GetBlockAckThreshold (void) const;

  void SetBlockAckInactivityTimeout (uint16_t timeout);
  void SendDelbaFrame (Mac48Address addr, uint8_t tid, bool byOriginator);
  void CompleteMpduTx (Ptr<WifiMacQueueItem> mpdu);
  bool GetAmpduExist (Mac48Address dest) const;
  void SetAmpduExist (Mac48Address dest, bool enableAmpdu);
  void SetAddBaResponseTimeout (Time addBaResponseTimeout);
  Time GetAddBaResponseTimeout (void) const;
  void SetFailedAddBaTimeout (Time failedAddBaTimeout);
  Time GetFailedAddBaTimeout (void) const;

  uint16_t GetNextSequenceNumberFor (const WifiMacHeader *hdr);
  uint16_t PeekNextSequenceNumberFor (const WifiMacHeader *hdr);
  Ptr<const WifiMacQueueItem> PeekNextFrame (uint8_t tid = 8, Mac48Address recipient = Mac48Address::GetBroadcast ());
  Ptr<WifiMacQueueItem> DequeuePeekedFrame (Ptr<const WifiMacQueueItem> peekedItem, WifiTxVector txVector,
                                            bool aggregate = true, uint32_t ampduSize = 0,
                                            Time ppduDurationLimit = Time::Min ());
  MacLowTransmissionParameters GetTransmissionParameters (Ptr<const WifiMacQueueItem> frame) const;

  void UpdateCurrentPacket (Ptr<WifiMacQueueItem> mpdu);
  void BaTxOk (const WifiMacHeader &hdr);
  void BaTxFailed (const WifiMacHeader &hdr);

  Mac48Address MapSrcAddressForAggregation (const WifiMacHeader &hdr);
  Mac48Address MapDestAddressForAggregation (const WifiMacHeader &hdr);


private:
  friend class AggregationCapableTransmissionListener;

  // Overridden from Txop
  void DoDispose (void);
  void DoInitialize (void);
  void TerminateTxop (void);
  uint32_t GetNextFragmentSize (void) const;
  uint32_t GetFragmentSize (void) const;
  uint32_t GetFragmentOffset (void) const;
  bool IsLastFragment (void) const;

  bool SetupBlockAckIfNeeded (void);
  void SendAddBaRequest (Mac48Address recipient, uint8_t tid, uint16_t startSeq,
                         uint16_t timeout, bool immediateBAck);
  bool IsQosOldPacket (Ptr<const WifiMacQueueItem> mpdu);

  bool IsTxopFragmentation (void) const;
  uint32_t GetTxopFragmentSize (void) const;
  uint32_t GetNTxopFragment (void) const;
  uint32_t GetNextTxopFragmentSize (uint32_t fragmentNumber) const;
  uint32_t GetTxopFragmentOffset (uint32_t fragmentNumber) const;
  void AddBaResponseTimeout (Mac48Address recipient, uint8_t tid);
  void ResetBa (Mac48Address recipient, uint8_t tid);

  AcIndex m_ac;                                         
  TypeOfStation m_typeOfStation;                        
  Ptr<WifiAckPolicySelector> m_ackPolicySelector;       
  Ptr<QosBlockedDestinations> m_qosBlockedDestinations; 
  Ptr<BlockAckManager> m_baManager;                     
  uint8_t m_blockAckThreshold;                          
  BlockAckType m_blockAckType;                          
  Time m_currentPacketTimestamp;                        
  uint16_t m_blockAckInactivityTimeout;                 
  Time m_startTxop;                                     
  bool m_isAccessRequestedForRts;                       
  bool m_currentIsFragmented;                           
  Time m_addBaResponseTimeout;                          
  Time m_failedAddBaTimeout;                            
  bool m_useExplicitBarAfterMissedBlockAck;             

  TracedCallback<Time, Time> m_txopTrace; 
};

} //namespace ns3

#endif /* QOS_TXOP_H */