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
27namespace ns3 {
28
29struct AmrrWifiRemoteStation;
30
45{
46public:
51 static TypeId GetTypeId (void);
52
54 virtual ~AmrrWifiManager ();
55
56
57private:
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;
70 WifiTxVector DoGetDataTxVector (WifiRemoteStation *station, uint16_t allowedWidth) 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
155
157};
158
159} //namespace ns3
160
161#endif /* AMRR_WIFI_MANAGER_H */
AMRR Rate control algorithm.
double m_failureRatio
failure ratio
void UpdateMode(AmrrWifiRemoteStation *station)
Update the mode used to send to the given station.
void DoReportFinalRtsFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
uint32_t m_minSuccessThreshold
minimum success threshold
bool IsMaxRate(AmrrWifiRemoteStation *station) const
Check if the current rate for the given station is the maximum rate.
TracedValue< uint64_t > m_currentRate
Trace rate changes.
static TypeId GetTypeId(void)
Get the type ID.
bool IsMinRate(AmrrWifiRemoteStation *station) const
Check if the current rate for the given station is the minimum rate.
void DoInitialize(void) override
Initialize() implementation.
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 ResetCnt(AmrrWifiRemoteStation *station)
Reset transmission statistics of the given station.
uint32_t m_maxSuccessThreshold
maximum success threshold
bool IsEnough(AmrrWifiRemoteStation *station) const
Check if the number of retransmission, transmission error, and successful transmission are greater th...
void DoReportRtsFailed(WifiRemoteStation *station) override
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.
void DoReportFinalDataFailed(WifiRemoteStation *station) override
This method is a pure virtual method that must be implemented by the sub-class.
bool IsSuccess(AmrrWifiRemoteStation *station) const
Check if the number of retransmission and transmission error is less than the number of successful tr...
void DoReportRxOk(WifiRemoteStation *station, double rxSnr, WifiMode txMode) 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.
WifiRemoteStation * DoCreateStation(void) const override
Time m_updatePeriod
update period
WifiTxVector DoGetDataTxVector(WifiRemoteStation *station, uint16_t allowedWidth) override
void IncreaseRate(AmrrWifiRemoteStation *station)
Increase the transmission rate to the given station.
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.
WifiTxVector DoGetRtsTxVector(WifiRemoteStation *station) override
bool IsFailure(AmrrWifiRemoteStation *station) const
Check if the number of retransmission and transmission error is greater than the number of successful...
double m_successRatio
success ratio
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:104
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.
hold per-remote-station state for AMRR Wifi manager.
hold per-remote-station state.