A Discrete-Event Network Simulator
API
amrr-wifi-manager.h
Go to the documentation of this file.
1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2003,2007 INRIA
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License version 2 as
7  * published by the Free Software Foundation;
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
19  */
20 
21 #ifndef AMRR_WIFI_MANAGER_H
22 #define AMRR_WIFI_MANAGER_H
23 
24 #include "ns3/traced-value.h"
26 
27 namespace ns3 {
28 
29 struct AmrrWifiRemoteStation;
30 
45 {
46 public:
51  static TypeId GetTypeId (void);
52 
53  AmrrWifiManager ();
54  virtual ~AmrrWifiManager ();
55 
56 
57 private:
58  // Overridden from base class.
59  void DoInitialize (void);
60  WifiRemoteStation * DoCreateStation (void) const;
61  void DoReportRxOk (WifiRemoteStation *station,
62  double rxSnr, WifiMode txMode);
63  void DoReportRtsFailed (WifiRemoteStation *station);
64  void DoReportDataFailed (WifiRemoteStation *station);
65  void DoReportRtsOk (WifiRemoteStation *station,
66  double ctsSnr, WifiMode ctsMode, double rtsSnr);
67  void DoReportDataOk (WifiRemoteStation *station,
68  double ackSnr, WifiMode ackMode, double dataSnr);
73  bool IsLowLatency (void) const;
74 
80  void UpdateMode (AmrrWifiRemoteStation *station);
86  void ResetCnt (AmrrWifiRemoteStation *station);
92  void IncreaseRate (AmrrWifiRemoteStation *station);
98  void DecreaseRate (AmrrWifiRemoteStation *station);
108  bool IsMinRate (AmrrWifiRemoteStation *station) const;
118  bool IsMaxRate (AmrrWifiRemoteStation *station) const;
129  bool IsSuccess (AmrrWifiRemoteStation *station) const;
140  bool IsFailure (AmrrWifiRemoteStation *station) const;
150  bool IsEnough (AmrrWifiRemoteStation *station) const;
151 
153  double m_failureRatio;
154  double m_successRatio;
157 
159 };
160 
161 } //namespace ns3
162 
163 #endif /* AMRR_WIFI_MANAGER_H */
uint32_t m_minSuccessThreshold
minimum success threshold
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
AMRR Rate control algorithmThis class implements the AMRR rate control algorithm which was initially ...
bool IsLowLatency(void) const
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
void DoReportFinalRtsFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
void ResetCnt(AmrrWifiRemoteStation *station)
Reset transmission statistics of the given station.
hold per-remote-station state for AMRR Wifi manager.
WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station)
void DoInitialize(void)
Initialize() implementation.
bool IsMinRate(AmrrWifiRemoteStation *station) const
Check if the current rate for the given station is the minimum rate.
Time m_updatePeriod
update period
represent a single transmission modeA WifiMode is implemented by a single integer which is used to lo...
Definition: wifi-mode.h:97
void DoReportRtsFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
WifiTxVector DoGetDataTxVector(WifiRemoteStation *station)
TracedValue< uint64_t > m_currentRate
Trace rate changes.
void DoReportDataFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
void DecreaseRate(AmrrWifiRemoteStation *station)
Decrease the transmission rate to the given station.
hold a list of per-remote-station state.
void IncreaseRate(AmrrWifiRemoteStation *station)
Increase the transmission rate to the given station.
WifiRemoteStation * DoCreateStation(void) const
bool IsEnough(AmrrWifiRemoteStation *station) const
Check if the number of retransmission, transmission error, and successful transmission are greater th...
void DoReportRtsOk(WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr)
This method is a pure virtual method that must be implemented by the sub-class.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
double m_successRatio
success ratio
void DoReportRxOk(WifiRemoteStation *station, double rxSnr, WifiMode txMode)
This method is a pure virtual method that must be implemented by the sub-class.
static TypeId GetTypeId(void)
Get the type ID.
void DoReportDataOk(WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr)
This method is a pure virtual method that must be implemented by the sub-class.
bool IsMaxRate(AmrrWifiRemoteStation *station) const
Check if the current rate for the given station is the maximum rate.
bool IsSuccess(AmrrWifiRemoteStation *station) const
Check if the number of retransmission and transmission error is less than the number of successful tr...
double m_failureRatio
failure ratio
uint32_t m_maxSuccessThreshold
maximum success threshold
void DoReportFinalDataFailed(WifiRemoteStation *station)
This method is a pure virtual method that must be implemented by the sub-class.
void UpdateMode(AmrrWifiRemoteStation *station)
Update the mode used to send to the given station.
bool IsFailure(AmrrWifiRemoteStation *station) const
Check if the number of retransmission and transmission error is greater than the number of successful...
a unique identifier for an interface.
Definition: type-id.h:58
hold per-remote-station state.