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"
25 #include "ns3/wifi-remote-station-manager.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  void DoInitialize (void) override;
59  WifiRemoteStation * DoCreateStation (void) const override;
60  void DoReportRxOk (WifiRemoteStation *station,
61  double rxSnr, WifiMode txMode) override;
62  void DoReportRtsFailed (WifiRemoteStation *station) override;
63  void DoReportDataFailed (WifiRemoteStation *station) override;
64  void DoReportRtsOk (WifiRemoteStation *station,
65  double ctsSnr, WifiMode ctsMode, double rtsSnr) override;
66  void DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode,
67  double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss) override;
68  void DoReportFinalRtsFailed (WifiRemoteStation *station) override;
69  void DoReportFinalDataFailed (WifiRemoteStation *station) override;
72 
78  void UpdateMode (AmrrWifiRemoteStation *station);
84  void ResetCnt (AmrrWifiRemoteStation *station);
90  void IncreaseRate (AmrrWifiRemoteStation *station);
96  void DecreaseRate (AmrrWifiRemoteStation *station);
106  bool IsMinRate (AmrrWifiRemoteStation *station) const;
116  bool IsMaxRate (AmrrWifiRemoteStation *station) const;
127  bool IsSuccess (AmrrWifiRemoteStation *station) const;
138  bool IsFailure (AmrrWifiRemoteStation *station) const;
148  bool IsEnough (AmrrWifiRemoteStation *station) const;
149 
151  double m_failureRatio;
152  double m_successRatio;
155 
157 };
158 
159 } //namespace ns3
160 
161 #endif /* AMRR_WIFI_MANAGER_H */
ns3::AmrrWifiManager::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: amrr-wifi-manager.cc:55
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::AmrrWifiManager::DoInitialize
void DoInitialize(void) override
Initialize() implementation.
Definition: amrr-wifi-manager.cc:107
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::AmrrWifiManager::DecreaseRate
void DecreaseRate(AmrrWifiRemoteStation *station)
Decrease the transmission rate to the given station.
Definition: amrr-wifi-manager.cc:249
ns3::AmrrWifiManager::DoCreateStation
WifiRemoteStation * DoCreateStation(void) const override
Definition: amrr-wifi-manager.cc:125
ns3::AmrrWifiManager::AmrrWifiManager
AmrrWifiManager()
Definition: amrr-wifi-manager.cc:94
ns3::AmrrWifiManager::m_currentRate
TracedValue< uint64_t > m_currentRate
Trace rate changes.
Definition: amrr-wifi-manager.h:156
ns3::AmrrWifiManager::IncreaseRate
void IncreaseRate(AmrrWifiRemoteStation *station)
Increase the transmission rate to the given station.
Definition: amrr-wifi-manager.cc:241
ns3::AmrrWifiManager::IsEnough
bool IsEnough(AmrrWifiRemoteStation *station) const
Check if the number of retransmission, transmission error, and successful transmission are greater th...
Definition: amrr-wifi-manager.cc:225
ns3::WifiRemoteStationManager
hold a list of per-remote-station state.
Definition: wifi-remote-station-manager.h:121
ns3::WifiTxVector
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
Definition: wifi-tx-vector.h:71
ns3::AmrrWifiRemoteStation
hold per-remote-station state for AMRR Wifi manager.
Definition: amrr-wifi-manager.cc:39
ns3::AmrrWifiManager::IsSuccess
bool IsSuccess(AmrrWifiRemoteStation *station) const
Check if the number of retransmission and transmission error is less than the number of successful tr...
Definition: amrr-wifi-manager.cc:211
ns3::AmrrWifiManager::DoReportRxOk
void DoReportRxOk(WifiRemoteStation *station, double rxSnr, WifiMode txMode) override
This method is a pure virtual method that must be implemented by the sub-class.
Definition: amrr-wifi-manager.cc:142
ns3::AmrrWifiManager
AMRR Rate control algorithm.
Definition: amrr-wifi-manager.h:45
ns3::AmrrWifiManager::IsMaxRate
bool IsMaxRate(AmrrWifiRemoteStation *station) const
Check if the current rate for the given station is the maximum rate.
Definition: amrr-wifi-manager.cc:203
ns3::AmrrWifiManager::DoGetDataTxVector
WifiTxVector DoGetDataTxVector(WifiRemoteStation *station) override
Definition: amrr-wifi-manager.cc:322
ns3::AmrrWifiManager::m_successRatio
double m_successRatio
success ratio
Definition: amrr-wifi-manager.h:152
ns3::WifiMode
represent a single transmission mode
Definition: wifi-mode.h:48
ns3::AmrrWifiManager::m_updatePeriod
Time m_updatePeriod
update period
Definition: amrr-wifi-manager.h:150
ns3::AmrrWifiManager::DoReportRtsFailed
void DoReportRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
Definition: amrr-wifi-manager.cc:149
ns3::AmrrWifiManager::DoReportFinalRtsFailed
void DoReportFinalRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
Definition: amrr-wifi-manager.cc:181
ns3::AmrrWifiManager::m_maxSuccessThreshold
uint32_t m_maxSuccessThreshold
maximum success threshold
Definition: amrr-wifi-manager.h:153
ns3::Time
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
ns3::AmrrWifiManager::DoReportRtsOk
void DoReportRtsOk(WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr) override
This method is a pure virtual method that must be implemented by the sub-class.
Definition: amrr-wifi-manager.cc:164
ns3::AmrrWifiManager::IsFailure
bool IsFailure(AmrrWifiRemoteStation *station) const
Check if the number of retransmission and transmission error is greater than the number of successful...
Definition: amrr-wifi-manager.cc:218
ns3::AmrrWifiManager::DoReportDataOk
void DoReportDataOk(WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss) override
This method is a pure virtual method that must be implemented by the sub-class.
Definition: amrr-wifi-manager.cc:171
ns3::AmrrWifiManager::IsMinRate
bool IsMinRate(AmrrWifiRemoteStation *station) const
Check if the current rate for the given station is the minimum rate.
Definition: amrr-wifi-manager.cc:196
ns3::AmrrWifiManager::ResetCnt
void ResetCnt(AmrrWifiRemoteStation *station)
Reset transmission statistics of the given station.
Definition: amrr-wifi-manager.cc:232
ns3::AmrrWifiManager::UpdateMode
void UpdateMode(AmrrWifiRemoteStation *station)
Update the mode used to send to the given station.
Definition: amrr-wifi-manager.cc:256
ns3::AmrrWifiManager::DoReportFinalDataFailed
void DoReportFinalDataFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
Definition: amrr-wifi-manager.cc:187
ns3::WifiRemoteStation
hold per-remote-station state.
Definition: wifi-remote-station-manager.h:62
ns3::TracedValue< uint64_t >
ns3::AmrrWifiManager::~AmrrWifiManager
virtual ~AmrrWifiManager()
Definition: amrr-wifi-manager.cc:101
ns3::AmrrWifiManager::m_minSuccessThreshold
uint32_t m_minSuccessThreshold
minimum success threshold
Definition: amrr-wifi-manager.h:154
ns3::AmrrWifiManager::DoReportDataFailed
void DoReportDataFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
Definition: amrr-wifi-manager.cc:155
ns3::AmrrWifiManager::DoGetRtsTxVector
WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station) override
Definition: amrr-wifi-manager.cc:381
ns3::AmrrWifiManager::m_failureRatio
double m_failureRatio
failure ratio
Definition: amrr-wifi-manager.h:151