ht-frame-exchange-manager.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2020 Universita' degli Studi di Napoli Federico II
 *
 * 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: Stefano Avallone <stavallo@unina.it>
 */

#ifndef HT_FRAME_EXCHANGE_MANAGER_H
#define HT_FRAME_EXCHANGE_MANAGER_H

#include "ns3/qos-frame-exchange-manager.h"
#include "ns3/mpdu-aggregator.h"
#include "ns3/msdu-aggregator.h"
#include "ns3/wifi-psdu.h"

class AmpduAggregationTest;
class TwoLevelAggregationTest;
class HeAggregationTest;

namespace ns3 {

class MgtAddBaResponseHeader;
class RecipientBlockAckAgreement;

class HtFrameExchangeManager : public QosFrameExchangeManager
{
public:
  friend class ::AmpduAggregationTest;
  friend class ::TwoLevelAggregationTest;
  friend class ::HeAggregationTest;

  static TypeId GetTypeId (void);
  HtFrameExchangeManager ();
  virtual ~HtFrameExchangeManager ();

  bool StartFrameExchange (Ptr<QosTxop> edca, Time availableTime, bool initialFrame) override;
  void SetWifiMac (const Ptr<RegularWifiMac> mac) override;
  void CalculateAcknowledgmentTime (WifiAcknowledgment* acknowledgment) const override;

  Ptr<MsduAggregator> GetMsduAggregator (void) const;
  Ptr<MpduAggregator> GetMpduAggregator (void) const;

  bool IsWithinLimitsIfAddMpdu (Ptr<const WifiMacQueueItem> mpdu,
                                const WifiTxParameters& txParams,
                                Time ppduDurationLimit) const override;

  virtual bool IsWithinAmpduSizeLimit (uint32_t ampduSize, Mac48Address receiver, uint8_t tid,
                                       WifiModulationClass modulation) const;

  virtual bool TryAggregateMsdu (Ptr<const WifiMacQueueItem> msdu, WifiTxParameters& txParams,
                                 Time availableTime) const;

  virtual bool IsWithinLimitsIfAggregateMsdu (Ptr<const WifiMacQueueItem> msdu,
                                              const WifiTxParameters& txParams,
                                              Time ppduDurationLimit) const;

  void CreateBlockAckAgreement (const MgtAddBaResponseHeader *respHdr,
                                Mac48Address originator, uint16_t startingSeq);
  void DestroyBlockAckAgreement (Mac48Address originator, uint8_t tid);
  void SendAddBaResponse (const MgtAddBaRequestHeader *reqHdr,
                          Mac48Address originator);
  virtual uint16_t GetSupportedBaBufferSize (void) const;

  bool GetBaAgreementEstablished (Mac48Address originator, uint8_t tid) const;

  BlockAckType GetBlockAckType (Mac48Address originator, uint8_t tid) const;

protected:
  void DoDispose () override;

  void ReceiveMpdu (Ptr<WifiMacQueueItem> mpdu, RxSignalInfo rxSignalInfo,
                    const WifiTxVector& txVector, bool inAmpdu) override;
  void EndReceiveAmpdu (Ptr<const WifiPsdu> psdu, const RxSignalInfo& rxSignalInfo,
                        const WifiTxVector& txVector, const std::vector<bool>& perMpduStatus) override;
  void NotifyReceivedNormalAck (Ptr<WifiMacQueueItem> mpdu) override;
  void NotifyPacketDiscarded (Ptr<const WifiMacQueueItem> mpdu) override;
  void RetransmitMpduAfterMissedAck (Ptr<WifiMacQueueItem> mpdu) const override;
  void RetransmitMpduAfterMissedCts (Ptr<WifiMacQueueItem> mpdu) const override;
  void ForwardMpduDown (Ptr<WifiMacQueueItem> mpdu, WifiTxVector& txVector) override;
  void CtsTimeout (Ptr<WifiMacQueueItem> rts, const WifiTxVector& txVector) override;
  void TransmissionSucceeded (void) override;
  void DequeueMpdu (Ptr<WifiMacQueueItem> mpdu) override;

  virtual Ptr<WifiPsdu> GetWifiPsdu (Ptr<WifiMacQueueItem> mpdu, const WifiTxVector& txVector) const;

  Ptr<BlockAckManager> GetBaManager (uint8_t tid) const;

  virtual Time GetPsduDurationId (Time txDuration, const WifiTxParameters& txParams) const;

  void SendPsduWithProtection (Ptr<WifiPsdu> psdu, WifiTxParameters& txParams);

  virtual void NotifyTxToEdca (Ptr<const WifiPsdu> psdu) const;

  virtual void ForwardPsduDown (Ptr<const WifiPsdu> psdu, WifiTxVector& txVector);

  void DequeuePsdu (Ptr<const WifiPsdu> psdu);

  virtual bool SendMpduFromBaManager (Ptr<QosTxop> edca, Time availableTime, bool initialFrame);

  virtual bool SendDataFrame (Ptr<const WifiMacQueueItem> peekedItem,
                              Time availableTime, bool initialFrame);

  virtual bool NeedSetupBlockAck (Mac48Address recipient, uint8_t tid);

  void SendAddBaRequest (Mac48Address recipient, uint8_t tid, uint16_t startingSeq,
                         uint16_t timeout, bool immediateBAck);

  void SendDelbaFrame (Mac48Address addr, uint8_t tid, bool byOriginator);

  void SendBlockAck (const RecipientBlockAckAgreement& agreement, Time durationId,
                     WifiTxVector& blockAckTxVector, double rxSnr);

  virtual void BlockAckTimeout (Ptr<WifiPsdu> psdu, const WifiTxVector& txVector);

  virtual void MissedBlockAck (Ptr<WifiPsdu> psdu, const WifiTxVector& txVector, bool& resetCw);

  typedef std::pair<Mac48Address, uint8_t> AgreementKey;

  std::map<AgreementKey, RecipientBlockAckAgreement> m_agreements; 
  Ptr<MsduAggregator> m_msduAggregator;                            
  Ptr<MpduAggregator> m_mpduAggregator;                            

private:
  void SendPsdu (void);

  Ptr<WifiPsdu> m_psdu;                               
  WifiTxParameters m_txParams;                        
};

} //namespace ns3

#endif /* HT_FRAME_EXCHANGE_MANAGER_H */