A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
ns3::AmrrWifiManager Class Reference
Wifi Models

AMRR Rate control algorithmThis class implements the AMRR rate control algorithm which was initially described in IEEE 802.11 Rate Adaptation: A Practical Approach, by M. Lacage, M.H. Manshaei, and T. Turletti. More...

#include <amrr-wifi-manager.h>

+ Inheritance diagram for ns3::AmrrWifiManager:
+ Collaboration diagram for ns3::AmrrWifiManager:

Public Member Functions

 AmrrWifiManager ()
- Public Member Functions inherited from ns3::WifiRemoteStationManager
 WifiRemoteStationManager ()
virtual ~WifiRemoteStationManager ()
void AddBasicMcs (uint8_t mcs)
void AddBasicMode (WifiMode mode)
void AddStationHtCapabilities (Mac48Address from, HtCapabilities htcapabilities)
void AddSupportedMcs (Mac48Address address, uint8_t mcs)
void AddSupportedMode (Mac48Address address, WifiMode mode)
WifiTxVector DoGetCtsToSelfTxVector (void)
WifiTxVector GetAckTxVector (Mac48Address address, WifiMode dataMode)
uint8_t GetBasicMcs (uint32_t i) const
WifiMode GetBasicMode (uint32_t i) const
WifiTxVector GetBlockAckTxVector (Mac48Address address, WifiMode dataMode)
WifiTxVector GetCtsToSelfTxVector (const WifiMacHeader *header, Ptr< const Packet > packet)
WifiTxVector GetCtsTxVector (Mac48Address address, WifiMode rtsMode)
WifiTxVector GetDataTxVector (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fullPacketSize)
uint8_t GetDefaultMcs (void) const
WifiMode GetDefaultMode (void) const
uint8_t GetDefaultTxPowerLevel (void) const
uint32_t GetFragmentationThreshold (void) const
uint32_t GetFragmentOffset (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fragmentNumber)
uint32_t GetFragmentSize (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fragmentNumber)
bool GetGreenfieldSupported (Mac48Address address) const
WifiRemoteStationInfo GetInfo (Mac48Address address)
uint32_t GetMaxSlrc (void) const
uint32_t GetMaxSsrc (void) const
uint32_t GetNBasicMcs (void) const
uint32_t GetNBasicModes (void) const
WifiMode GetNonUnicastMode (void) const
uint32_t GetNumberOfTransmitAntennas (void)
uint32_t GetRtsCtsThreshold (void) const
WifiTxVector GetRtsTxVector (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
bool HasHtSupported (void) const
bool IsAssociated (Mac48Address address) const
bool IsBrandNew (Mac48Address address) const
bool IsLastFragment (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fragmentNumber)
bool IsWaitAssocTxOk (Mac48Address address) const
bool NeedCtsToSelf (WifiTxVector txVector)
bool NeedDataRetransmission (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
bool NeedFragmentation (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
bool NeedRts (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
bool NeedRtsRetransmission (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
void PrepareForQueue (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fullPacketSize)
void RecordDisassociated (Mac48Address address)
void RecordGotAssocTxFailed (Mac48Address address)
void RecordGotAssocTxOk (Mac48Address address)
void RecordWaitAssocTxOk (Mac48Address address)
void ReportDataFailed (Mac48Address address, const WifiMacHeader *header)
void ReportDataOk (Mac48Address address, const WifiMacHeader *header, double ackSnr, WifiMode ackMode, double dataSnr)
void ReportFinalDataFailed (Mac48Address address, const WifiMacHeader *header)
void ReportFinalRtsFailed (Mac48Address address, const WifiMacHeader *header)
void ReportRtsFailed (Mac48Address address, const WifiMacHeader *header)
void ReportRtsOk (Mac48Address address, const WifiMacHeader *header, double ctsSnr, WifiMode ctsMode, double rtsSnr)
void ReportRxOk (Mac48Address address, const WifiMacHeader *header, double rxSnr, WifiMode txMode)
void Reset (void)
void Reset (Mac48Address address)
void SetDefaultTxPowerLevel (uint8_t txPower)
void SetFragmentationThreshold (uint32_t threshold)
void SetHtSupported (bool enable)
void SetMaxSlrc (uint32_t maxSlrc)
void SetMaxSsrc (uint32_t maxSsrc)
void SetRtsCtsThreshold (uint32_t threshold)
virtual void SetupPhy (Ptr< WifiPhy > phy)
- Public Member Functions inherited from ns3::Object
 Object ()
virtual ~Object ()
void AggregateObject (Ptr< Object > other)
void Dispose (void)
AggregateIterator GetAggregateIterator (void) const
virtual TypeId GetInstanceTypeId (void) const
template<typename T >
Ptr< T > GetObject (void) const
template<typename T >
Ptr< T > GetObject (TypeId tid) const
void Initialize (void)
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 SimpleRefCount (const SimpleRefCount &o)
uint32_t GetReferenceCount (void) const
SimpleRefCount & operator= (const SimpleRefCount &o)
void Ref (void) const
void Unref (void) const
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
void GetAttribute (std::string name, AttributeValue &value) const
bool GetAttributeFailSafe (std::string name, AttributeValue &attribute) const
void SetAttribute (std::string name, const AttributeValue &value)
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)

Static Public Member Functions

static TypeId GetTypeId (void)

Private Member Functions

void DecreaseRate (AmrrWifiRemoteStation *station)
virtual WifiRemoteStation * DoCreateStation (void) const
virtual WifiTxVector DoGetDataTxVector (WifiRemoteStation *station, uint32_t size)
virtual WifiTxVector DoGetRtsTxVector (WifiRemoteStation *station)
virtual void DoReportDataFailed (WifiRemoteStation *station)
virtual void DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr)
virtual void DoReportFinalDataFailed (WifiRemoteStation *station)
virtual void DoReportFinalRtsFailed (WifiRemoteStation *station)
virtual void DoReportRtsFailed (WifiRemoteStation *station)
virtual void DoReportRtsOk (WifiRemoteStation *station, double ctsSnr, WifiMode ctsMode, double rtsSnr)
virtual void DoReportRxOk (WifiRemoteStation *station, double rxSnr, WifiMode txMode)
void IncreaseRate (AmrrWifiRemoteStation *station)
bool IsEnough (AmrrWifiRemoteStation *station) const
bool IsFailure (AmrrWifiRemoteStation *station) const
virtual bool IsLowLatency (void) const
bool IsMaxRate (AmrrWifiRemoteStation *station) const
bool IsMinRate (AmrrWifiRemoteStation *station) const
bool IsSuccess (AmrrWifiRemoteStation *station) const
void ResetCnt (AmrrWifiRemoteStation *station)
void UpdateMode (AmrrWifiRemoteStation *station)
void UpdateRetry (AmrrWifiRemoteStation *station)

Private Attributes

double m_failureRatio
uint32_t m_maxSuccessThreshold
uint32_t m_minSuccessThreshold
double m_successRatio
Time m_updatePeriod

Additional Inherited Members

- Protected Member Functions inherited from ns3::WifiRemoteStationManager
virtual void DoDispose (void)
bool GetGreenfield (const WifiRemoteStation *station) const
uint32_t GetLongRetryCount (const WifiRemoteStation *station) const
uint8_t GetMcsSupported (const WifiRemoteStation *station, uint32_t i) const
uint32_t GetNMcsSupported (const WifiRemoteStation *station) const
uint32_t GetNSupported (const WifiRemoteStation *station) const
uint32_t GetNumberOfReceiveAntennas (const WifiRemoteStation *station) const
uint32_t GetNumberOfTransmitAntennas (const WifiRemoteStation *station) const
bool GetShortGuardInterval (const WifiRemoteStation *station) const
uint32_t GetShortRetryCount (const WifiRemoteStation *station) const
bool GetStbc (const WifiRemoteStation *station) const
WifiMode GetSupported (const WifiRemoteStation *station, uint32_t i) const

Detailed Description

AMRR Rate control algorithm

This class implements the AMRR rate control algorithm which was initially described in IEEE 802.11 Rate Adaptation: A Practical Approach, by M. Lacage, M.H. Manshaei, and T. Turletti.

Config Paths

ns3::AmrrWifiManager is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/RemoteStationManager/$ns3::AmrrWifiManager

Attributes

  • UpdatePeriod: The interval between decisions about rate control changes
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9223372036854775808.0ns:+9223372036854775807.0ns
    • Initial value: +1000000000.0ns
    • Flags: construct write read
  • FailureRatio: Ratio of minimum erroneous transmissions needed to switch to a lower rate
    • Set with class: ns3::DoubleValue
    • Underlying type: double 0:1
    • Initial value: 0.333333
    • Flags: construct write read
  • SuccessRatio: Ratio of maximum erroneous transmissions needed to switch to a higher rate
  • MaxSuccessThreshold: Maximum number of consecutive success periods needed to switch to a higher rate
  • MinSuccessThreshold: Minimum number of consecutive success periods needed to switch to a higher rate

Attributes defined in parent class ns3::WifiRemoteStationManager

  • IsLowLatency: If true, we attempt to modelize a so-called low-latency device: a device where decisions about tx parameters can be made on a per-packet basis and feedback about the transmission of each packet is obtained before sending the next. Otherwise, we modelize a high-latency device, that is a device where we cannot update our decision about tx parameters after every packet transmission.
  • MaxSsrc: The maximum number of retransmission attempts for an RTS. This value will not have any effect on some rate control algorithms.
  • MaxSlrc: The maximum number of retransmission attempts for a DATA packet. This value will not have any effect on some rate control algorithms.
  • RtsCtsThreshold: If the size of the data packet + LLC header + MAC header + FCS trailer is bigger than this value, we use an RTS/CTS handshake before sending the data, as per IEEE Std. 802.11-2007, Section 9.2.6. This value will not have any effect on some rate control algorithms.
  • FragmentationThreshold: If the size of the data packet + LLC header + MAC header + FCS trailer is biggerthan this value, we fragment it such that the size of the fragments are equal or smaller than this value, as per IEEE Std. 802.11-2007, Section 9.4. This value will not have any effect on some rate control algorithms.
  • NonUnicastMode: Wifi mode used for non-unicast transmissions.
    • Set with class: WifiModeValue
    • Underlying type: WifiMode
    • Initial value: Invalid-WifiMode
    • Flags: construct write read
  • DefaultTxPowerLevel: Default power level to be used for transmissions. This is the power level that is used by all those WifiManagers that do notimplement TX power control.

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::WifiRemoteStationManager

  • MacTxRtsFailed: The transmission of a RTS by the MAC layer has failed
  • MacTxDataFailed: The transmission of a data packet by the MAC layer has failed
  • MacTxFinalRtsFailed: The transmission of a RTS has exceeded the maximum number of attempts
  • MacTxFinalDataFailed: The transmission of a data packet has exceeded the maximum number of attempts

Definition at line 39 of file amrr-wifi-manager.h.

Constructor & Destructor Documentation

ns3::AmrrWifiManager::AmrrWifiManager ( )

Definition at line 84 of file amrr-wifi-manager.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

void ns3::AmrrWifiManager::DecreaseRate ( AmrrWifiRemoteStation *  station)
private

Definition at line 201 of file amrr-wifi-manager.cc.

References ns3::AmrrWifiRemoteStation::m_txrate, and NS_LOG_FUNCTION.

Referenced by UpdateMode().

+ Here is the caller graph for this function:

WifiRemoteStation * ns3::AmrrWifiManager::DoCreateStation ( void  ) const
privatevirtual

Definition at line 90 of file amrr-wifi-manager.cc.

References m_minSuccessThreshold, ns3::AmrrWifiRemoteStation::m_nextModeUpdate, ns3::AmrrWifiRemoteStation::m_recovery, ns3::AmrrWifiRemoteStation::m_retry, ns3::AmrrWifiRemoteStation::m_success, ns3::AmrrWifiRemoteStation::m_successThreshold, ns3::AmrrWifiRemoteStation::m_tx_err, ns3::AmrrWifiRemoteStation::m_tx_ok, ns3::AmrrWifiRemoteStation::m_tx_retr, ns3::AmrrWifiRemoteStation::m_txrate, m_updatePeriod, ns3::Now(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

WifiTxVector ns3::AmrrWifiManager::DoGetDataTxVector ( WifiRemoteStation *  station,
uint32_t  size 
)
privatevirtual

Definition at line 273 of file amrr-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), ns3::WifiRemoteStationManager::GetLongRetryCount(), ns3::WifiRemoteStationManager::GetNSupported(), ns3::WifiRemoteStationManager::GetNumberOfReceiveAntennas(), ns3::WifiRemoteStationManager::GetNumberOfTransmitAntennas(), ns3::WifiRemoteStationManager::GetShortGuardInterval(), ns3::WifiRemoteStationManager::GetStbc(), ns3::WifiRemoteStationManager::GetSupported(), ns3::AmrrWifiRemoteStation::m_retry, ns3::AmrrWifiRemoteStation::m_txrate, ns3::Min(), NS_ASSERT, NS_LOG_FUNCTION, and UpdateMode().

+ Here is the call graph for this function:

WifiTxVector ns3::AmrrWifiManager::DoGetRtsTxVector ( WifiRemoteStation *  station)
privatevirtual
Todo:
can we implement something smarter ?

Definition at line 321 of file amrr-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), ns3::WifiRemoteStationManager::GetLongRetryCount(), ns3::WifiRemoteStationManager::GetNumberOfReceiveAntennas(), ns3::WifiRemoteStationManager::GetNumberOfTransmitAntennas(), ns3::WifiRemoteStationManager::GetShortGuardInterval(), ns3::WifiRemoteStationManager::GetStbc(), ns3::WifiRemoteStationManager::GetSupported(), ns3::Min(), NS_LOG_FUNCTION, and UpdateMode().

+ Here is the call graph for this function:

void ns3::AmrrWifiManager::DoReportDataFailed ( WifiRemoteStation *  station)
privatevirtual

Definition at line 119 of file amrr-wifi-manager.cc.

References ns3::AmrrWifiRemoteStation::m_retry, ns3::AmrrWifiRemoteStation::m_tx_retr, and NS_LOG_FUNCTION.

void ns3::AmrrWifiManager::DoReportDataOk ( WifiRemoteStation *  station,
double  ackSnr,
WifiMode  ackMode,
double  dataSnr 
)
privatevirtual

Definition at line 133 of file amrr-wifi-manager.cc.

References ns3::AmrrWifiRemoteStation::m_retry, ns3::AmrrWifiRemoteStation::m_tx_ok, and NS_LOG_FUNCTION.

void ns3::AmrrWifiManager::DoReportFinalDataFailed ( WifiRemoteStation *  station)
privatevirtual

Definition at line 147 of file amrr-wifi-manager.cc.

References ns3::AmrrWifiRemoteStation::m_retry, ns3::AmrrWifiRemoteStation::m_tx_err, and NS_LOG_FUNCTION.

void ns3::AmrrWifiManager::DoReportFinalRtsFailed ( WifiRemoteStation *  station)
privatevirtual

Definition at line 142 of file amrr-wifi-manager.cc.

References NS_LOG_FUNCTION.

void ns3::AmrrWifiManager::DoReportRtsFailed ( WifiRemoteStation *  station)
privatevirtual

Definition at line 114 of file amrr-wifi-manager.cc.

References NS_LOG_FUNCTION.

void ns3::AmrrWifiManager::DoReportRtsOk ( WifiRemoteStation *  station,
double  ctsSnr,
WifiMode  ctsMode,
double  rtsSnr 
)
privatevirtual

Definition at line 127 of file amrr-wifi-manager.cc.

References NS_LOG_FUNCTION.

void ns3::AmrrWifiManager::DoReportRxOk ( WifiRemoteStation *  station,
double  rxSnr,
WifiMode  txMode 
)
privatevirtual

Definition at line 108 of file amrr-wifi-manager.cc.

References NS_LOG_FUNCTION.

TypeId ns3::AmrrWifiManager::GetTypeId ( void  )
static

Get the type ID.

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 50 of file amrr-wifi-manager.cc.

References m_failureRatio, m_maxSuccessThreshold, m_minSuccessThreshold, m_successRatio, m_updatePeriod, ns3::MakeTimeChecker(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

void ns3::AmrrWifiManager::IncreaseRate ( AmrrWifiRemoteStation *  station)
private

Definition at line 194 of file amrr-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetNSupported(), ns3::AmrrWifiRemoteStation::m_txrate, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by UpdateMode().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::AmrrWifiManager::IsEnough ( AmrrWifiRemoteStation *  station) const
private

Definition at line 180 of file amrr-wifi-manager.cc.

References ns3::AmrrWifiRemoteStation::m_tx_err, ns3::AmrrWifiRemoteStation::m_tx_ok, ns3::AmrrWifiRemoteStation::m_tx_retr, and NS_LOG_FUNCTION.

Referenced by UpdateMode().

+ Here is the caller graph for this function:

bool ns3::AmrrWifiManager::IsFailure ( AmrrWifiRemoteStation *  station) const
private

Definition at line 174 of file amrr-wifi-manager.cc.

References m_failureRatio, ns3::AmrrWifiRemoteStation::m_tx_err, ns3::AmrrWifiRemoteStation::m_tx_ok, ns3::AmrrWifiRemoteStation::m_tx_retr, and NS_LOG_FUNCTION.

Referenced by UpdateMode().

+ Here is the caller graph for this function:

bool ns3::AmrrWifiManager::IsLowLatency ( void  ) const
privatevirtual

Definition at line 332 of file amrr-wifi-manager.cc.

References NS_LOG_FUNCTION.

bool ns3::AmrrWifiManager::IsMaxRate ( AmrrWifiRemoteStation *  station) const
private

Definition at line 161 of file amrr-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetNSupported(), ns3::AmrrWifiRemoteStation::m_txrate, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by UpdateMode().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

bool ns3::AmrrWifiManager::IsMinRate ( AmrrWifiRemoteStation *  station) const
private

Definition at line 155 of file amrr-wifi-manager.cc.

References ns3::AmrrWifiRemoteStation::m_txrate, and NS_LOG_FUNCTION.

Referenced by UpdateMode().

+ Here is the caller graph for this function:

bool ns3::AmrrWifiManager::IsSuccess ( AmrrWifiRemoteStation *  station) const
private

Definition at line 168 of file amrr-wifi-manager.cc.

References m_successRatio, ns3::AmrrWifiRemoteStation::m_tx_err, ns3::AmrrWifiRemoteStation::m_tx_ok, ns3::AmrrWifiRemoteStation::m_tx_retr, and NS_LOG_FUNCTION.

Referenced by UpdateMode().

+ Here is the caller graph for this function:

void ns3::AmrrWifiManager::ResetCnt ( AmrrWifiRemoteStation *  station)
private

Definition at line 186 of file amrr-wifi-manager.cc.

References ns3::AmrrWifiRemoteStation::m_tx_err, ns3::AmrrWifiRemoteStation::m_tx_ok, ns3::AmrrWifiRemoteStation::m_tx_retr, and NS_LOG_FUNCTION.

Referenced by UpdateMode().

+ Here is the caller graph for this function:

void ns3::AmrrWifiManager::UpdateMode ( AmrrWifiRemoteStation *  station)
private

Definition at line 208 of file amrr-wifi-manager.cc.

References DecreaseRate(), ns3::WifiRemoteStationManager::GetNSupported(), IncreaseRate(), IsEnough(), IsFailure(), IsMaxRate(), IsMinRate(), IsSuccess(), m_maxSuccessThreshold, m_minSuccessThreshold, ns3::AmrrWifiRemoteStation::m_nextModeUpdate, ns3::AmrrWifiRemoteStation::m_recovery, ns3::AmrrWifiRemoteStation::m_success, ns3::AmrrWifiRemoteStation::m_successThreshold, ns3::AmrrWifiRemoteStation::m_tx_err, ns3::AmrrWifiRemoteStation::m_tx_ok, ns3::AmrrWifiRemoteStation::m_tx_retr, ns3::AmrrWifiRemoteStation::m_txrate, m_updatePeriod, ns3::Now(), ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ResetCnt().

Referenced by DoGetDataTxVector(), and DoGetRtsTxVector().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::AmrrWifiManager::UpdateRetry ( AmrrWifiRemoteStation *  station)
private

Member Data Documentation

double ns3::AmrrWifiManager::m_failureRatio
private

Definition at line 75 of file amrr-wifi-manager.h.

Referenced by GetTypeId(), and IsFailure().

uint32_t ns3::AmrrWifiManager::m_maxSuccessThreshold
private

Definition at line 77 of file amrr-wifi-manager.h.

Referenced by GetTypeId(), and UpdateMode().

uint32_t ns3::AmrrWifiManager::m_minSuccessThreshold
private

Definition at line 78 of file amrr-wifi-manager.h.

Referenced by DoCreateStation(), GetTypeId(), and UpdateMode().

double ns3::AmrrWifiManager::m_successRatio
private

Definition at line 76 of file amrr-wifi-manager.h.

Referenced by GetTypeId(), and IsSuccess().

Time ns3::AmrrWifiManager::m_updatePeriod
private

Definition at line 74 of file amrr-wifi-manager.h.

Referenced by DoCreateStation(), GetTypeId(), and UpdateMode().

The documentation for this class was generated from the following files: