A Discrete-Event Network Simulator
API
aarfcd-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) 2005,2006 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: Federico Maguolo <maguolof@dei.unipd.it>
19  */
20 
21 #ifndef AARFCD_WIFI_MANAGER_H
22 #define AARFCD_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 AarfcdWifiRemoteStation;
30 
45 {
46 public:
51  static TypeId GetTypeId (void);
53  virtual ~AarfcdWifiManager ();
54 
55 
56 private:
57  void DoInitialize (void) override;
58  WifiRemoteStation * DoCreateStation (void) const override;
59  void DoReportRxOk (WifiRemoteStation *station,
60  double rxSnr, WifiMode txMode) override;
61 
62  void DoReportRtsFailed (WifiRemoteStation *station) override;
74  void DoReportDataFailed (WifiRemoteStation *station) override;
75  void DoReportRtsOk (WifiRemoteStation *station,
76  double ctsSnr, WifiMode ctsMode, double rtsSnr) override;
77  void DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode,
78  double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss) override;
79  void DoReportFinalRtsFailed (WifiRemoteStation *station) override;
80  void DoReportFinalDataFailed (WifiRemoteStation *station) override;
83  bool DoNeedRts (WifiRemoteStation *station,
84  uint32_t size, bool normally) override;
85 
91  void CheckRts (AarfcdWifiRemoteStation *station);
103  void ResetRtsWnd (AarfcdWifiRemoteStation *station);
109  void TurnOffRts (AarfcdWifiRemoteStation *station);
115  void TurnOnRts (AarfcdWifiRemoteStation *station);
116 
117  //AARF fields below
120  double m_successK;
122  double m_timerK;
123 
124  //AARF-CD fields below
125  uint32_t m_minRtsWnd;
126  uint32_t m_maxRtsWnd;
129 
131 };
132 
133 } //namespace ns3
134 
135 #endif /* AARFCD_WIFI_MANAGER_H */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::AarfcdWifiManager::m_minSuccessThreshold
uint32_t m_minSuccessThreshold
minimum success threshold
Definition: aarfcd-wifi-manager.h:119
ns3::AarfcdWifiManager::AarfcdWifiManager
AarfcdWifiManager()
Definition: aarfcd-wifi-manager.cc:116
ns3::AarfcdWifiRemoteStation
hold per-remote-station state for AARF-CD Wifi manager.
Definition: aarfcd-wifi-manager.cc:40
ns3::AarfcdWifiManager::m_successK
double m_successK
Multiplication factor for the success threshold.
Definition: aarfcd-wifi-manager.h:120
ns3::AarfcdWifiManager::DoReportRtsFailed
void DoReportRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
Definition: aarfcd-wifi-manager.cc:172
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::AarfcdWifiManager::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: aarfcd-wifi-manager.cc:58
ns3::WifiRemoteStationManager
hold a list of per-remote-station state.
Definition: wifi-remote-station-manager.h:121
ns3::AarfcdWifiManager::m_minTimerThreshold
uint32_t m_minTimerThreshold
minimum timer threshold
Definition: aarfcd-wifi-manager.h:118
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::AarfcdWifiManager::m_maxSuccessThreshold
uint32_t m_maxSuccessThreshold
maximum success threshold
Definition: aarfcd-wifi-manager.h:121
ns3::AarfcdWifiManager::DoNeedRts
bool DoNeedRts(WifiRemoteStation *station, uint32_t size, bool normally) override
Definition: aarfcd-wifi-manager.cc:363
ns3::AarfcdWifiManager::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: aarfcd-wifi-manager.cc:256
ns3::AarfcdWifiManager::DoGetRtsTxVector
WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station) override
Definition: aarfcd-wifi-manager.cc:337
ns3::AarfcdWifiManager::m_turnOnRtsAfterRateIncrease
bool m_turnOnRtsAfterRateIncrease
turn on RTS after rate increase
Definition: aarfcd-wifi-manager.h:128
ns3::AarfcdWifiManager::DoGetDataTxVector
WifiTxVector DoGetDataTxVector(WifiRemoteStation *station) override
Definition: aarfcd-wifi-manager.cc:318
ns3::AarfcdWifiManager::ResetRtsWnd
void ResetRtsWnd(AarfcdWifiRemoteStation *station)
Reset the RTS window of the given station.
Definition: aarfcd-wifi-manager.cc:415
ns3::AarfcdWifiManager::CheckRts
void CheckRts(AarfcdWifiRemoteStation *station)
Check if the use of RTS for the given station can be turned off.
Definition: aarfcd-wifi-manager.cc:374
ns3::AarfcdWifiManager::DoCreateStation
WifiRemoteStation * DoCreateStation(void) const override
Definition: aarfcd-wifi-manager.cc:147
ns3::WifiMode
represent a single transmission mode
Definition: wifi-mode.h:48
ns3::AarfcdWifiManager
an implementation of the AARF-CD algorithm
Definition: aarfcd-wifi-manager.h:45
ns3::AarfcdWifiManager::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: aarfcd-wifi-manager.cc:273
ns3::AarfcdWifiManager::DoReportDataFailed
void DoReportDataFailed(WifiRemoteStation *station) override
It is important to realize that "recovery" mode starts after failure of the first transmission after ...
Definition: aarfcd-wifi-manager.cc:178
ns3::AarfcdWifiManager::m_maxRtsWnd
uint32_t m_maxRtsWnd
maximum RTS window
Definition: aarfcd-wifi-manager.h:126
ns3::AarfcdWifiManager::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: aarfcd-wifi-manager.cc:263
ns3::AarfcdWifiManager::IncreaseRtsWnd
void IncreaseRtsWnd(AarfcdWifiRemoteStation *station)
Increase the RTS window size of the given station.
Definition: aarfcd-wifi-manager.cc:399
ns3::WifiRemoteStation
hold per-remote-station state.
Definition: wifi-remote-station-manager.h:62
ns3::AarfcdWifiManager::m_minRtsWnd
uint32_t m_minRtsWnd
minimum RTS window
Definition: aarfcd-wifi-manager.h:125
ns3::TracedValue< uint64_t >
ns3::AarfcdWifiManager::m_turnOffRtsAfterRateDecrease
bool m_turnOffRtsAfterRateDecrease
turn off RTS after rate decrease
Definition: aarfcd-wifi-manager.h:127
ns3::AarfcdWifiManager::~AarfcdWifiManager
virtual ~AarfcdWifiManager()
Definition: aarfcd-wifi-manager.cc:123
ns3::AarfcdWifiManager::DoReportFinalRtsFailed
void DoReportFinalRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
Definition: aarfcd-wifi-manager.cc:306
ns3::AarfcdWifiManager::TurnOnRts
void TurnOnRts(AarfcdWifiRemoteStation *station)
Turn on RTS for the given station.
Definition: aarfcd-wifi-manager.cc:392
ns3::AarfcdWifiManager::DoInitialize
void DoInitialize(void) override
Initialize() implementation.
Definition: aarfcd-wifi-manager.cc:129
ns3::AarfcdWifiManager::TurnOffRts
void TurnOffRts(AarfcdWifiRemoteStation *station)
Turn off RTS for the given station.
Definition: aarfcd-wifi-manager.cc:384
ns3::AarfcdWifiManager::DoReportFinalDataFailed
void DoReportFinalDataFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
Definition: aarfcd-wifi-manager.cc:312
ns3::AarfcdWifiManager::m_currentRate
TracedValue< uint64_t > m_currentRate
Trace rate changes.
Definition: aarfcd-wifi-manager.h:130
ns3::AarfcdWifiManager::m_timerK
double m_timerK
Multiplication factor for the timer threshold.
Definition: aarfcd-wifi-manager.h:122