/* -*-  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

 *

 * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>

 * Author: Mirko Banchi <mk.banchi@gmail.com>

 */

#ifndef QSTA_WIFI_MAC_H

#define QSTA_WIFI_MAC_H

#include "ns3/callback.h"

#include "ns3/packet.h"

#include "ns3/event-id.h"

#include "wifi-mac.h"

#include "supported-rates.h"

#include "qos-utils.h"

#include <string>

#include <vector>

#include <list>

#include <map>

namespace ns3  {

class DcfManager;

class EdcaTxopN;

class MacRxMiddle;

class MacTxMiddle;

class MacLow;

class WifiMacHeader;

class AmsduSubframeHeader;

class MsduAggregator;

class MgtAddBaRequestHeader;

class QstaWifiMac : public WifiMac

{

public:

  static TypeId GetTypeId (void);

  QstaWifiMac ();

  virtual ~QstaWifiMac ();

  // inherited from WifiMac.

  virtual void SetSlot (Time slotTime);

  virtual void SetSifs (Time sifs);

  virtual void SetEifsNoDifs (Time eifsNoDifs);

  virtual void SetAckTimeout (Time ackTimeout);

  virtual void SetCtsTimeout (Time ctsTimeout);

  virtual void SetPifs (Time pifs);

  virtual Time GetSlot (void) const;

  virtual Time GetSifs (void) const;

  virtual Time GetEifsNoDifs (void) const;

  virtual Time GetAckTimeout (void) const;

  virtual Time GetCtsTimeout (void) const;

  virtual Time GetPifs (void) const;

  virtual void SetWifiPhy (Ptr<WifiPhy> phy);

  virtual void SetWifiRemoteStationManager (Ptr<WifiRemoteStationManager> stationManager);

  virtual void Enqueue (Ptr<const Packet> packet, Mac48Address to, Mac48Address from){};

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

  virtual bool SupportsSendFrom (void) const;

  virtual void SetForwardUpCallback (Callback<void,Ptr<Packet>, Mac48Address, Mac48Address> upCallback);

  virtual void SetLinkUpCallback (Callback<void> linkUp);

  virtual void SetLinkDownCallback (Callback<void> linkDown);

  virtual Mac48Address GetAddress (void) const;

  virtual Ssid GetSsid (void) const;

  virtual void SetAddress (Mac48Address address);

  virtual void SetSsid (Ssid ssid);

  virtual Mac48Address GetBssid (void) const;

  void SetMaxMissedBeacons (uint32_t missed);

  void SetProbeRequestTimeout (Time timeout);

  void SetAssocRequestTimeout (Time timeout);

  void StartActiveAssociation (void);

private:

  void SetBssid (Mac48Address bssid);

  Mac48Address GetBroadcastBssid (void);

  void Receive (Ptr<Packet> p, const WifiMacHeader *hdr);

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

  void SetActiveProbing (bool enable);

  bool GetActiveProbing (void) const;

  void MissedBeacons (void);

  SupportedRates GetSupportedRates (void) const;

  void RestartBeaconWatchdog (Time delay);

  void AssocRequestTimeout (void);

  void ProbeRequestTimeout (void);

  void SendAssociationRequest (void);

  void SendProbeRequest (void);

  void SendAddBaResponse (const MgtAddBaRequestHeader *reqHdr, Mac48Address originator);

  void TryToEnsureAssociated (void);

  bool IsAssociated (void) const;

  bool IsWaitAssocResp (void) const;

  virtual void DoDispose (void);

 /**

  * When an A-MSDU is received, is deaggregated by this method and all extracted packets are

  * forwarded up.

  */

  void DeaggregateAmsduAndForward (Ptr<Packet> aggregatedPacket, const WifiMacHeader *hdr);

  QstaWifiMac &operator = (const QstaWifiMac &);

  QstaWifiMac (const QstaWifiMac &);

  virtual void FinishConfigureStandard (enum WifiPhyStandard standard);

  void SetQueue (enum AccessClass ac);

  Ptr<EdcaTxopN> GetVOQueue (void) const;

  Ptr<EdcaTxopN> GetVIQueue (void) const;

  Ptr<EdcaTxopN> GetBEQueue (void) const;

  Ptr<EdcaTxopN> GetBKQueue (void) const;

  typedef std::map<AccessClass, Ptr<EdcaTxopN> > Queues;

  typedef std::list<std::pair<Ptr<Packet>, AmsduSubframeHeader> > DeaggregatedMsdus;

  typedef std::list<std::pair<Ptr<Packet>, AmsduSubframeHeader> >::const_iterator DeaggregatedMsdusCI;

  enum {

    ASSOCIATED,

    WAIT_PROBE_RESP,

    WAIT_ASSOC_RESP,

    BEACON_MISSED,

    REFUSED

  } m_state;

  Queues m_queues;

  Ptr<MacLow> m_low;

  Ptr<WifiPhy> m_phy;

  Ptr<WifiRemoteStationManager> m_stationManager;

  DcfManager *m_dcfManager;

  MacRxMiddle *m_rxMiddle;

  MacTxMiddle *m_txMiddle;

  Ssid m_ssid;

  Callback<void, Ptr<Packet>, Mac48Address, Mac48Address> m_forwardUp;

  Callback<void> m_linkUp;

  Callback<void> m_linkDown;

  Time m_probeRequestTimeout;

  Time m_assocRequestTimeout;

  EventId m_probeRequestEvent;

  EventId m_assocRequestEvent;

  Time m_beaconWatchdogEnd;

  EventId m_beaconWatchdog;

  uint32_t m_maxMissedBeacons;

};

}  //namespace ns3

#endif /* QSTA_WIFI_MAC_H */