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::OnoeWifiManager Class Reference
Wifi Models

an implementation of the rate control algorithm developed by Atsushi Onoe More...

#include <onoe-wifi-manager.h>

+ Inheritance diagram for ns3::OnoeWifiManager:
+ Collaboration diagram for ns3::OnoeWifiManager:

Public Member Functions

 OnoeWifiManager ()
- 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::OnoeWifiManager.

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
void UpdateMode (OnoeWifiRemoteStation *station)
void UpdateRetry (OnoeWifiRemoteStation *station)

Private Attributes

uint32_t m_addCreditThreshold
uint32_t m_raiseThreshold
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

an implementation of the rate control algorithm developed by Atsushi Onoe

This algorithm is well known because it has been used as the default rate control algorithm for the madwifi driver. I am not aware of any publication or reference about this algorithm beyond the madwifi source code.

Definition at line 41 of file onoe-wifi-manager.h.

Constructor & Destructor Documentation

ns3::OnoeWifiManager::OnoeWifiManager ( )

Definition at line 68 of file onoe-wifi-manager.cc.

Member Function Documentation

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

Definition at line 72 of file onoe-wifi-manager.cc.

References ns3::OnoeWifiRemoteStation::m_longRetry, ns3::OnoeWifiRemoteStation::m_nextModeUpdate, ns3::OnoeWifiRemoteStation::m_shortRetry, ns3::OnoeWifiRemoteStation::m_tx_err, ns3::OnoeWifiRemoteStation::m_tx_ok, ns3::OnoeWifiRemoteStation::m_tx_retr, ns3::OnoeWifiRemoteStation::m_tx_upper, ns3::OnoeWifiRemoteStation::m_txrate, m_updatePeriod, and ns3::Now().

+ Here is the call graph for this function:

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

Definition at line 219 of file onoe-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetNSupported(), ns3::WifiRemoteStationManager::GetSupported(), ns3::OnoeWifiRemoteStation::m_longRetry, ns3::OnoeWifiRemoteStation::m_txrate, NS_ASSERT, and UpdateMode().

+ Here is the call graph for this function:

WifiMode ns3::OnoeWifiManager::DoGetRtsMode ( WifiRemoteStation *  station)
privatevirtual

Definition at line 266 of file onoe-wifi-manager.cc.

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

+ Here is the call graph for this function:

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

Definition at line 97 of file onoe-wifi-manager.cc.

References ns3::OnoeWifiRemoteStation::m_longRetry.

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

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

References ns3::OnoeWifiRemoteStation::m_tx_ok, and UpdateRetry().

+ Here is the call graph for this function:

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

Definition at line 123 of file onoe-wifi-manager.cc.

References ns3::OnoeWifiRemoteStation::m_tx_err, and UpdateRetry().

+ Here is the call graph for this function:

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

Definition at line 116 of file onoe-wifi-manager.cc.

References ns3::OnoeWifiRemoteStation::m_tx_err, and UpdateRetry().

+ Here is the call graph for this function:

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

Definition at line 91 of file onoe-wifi-manager.cc.

References ns3::OnoeWifiRemoteStation::m_shortRetry.

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

Definition at line 103 of file onoe-wifi-manager.cc.

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

Definition at line 86 of file onoe-wifi-manager.cc.

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

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

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

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

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
  • RaiseThreshold: Attempt to raise the rate if we hit that threshold
  • AddCreditThreshold: Add credit threshold

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 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 46 of file onoe-wifi-manager.cc.

References m_addCreditThreshold, m_raiseThreshold, m_updatePeriod, ns3::Seconds(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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

Definition at line 275 of file onoe-wifi-manager.cc.

void ns3::OnoeWifiManager::UpdateMode ( OnoeWifiRemoteStation *  station)
private

The following 20 lines of code were copied from the Onoe rate control kernel module used in the madwifi driver.

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

References ns3::WifiRemoteStationManager::GetNSupported(), m_addCreditThreshold, ns3::OnoeWifiRemoteStation::m_nextModeUpdate, m_raiseThreshold, ns3::OnoeWifiRemoteStation::m_tx_err, ns3::OnoeWifiRemoteStation::m_tx_ok, ns3::OnoeWifiRemoteStation::m_tx_retr, ns3::OnoeWifiRemoteStation::m_tx_upper, ns3::OnoeWifiRemoteStation::m_txrate, m_updatePeriod, ns3::Now(), ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_DEBUG.

Referenced by DoGetDataMode(), and DoGetRtsMode().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void ns3::OnoeWifiManager::UpdateRetry ( OnoeWifiRemoteStation *  station)
private

Definition at line 130 of file onoe-wifi-manager.cc.

References ns3::OnoeWifiRemoteStation::m_longRetry, ns3::OnoeWifiRemoteStation::m_shortRetry, and ns3::OnoeWifiRemoteStation::m_tx_retr.

Referenced by DoReportDataOk(), DoReportFinalDataFailed(), and DoReportFinalRtsFailed().

+ Here is the caller graph for this function:

Member Data Documentation

uint32_t ns3::OnoeWifiManager::m_addCreditThreshold
private

Definition at line 69 of file onoe-wifi-manager.h.

Referenced by GetTypeId(), and UpdateMode().

uint32_t ns3::OnoeWifiManager::m_raiseThreshold
private

Definition at line 70 of file onoe-wifi-manager.h.

Referenced by GetTypeId(), and UpdateMode().

Time ns3::OnoeWifiManager::m_updatePeriod
private

Definition at line 68 of file onoe-wifi-manager.h.

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

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