A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::ThompsonSamplingWifiManager Class Reference

Thompson Sampling rate control algorithm. More...

#include "thompson-sampling-wifi-manager.h"

+ Inheritance diagram for ns3::ThompsonSamplingWifiManager:
+ Collaboration diagram for ns3::ThompsonSamplingWifiManager:

Public Member Functions

 ThompsonSamplingWifiManager ()
 
 ~ThompsonSamplingWifiManager () override
 
int64_t AssignStreams (int64_t stream) override
 Assign a fixed random variable stream number to the random variables used by this model.
 
- 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, const EhtCapabilities &ehtCapabilities)
 Records EHT capabilities of the remote station.
 
void AddStationExtendedCapabilities (Mac48Address from, const ExtendedCapabilities &extendedCapabilities)
 Records extended 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, const HeCapabilities &heCapabilities)
 Records HE capabilities of the remote station.
 
void AddStationHtCapabilities (Mac48Address from, const 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, const 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.
 
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< Mac48AddressGetAffiliatedStaAddress (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 shortest 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< WifiMacGetMac () const
 Return the WifiMac.
 
uint8_t GetMaxNumberOfTransmitStreams () const
 
std::optional< Mac48AddressGetMldAddress (const Mac48Address &address) const
 Get the address of the MLD the given station is affiliated with, if any.
 
std::optional< dBm_uGetMostRecentRssi (Mac48Address address) const
 
std::list< Ptr< WifiMpdu > > GetMpdusToDropOnTxFailure (Ptr< WifiPsdu > psdu)
 Increment the retry count for all the MPDUs (if needed) in the given PSDU and find the MPDUs to drop based on the frame retry count.
 
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< WifiPhyGetPhy () 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 EhtCapabilitiesGetStationEhtCapabilities (Mac48Address from)
 Return the EHT capabilities sent by the remote station.
 
std::optional< std::reference_wrapper< CommonInfoBasicMle::EmlCapabilities > > GetStationEmlCapabilities (const Mac48Address &from)
 
Ptr< const ExtendedCapabilitiesGetStationExtendedCapabilities (const Mac48Address &from)
 Return the extended capabilities sent by the remote station.
 
Ptr< const He6GhzBandCapabilitiesGetStationHe6GhzCapabilities (const Mac48Address &from) const
 Return the HE 6 GHz Band Capabilities sent by a remote station.
 
Ptr< const HeCapabilitiesGetStationHeCapabilities (Mac48Address from)
 Return the HE capabilities sent by the remote station.
 
Ptr< const HtCapabilitiesGetStationHtCapabilities (Mac48Address from)
 Return the HT capabilities sent by the remote station.
 
std::optional< std::reference_wrapper< CommonInfoBasicMle::MldCapabilities > > GetStationMldCapabilities (const Mac48Address &from)
 
Ptr< const VhtCapabilitiesGetStationVhtCapabilities (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 (const WifiTxVector &txVector)
 Return if we need to do CTS-to-self before sending a DATA.
 
bool NeedFragmentation (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 frames are dropped.
 
void ReportFinalRtsFailed (const WifiMacHeader &header)
 Should be invoked after calling ReportRtsFailed if frames are dropped.
 
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, const 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 SetLinkId (uint8_t linkId)
 Set the ID of the link this Remote Station Manager is associated with.
 
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.
 
virtual void SetupMac (const Ptr< WifiMac > mac)
 Set up MAC associated with this device since it is the object that knows the full set of timing parameters (e.g.
 
virtual void SetupPhy (const Ptr< WifiPhy > phy)
 Set up PHY associated with this device since it is the object that knows the full set of transmit rates that are supported.
 
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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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 Member Functions

void Decay (WifiRemoteStation *st, size_t i) const
 Applies exponential decay to MCS statistics.
 
WifiRemoteStationDoCreateStation () const override
 
WifiTxVector DoGetDataTxVector (WifiRemoteStation *station, MHz_u allowedWidth) override
 
WifiTxVector DoGetRtsTxVector (WifiRemoteStation *station) override
 
void DoReportAmpduTxStatus (WifiRemoteStation *station, uint16_t nSuccessfulMpdus, uint16_t nFailedMpdus, double rxSnr, double dataSnr, MHz_u dataChannelWidth, uint8_t dataNss) override
 Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed.
 
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 GetModeGuardInterval (WifiRemoteStation *st, WifiMode mode) const
 Returns guard interval for the given mode.
 
void InitializeStation (WifiRemoteStation *station) const
 Initializes station rate tables.
 
double SampleBetaVariable (uint64_t alpha, uint64_t beta) const
 Sample beta random variable with given parameters.
 
void UpdateNextMode (WifiRemoteStation *station) const
 Draws a new MCS and related parameters to try next time for this station.
 

Private Attributes

TracedValue< uint64_t > m_currentRate
 Trace rate changes.
 
double m_decay
 Exponential decay coefficient, Hz.
 
Ptr< GammaRandomVariablem_gammaRandomVariable
 Variable used to sample beta-distributed random variables.
 

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 shortest 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 DoInitialize ()
 Initialize() implementation.
 
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.
 
- Protected Attributes inherited from ns3::WifiRemoteStationManager
bool m_incrRetryCountUnderBa
 whether to increment the retry count of frames that are part of a Block Ack agreement
 
uint8_t m_linkId
 the ID of the link this object is associated with
 

Detailed Description

Thompson Sampling rate control algorithm.

This class implements Thompson Sampling rate control algorithm.

It was implemented for use as a baseline in https://doi.org/10.1109/ACCESS.2020.3023552

Config Paths

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

  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/RemoteStationManager/$ns3::ThompsonSamplingWifiManager"
  • "/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/RemoteStationManagers/[i]/$ns3::ThompsonSamplingWifiManager"

Attributes

  • Decay: Exponential decay coefficient, Hz; zero is a valid value for static scenarios
    • Set with class: ns3::DoubleValue
    • Underlying type: double 0:1.79769e+308
    • Initial value: 1
    • Flags: constructwriteread
    • Support level: SUPPORTED

Attributes defined in parent class ns3::WifiRemoteStationManager

  • DefaultTxPowerLevel: Default power level to be used for transmissions. This is the power level that is used by all those WifiManagers that do not implement TX power control.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 0
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • ErpProtectionMode: Protection mode used when non-ERP STAs are connected to an ERP AP: Rts-Cts or Cts-To-Self
  • FragmentationThreshold: If the size of the PSDU is bigger than this value, we fragment it such that the size of the fragments are equal or smaller. This value does not apply when it is carried in an A-MPDU. 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: 65535
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • HtProtectionMode: Protection mode used when non-HT STAs are connected to a HT AP: Rts-Cts or Cts-To-Self
  • IncrementRetryCountUnderBa: The 802.11-2020 standard states that the retry count for frames that are part of a Block Ack agreement shall not be incremented when a transmission fails. As a consequence, frames that are part of a Block Ack agreement are not dropped based on the number of retries. Set this attribute to true to override the standard behavior and increment the retry count (and eventually drop) frames that are part of a Block Ack agreement.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • MaxSlrc: The maximum number of retransmission attempts for any packet with size > RtsCtsThreshold. 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: 4
    • Flags: constructwrite
    • Support level: OBSOLETE: Use WifiMac::FrameRetryLimit instead
  • MaxSsrc: The maximum number of retransmission attempts for any packet with size <= RtsCtsThreshold. 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: constructwrite
    • Support level: OBSOLETE: Use WifiMac::FrameRetryLimit instead
  • NonUnicastMode: Wifi mode used for non-unicast transmissions.
    • Set with class: ns3::WifiModeValue
    • Underlying type: WifiMode
    • Initial value: Invalid-WifiMode
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • RtsCtsThreshold: If the size of the PSDU is bigger than this value, we use an RTS/CTS handshake before sending the data frame.This value will not have any effect on some rate control algorithms.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint32_t 0:4692480
    • Initial value: 4692480
    • Flags: constructwrite
    • Support level: SUPPORTED
  • RtsCtsTxDurationThresh: If this threshold is a strictly positive value and the TX duration of the PSDU is greater than or equal to this threshold, we use an RTS/CTS handshake before sending the data frame.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: constructwriteread
    • Support level: SUPPORTED

TraceSources

TraceSources defined in parent class ns3::WifiRemoteStationManager

Group: Wifi

Size of this type is 456 bytes (on a 64-bit architecture).

Definition at line 28 of file thompson-sampling-wifi-manager.h.

Constructor & Destructor Documentation

◆ ThompsonSamplingWifiManager()

ns3::ThompsonSamplingWifiManager::ThompsonSamplingWifiManager ( )

Definition at line 80 of file thompson-sampling-wifi-manager.cc.

References ns3::CreateObject(), m_gammaRandomVariable, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ ~ThompsonSamplingWifiManager()

ns3::ThompsonSamplingWifiManager::~ThompsonSamplingWifiManager ( )
override

Definition at line 88 of file thompson-sampling-wifi-manager.cc.

References NS_LOG_FUNCTION.

Member Function Documentation

◆ AssignStreams()

int64_t ns3::ThompsonSamplingWifiManager::AssignStreams ( int64_t stream)
overridevirtual

Assign a fixed random variable stream number to the random variables used by this model.

Return the number of streams (possibly zero) that have been assigned.

Parameters
streamfirst stream index to use
Returns
the number of stream indices assigned by this model

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 403 of file thompson-sampling-wifi-manager.cc.

References m_gammaRandomVariable, and NS_LOG_FUNCTION.

◆ Decay()

void ns3::ThompsonSamplingWifiManager::Decay ( WifiRemoteStation * st,
size_t i ) const
private

Applies exponential decay to MCS statistics.

Parameters
stRemote STA for which MCS statistics is to be updated.
iMCS index.

Definition at line 384 of file thompson-sampling-wifi-manager.cc.

References InitializeStation(), m_decay, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Referenced by DoReportAmpduTxStatus(), DoReportDataFailed(), DoReportDataOk(), and UpdateNextMode().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ DoCreateStation()

WifiRemoteStation * ns3::ThompsonSamplingWifiManager::DoCreateStation ( ) const
overrideprivatevirtual
Returns
a new station data structure

Implements ns3::WifiRemoteStationManager.

Definition at line 94 of file thompson-sampling-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoGetDataTxVector()

WifiTxVector ns3::ThompsonSamplingWifiManager::DoGetDataTxVector ( WifiRemoteStation * station,
MHz_u allowedWidth )
overrideprivatevirtual
Parameters
stationthe station that we need to communicate
allowedWidththe 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 309 of file thompson-sampling-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetAggregation(), ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), GetModeGuardInterval(), ns3::WifiRemoteStationManager::GetNumberOfAntennas(), ns3::WifiRemoteStationManager::GetPhy(), ns3::GetPreambleForTransmission(), ns3::WifiRemoteStationManager::GetShortPreambleEnabled(), InitializeStation(), m_currentRate, ns3::ThompsonSamplingWifiRemoteStation::m_mcsStats, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoGetRtsTxVector()

WifiTxVector ns3::ThompsonSamplingWifiManager::DoGetRtsTxVector ( WifiRemoteStation * station)
overrideprivatevirtual
Parameters
stationthe 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 348 of file thompson-sampling-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetAggregation(), ns3::WifiRemoteStationManager::GetDefaultTxPowerLevel(), GetModeGuardInterval(), ns3::WifiMode::GetModulationClass(), ns3::WifiRemoteStationManager::GetNumberOfAntennas(), ns3::WifiRemoteStationManager::GetPhy(), ns3::GetPreambleForTransmission(), ns3::WifiRemoteStationManager::GetShortPreambleEnabled(), InitializeStation(), ns3::ThompsonSamplingWifiRemoteStation::m_mcsStats, NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoReportAmpduTxStatus()

void ns3::ThompsonSamplingWifiManager::DoReportAmpduTxStatus ( WifiRemoteStation * station,
uint16_t nSuccessfulMpdus,
uint16_t nFailedMpdus,
double rxSnr,
double dataSnr,
MHz_u dataChannelWidth,
uint8_t dataNss )
overrideprivatevirtual

Typically called per A-MPDU, either when a Block ACK was successfully received or when a BlockAckTimeout has elapsed.

This method is a virtual method that must be implemented by the sub-class intended to handle A-MPDUs. This allows different types of WifiRemoteStationManager to respond differently.

Parameters
stationthe station that sent the DATA to us
nSuccessfulMpdusnumber of successfully transmitted MPDUs. A value of 0 means that the Block ACK was missed.
nFailedMpdusnumber of unsuccessfuly transmitted MPDUs.
rxSnrreceived SNR of the block ack frame itself
dataSnrdata SNR reported by remote station
dataChannelWidththe channel width of the A-MPDU we sent
dataNssthe number of spatial streams used to send the A-MPDU

Reimplemented from ns3::WifiRemoteStationManager.

Definition at line 258 of file thompson-sampling-wifi-manager.cc.

References Decay(), InitializeStation(), NS_LOG_FUNCTION, and UpdateNextMode().

+ Here is the call graph for this function:

◆ DoReportDataFailed()

void ns3::ThompsonSamplingWifiManager::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
stationthe station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 183 of file thompson-sampling-wifi-manager.cc.

References Decay(), InitializeStation(), NS_LOG_FUNCTION, and UpdateNextMode().

+ Here is the call graph for this function:

◆ DoReportDataOk()

void ns3::ThompsonSamplingWifiManager::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
stationthe station that we successfully sent RTS
ackSnrthe SNR of the ACK we received
ackModethe WifiMode the receiver used to send the ACK
dataSnrthe SNR of the DATA we sent
dataChannelWidththe channel width of the DATA we sent
dataNssthe number of spatial streams used to send the DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 242 of file thompson-sampling-wifi-manager.cc.

References Decay(), ns3::WifiMode::GetUniqueName(), InitializeStation(), NS_LOG_FUNCTION, and UpdateNextMode().

+ Here is the call graph for this function:

◆ DoReportFinalDataFailed()

void ns3::ThompsonSamplingWifiManager::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
stationthe station that we failed to send DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 284 of file thompson-sampling-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportFinalRtsFailed()

void ns3::ThompsonSamplingWifiManager::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
stationthe station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 278 of file thompson-sampling-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRtsFailed()

void ns3::ThompsonSamplingWifiManager::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
stationthe station that we failed to send RTS

Implements ns3::WifiRemoteStationManager.

Definition at line 177 of file thompson-sampling-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ DoReportRtsOk()

void ns3::ThompsonSamplingWifiManager::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
stationthe station that we successfully sent RTS
ctsSnrthe SNR of the CTS we received
ctsModethe WifiMode the receiver used to send the CTS
rtsSnrthe SNR of the RTS we sent

Implements ns3::WifiRemoteStationManager.

Definition at line 194 of file thompson-sampling-wifi-manager.cc.

References ns3::WifiMode::GetUniqueName(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoReportRxOk()

void ns3::ThompsonSamplingWifiManager::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
stationthe station that sent the DATA to us
rxSnrthe SNR of the DATA we received
txModethe WifiMode the sender used to send the DATA

Implements ns3::WifiRemoteStationManager.

Definition at line 171 of file thompson-sampling-wifi-manager.cc.

References NS_LOG_FUNCTION.

◆ GetModeGuardInterval()

Time ns3::ThompsonSamplingWifiManager::GetModeGuardInterval ( WifiRemoteStation * st,
WifiMode mode ) const
private

Returns guard interval for the given mode.

Parameters
stRemote STA
modeThe WifiMode
Returns
the guard interval

Definition at line 290 of file thompson-sampling-wifi-manager.cc.

References ns3::WifiRemoteStationManager::GetGuardInterval(), ns3::WifiMode::GetModulationClass(), ns3::WifiRemoteStationManager::GetShortGuardIntervalSupported(), ns3::NanoSeconds(), ns3::WIFI_MOD_CLASS_HE, ns3::WIFI_MOD_CLASS_HT, and ns3::WIFI_MOD_CLASS_VHT.

Referenced by DoGetDataTxVector(), DoGetRtsTxVector(), and UpdateNextMode().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ GetTypeId()

TypeId ns3::ThompsonSamplingWifiManager::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 60 of file thompson-sampling-wifi-manager.cc.

References m_currentRate, m_decay, ns3::MakeDoubleAccessor(), ns3::MakeDoubleChecker(), ns3::MakeTraceSourceAccessor(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ InitializeStation()

void ns3::ThompsonSamplingWifiManager::InitializeStation ( WifiRemoteStation * station) const
private

Initializes station rate tables.

If station is already initialized, nothing is done.

Parameters
stationStation which should be initialized.

Definition at line 104 of file thompson-sampling-wifi-manager.cc.

References ns3::RateStats::channelWidth, ns3::WifiPhy::GetChannelWidth(), ns3::WifiRemoteStationManager::GetHeSupported(), ns3::WifiPhy::GetMaxSupportedTxSpatialStreams(), ns3::WifiPhy::GetMcsList(), ns3::WifiMode::GetModulationClass(), ns3::WifiRemoteStationManager::GetNSupported(), ns3::WifiRemoteStationManager::GetPhy(), ns3::WifiRemoteStationManager::GetSupported(), ns3::WifiRemoteStationManager::GetVhtSupported(), ns3::RateStats::mode, NS_ASSERT_MSG, ns3::RateStats::nss, UpdateNextMode(), ns3::WIFI_MOD_CLASS_DSSS, ns3::WIFI_MOD_CLASS_HE, ns3::WIFI_MOD_CLASS_HR_DSSS, ns3::WIFI_MOD_CLASS_HT, and ns3::WIFI_MOD_CLASS_VHT.

Referenced by Decay(), DoGetDataTxVector(), DoGetRtsTxVector(), DoReportAmpduTxStatus(), DoReportDataFailed(), DoReportDataOk(), and UpdateNextMode().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ SampleBetaVariable()

double ns3::ThompsonSamplingWifiManager::SampleBetaVariable ( uint64_t alpha,
uint64_t beta ) const
private

Sample beta random variable with given parameters.

Parameters
alphafirst parameter of beta distribution
betasecond parameter of beta distribution
Returns
beta random variable sample

Definition at line 376 of file thompson-sampling-wifi-manager.cc.

References m_gammaRandomVariable.

Referenced by UpdateNextMode().

+ Here is the caller graph for this function:

◆ UpdateNextMode()

void ns3::ThompsonSamplingWifiManager::UpdateNextMode ( WifiRemoteStation * station) const
private

Draws a new MCS and related parameters to try next time for this station.

This method should only be called between TXOPs to avoid sending multiple frames using different modes. Otherwise it is impossible to tell which mode was used for succeeded/failed frame when feedback is received.

Parameters
stationStation for which a new mode should be drawn.

Definition at line 203 of file thompson-sampling-wifi-manager.cc.

References Decay(), GetModeGuardInterval(), InitializeStation(), NS_ASSERT, NS_LOG_DEBUG, and SampleBetaVariable().

Referenced by DoReportAmpduTxStatus(), DoReportDataFailed(), DoReportDataOk(), and InitializeStation().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Member Data Documentation

◆ m_currentRate

TracedValue<uint64_t> ns3::ThompsonSamplingWifiManager::m_currentRate
private

Trace rate changes.

Definition at line 119 of file thompson-sampling-wifi-manager.h.

Referenced by DoGetDataTxVector(), and GetTypeId().

◆ m_decay

double ns3::ThompsonSamplingWifiManager::m_decay
private

Exponential decay coefficient, Hz.

Definition at line 117 of file thompson-sampling-wifi-manager.h.

Referenced by Decay(), and GetTypeId().

◆ m_gammaRandomVariable

Ptr<GammaRandomVariable> ns3::ThompsonSamplingWifiManager::m_gammaRandomVariable
private

Variable used to sample beta-distributed random variables.

Definition at line 115 of file thompson-sampling-wifi-manager.h.

Referenced by ThompsonSamplingWifiManager(), AssignStreams(), and SampleBetaVariable().


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