/* -*-  Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */

/*

 * Copyright (c) 2003,2007 INRIA

 *

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

 */

#ifndef AMRR_WIFI_MANAGER_H

#define AMRR_WIFI_MANAGER_H

#include "wifi-remote-station-manager.h"

#include "ns3/nstime.h"

namespace ns3 {

/**

 * \brief AMRR Rate control algorithm

 *

 * This class implements the AMRR rate control algorithm which

 * was initially described in <i>IEEE 802.11 Rate Adaptation:

 * A Practical Approach</i>, by M. Lacage, M.H. Manshaei, and 

 * T. Turletti.

 */

class AmrrWifiManager : public WifiRemoteStationManager

{

public:

  static TypeId GetTypeId (void);

  AmrrWifiManager ();

private:

  friend class AmrrWifiRemoteStation;

  virtual WifiRemoteStation *CreateStation (void);

  Time m_updatePeriod;

  double m_failureRatio;

  double m_successRatio;

  uint32_t m_maxSuccessThreshold;

  uint32_t m_minSuccessThreshold;

};

/**

 */

class AmrrWifiRemoteStation : public WifiRemoteStation

{

public:

  AmrrWifiRemoteStation (Ptr<AmrrWifiManager> stations);

  virtual ~AmrrWifiRemoteStation ();

protected:

  virtual void DoReportRxOk (double rxSnr, WifiMode txMode);

  virtual void DoReportRtsFailed (void);

  virtual void DoReportDataFailed (void);

  virtual void DoReportRtsOk (double ctsSnr, WifiMode ctsMode, double rtsSnr);

  virtual void DoReportDataOk (double ackSnr, WifiMode ackMode, double dataSnr);

  virtual void DoReportFinalRtsFailed (void);

  virtual void DoReportFinalDataFailed (void);

private:

  virtual Ptr<WifiRemoteStationManager> GetManager (void) const;

  virtual WifiMode DoGetDataMode (uint32_t size);

  virtual WifiMode DoGetRtsMode (void);

  void UpdateRetry (void);

  void UpdateMode (void);

  void ResetCnt (void);

  void IncreaseRate (void);

  void DecreaseRate (void);

  bool IsMinRate (void) const;

  bool IsMaxRate (void) const;

  bool IsSuccess (void) const;

  bool IsFailure (void) const;

  bool IsEnough (void) const;

  Ptr<AmrrWifiManager> m_stations;

  Time m_nextModeUpdate;

  uint32_t m_tx_ok;

  uint32_t m_tx_err;

  uint32_t m_tx_retr;

  uint32_t m_retry;

  uint32_t m_txrate;

  uint32_t m_successThreshold;

  uint32_t m_success;

  bool m_recovery;

};

} // namespace ns3

#endif /* AMRR_WIFI_MANAGER_H */