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

ARF Rate control algorithm. More...

#include <arf-wifi-manager.h>

+ Inheritance diagram for ns3::ArfWifiManager:

Static Public Member Functions

static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::WifiRemoteStationManager
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId (void)
 
- Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
static void Cleanup (void)
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId (void)
 

Private Member Functions

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)
 
virtual bool IsLowLatency (void) const
 

Private Attributes

uint32_t m_successThreshold
 
uint32_t m_timerThreshold
 

Additional Inherited Members

- Public Member Functions inherited from ns3::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
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 (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
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)
 
- 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
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 
virtual void DoInitialize (void)
 
virtual void NotifyNewAggregate (void)
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 
virtual void NotifyConstructionCompleted (void)
 

Detailed Description

ARF Rate control algorithm.

This class implements the so-called ARF algorithm which was initially described in WaveLAN-II: A High-performance wireless LAN for the unlicensed band, by A. Kamerman and L. Monteban. in Bell Lab Technical Journal, pages 118-133, Summer 1997.

This implementation differs from the initial description in that it uses a packet-based timer rather than a time-based timer as described in XXX (I cannot find back the original paper which described how the time-based timer could be easily replaced with a packet-based timer.)

Config Paths

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

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

Attributes

  • TimerThreshold: The 'timer' threshold in the ARF algorithm.
  • SuccessThreshold: The minimum number of sucessfull transmissions to try a new 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

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 42 of file arf-wifi-manager.h.

Member Function Documentation

WifiRemoteStation * ns3::ArfWifiManager::DoCreateStation ( void  ) const
privatevirtual
Returns
a new station data structure

Implements ns3::WifiRemoteStationManager.

Definition at line 75 of file arf-wifi-manager.cc.

References NS_LOG_FUNCTION.

WifiMode ns3::ArfWifiManager::DoGetDataMode ( WifiRemoteStation *  station,
uint32_t  size 
)
privatevirtual
Parameters
stationthe station with which we need to communicate
sizesize of the packet or fragment we want to send
Returns
the transmission mode 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 192 of file arf-wifi-manager.cc.

References NS_LOG_FUNCTION.

WifiMode ns3::ArfWifiManager::DoGetRtsMode ( WifiRemoteStation *  station)
privatevirtual
Parameters
stationthe station with which 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 199 of file arf-wifi-manager.cc.

References NS_LOG_FUNCTION.

void ns3::ArfWifiManager::DoReportDataFailed ( WifiRemoteStation *  st)
privatevirtual

It is important to realize that "recovery" mode starts after failure of the first transmission after a rate increase and ends at the first successful transmission. Specifically, recovery mode transcends retransmissions boundaries. Fundamentally, ARF handles each data transmission independently, whether it is the initial transmission of a packet or the retransmission of a packet. The fundamental reason for this is that there is a backoff between each data transmission, be it an initial transmission or a retransmission.

Implements ns3::WifiRemoteStationManager.

Definition at line 107 of file arf-wifi-manager.cc.

References NS_ASSERT, and NS_LOG_FUNCTION.

bool ns3::ArfWifiManager::IsLowLatency ( void  ) const
privatevirtual
Returns
whether this manager is a manager designed to work in low-latency environments.

Note: In this context, low vs high latency is defined in IEEE 802.11 Rate Adaptation: A Practical Approach, by M. Lacage, M.H. Manshaei, and T. Turletti.

Implements ns3::WifiRemoteStationManager.

Definition at line 209 of file arf-wifi-manager.cc.

References NS_LOG_FUNCTION.

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