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"

namespace ns3 {

class QosBlockedDestinations;
class MgtAddBaResponseHeader;
class MgtDelBaHeader;
class AggregationCapableTransmissionListener;
class WifiTxVector;
class QosFrameExchangeManager;
class WifiTxParameters;

class QosTxop : public Txop
{
public:
  static TypeId GetTypeId (void);

  QosTxop ();
  virtual ~QosTxop ();

  bool IsQosTxop (void) const override;
  AcIndex GetAccessCategory (void) const override;
  void SetWifiRemoteStationManager (const Ptr<WifiRemoteStationManager> remoteManager) override;
  bool HasFramesToTransmit (void) override;
  void NotifyInternalCollision (void) override;
  void NotifyChannelAccessed (Time txopDuration) override;
  void NotifyChannelReleased (void) override;
  void SetDroppedMpduCallback (DroppedMpdu callback) override;

  void SetQosFrameExchangeManager (const Ptr<QosFrameExchangeManager> qosFem);

  bool UseExplicitBarAfterMissedBlockAck (void) const;

  Ptr<BlockAckManager> GetBaManager (void);
  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;
  BlockAckReqType GetBlockAckReqType (Mac48Address recipient, uint8_t tid) const;
  BlockAckType GetBlockAckType (Mac48Address recipient, 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 GotAddBaResponse (const MgtAddBaResponseHeader *respHdr, Mac48Address recipient);
  void GotDelBaFrame (const MgtDelBaHeader *delBaHdr, Mac48Address recipient);
  void AddBaResponseTimeout (Mac48Address recipient, uint8_t tid);
  void ResetBa (Mac48Address recipient, uint8_t tid);

  void SetAccessCategory (AcIndex ac);

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

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

  void SetBlockAckInactivityTimeout (uint16_t timeout);
  uint16_t GetBlockAckInactivityTimeout (void) const;
  void CompleteMpduTx (Ptr<WifiMacQueueItem> mpdu);
  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> PeekNextMpdu (uint8_t tid = 8,
                                            Mac48Address recipient = Mac48Address::GetBroadcast ());
  Ptr<const WifiMacQueueItem> PeekNextMpdu (WifiMacQueueItem::QueueIteratorPair queueIt,
                                            uint8_t tid = 8,
                                            Mac48Address recipient = Mac48Address::GetBroadcast ());
  Ptr<WifiMacQueueItem> GetNextMpdu (Ptr<const WifiMacQueueItem> peekedItem, WifiTxParameters& txParams,
                                     Time availableTime, bool initialFrame,
                                     WifiMacQueueItem::QueueIteratorPair& queueIt);

  void AssignSequenceNumber (Ptr<WifiMacQueueItem> mpdu) const;

  void SetQosQueueSize (Ptr<WifiMacQueueItem> mpdu);

  virtual bool IsTxopStarted (void) const;
  virtual Time GetRemainingTxop (void) const;

protected:
  void DoDispose (void) override;

private:
  friend class AggregationCapableTransmissionListener;

  void DoInitialize (void) override;

  bool IsQosOldPacket (Ptr<const WifiMacQueueItem> mpdu);

  AcIndex m_ac;                                         
  Ptr<QosFrameExchangeManager> m_qosFem;                
  Ptr<QosBlockedDestinations> m_qosBlockedDestinations; 
  Ptr<BlockAckManager> m_baManager;                     
  uint8_t m_blockAckThreshold;                          
  Time m_currentPacketTimestamp;                        
  uint16_t m_blockAckInactivityTimeout;                 
  Time m_startTxop;                                     
  Time m_txopDuration;                                  
  Time m_addBaResponseTimeout;                          
  Time m_failedAddBaTimeout;                            
  bool m_useExplicitBarAfterMissedBlockAck;             

  TracedCallback<Time, Time> m_txopTrace; 
};

} //namespace ns3

#endif /* QOS_TXOP_H */