A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
ns3::CaraWifiManager Class Reference

implement the CARA rate control algorithmImplement the CARA algorithm from: J. Kim, S. Kim, S. Choi, and D. Qiao. "CARA: Collision-Aware Rate Adaptation for IEEE 802.11 WLANs." More...

#include <cara-wifi-manager.h>

+ Inheritance diagram for ns3::CaraWifiManager:
+ Collaboration diagram for ns3::CaraWifiManager:

Public Member Functions

 CaraWifiManager ()
virtual ~CaraWifiManager ()
- 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
SimpleRefCountoperator= (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::CaraWifiManager.

Private Member Functions

virtual WifiRemoteStationDoCreateStation (void) const
virtual WifiMode DoGetDataMode (WifiRemoteStation *station, uint32_t size)
virtual WifiMode DoGetRtsMode (WifiRemoteStation *station)
virtual bool DoNeedRts (WifiRemoteStation *station, Ptr< const Packet > packet, bool normally)
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_failureThreshold
uint32_t m_probeThreshold
uint32_t m_successThreshold
uint32_t m_timerTimeout

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

implement the CARA rate control algorithm

Implement the CARA algorithm from: J. Kim, S. Kim, S. Choi, and D. Qiao. "CARA: Collision-Aware Rate Adaptation for IEEE 802.11 WLANs."

Originally implemented by Federico Maguolo for a very early prototype version of ns-3.

Definition at line 38 of file cara-wifi-manager.h.

Constructor & Destructor Documentation

ns3::CaraWifiManager::CaraWifiManager ( )

Definition at line 73 of file cara-wifi-manager.cc.

ns3::CaraWifiManager::~CaraWifiManager ( )
virtual

Definition at line 77 of file cara-wifi-manager.cc.

Member Function Documentation

WifiRemoteStation * ns3::CaraWifiManager::DoCreateStation ( void  ) const
privatevirtual
WifiMode ns3::CaraWifiManager::DoGetDataMode ( WifiRemoteStation station,
uint32_t  size 
)
privatevirtual

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

References ns3::WifiRemoteStationManager::GetSupported(), and ns3::CaraWifiRemoteStation::m_rate.

+ Here is the call graph for this function:

WifiMode ns3::CaraWifiManager::DoGetRtsMode ( WifiRemoteStation station)
privatevirtual

Definition at line 165 of file cara-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetSupported().

+ Here is the call graph for this function:

bool ns3::CaraWifiManager::DoNeedRts ( WifiRemoteStation station,
Ptr< const Packet packet,
bool  normally 
)
privatevirtual

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

References ns3::CaraWifiRemoteStation::m_failed, and m_probeThreshold.

void ns3::CaraWifiManager::DoReportDataOk ( WifiRemoteStation station,
double  ackSnr,
WifiMode  ackMode,
double  dataSnr 
)
privatevirtual
void ns3::CaraWifiManager::DoReportFinalDataFailed ( WifiRemoteStation station)
privatevirtual

Definition at line 153 of file cara-wifi-manager.cc.

void ns3::CaraWifiManager::DoReportFinalRtsFailed ( WifiRemoteStation station)
privatevirtual

Definition at line 149 of file cara-wifi-manager.cc.

void ns3::CaraWifiManager::DoReportRtsFailed ( WifiRemoteStation station)
privatevirtual

Definition at line 93 of file cara-wifi-manager.cc.

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

Definition at line 122 of file cara-wifi-manager.cc.

References NS_LOG_DEBUG.

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

Definition at line 117 of file cara-wifi-manager.cc.

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

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

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

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

Attributes defined for this type:

  • ProbeThreshold: The number of consecutive transmissions failure to activate the RTS probe.
  • FailureThreshold: The number of consecutive transmissions failure to decrease the rate.
  • SuccessThreshold: The minimum number of sucessfull transmissions to try a new rate.
  • Timeout: The 'timer' in the CARA algorithm

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 44 of file cara-wifi-manager.cc.

References m_failureThreshold, m_probeThreshold, m_successThreshold, m_timerTimeout, and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

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

Definition at line 181 of file cara-wifi-manager.cc.

Member Data Documentation

uint32_t ns3::CaraWifiManager::m_failureThreshold
private

Definition at line 66 of file cara-wifi-manager.h.

Referenced by DoReportDataFailed(), and GetTypeId().

uint32_t ns3::CaraWifiManager::m_probeThreshold
private

Definition at line 67 of file cara-wifi-manager.h.

Referenced by DoNeedRts(), and GetTypeId().

uint32_t ns3::CaraWifiManager::m_successThreshold
private

Definition at line 65 of file cara-wifi-manager.h.

Referenced by DoReportDataOk(), and GetTypeId().

uint32_t ns3::CaraWifiManager::m_timerTimeout
private

Definition at line 64 of file cara-wifi-manager.h.

Referenced by DoReportDataOk(), and GetTypeId().


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