Robust Rate Adaptation Algorithm. More...

#include "rraa-wifi-manager.h"

Inheritance diagram for ns3::RraaWifiManager:

Collaboration diagram for ns3::RraaWifiManager:

Public Member Functions
	RraaWifiManager ()

	~RraaWifiManager () override

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 parameters (e.g.

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 rates that are supported.

Public Member Functions inherited from ns3::WifiRemoteStationManager
	WifiRemoteStationManager ()

	~WifiRemoteStationManager () override

void	AddAllSupportedMcs (Mac48Address address)
	Invoked in a STA or AP to store all of the MCS supported by a destination which is also supported locally.

void	AddAllSupportedModes (Mac48Address address)
	Invoked in a STA or AP to store all of the modes supported by a destination which is also supported locally.

void	AddBasicMcs (WifiMode mcs)
	Add a given Modulation and Coding Scheme (MCS) index to the set of basic MCS.

void	AddBasicMode (WifiMode mode)
	Invoked in a STA upon association to store the set of rates which belong to the BSSBasicRateSet of the associated AP and which are supported locally.

void	AddStationEhtCapabilities (Mac48Address from, EhtCapabilities ehtCapabilities)
	Records EHT capabilities of the remote station.

void	AddStationHe6GhzCapabilities (const Mac48Address &from, const He6GhzBandCapabilities &he6GhzCapabilities)
	Records HE 6 GHz Band Capabilities of a remote station.

void	AddStationHeCapabilities (Mac48Address from, HeCapabilities heCapabilities)
	Records HE capabilities of the remote station.

void	AddStationHtCapabilities (Mac48Address from, HtCapabilities htCapabilities)
	Records HT capabilities of the remote station.

void	AddStationMleCommonInfo (Mac48Address from, const std::shared_ptr< CommonInfoBasicMle > &mleCommonInfo)
	Records the Common Info field advertised by the given remote station in a Multi-Link Element.

void	AddStationVhtCapabilities (Mac48Address from, VhtCapabilities vhtCapabilities)
	Records VHT capabilities of the remote station.

void	AddSupportedErpSlotTime (Mac48Address address, bool isShortSlotTimeSupported)
	Record whether the short ERP slot time is supported by the station.

void	AddSupportedMcs (Mac48Address address, WifiMode mcs)
	Record the MCS index supported by the station.

void	AddSupportedMode (Mac48Address address, WifiMode mode)
	Invoked in a STA or AP to store the set of modes supported by a destination which is also supported locally.

void	AddSupportedPhyPreamble (Mac48Address address, bool isShortPreambleSupported)
	Record whether the short PHY preamble is supported by the station.

void	AdjustTxVectorForIcf (WifiTxVector &txVector) const
	Adjust the TXVECTOR for an initial Control frame to ensure that the modulation class is non-HT and the rate is 6 Mbps, 12 Mbps or 24 Mbps.

virtual int64_t	AssignStreams (int64_t stream)
	Assign a fixed random variable stream number to the random variables used by this model.

WifiTxVector	GetAckTxVector (Mac48Address to, const WifiTxVector &dataTxVector) const
	Return a TXVECTOR for the Ack frame given the destination and the mode of the Data used by the sender.

std::optional< Mac48Address >	GetAffiliatedStaAddress (const Mac48Address &mldAddress) const
	Get the address of the remote station operating on this link and affiliated with the MLD having the given MAC address, if any.

uint16_t	GetAssociationId (Mac48Address remoteAddress) const
	Get the AID of a remote station.

WifiMode	GetBasicMcs (uint8_t i) const
	Return the MCS at the given list index.

WifiMode	GetBasicMode (uint8_t i) const
	Return a basic mode from the set of basic modes.

WifiTxVector	GetBlockAckTxVector (Mac48Address to, const WifiTxVector &dataTxVector) const
	Return a TXVECTOR for the BlockAck frame given the destination and the mode of the Data used by the sender.

MHz_u	GetChannelWidthSupported (Mac48Address address) const
	Return the channel width supported by the station.

WifiMode	GetControlAnswerMode (WifiMode reqMode) const
	Get control answer mode function.

WifiTxVector	GetCtsToSelfTxVector ()
	Since CTS-to-self parameters are not dependent on the station, it is implemented in wifi remote station manager.

WifiTxVector	GetCtsTxVector (Mac48Address to, WifiMode rtsTxMode) const
	Return a TXVECTOR for the CTS frame given the destination and the mode of the RTS used by the sender.

WifiTxVector	GetDataTxVector (const WifiMacHeader &header, MHz_u allowedWidth)

WifiMode	GetDefaultMcs () const
	Return the default Modulation and Coding Scheme (MCS) index.

WifiMode	GetDefaultMode () const
	Return the default transmission mode.

WifiMode	GetDefaultModeForSta (const WifiRemoteStation *st) const
	Return the default MCS to use to transmit frames to the given station.

uint8_t	GetDefaultTxPowerLevel () const

bool	GetDsssSupported (const Mac48Address &address) const
	Return whether the station supports DSSS or not.

bool	GetEhtSupported () const
	Return whether the device has EHT capability support enabled.

bool	GetEhtSupported (Mac48Address address) const
	Return whether the station supports EHT or not.

bool	GetEmlsrEnabled (const Mac48Address &address) const

bool	GetEmlsrSupported (const Mac48Address &address) const

bool	GetErpOfdmSupported (const Mac48Address &address) const
	Return whether the station supports ERP OFDM or not.

uint32_t	GetFragmentationThreshold () const
	Return the fragmentation threshold.

uint32_t	GetFragmentOffset (Ptr< const WifiMpdu > mpdu, uint32_t fragmentNumber)

uint32_t	GetFragmentSize (Ptr< const WifiMpdu > mpdu, uint32_t fragmentNumber)

Time	GetGuardInterval () const
	Return the supported HE guard interval duration.

bool	GetHeSupported () const
	Return whether the device has HE capability support enabled.

bool	GetHeSupported (Mac48Address address) const
	Return whether the station supports HE or not.

bool	GetHtSupported () const
	Return whether the device has HT capability support enabled on the link this manager is associated with.

bool	GetHtSupported (Mac48Address address) const
	Return whether the station supports HT or not.

WifiRemoteStationInfo	GetInfo (Mac48Address address)

bool	GetLdpcSupported () const
	Return whether the device has LDPC support enabled.

bool	GetLdpcSupported (Mac48Address address) const
	Return whether the station supports LDPC or not.

Ptr< WifiMac >	GetMac () const
	Return the WifiMac.

uint8_t	GetMaxNumberOfTransmitStreams () const

std::optional< Mac48Address >	GetMldAddress (const Mac48Address &address) const
	Get the address of the MLD the given station is affiliated with, if any.

std::optional< dBm_u >	GetMostRecentRssi (Mac48Address address) const

uint8_t	GetNBasicMcs () const
	Return the number of basic MCS index.

uint8_t	GetNBasicModes () const
	Return the number of basic modes we support.

uint8_t	GetNMcsSupported (Mac48Address address) const
	Return the number of MCS supported by the station.

uint32_t	GetNNonErpBasicModes () const
	Return the number of non-ERP basic modes we support.

WifiMode	GetNonErpBasicMode (uint8_t i) const
	Return a basic mode from the set of basic modes that is not an ERP mode.

WifiMode	GetNonUnicastMode () const
	Return a mode for non-unicast packets.

uint8_t	GetNumberOfAntennas () const

uint8_t	GetNumberOfSupportedStreams (Mac48Address address) const
	Return the number of spatial streams supported by the station.

bool	GetOfdmSupported (const Mac48Address &address) const
	Return whether the station supports OFDM or not.

Ptr< WifiPhy >	GetPhy () const
	Return the WifiPhy.

bool	GetQosSupported (Mac48Address address) const
	Return whether the given station is QoS capable.

WifiTxVector	GetRtsTxVector (Mac48Address address, MHz_u allowedWidth)

bool	GetShortGuardIntervalSupported () const
	Return whether the device has SGI support enabled.

bool	GetShortGuardIntervalSupported (Mac48Address address) const
	Return whether the station supports HT/VHT short guard interval.

bool	GetShortPreambleEnabled () const
	Return whether the device uses short PHY preambles.

bool	GetShortPreambleSupported (Mac48Address address) const
	Return whether the station supports short PHY preamble or not.

bool	GetShortSlotTimeEnabled () const
	Return whether the device uses short slot time.

bool	GetShortSlotTimeSupported (Mac48Address address) const
	Return whether the station supports short ERP slot time or not.

Ptr< const EhtCapabilities >	GetStationEhtCapabilities (Mac48Address from)
	Return the EHT capabilities sent by the remote station.

std::optional< std::reference_wrapper< CommonInfoBasicMle::EmlCapabilities > >	GetStationEmlCapabilities (const Mac48Address &from)

Ptr< const He6GhzBandCapabilities >	GetStationHe6GhzCapabilities (const Mac48Address &from) const
	Return the HE 6 GHz Band Capabilities sent by a remote station.

Ptr< const HeCapabilities >	GetStationHeCapabilities (Mac48Address from)
	Return the HE capabilities sent by the remote station.

Ptr< const HtCapabilities >	GetStationHtCapabilities (Mac48Address from)
	Return the HT capabilities sent by the remote station.

std::optional< std::reference_wrapper< CommonInfoBasicMle::MldCapabilities > >	GetStationMldCapabilities (const Mac48Address &from)

Ptr< const VhtCapabilities >	GetStationVhtCapabilities (Mac48Address from)
	Return the VHT capabilities sent by the remote station.

bool	GetUseNonErpProtection () const
	Return whether the device supports protection of non-ERP stations.

bool	GetUseNonHtProtection () const
	Return whether the device supports protection of non-HT stations.

bool	GetVhtSupported () const
	Return whether the device has VHT capability support enabled on the link this manager is associated with.

bool	GetVhtSupported (Mac48Address address) const
	Return whether the station supports VHT or not.

bool	IsAssociated (Mac48Address address) const
	Return whether the station associated.

bool	IsAssocRefused (Mac48Address address) const
	Return whether we refused an association request from the given station.

bool	IsBrandNew (Mac48Address address) const
	Return whether the station state is brand new.

bool	IsInPsMode (const Mac48Address &address) const
	Return whether the STA is currently in Power Save mode.

bool	IsLastFragment (Ptr< const WifiMpdu > mpdu, uint32_t fragmentNumber)

bool	IsWaitAssocTxOk (Mac48Address address) const
	Return whether we are waiting for an ACK for the association response we sent.

bool	NeedCtsToSelf (WifiTxVector txVector)
	Return if we need to do CTS-to-self before sending a DATA.

bool	NeedFragmentation (Ptr< const WifiMpdu > mpdu)

bool	NeedRetransmission (Ptr< const WifiMpdu > mpdu)

bool	NeedRts (const WifiMacHeader &header, const WifiTxParameters &txParams)

void	RecordAssocRefused (Mac48Address address)
	Records that association request was refused.

void	RecordDisassociated (Mac48Address address)
	Records that the STA was disassociated.

void	RecordGotAssocTxFailed (Mac48Address address)
	Records that we missed an ACK for the association response we sent.

void	RecordGotAssocTxOk (Mac48Address address)
	Records that we got an ACK for the association response we sent.

void	RecordWaitAssocTxOk (Mac48Address address)
	Records that we are waiting for an ACK for the association response we sent.

void	RemoveAllSupportedMcs (Mac48Address address)
	Invoked in a STA or AP to delete all of the supported MCS by a destination.

void	ReportAmpduTxStatus (Mac48Address address, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus, double rxSnr, double dataSnr, WifiTxVector dataTxVector)
	Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed.

void	ReportDataFailed (Ptr< const WifiMpdu > mpdu)
	Should be invoked whenever the AckTimeout associated to a transmission attempt expires.

void	ReportDataOk (Ptr< const WifiMpdu > mpdu, double ackSnr, WifiMode ackMode, double dataSnr, WifiTxVector dataTxVector)
	Should be invoked whenever we receive the ACK associated to a data packet we just sent.

void	ReportFinalDataFailed (Ptr< const WifiMpdu > mpdu)
	Should be invoked after calling ReportDataFailed if NeedRetransmission returns false.

void	ReportFinalRtsFailed (const WifiMacHeader &header)
	Should be invoked after calling ReportRtsFailed if NeedRetransmission returns false.

void	ReportRtsFailed (const WifiMacHeader &header)
	Should be invoked whenever the RtsTimeout associated to a transmission attempt expires.

void	ReportRtsOk (const WifiMacHeader &header, double ctsSnr, WifiMode ctsMode, double rtsSnr)
	Should be invoked whenever we receive the CTS associated to an RTS we just sent.

void	ReportRxOk (Mac48Address address, RxSignalInfo rxSignalInfo, WifiTxVector txVector)

void	Reset ()
	Reset the station, invoked in a STA upon dis-association or in an AP upon reboot.

void	SetAssociationId (Mac48Address remoteAddress, uint16_t aid)
	Record the AID of a remote station.

void	SetDefaultTxPowerLevel (uint8_t txPower)
	Set the default transmission power level.

void	SetEmlsrEnabled (const Mac48Address &from, bool emlsrEnabled)

void	SetFragmentationThreshold (uint32_t threshold)
	Sets a fragmentation threshold.

void	SetMaxSlrc (uint32_t maxSlrc)
	Sets the maximum STA long retry count (SLRC).

void	SetMaxSsrc (uint32_t maxSsrc)
	Sets the maximum STA short retry count (SSRC).

void	SetPsMode (const Mac48Address &address, bool isInPsMode)
	Register whether the STA is in Power Save mode or not.

void	SetQosSupport (Mac48Address from, bool qosSupported)
	Records QoS support of the remote station.

void	SetRtsCtsThreshold (uint32_t threshold)
	Sets the RTS threshold.

void	SetShortPreambleEnabled (bool enable)
	Enable or disable short PHY preambles.

void	SetShortSlotTimeEnabled (bool enable)
	Enable or disable short slot time.

void	SetUseNonErpProtection (bool enable)
	Enable or disable protection for non-ERP stations.

void	SetUseNonHtProtection (bool enable)
	Enable or disable protection for non-HT stations.

bool	UseLdpcForDestination (Mac48Address dest) const

Public Member Functions inherited from ns3::Object
	Object ()
	Constructor.

	~Object () override
	Destructor.

void	AggregateObject (Ptr< Object > other)
	Aggregate two Objects together.

void	Dispose ()
	Dispose of this Object.

AggregateIterator	GetAggregateIterator () const
	Get an iterator to the Objects aggregated to this one.

TypeId	GetInstanceTypeId () const override
	Get the most derived TypeId for this Object.

template<typename T >
Ptr< T >	GetObject () const
	Get a pointer to the requested aggregated Object.

template<>
Ptr< Object >	GetObject () const
	Specialization of () for objects of type ns3::Object.

template<typename T >
Ptr< T >	GetObject (TypeId tid) const
	Get a pointer to the requested aggregated Object by TypeId.

template<>
Ptr< Object >	GetObject (TypeId tid) const
	Specialization of (TypeId tid) for objects of type ns3::Object.

void	Initialize ()
	Invoke DoInitialize on all Objects aggregated to this one.

bool	IsInitialized () const
	Check if the object has been initialized.

void	UnidirectionalAggregateObject (Ptr< Object > other)
	Aggregate an Object to another Object.

Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
	SimpleRefCount ()
	Default constructor.

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor.

uint32_t	GetReferenceCount () const
	Get the reference count of the object.

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator.

void	Ref () const
	Increment the reference count.

void	Unref () const
	Decrement the reference count.

Public Member Functions inherited from ns3::ObjectBase
virtual	~ObjectBase ()
	Virtual destructor.

void	GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
	Get the value of an attribute, raising fatal errors if unsuccessful.

bool	GetAttributeFailSafe (std::string name, AttributeValue &value) const
	Get the value of an attribute without raising errors.

void	SetAttribute (std::string name, const AttributeValue &value)
	Set a single attribute, raising fatal errors if unsuccessful.

bool	SetAttributeFailSafe (std::string name, const AttributeValue &value)
	Set a single attribute without raising errors.

bool	TraceConnect (std::string name, std::string context, const CallbackBase &cb)
	Connect a TraceSource to a Callback with a context.

bool	TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
	Connect a TraceSource to a Callback without a context.

bool	TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected with a context.

bool	TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
	Disconnect from a TraceSource a Callback previously connected without a context.

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::WifiRemoteStationManager
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::Object
static TypeId	GetTypeId ()
	Register this type.

Static Public Member Functions inherited from ns3::ObjectBase
static TypeId	GetTypeId ()
	Get the type ID.

Private Types
typedef std::vector< std::pair< Time, WifiMode > >	TxTime
	typedef for a vector of a pair of Time, WifiMode.

Private Member Functions
void	AddCalcTxTime (WifiMode mode, Time t)
	Add transmission time for the given mode to an internal list.

void	ARts (RraaWifiRemoteStation *station)
	Activate the use of RTS for the given station if the conditions are met.

void	CheckInit (RraaWifiRemoteStation *station)
	Check for initializations.

void	CheckTimeout (RraaWifiRemoteStation *station)
	Check if the counter should be reset.

WifiRemoteStation *	DoCreateStation () const override

WifiTxVector	DoGetDataTxVector (WifiRemoteStation *station, MHz_u allowedWidth) override

WifiTxVector	DoGetRtsTxVector (WifiRemoteStation *station) override

void	DoInitialize () override
	Initialize() implementation.

bool	DoNeedRts (WifiRemoteStation *st, uint32_t size, bool normally) override

void	DoReportDataFailed (WifiRemoteStation *station) override
	This method is a pure virtual method that must be implemented by the sub-class.

void	DoReportDataOk (WifiRemoteStation *station, double ackSnr, WifiMode ackMode, double dataSnr, MHz_u dataChannelWidth, uint8_t dataNss) override
	This method is a pure virtual method that must be implemented by the sub-class.

void	DoReportFinalDataFailed (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.

void	DoReportRtsFailed (WifiRemoteStation *station) override
	This method is a pure virtual method that must be implemented by the sub-class.

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	DoReportRxOk (WifiRemoteStation *station, double rxSnr, WifiMode txMode) override
	This method is a pure virtual method that must be implemented by the sub-class.

Time	GetCalcTxTime (WifiMode mode) const
	Get the estimated TxTime of a packet with a given mode.

uint8_t	GetMaxRate (RraaWifiRemoteStation *station) const
	Return the index for the maximum transmission rate for the given station.

WifiRraaThresholds	GetThresholds (RraaWifiRemoteStation *station, uint8_t index) const
	Get the thresholds for the given station and mode index.

WifiRraaThresholds	GetThresholds (RraaWifiRemoteStation *station, WifiMode mode) const
	Get the thresholds for the given station and mode.

void	InitThresholds (RraaWifiRemoteStation *station)
	Initialize the thresholds internal list for the given station.

void	ResetCountersBasic (RraaWifiRemoteStation *station)
	Reset the counters of the given station.

void	RunBasicAlgorithm (RraaWifiRemoteStation *station)
	Find an appropriate rate for the given station, using a basic algorithm.

Private Attributes
uint32_t	m_ackLength
	Ack frame length used to calculate mode TxTime.

double	m_alpha
	Alpha value for RRAA (value for calculating MTL threshold)

bool	m_basic
	basic

double	m_beta
	Beta value for RRAA (value for calculating ORI threshold).

TxTime	m_calcTxTime
	To hold all the calculated TxTime for all modes.

TracedValue< uint64_t >	m_currentRate
	Trace rate changes.

Time	m_difs
	Value of DIFS configured in the device.

uint32_t	m_frameLength
	Data frame length used to calculate mode TxTime.

Time	m_sifs
	Value of SIFS configured in the device.

double	m_tau
	Tau value for RRAA (value for calculating EWND size).

Time	m_timeout
	timeout

Additional Inherited Members
Public Types inherited from ns3::WifiRemoteStationManager
typedef void(*	PowerChangeTracedCallback) (double oldPower, double newPower, Mac48Address remoteAddress)
	TracedCallback signature for power change events.

enum	ProtectionMode { RTS_CTS , CTS_TO_SELF }
	ProtectionMode enumeration. More...

typedef void(*	RateChangeTracedCallback) (DataRate oldRate, DataRate newRate, Mac48Address remoteAddress)
	TracedCallback signature for rate change events.

using	Stations = std::unordered_map<Mac48Address, WifiRemoteStation*, WifiAddressHash>
	A map of WifiRemoteStations with Mac48Address as key.

using	StationStates
	A map of WifiRemoteStationStates with Mac48Address as key.

Protected Member Functions inherited from ns3::WifiRemoteStationManager
void	DoDispose () override
	Destructor implementation.

Mac48Address	GetAddress (const WifiRemoteStation *station) const
	Return the address of the station.

bool	GetAggregation (const WifiRemoteStation *station) const
	Return whether the given station supports A-MPDU.

MHz_u	GetChannelWidth (const WifiRemoteStation *station) const
	Return the channel width supported by the station.

bool	GetEhtSupported (const WifiRemoteStation *station) const
	Return whether the given station is EHT capable.

bool	GetEmlsrEnabled (const WifiRemoteStation *station) const

bool	GetEmlsrSupported (const WifiRemoteStation *station) const

Time	GetGuardInterval (const WifiRemoteStation *station) const
	Return the HE guard interval duration supported by the station.

bool	GetHeSupported (const WifiRemoteStation *station) const
	Return whether the given station is HE capable.

bool	GetHtSupported (const WifiRemoteStation *station) const
	Return whether the given station is HT capable.

WifiMode	GetMcsSupported (const WifiRemoteStation *station, uint8_t i) const
	Return the WifiMode supported by the specified station at the specified index.

uint8_t	GetNess (const WifiRemoteStation *station) const

uint8_t	GetNMcsSupported (const WifiRemoteStation *station) const
	Return the number of MCS supported by the given station.

uint32_t	GetNNonErpSupported (const WifiRemoteStation *station) const
	Return the number of non-ERP modes supported by the given station.

WifiMode	GetNonErpSupported (const WifiRemoteStation *station, uint8_t i) const
	Return whether non-ERP mode associated with the specified station at the specified index.

uint8_t	GetNSupported (const WifiRemoteStation *station) const
	Return the number of modes supported by the given station.

uint8_t	GetNumberOfSupportedStreams (const WifiRemoteStation *station) const
	Return the number of supported streams the station has.

bool	GetQosSupported (const WifiRemoteStation *station) const
	Return whether the given station is QoS capable.

bool	GetShortGuardIntervalSupported (const WifiRemoteStation *station) const
	Return whether the given station supports HT/VHT short guard interval.

WifiMode	GetSupported (const WifiRemoteStation *station, uint8_t i) const
	Return whether mode associated with the specified station at the specified index.

bool	GetVhtSupported (const WifiRemoteStation *station) const
	Return whether the given station is VHT capable.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	NotifyNewAggregate ()
	Notify all Objects aggregated to this one of a new Object being aggregated.

Protected Member Functions inherited from ns3::ObjectBase
void	ConstructSelf (const AttributeConstructionList &attributes)
	Complete construction of ObjectBase; invoked by derived classes.

virtual void	NotifyConstructionCompleted ()
	Notifier called once the ObjectBase is fully constructed.

Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

Robust Rate Adaptation Algorithm.

This is an implementation of RRAA as described in "Robust rate adaptation for 802.11 wireless networks" by "Starsky H. Y. Wong", "Hao Yang", "Songwu Lu", and, "Vaduvur Bharghavan" published in Mobicom 06.

This RAA does not support HT modes and will error exit if the user tries to configure this RAA with a Wi-Fi MAC that supports 802.11n or higher.

Definition at line 47 of file rraa-wifi-manager.h.

Member Typedef Documentation

◆ TxTime

typedef std::vector<std::pair<Time, WifiMode> > ns3::RraaWifiManager::TxTime

private

typedef for a vector of a pair of Time, WifiMode.

Essentially a list for WifiMode and its corresponding transmission time to transmit a reference packet.

Definition at line 167 of file rraa-wifi-manager.h.

Constructor & Destructor Documentation

◆ RraaWifiManager()

ns3::RraaWifiManager::RraaWifiManager ( )

Definition at line 99 of file rraa-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ ~RraaWifiManager()

ns3::RraaWifiManager::~RraaWifiManager ( )

override

Definition at line 106 of file rraa-wifi-manager.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AddCalcTxTime()

void ns3::RraaWifiManager::AddCalcTxTime	(	WifiMode	mode,
		Time	t )

private

Add transmission time for the given mode to an internal list.

Parameters

mode	the WifiMode
t	transmission time

Definition at line 173 of file rraa-wifi-manager.cc.

References m_calcTxTime, and NS_LOG_FUNCTION.

Referenced by SetupPhy().

Here is the caller graph for this function:

◆ ARts()

void ns3::RraaWifiManager::ARts ( RraaWifiRemoteStation * station )

private

Activate the use of RTS for the given station if the conditions are met.

Parameters

station the remote station

Definition at line 451 of file rraa-wifi-manager.cc.

References ns3::RraaWifiRemoteStation::m_adaptiveRtsOn, ns3::RraaWifiRemoteStation::m_adaptiveRtsWnd, ns3::RraaWifiRemoteStation::m_lastFrameFail, and ns3::RraaWifiRemoteStation::m_rtsCounter.

Referenced by DoNeedRts().

Here is the caller graph for this function:

◆ CheckInit()

void ns3::RraaWifiManager::CheckInit ( RraaWifiRemoteStation * station )

private

Check for initializations.

Parameters

station The remote station.

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

References GetMaxRate(), ns3::WifiRemoteStationManager::GetNSupported(), InitThresholds(), ns3::RraaWifiRemoteStation::m_initialized, ns3::RraaWifiRemoteStation::m_nRate, ns3::RraaWifiRemoteStation::m_rateIndex, ns3::RraaWifiRemoteStation::m_thresholds, NS_LOG_FUNCTION, and ResetCountersBasic().

Referenced by DoGetDataTxVector(), and DoNeedRts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckTimeout()

void ns3::RraaWifiManager::CheckTimeout ( RraaWifiRemoteStation * station )

private

Check if the counter should be reset.

Parameters

station the remote station

Definition at line 420 of file rraa-wifi-manager.cc.

References ns3::RraaWifiRemoteStation::m_counter, ns3::RraaWifiRemoteStation::m_lastReset, m_timeout, ns3::Simulator::Now(), NS_LOG_FUNCTION, and ResetCountersBasic().

Referenced by DoReportDataFailed(), and DoReportDataOk().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoCreateStation()

WifiRemoteStation * ns3::RraaWifiManager::DoCreateStation ( ) const

overrideprivatevirtual

Returns: a new station data structure

Implements ns3::WifiRemoteStationManager.

Definition at line 196 of file rraa-wifi-manager.cc.

◆ DoGetDataTxVector()

WifiTxVector ns3::RraaWifiManager::DoGetDataTxVector	(	WifiRemoteStation *	station,
		MHz_u	allowedWidth )

overrideprivatevirtual

Parameters

station	the station that we need to communicate
allowedWidth	the allowed width to send a packet to the station

Returns: the TXVECTOR to use to send a packet to the station

Note: This method is called before sending a unicast packet or a fragment of a unicast packet to decide which transmission mode to use.

Implements ns3::WifiRemoteStationManager.

Definition at line 345 of file rraa-wifi-manager.cc.

References CheckInit(), ns3::WifiRemoteStationManager::GetAggregation(), ns3::WifiRemoteStationManager::GetChannelWidth(), ns3::WifiMode::GetDataRate(), ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), ns3::WifiMode::GetModulationClass(), ns3::GetPreambleForTransmission(), ns3::WifiRemoteStationManager::GetShortPreambleEnabled(), ns3::WifiRemoteStationManager::GetSupported(), m_currentRate, ns3::NanoSeconds(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoGetRtsTxVector()

WifiTxVector ns3::RraaWifiManager::DoGetRtsTxVector ( WifiRemoteStation * station )

overrideprivatevirtual

Parameters

station the station that we need to communicate

Returns: the transmission mode to use to send an RTS to the station

Note: This method is called before sending an RTS to a station to decide which transmission mode to use for the RTS.

Implements ns3::WifiRemoteStationManager.

Definition at line 375 of file rraa-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetAggregation(), ns3::WifiRemoteStationManager::GetChannelWidth(), ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), ns3::WifiMode::GetModulationClass(), ns3::WifiRemoteStationManager::GetNonErpSupported(), ns3::GetPreambleForTransmission(), ns3::WifiRemoteStationManager::GetShortPreambleEnabled(), ns3::WifiRemoteStationManager::GetSupported(), ns3::WifiRemoteStationManager::GetUseNonErpProtection(), ns3::NanoSeconds(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoInitialize()

void ns3::RraaWifiManager::DoInitialize ( )

overrideprivatevirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 140 of file rraa-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetHeSupported(), ns3::WifiRemoteStationManager::GetHtSupported(), ns3::WifiRemoteStationManager::GetVhtSupported(), NS_FATAL_ERROR, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoNeedRts()

bool ns3::RraaWifiManager::DoNeedRts	(	WifiRemoteStation *	station,
		uint32_t	size,
		bool	normally )

overrideprivatevirtual

Parameters

station	the station that we need to communicate
size	the size of the frame to send in bytes
normally	indicates whether the normal 802.11 RTS enable mechanism would request that the RTS is sent or not.

Returns: true if we want to use an RTS/CTS handshake for this frame before sending it, false otherwise.

Note: This method is called before a unicast packet is sent on the medium.

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 406 of file rraa-wifi-manager.cc.

References ARts(), CheckInit(), m_basic, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ DoReportDataFailed()

void ns3::RraaWifiManager::DoReportDataFailed ( WifiRemoteStation * station )

overrideprivatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters

station the station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 290 of file rraa-wifi-manager.cc.

References CheckTimeout(), ns3::RraaWifiRemoteStation::m_lastFrameFail, NS_LOG_FUNCTION, and RunBasicAlgorithm().

Here is the call graph for this function:

◆ DoReportDataOk()

void ns3::RraaWifiManager::DoReportDataOk	(	WifiRemoteStation *	station,
		double	ackSnr,
		WifiMode	ackMode,
		double	dataSnr,
		MHz_u	dataChannelWidth,
		uint8_t	dataNss )

overrideprivatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters

station	the station that we successfully sent RTS
ackSnr	the SNR of the ACK we received
ackMode	the WifiMode the receiver used to send the ACK
dataSnr	the SNR of the DATA we sent
dataChannelWidth	the channel width of the DATA we sent
dataNss	the number of spatial streams used to send the DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 317 of file rraa-wifi-manager.cc.

References CheckTimeout(), ns3::RraaWifiRemoteStation::m_lastFrameFail, NS_LOG_FUNCTION, and RunBasicAlgorithm().

Here is the call graph for this function:

◆ DoReportFinalDataFailed()

void ns3::RraaWifiManager::DoReportFinalDataFailed ( WifiRemoteStation * station )

overrideprivatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters

station the station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 339 of file rraa-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportFinalRtsFailed()

void ns3::RraaWifiManager::DoReportFinalRtsFailed ( WifiRemoteStation * station )

overrideprivatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters

station the station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 333 of file rraa-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRtsFailed()

void ns3::RraaWifiManager::DoReportRtsFailed ( WifiRemoteStation * station )

overrideprivatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters

station the station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 284 of file rraa-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRtsOk()

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

overrideprivatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters

station	the station that we successfully sent RTS
ctsSnr	the SNR of the CTS we received
ctsMode	the WifiMode the receiver used to send the CTS
rtsSnr	the SNR of the RTS we sent

Implements ns3::WifiRemoteStationManager.

Definition at line 308 of file rraa-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRxOk()

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

overrideprivatevirtual

This method is a pure virtual method that must be implemented by the sub-class.

This allows different types of WifiRemoteStationManager to respond differently,

Parameters

station	the station that sent the DATA to us
rxSnr	the SNR of the DATA we received
txMode	the WifiMode the sender used to send the DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 302 of file rraa-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ GetCalcTxTime()

Time ns3::RraaWifiManager::GetCalcTxTime ( WifiMode mode ) const

private

Get the estimated TxTime of a packet with a given mode.

Parameters

mode	the WifiMode

Returns: the estimated TX time

Definition at line 158 of file rraa-wifi-manager.cc.

References m_calcTxTime, NS_ASSERT, NS_LOG_FUNCTION, and ns3::Seconds().

Referenced by InitThresholds().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMaxRate()

uint8_t ns3::RraaWifiManager::GetMaxRate ( RraaWifiRemoteStation * station ) const

private

Return the index for the maximum transmission rate for the given station.

Parameters

station the remote station

Returns: the index for the maximum transmission rate

Definition at line 278 of file rraa-wifi-manager.cc.

References ns3::RraaWifiRemoteStation::m_nRate.

Referenced by CheckInit(), InitThresholds(), and RunBasicAlgorithm().

Here is the caller graph for this function:

◆ GetThresholds() [1/2]

WifiRraaThresholds ns3::RraaWifiManager::GetThresholds	(	RraaWifiRemoteStation *	station,
		uint8_t	index ) const

private

Get the thresholds for the given station and mode index.

Parameters

station	the remote station
index	the mode index in the supported rates

Returns: the RRAA thresholds

Definition at line 476 of file rraa-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetSupported(), GetThresholds(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetThresholds() [2/2]

WifiRraaThresholds ns3::RraaWifiManager::GetThresholds	(	RraaWifiRemoteStation *	station,
		WifiMode	mode ) const

private

Get the thresholds for the given station and mode.

Parameters

station	the remote station
mode	the WifiMode

Returns: the RRAA thresholds

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

References ns3::RraaWifiRemoteStation::m_thresholds, NS_ABORT_MSG, and NS_LOG_FUNCTION.

Referenced by GetThresholds(), ResetCountersBasic(), and RunBasicAlgorithm().

Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::RraaWifiManager::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 49 of file rraa-wifi-manager.cc.

References m_ackLength, m_alpha, m_basic, m_beta, m_currentRate, m_frameLength, m_tau, m_timeout, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MakeUintegerAccessor(), ns3::MakeUintegerChecker(), ns3::Seconds(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ InitThresholds()

void ns3::RraaWifiManager::InitThresholds ( RraaWifiRemoteStation * station )

private

Initialize the thresholds internal list for the given station.

Parameters

station the remote station

Definition at line 229 of file rraa-wifi-manager.cc.

References GetCalcTxTime(), GetMaxRate(), ns3::Time::GetSeconds(), ns3::WifiRemoteStationManager::GetSupported(), m_alpha, m_beta, m_difs, ns3::WifiRraaThresholds::m_ewnd, ns3::WifiRraaThresholds::m_mtl, ns3::RraaWifiRemoteStation::m_nRate, ns3::WifiRraaThresholds::m_ori, m_sifs, m_tau, ns3::RraaWifiRemoteStation::m_thresholds, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by CheckInit().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ResetCountersBasic()

void ns3::RraaWifiManager::ResetCountersBasic ( RraaWifiRemoteStation * station )

private

Reset the counters of the given station.

Parameters

station the remote station

Definition at line 269 of file rraa-wifi-manager.cc.

References GetThresholds(), ns3::RraaWifiRemoteStation::m_counter, ns3::WifiRraaThresholds::m_ewnd, ns3::RraaWifiRemoteStation::m_lastReset, ns3::RraaWifiRemoteStation::m_nFailed, ns3::RraaWifiRemoteStation::m_rateIndex, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Referenced by CheckInit(), CheckTimeout(), and RunBasicAlgorithm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RunBasicAlgorithm()

void ns3::RraaWifiManager::RunBasicAlgorithm ( RraaWifiRemoteStation * station )

private

Find an appropriate rate for the given station, using a basic algorithm.

Parameters

station the remote station

Definition at line 431 of file rraa-wifi-manager.cc.

References GetMaxRate(), GetThresholds(), ns3::RraaWifiRemoteStation::m_counter, ns3::WifiRraaThresholds::m_ewnd, ns3::WifiRraaThresholds::m_mtl, ns3::RraaWifiRemoteStation::m_nFailed, ns3::WifiRraaThresholds::m_ori, ns3::RraaWifiRemoteStation::m_rateIndex, NS_LOG_FUNCTION, and ResetCountersBasic().

Referenced by DoReportDataFailed(), and DoReportDataOk().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetupMac()

void ns3::RraaWifiManager::SetupMac ( const Ptr< WifiMac > mac )

overridevirtual

Set up MAC associated with this device since it is the object that knows the full set of timing parameters (e.g.

IFS).

Parameters

mac	the MAC of this device

Reimplemented from ns3::WifiRemoteStationManager.

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

References NS_LOG_FUNCTION, and ns3::WifiRemoteStationManager::SetupMac().

Here is the call graph for this function:

◆ SetupPhy()

void ns3::RraaWifiManager::SetupPhy ( const Ptr< WifiPhy > phy )

overridevirtual

Set up PHY associated with this device since it is the object that knows the full set of transmit rates that are supported.

Parameters

phy	the PHY of this device

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 112 of file rraa-wifi-manager.cc.

References AddCalcTxTime(), m_ackLength, m_difs, m_frameLength, m_sifs, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::WifiTxVector::SetMode(), ns3::WifiTxVector::SetPreambleType(), ns3::WifiRemoteStationManager::SetupPhy(), and ns3::WIFI_PREAMBLE_LONG.

Here is the call graph for this function:

Member Data Documentation

◆ m_ackLength

uint32_t ns3::RraaWifiManager::m_ackLength

private

Ack frame length used to calculate mode TxTime.

Definition at line 174 of file rraa-wifi-manager.h.

Referenced by GetTypeId(), and SetupPhy().

◆ m_alpha

double ns3::RraaWifiManager::m_alpha

private

Alpha value for RRAA (value for calculating MTL threshold)

Definition at line 178 of file rraa-wifi-manager.h.

Referenced by GetTypeId(), and InitThresholds().

◆ m_basic

bool ns3::RraaWifiManager::m_basic

private

basic

Definition at line 176 of file rraa-wifi-manager.h.

Referenced by DoNeedRts(), and GetTypeId().

◆ m_beta

double ns3::RraaWifiManager::m_beta

private

Beta value for RRAA (value for calculating ORI threshold).

Definition at line 179 of file rraa-wifi-manager.h.

Referenced by GetTypeId(), and InitThresholds().

◆ m_calcTxTime

TxTime ns3::RraaWifiManager::m_calcTxTime

private

To hold all the calculated TxTime for all modes.

Definition at line 169 of file rraa-wifi-manager.h.

Referenced by AddCalcTxTime(), and GetCalcTxTime().

◆ m_currentRate

TracedValue<uint64_t> ns3::RraaWifiManager::m_currentRate

private

Trace rate changes.

Definition at line 182 of file rraa-wifi-manager.h.

Referenced by DoGetDataTxVector(), and GetTypeId().

◆ m_difs

Time ns3::RraaWifiManager::m_difs

private

Value of DIFS configured in the device.

Definition at line 171 of file rraa-wifi-manager.h.

Referenced by InitThresholds(), and SetupPhy().

◆ m_frameLength

uint32_t ns3::RraaWifiManager::m_frameLength

private

Data frame length used to calculate mode TxTime.

Definition at line 173 of file rraa-wifi-manager.h.

Referenced by GetTypeId(), and SetupPhy().

◆ m_sifs

Time ns3::RraaWifiManager::m_sifs

private

Value of SIFS configured in the device.

Definition at line 170 of file rraa-wifi-manager.h.

Referenced by InitThresholds(), and SetupPhy().

◆ m_tau

double ns3::RraaWifiManager::m_tau

private

Tau value for RRAA (value for calculating EWND size).

Definition at line 180 of file rraa-wifi-manager.h.

Referenced by GetTypeId(), and InitThresholds().

◆ m_timeout

Time ns3::RraaWifiManager::m_timeout

private

timeout

Definition at line 177 of file rraa-wifi-manager.h.

Referenced by CheckTimeout(), and GetTypeId().

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

src/wifi/model/rate-control/rraa-wifi-manager.h
src/wifi/model/rate-control/rraa-wifi-manager.cc

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TxTime

Constructor & Destructor Documentation

◆ RraaWifiManager()

◆ ~RraaWifiManager()

Member Function Documentation

◆ AddCalcTxTime()

◆ ARts()

◆ CheckInit()

◆ CheckTimeout()

◆ DoCreateStation()

◆ DoGetDataTxVector()

◆ DoGetRtsTxVector()

◆ DoInitialize()

◆ DoNeedRts()

◆ DoReportDataFailed()

◆ DoReportDataOk()

◆ DoReportFinalDataFailed()

◆ DoReportFinalRtsFailed()

◆ DoReportRtsFailed()

◆ DoReportRtsOk()

◆ DoReportRxOk()

◆ GetCalcTxTime()

◆ GetMaxRate()

◆ GetThresholds() [1/2]

◆ GetThresholds() [2/2]

◆ GetTypeId()

◆ InitThresholds()

◆ ResetCountersBasic()

◆ RunBasicAlgorithm()

◆ SetupMac()

◆ SetupPhy()

Member Data Documentation

◆ m_ackLength

◆ m_alpha

◆ m_basic

◆ m_beta

◆ m_calcTxTime

◆ m_currentRate

◆ m_difs

◆ m_frameLength

◆ m_sifs

◆ m_tau

◆ m_timeout