/usr/include/ns3.27/ns3/amrr-wifi-manager.h is in libns3-dev 3.27+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2003,2007 INRIA
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2 as
* published by the Free Software Foundation;
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Author: Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
*/
#ifndef AMRR_WIFI_MANAGER_H
#define AMRR_WIFI_MANAGER_H
#include "ns3/traced-value.h"
#include "wifi-remote-station-manager.h"
namespace ns3 {
struct AmrrWifiRemoteStation;
/**
* \brief AMRR Rate control algorithm
* \ingroup wifi
*
* This class implements the AMRR rate control algorithm which
* was initially described in <i>IEEE 802.11 Rate Adaptation:
* A Practical Approach</i>, by M. Lacage, M.H. Manshaei, and
* T. Turletti.
*
* This RAA does not support HT, VHT nor HE modes and will error
* exit if the user tries to configure this RAA with a Wi-Fi MAC
* that has VhtSupported, HtSupported or HeSupported set.
*/
class AmrrWifiManager : public WifiRemoteStationManager
{
public:
/**
* \brief Get the type ID.
* \return the object TypeId
*/
static TypeId GetTypeId (void);
AmrrWifiManager ();
virtual ~AmrrWifiManager ();
// Inherited from WifiRemoteStationManager
void SetHtSupported (bool enable);
void SetVhtSupported (bool enable);
void SetHeSupported (bool enable);
private:
//overriden from base class
WifiRemoteStation * DoCreateStation (void) const;
void DoReportRxOk (WifiRemoteStation *station,
double rxSnr, WifiMode txMode);
void DoReportRtsFailed (WifiRemoteStation *station);
void DoReportDataFailed (WifiRemoteStation *station);
void DoReportRtsOk (WifiRemoteStation *station,
double ctsSnr, WifiMode ctsMode, double rtsSnr);
void DoReportDataOk (WifiRemoteStation *station,
double ackSnr, WifiMode ackMode, double dataSnr);
void DoReportFinalRtsFailed (WifiRemoteStation *station);
void DoReportFinalDataFailed (WifiRemoteStation *station);
WifiTxVector DoGetDataTxVector (WifiRemoteStation *station);
WifiTxVector DoGetRtsTxVector (WifiRemoteStation *station);
bool IsLowLatency (void) const;
/**
* Update the mode used to send to the given station.
*
* \param station
*/
void UpdateMode (AmrrWifiRemoteStation *station);
/**
* Reset transmission statistics of the given station.
*
* \param station
*/
void ResetCnt (AmrrWifiRemoteStation *station);
/**
* Increase the transmission rate to the given station.
*
* \param station
*/
void IncreaseRate (AmrrWifiRemoteStation *station);
/**
* Decrease the transmission rate to the given station.
*
* \param station
*/
void DecreaseRate (AmrrWifiRemoteStation *station);
/**
* Check if the current rate for the given station is the
* minimum rate.
*
* \param station
*
* \return true if the current rate is the minimum rate,
* false otherwise
*/
bool IsMinRate (AmrrWifiRemoteStation *station) const;
/**
* Check if the current rate for the given station is the
* maximum rate.
*
* \param station
*
* \return true if the current rate is the maximum rate,
* false otherwise
*/
bool IsMaxRate (AmrrWifiRemoteStation *station) const;
/**
* Check if the number of retransmission and transmission error
* is less than the number of successful transmission (times ratio).
*
* \param station
*
* \return true if the number of retransmission and transmission error
* is less than the number of successful transmission
* (times ratio), false otherwise
*/
bool IsSuccess (AmrrWifiRemoteStation *station) const;
/**
* Check if the number of retransmission and transmission error
* is greater than the number of successful transmission (times ratio).
*
* \param station
*
* \return true if the number of retransmission and transmission error
* is less than the number of successful transmission
* (times ratio), false otherwise
*/
bool IsFailure (AmrrWifiRemoteStation *station) const;
/**
* Check if the number of retransmission, transmission error,
* and successful transmission are greater than 10.
*
* \param station
* \return true if the number of retransmission, transmission error,
* and successful transmission are greater than 10,
* false otherwise
*/
bool IsEnough (AmrrWifiRemoteStation *station) const;
Time m_updatePeriod; ///< update period
double m_failureRatio; ///< failure ratio
double m_successRatio; ///< success ratio
uint32_t m_maxSuccessThreshold; ///< maximum success threshold
uint32_t m_minSuccessThreshold; ///< mnimum success threshold
TracedValue<uint64_t> m_currentRate; //!< Trace rate changes
};
} //namespace ns3
#endif /* AMRR_WIFI_MANAGER_H */
|