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 FRAME_EXCHANGE_MANAGER_H
#define FRAME_EXCHANGE_MANAGER_H

#include "ns3/object.h"
#include "qos-txop.h"
#include "wifi-tx-vector.h"
#include "wifi-psdu.h"
#include "regular-wifi-mac.h"
#include "mac-rx-middle.h"
#include "mac-tx-middle.h"
#include "wifi-phy.h"
#include "wifi-tx-timer.h"
#include "wifi-tx-parameters.h"
// Needed to compile wave bindings
#include "ns3/wifi-protection-manager.h"
#include "ns3/wifi-ack-manager.h"
#include "channel-access-manager.h"

namespace ns3 {

struct RxSignalInfo;
struct WifiProtection;
struct WifiAcknowledgment;

class FrameExchangeManager : public Object
{
public:
  static TypeId GetTypeId (void);
  FrameExchangeManager ();
  virtual ~FrameExchangeManager ();

  typedef Callback <void, WifiMacDropReason, Ptr<const WifiMacQueueItem>> DroppedMpdu;
  typedef Callback <void, Ptr<const WifiMacQueueItem>> AckedMpdu;

  virtual bool StartTransmission (Ptr<Txop> dcf);

  void Receive (Ptr<WifiPsdu> psdu, RxSignalInfo rxSignalInfo,
                WifiTxVector txVector, std::vector<bool> perMpduStatus);

  virtual void SetWifiMac (const Ptr<RegularWifiMac> mac);
  virtual void SetMacTxMiddle (const Ptr<MacTxMiddle> txMiddle);
  virtual void SetMacRxMiddle (const Ptr<MacRxMiddle> rxMiddle);
  virtual void SetChannelAccessManager (const Ptr<ChannelAccessManager> channelAccessManager);
  virtual void SetWifiPhy (const Ptr<WifiPhy> phy);
  virtual void ResetPhy (void);
  virtual void SetProtectionManager (Ptr<WifiProtectionManager> protectionManager);
  virtual void SetAckManager (Ptr<WifiAckManager> ackManager);
  virtual void SetAddress (Mac48Address address);
  virtual void SetBssid (Mac48Address bssid);
  virtual void SetDroppedMpduCallback (DroppedMpdu callback);
  void SetAckedMpduCallback (AckedMpdu callback);
  void SetPromisc (void);
  bool IsPromisc (void) const;

  const WifiTxTimer& GetWifiTxTimer (void) const;

  Ptr<WifiProtectionManager> GetProtectionManager (void) const;

  virtual void CalculateProtectionTime (WifiProtection* protection) const;

  Ptr<WifiAckManager> GetAckManager (void) const;

  virtual void CalculateAcknowledgmentTime (WifiAcknowledgment* acknowledgment) const;

  void NotifySwitchingStartNow (Time duration);

  void NotifySleepNow (void);

  void NotifyOffNow (void);

protected:
  void DoDispose () override;

  Ptr<WifiMacQueueItem> GetFirstFragmentIfNeeded (Ptr<WifiMacQueueItem> mpdu);

  void SendMpduWithProtection (Ptr<WifiMacQueueItem> mpdu, WifiTxParameters& txParams);

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

  virtual void NavResetTimeout (void);

  virtual void ReceiveMpdu (Ptr<WifiMacQueueItem> mpdu, RxSignalInfo rxSignalInfo,
                            const WifiTxVector& txVector, bool inAmpdu);

  virtual void EndReceiveAmpdu (Ptr<const WifiPsdu> psdu, const RxSignalInfo& rxSignalInfo,
                                const WifiTxVector& txVector, const std::vector<bool>& perMpduStatus);

  virtual void ReceivedNormalAck (Ptr<WifiMacQueueItem> mpdu, const WifiTxVector& txVector,
                                  const WifiTxVector& ackTxVector, const RxSignalInfo& rxInfo, double snr);

  virtual void NotifyReceivedNormalAck (Ptr<WifiMacQueueItem> mpdu);

  virtual void RetransmitMpduAfterMissedAck (Ptr<WifiMacQueueItem> mpdu) const;

  virtual void RetransmitMpduAfterMissedCts (Ptr<WifiMacQueueItem> mpdu) const;

  virtual void NotifyPacketDiscarded (Ptr<const WifiMacQueueItem> mpdu);

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

  virtual Time GetTxDuration (uint32_t ppduPayloadSize, Mac48Address receiver,
                                 const WifiTxParameters& txParams) const;

  void UpdateTxDuration (Mac48Address receiver, WifiTxParameters& txParams) const;

  Ptr<Txop> m_dcf;                                  
  WifiTxTimer m_txTimer;                            
  EventId m_navResetEvent;                          
  Ptr<RegularWifiMac> m_mac;                        
  Ptr<MacTxMiddle> m_txMiddle;                      
  Ptr<MacRxMiddle> m_rxMiddle;                      
  Ptr<ChannelAccessManager> m_channelAccessManager; 
  Ptr<WifiPhy> m_phy;                               
  Mac48Address m_self;                              
  Mac48Address m_bssid;                             
  Time m_navEnd;                                    
  bool m_promisc;                                   
  DroppedMpdu m_droppedMpduCallback;                
  AckedMpdu m_ackedMpduCallback;                    

  virtual void ForwardMpduDown (Ptr<WifiMacQueueItem> mpdu, WifiTxVector& txVector);

  virtual void DequeueMpdu (Ptr<WifiMacQueueItem> mpdu);

  virtual Time GetFrameDurationId (const WifiMacHeader& header, uint32_t size,
                                   const WifiTxParameters& txParams,
                                   Ptr<Packet> fragmentedPacket) const;

  virtual Time GetRtsDurationId (const WifiTxVector& rtsTxVector, Time txDuration, Time response) const;

  void SendRts (const WifiTxParameters& txParams);

  void SendCtsAfterRts (const WifiMacHeader& rtsHdr, WifiMode rtsTxMode, double rtsSnr);

  void DoSendCtsAfterRts (const WifiMacHeader& rtsHdr, WifiTxVector& ctsTxVector, double rtsSnr);

  virtual Time GetCtsToSelfDurationId (const WifiTxVector& ctsTxVector, Time txDuration,
                                       Time response) const;

  void SendCtsToSelf (const WifiTxParameters& txParams);

  void SendNormalAck (const WifiMacHeader& hdr, const WifiTxVector& dataTxVector, double dataSnr);

  Ptr<WifiMacQueueItem> GetNextFragment (void);

  virtual void TransmissionSucceeded (void);

  virtual void TransmissionFailed (void);

  void NormalAckTimeout (Ptr<WifiMacQueueItem> mpdu, const WifiTxVector& txVector);

  virtual void CtsTimeout (Ptr<WifiMacQueueItem> rts, const WifiTxVector& txVector);

private:
  void RxStartIndication (WifiTxVector txVector, Time psduDuration);

  void SendMpdu (void);

  virtual void Reset (void);

  Ptr<WifiMacQueueItem> m_mpdu;                   
  WifiTxParameters m_txParams;                    
  Ptr<Packet> m_fragmentedPacket;                 
  bool m_moreFragments;                           
  Ptr<WifiProtectionManager> m_protectionManager; 
  Ptr<WifiAckManager> m_ackManager;               
};

} //namespace ns3

#endif /* FRAME_EXCHANGE_MANAGER_H */