A Discrete-Event Network Simulator
API
rrpaa-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) 2017 Universidad de la República - Uruguay
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: Matías Richart <mrichart@fing.edu.uy>
19 */
20
21#ifndef RRPAA_WIFI_MANAGER_H
22#define RRPAA_WIFI_MANAGER_H
23
24#include "ns3/nstime.h"
25#include "ns3/random-variable-stream.h"
26#include "ns3/wifi-remote-station-manager.h"
27
28namespace ns3 {
29
30struct RrpaaWifiRemoteStation;
31
58{
59 double m_ori;
60 double m_mtl;
62};
63
67typedef std::vector<std::pair<WifiRrpaaThresholds,WifiMode> > RrpaaThresholdsTable;
68
72typedef std::vector<std::vector<double> > RrpaaProbabilitiesTable;
73
75{
76public:
81 static TypeId GetTypeId (void);
83 virtual ~RrpaaWifiManager ();
84
85 void SetupPhy (const Ptr<WifiPhy> phy) override;
86 void SetupMac (const Ptr<WifiMac> mac) override;
87
97 int64_t AssignStreams (int64_t stream) override;
98
99private:
100 void DoInitialize (void) override;
101 WifiRemoteStation * DoCreateStation (void) const override;
102 void DoReportRxOk (WifiRemoteStation *station,
103 double rxSnr, WifiMode txMode) override;
104 void DoReportRtsFailed (WifiRemoteStation *station) override;
105 void DoReportDataFailed (WifiRemoteStation *station) override;
106 void DoReportRtsOk (WifiRemoteStation *station,
107 double ctsSnr, WifiMode ctsMode, double rtsSnr) override;
108 void DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode,
109 double dataSnr, uint16_t dataChannelWidth, uint8_t dataNss) override;
110 void DoReportFinalRtsFailed (WifiRemoteStation *station) override;
111 void DoReportFinalDataFailed (WifiRemoteStation *station) override;
112 WifiTxVector DoGetDataTxVector (WifiRemoteStation *station, uint16_t allowedWidth) override;
115 uint32_t size, bool normally) override;
116
121 void CheckInit (RrpaaWifiRemoteStation *station);
122
128 void CheckTimeout (RrpaaWifiRemoteStation *station);
149
156
166
175 WifiRrpaaThresholds GetThresholds (RrpaaWifiRemoteStation *station, uint8_t index) const;
176
184 Time GetCalcTxTime (WifiMode mode) const;
191 void AddCalcTxTime (WifiMode mode, Time t);
192
198 typedef std::vector<std::pair<Time,WifiMode> > TxTime;
199
203
206
207 bool m_basic;
209 double m_alpha;
210 double m_beta;
211 double m_tau;
212 double m_gamma;
213 double m_delta;
214
222
231
233};
234
235} //namespace ns3
236
237#endif /* RRPAA__WIFI_MANAGER_H */
Time m_sifs
Value of SIFS configured in the device.
Ptr< UniformRandomVariable > m_uniformRandomVariable
Provides uniform random variables for probabilistic changes.
uint8_t m_maxPowerLevel
Maximal power level.
void ResetCountersBasic(RrpaaWifiRemoteStation *station)
Reset the counters of the given station.
double m_beta
Beta value for RRPAA (value for calculating ORI threshold).
int64_t AssignStreams(int64_t stream) override
Assign a fixed random variable stream number to the random variables used by this model.
Time m_difs
Value of DIFS configured in the device.
bool m_basic
If using the basic algorithm (without RTS/CTS).
void DoReportRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
void SetupPhy(const Ptr< WifiPhy > phy) override
Set up PHY associated with this device since it is the object that knows the full set of transmit rat...
TxTime m_calcTxTime
To hold all the calculated TxTime for all modes.
static TypeId GetTypeId(void)
Register this type.
void CheckInit(RrpaaWifiRemoteStation *station)
Check for initializations.
WifiTxVector DoGetDataTxVector(WifiRemoteStation *station, uint16_t allowedWidth) override
std::vector< std::pair< Time, WifiMode > > TxTime
typedef for a vector of a pair of Time, WifiMode.
TracedCallback< double, double, Mac48Address > m_powerChange
The trace source fired when the transmission power change.
uint8_t m_minPowerLevel
Differently form rate, power levels do not depend on the remote station.
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.
void SetupMac(const Ptr< WifiMac > mac) override
Set up MAC associated with this device since it is the object that knows the full set of timing param...
void RunAdaptiveRtsAlgorithm(RrpaaWifiRemoteStation *station)
Run an enhanced algorithm which activates the use of RTS for the given station if the conditions are ...
TracedCallback< DataRate, DataRate, Mac48Address > m_rateChange
The trace source fired when the transmission rate change.
Time m_timeout
Timeout for the RRAA BASIC loss estimation block.
uint32_t m_ackLength
Ack frame length used to calculate mode TxTime (in bytes).
uint8_t m_nPowerLevels
Number of power levels.
WifiRrpaaThresholds GetThresholds(RrpaaWifiRemoteStation *station, WifiMode mode) const
Get the thresholds for the given station and mode.
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.
double m_tau
Tau value for RRPAA (value for calculating EWND size).
void DoReportRxOk(WifiRemoteStation *station, double rxSnr, WifiMode txMode) override
This method is a pure virtual method that must be implemented by the sub-class.
double m_gamma
Gamma value for RRPAA (value for pdTable decrements).
Time GetCalcTxTime(WifiMode mode) const
Get the estimated TxTime of a packet with a given mode.
double m_delta
Delta value for RRPAA (value for pdTable increments).
void CheckTimeout(RrpaaWifiRemoteStation *station)
Check if the counter should be reset.
WifiRemoteStation * DoCreateStation(void) const override
double m_alpha
Alpha value for RRPAA (value for calculating MTL threshold)
bool DoNeedRts(WifiRemoteStation *st, uint32_t size, bool normally) override
void DoReportFinalDataFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
void DoReportDataFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
void DoReportFinalRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
uint32_t m_frameLength
Data frame length used to calculate mode TxTime (in bytes).
void DoInitialize(void) override
Initialize() implementation.
void AddCalcTxTime(WifiMode mode, Time t)
Add transmission time for the given mode to an internal list.
void InitThresholds(RrpaaWifiRemoteStation *station)
Initialize the thresholds internal list for the given station.
WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station) override
void RunBasicAlgorithm(RrpaaWifiRemoteStation *station)
Find an appropriate rate and power for the given station, using a basic algorithm.
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
Forward calls to a chain of Callback.
a unique identifier for an interface.
Definition: type-id.h:59
represent a single transmission mode
Definition: wifi-mode.h:48
hold a list of per-remote-station state.
This class mimics the TXVECTOR which is to be passed to the PHY in order to define the parameters whi...
Every class exported by the ns3 library is enclosed in the ns3 namespace.
std::vector< std::pair< WifiRrpaaThresholds, WifiMode > > RrpaaThresholdsTable
List of thresholds for each mode.
std::vector< std::vector< double > > RrpaaProbabilitiesTable
List of probabilities.
mac
Definition: third.py:87
phy
Definition: third.py:84
Hold per-remote-station state for RRPAA Wifi manager.
hold per-remote-station state.
Robust Rate and Power Adaptation Algorithm.
double m_ori
The Opportunistic Rate Increase threshold.
uint32_t m_ewnd
The Estimation Window size.
double m_mtl
The Maximum Tolerable Loss threshold.