ap-wifi-mac.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 AP_WIFI_MAC_H
#define AP_WIFI_MAC_H

#include "regular-wifi-mac.h"
#include <unordered_map>

namespace ns3 {

class SupportedRates;
class CapabilityInformation;
class DsssParameterSet;
class ErpInformation;
class EdcaParameterSet;
class HtOperation;
class VhtOperation;
class HeOperation;
class CfParameterSet;

class ApWifiMac : public RegularWifiMac
{
public:
  static TypeId GetTypeId (void);

  ApWifiMac ();
  virtual ~ApWifiMac ();

  void SetWifiRemoteStationManager (const Ptr<WifiRemoteStationManager> stationManager) override;
  void SetLinkUpCallback (Callback<void> linkUp) override;
  void Enqueue (Ptr<Packet> packet, Mac48Address to) override;
  void Enqueue (Ptr<Packet> packet, Mac48Address to, Mac48Address from) override;
  bool SupportsSendFrom (void) const override;
  void SetAddress (Mac48Address address) override;

  void SetBeaconInterval (Time interval);
  Time GetBeaconInterval (void) const;

  uint16_t GetVhtOperationalChannelWidth (void) const;

  int64_t AssignStreams (int64_t stream);

  const std::map<uint16_t, Mac48Address>& GetStaList (void) const;
  uint16_t GetAssociationId (Mac48Address addr) const;

  uint8_t GetBufferStatus (uint8_t tid, Mac48Address address) const;
  void SetBufferStatus (uint8_t tid, Mac48Address address, uint8_t size);
  uint8_t GetMaxBufferStatus (Mac48Address address) const;

private:
  void Receive (Ptr<WifiMacQueueItem> mpdu)  override;
  void TxOk (Ptr<const WifiMacQueueItem> mpdu);
  void TxFailed (uint8_t timeoutReason, Ptr<const WifiMacQueueItem> mpdu, const WifiTxVector& txVector);

  void DeaggregateAmsduAndForward (Ptr<WifiMacQueueItem> mpdu) override;
  void ForwardDown (Ptr<Packet> packet, Mac48Address from, Mac48Address to);
  void ForwardDown (Ptr<Packet> packet, Mac48Address from, Mac48Address to, uint8_t tid);
  void SendProbeResp (Mac48Address to);
  void SendAssocResp (Mac48Address to, bool success, bool isReassoc);
  void SendOneBeacon (void);

  CapabilityInformation GetCapabilities (void) const;
  ErpInformation GetErpInformation (void) const;
  EdcaParameterSet GetEdcaParameterSet (void) const;
  HtOperation GetHtOperation (void) const;
  VhtOperation GetVhtOperation (void) const;
  HeOperation GetHeOperation (void) const;
  SupportedRates GetSupportedRates (void) const;
  DsssParameterSet GetDsssParameterSet (void) const;
  void SetBeaconGeneration (bool enable);

  void UpdateShortSlotTimeEnabled (void);
  void UpdateShortPreambleEnabled (void);

  bool GetUseNonErpProtection (void) const;

  void DoDispose (void) override;
  void DoInitialize (void) override;

  uint16_t GetNextAssociationId (void);

  Ptr<Txop> m_beaconTxop;                    
  bool m_enableBeaconGeneration;             
  Time m_beaconInterval;                     
  EventId m_beaconEvent;                     
  Ptr<UniformRandomVariable> m_beaconJitter; 
  bool m_enableBeaconJitter;                 
  std::map<uint16_t, Mac48Address> m_staList; 
  std::unordered_map<Mac48Address, uint16_t, WifiAddressHash> m_addressIdMap;
  uint16_t m_numNonErpStations;              
  uint16_t m_numNonHtStations;               
  bool m_shortSlotTimeEnabled;               
  bool m_shortPreambleEnabled;               
  bool m_enableNonErpProtection;             
  Time m_bsrLifetime;                        
  typedef struct
  {
    uint8_t value;  
    Time timestamp; 
  } bsrType;
  std::unordered_map<WifiAddressTidPair, bsrType, WifiAddressTidHash> m_bufferStatus;

  typedef void (* AssociationCallback)(uint16_t aid, Mac48Address address);

  TracedCallback<uint16_t /* AID */, Mac48Address> m_assocLogger;   
  TracedCallback<uint16_t /* AID */, Mac48Address> m_deAssocLogger; 
};

} //namespace ns3

#endif /* AP_WIFI_MAC_H */