sta-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 STA_WIFI_MAC_H
#define STA_WIFI_MAC_H

#include "infrastructure-wifi-mac.h"
#include "mgt-headers.h"

class TwoLevelAggregationTest;
class AmpduAggregationTest;
class HeAggregationTest;

namespace ns3  {

class SupportedRates;
class CapabilityInformation;

struct ApInfo
{
  Mac48Address m_bssid;               
  Mac48Address m_apAddr;              
  double m_snr;                       
  bool m_activeProbing;               
  MgtBeaconHeader m_beacon;           
  MgtProbeResponseHeader m_probeResp; 
};

class StaWifiMac : public InfrastructureWifiMac
{
public:
  friend class ::TwoLevelAggregationTest;
  friend class ::AmpduAggregationTest;
  friend class ::HeAggregationTest;
  static TypeId GetTypeId (void);

  StaWifiMac ();
  virtual ~StaWifiMac ();

  void SetWifiRemoteStationManager (const Ptr<WifiRemoteStationManager> stationManager);

  void Enqueue (Ptr<Packet> packet, Mac48Address to);

  void SetWifiPhy (const Ptr<WifiPhy> phy);

  bool IsAssociated (void) const;

  uint16_t GetAssociationId (void) const;

private:
  enum MacState
  {
    ASSOCIATED,
    WAIT_BEACON,
    WAIT_PROBE_RESP,
    WAIT_ASSOC_RESP,
    UNASSOCIATED,
    REFUSED
  };

  void SetActiveProbing (bool enable);
  bool GetActiveProbing (void) const;

  void Receive (Ptr<WifiMacQueueItem> mpdu);
  void UpdateApInfoFromBeacon (MgtBeaconHeader beacon, Mac48Address apAddr, Mac48Address bssid);
  void UpdateApInfoFromProbeResp (MgtProbeResponseHeader probeResp, Mac48Address apAddr, Mac48Address bssid);
  void UpdateApInfoFromAssocResp (MgtAssocResponseHeader assocResp, Mac48Address apAddr);
  void UpdateCandidateApList (ApInfo newApInfo);

  void SendProbeRequest (void);
  void SendAssociationRequest (bool isReassoc);
  void SendCfPollResponse (void);
  void TryToEnsureAssociated (void);
  void AssocRequestTimeout (void);
  void StartScanning (void);
  void ScanningTimeout (void);
  bool IsWaitAssocResp (void) const;
  void MissedBeacons (void);
  void RestartBeaconWatchdog (Time delay);
  SupportedRates GetSupportedRates (void) const;
  void SetState (MacState value);
  void SetEdcaParameters (AcIndex ac, uint32_t cwMin, uint32_t cwMax, uint8_t aifsn, Time txopLimit);
  CapabilityInformation GetCapabilities (void) const;

  void PhyCapabilitiesChanged (void);

  void DoInitialize (void);

  MacState m_state;            
  uint16_t m_aid;              
  Time m_waitBeaconTimeout;    
  Time m_probeRequestTimeout;  
  Time m_assocRequestTimeout;  
  EventId m_waitBeaconEvent;   
  EventId m_probeRequestEvent; 
  EventId m_assocRequestEvent; 
  EventId m_beaconWatchdog;    
  Time m_beaconWatchdogEnd;    
  uint32_t m_maxMissedBeacons; 
  bool m_activeProbing;        
  std::vector<ApInfo> m_candidateAps; 
  // Note: std::multiset<ApInfo> might be a candidate container to implement
  // this sorted list, but we are using a std::vector because we want to sort
  // based on SNR but find duplicates based on BSSID, and in practice this
  // candidate vector should not be too large.

  TracedCallback<Mac48Address> m_assocLogger;   
  TracedCallback<Mac48Address> m_deAssocLogger; 
  TracedCallback<Time>         m_beaconArrival; 
};

} //namespace ns3

#endif /* STA_WIFI_MAC_H */