he-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 HE_FRAME_EXCHANGE_MANAGER_H
#define HE_FRAME_EXCHANGE_MANAGER_H

#include "ns3/vht-frame-exchange-manager.h"
#include "mu-snr-tag.h"
#include <map>
#include <unordered_map>

namespace ns3 {

class MultiUserScheduler;
class ApWifiMac;
class StaWifiMac;
class CtrlTriggerHeader;

typedef std::unordered_map <uint16_t /* staId */, Ptr<WifiPsdu> /* PSDU */> WifiPsduMap;
typedef std::unordered_map <uint16_t /* staId */, Ptr<const WifiPsdu> /* PSDU */> WifiConstPsduMap;

class HeFrameExchangeManager : public VhtFrameExchangeManager
{
public:
  static TypeId GetTypeId (void);
  HeFrameExchangeManager ();
  virtual ~HeFrameExchangeManager ();

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

  void SetMultiUserScheduler (const Ptr<MultiUserScheduler> muScheduler);

  static Ptr<WifiPsdu> GetPsduTo (Mac48Address to, const WifiPsduMap& psduMap);

  virtual void SetTargetRssi (CtrlTriggerHeader& trigger) 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;
  Time GetTxDuration (uint32_t ppduPayloadSize, Mac48Address receiver,
                      const WifiTxParameters& txParams) const override;
  bool SendMpduFromBaManager (Ptr<QosTxop> edca, Time availableTime, bool initialFrame) override;

  void SendPsduMapWithProtection (WifiPsduMap psduMap, WifiTxParameters& txParams);

  void ForwardPsduMapDown (WifiConstPsduMap psduMap, WifiTxVector& txVector);

  virtual void BlockAcksInTbPpduTimeout (WifiPsduMap* psduMap,
                                         const std::set<Mac48Address>* staMissedBlockAckFrom,
                                         std::size_t nSolicitedStations);

  virtual void TbPpduTimeout (WifiPsduMap* psduMap,
                              const std::set<Mac48Address>* staMissedTbPpduFrom,
                              std::size_t nSolicitedStations);

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

  WifiTxVector GetHeTbTxVector (CtrlTriggerHeader trigger, Mac48Address triggerSender) const;

  Ptr<WifiMacQueueItem> PrepareMuBar (const WifiTxVector& responseTxVector,
                                      std::map<uint16_t, CtrlBAckRequestHeader> recipients) const;

  void SendMultiStaBlockAck (const WifiTxParameters& txParams);

  void SendQosNullFramesInTbPpdu (const CtrlTriggerHeader& trigger, const WifiMacHeader& hdr);

  Ptr<ApWifiMac> m_apMac;                             
  Ptr<StaWifiMac> m_staMac;                           

private:
  void SendPsduMap (void);

  void ReceiveBasicTrigger (const CtrlTriggerHeader& trigger, const WifiMacHeader& hdr);

  WifiPsduMap m_psduMap;                              
  WifiTxParameters m_txParams;                        
  Ptr<MultiUserScheduler> m_muScheduler;              
  Ptr<WifiMacQueueItem> m_triggerFrame;               
  std::set<Mac48Address> m_staExpectTbPpduFrom;       
  EventId m_multiStaBaEvent;                          
  MuSnrTag m_muSnrTag;                                
  bool m_triggerFrameInAmpdu;                         
};

} //namespace ns3

#endif /* HE_FRAME_EXCHANGE_MANAGER_H */