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	AddBasicMode (WifiMode mode)
void	AddSupportedMode (Mac48Address address, WifiMode mode)
WifiMode	GetAckMode (Mac48Address address, WifiMode dataMode)
WifiMode	GetBasicMode (uint32_t i) const
WifiMode	GetCtsMode (Mac48Address address, WifiMode rtsMode)
WifiMode	GetDataMode (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet, uint32_t fullPacketSize)
WifiMode	GetDefaultMode (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)
WifiRemoteStationInfo	GetInfo (Mac48Address address)
uint32_t	GetMaxSlrc (void) const
uint32_t	GetMaxSsrc (void) const
uint32_t	GetNBasicModes (void) const
WifiMode	GetNonUnicastMode (void) const
uint32_t	GetRtsCtsThreshold (void) const
WifiMode	GetRtsMode (Mac48Address address, const WifiMacHeader *header, Ptr< const Packet > packet)
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	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	SetFragmentationThreshold (uint32_t threshold)
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	Start (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)
	This method returns the TypeId associated to ns3::AmrrWifiManager.

Private Member Functions
void	DecreaseRate (AmrrWifiRemoteStation *station)
virtual WifiRemoteStation *	DoCreateStation (void) const
virtual WifiMode	DoGetDataMode (WifiRemoteStation *station, uint32_t size)
virtual WifiMode	DoGetRtsMode (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)
uint32_t	GetNSupported (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.

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

Constructor & Destructor Documentation

ns3::AmrrWifiManager::AmrrWifiManager ( )

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

Member Function Documentation

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

private

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

References ns3::AmrrWifiRemoteStation::m_txrate.

Referenced by UpdateMode().

Here is the caller graph for this function:

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

privatevirtual

Definition at line 87 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, and ns3::Now().

Here is the call graph for this function:

WifiMode ns3::AmrrWifiManager::DoGetDataMode	(	WifiRemoteStation *	station,
		uint32_t	size
	)

privatevirtual

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

References ns3::WifiRemoteStationManager::GetNSupported(), ns3::WifiRemoteStationManager::GetSupported(), ns3::AmrrWifiRemoteStation::m_retry, ns3::AmrrWifiRemoteStation::m_txrate, NS_ASSERT, and UpdateMode().

Here is the call graph for this function:

WifiMode ns3::AmrrWifiManager::DoGetRtsMode ( WifiRemoteStation * station )

privatevirtual

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

References ns3::WifiRemoteStationManager::GetSupported(), and UpdateMode().

Here is the call graph for this function:

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

privatevirtual

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

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

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

privatevirtual

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

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

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

privatevirtual

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

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

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

privatevirtual

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

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

privatevirtual

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

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

privatevirtual

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

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

privatevirtual

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

TypeId ns3::AmrrWifiManager::GetTypeId ( void )

static

This method returns the TypeId associated to ns3::AmrrWifiManager.

This object is accessible through the following paths with Config::Set and Config::Connect:

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

Attributes defined for this type:

UpdatePeriod: The interval between decisions about rate control changes
- Set with class: TimeValue
- Underlying type: Time
- 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
- Set with class: ns3::DoubleValue
- Underlying type: double 0:1
- Initial value: 0.1
- Flags: construct write read
MaxSuccessThreshold: Maximum number of consecutive success periods needed to switch to a higher rate
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 10
- Flags: construct write read
MinSuccessThreshold: Minimum number of consecutive success periods needed to switch to a higher rate
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 1
- Flags: construct write read

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.
- Set with class: BooleanValue
- Underlying type: bool
- Flags: read
MaxSsrc: The maximum number of retransmission attempts for an RTS. This value will not have any effect on some rate control algorithms.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 7
- Flags: construct write read
MaxSlrc: The maximum number of retransmission attempts for a DATA packet. This value will not have any effect on some rate control algorithms.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 7
- Flags: construct write read
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.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 2346
- Flags: construct write read
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.
- Set with class: ns3::UintegerValue
- Underlying type: uint32_t 0:4294967295
- Initial value: 2346
- Flags: construct write read
NonUnicastMode: Wifi mode used for non-unicast transmissions.
- Set with class: WifiModeValue
- Underlying type: WifiMode
- Initial value: Invalid-WifiMode
- Flags: construct write read

No TraceSources 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

Reimplemented from ns3::WifiRemoteStationManager.

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

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

Here is the call graph for this function: