Thompson Sampling rate control algorithm. More...
#include "thompson-sampling-wifi-manager.h"
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< Mac48Address > | GetAffiliatedStaAddress (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< WifiMac > | GetMac () const |
Return the WifiMac. | |
uint8_t | GetMaxNumberOfTransmitStreams () const |
std::optional< Mac48Address > | GetMldAddress (const Mac48Address &address) const |
Get the address of the MLD the given station is affiliated with, if any. | |
std::optional< dBm_u > | GetMostRecentRssi (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< WifiPhy > | GetPhy () 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 EhtCapabilities > | GetStationEhtCapabilities (Mac48Address from) |
Return the EHT capabilities sent by the remote station. | |
std::optional< std::reference_wrapper< CommonInfoBasicMle::EmlCapabilities > > | GetStationEmlCapabilities (const Mac48Address &from) |
Ptr< const ExtendedCapabilities > | GetStationExtendedCapabilities (const Mac48Address &from) |
Return the extended capabilities sent by the remote station. | |
Ptr< const He6GhzBandCapabilities > | GetStationHe6GhzCapabilities (const Mac48Address &from) const |
Return the HE 6 GHz Band Capabilities sent by a remote station. | |
Ptr< const HeCapabilities > | GetStationHeCapabilities (Mac48Address from) |
Return the HE capabilities sent by the remote station. | |
Ptr< const HtCapabilities > | GetStationHtCapabilities (Mac48Address from) |
Return the HT capabilities sent by the remote station. | |
std::optional< std::reference_wrapper< CommonInfoBasicMle::MldCapabilities > > | GetStationMldCapabilities (const Mac48Address &from) |
Ptr< const VhtCapabilities > | GetStationVhtCapabilities (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< Object > | GetObject () 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< Object > | GetObject (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. | |
SimpleRefCount & | operator= (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. | |
WifiRemoteStation * | DoCreateStation () 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< GammaRandomVariable > | m_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 | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
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
ns3::ThompsonSamplingWifiManager is accessible through the following paths with Config::Set and Config::Connect:
Rts-Cts|Cts-To-Self
Rts-Cts|Cts-To-Self
WifiMode
Time
-9.22337e+18ns:+9.22337e+18ns 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.
ns3::ThompsonSamplingWifiManager::ThompsonSamplingWifiManager | ( | ) |
Definition at line 80 of file thompson-sampling-wifi-manager.cc.
References ns3::CreateObject(), m_gammaRandomVariable, and NS_LOG_FUNCTION.
|
override |
Definition at line 88 of file thompson-sampling-wifi-manager.cc.
References NS_LOG_FUNCTION.
|
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.
stream | first stream index to use |
Reimplemented from ns3::WifiRemoteStationManager.
Definition at line 403 of file thompson-sampling-wifi-manager.cc.
References m_gammaRandomVariable, and NS_LOG_FUNCTION.
|
private |
Applies exponential decay to MCS statistics.
st | Remote STA for which MCS statistics is to be updated. |
i | MCS 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().
|
overrideprivatevirtual |
Implements ns3::WifiRemoteStationManager.
Definition at line 94 of file thompson-sampling-wifi-manager.cc.
References NS_LOG_FUNCTION.
|
overrideprivatevirtual |
station | the station that we need to communicate |
allowedWidth | the allowed width 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.
|
overrideprivatevirtual |
station | the station that we need to communicate |
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.
|
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.
station | the station that sent the DATA to us |
nSuccessfulMpdus | number of successfully transmitted MPDUs. A value of 0 means that the Block ACK was missed. |
nFailedMpdus | number of unsuccessfuly transmitted MPDUs. |
rxSnr | received SNR of the block ack frame itself |
dataSnr | data SNR reported by remote station |
dataChannelWidth | the channel width of the A-MPDU we sent |
dataNss | the 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().
|
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,
station | the 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().
|
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,
station | the station that we successfully sent RTS |
ackSnr | the SNR of the ACK we received |
ackMode | the WifiMode the receiver used to send the ACK |
dataSnr | the SNR of the DATA we sent |
dataChannelWidth | the channel width of the DATA we sent |
dataNss | the 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().
|
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,
station | the 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.
|
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,
station | the 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.
|
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,
station | the 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.
|
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,
station | the station that we successfully sent RTS |
ctsSnr | the SNR of the CTS we received |
ctsMode | the WifiMode the receiver used to send the CTS |
rtsSnr | the 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.
|
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,
station | the station that sent the DATA to us |
rxSnr | the SNR of the DATA we received |
txMode | the 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.
|
private |
Returns guard interval for the given mode.
st | Remote STA |
mode | The WifiMode |
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().
|
static |
Get the type ID.
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().
|
private |
Initializes station rate tables.
If station is already initialized, nothing is done.
station | Station 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().
|
private |
Sample beta random variable with given parameters.
alpha | first parameter of beta distribution |
beta | second parameter of beta distribution |
Definition at line 376 of file thompson-sampling-wifi-manager.cc.
References m_gammaRandomVariable.
Referenced by UpdateNextMode().
|
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.
station | Station 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().
|
private |
Trace rate changes.
Definition at line 119 of file thompson-sampling-wifi-manager.h.
Referenced by DoGetDataTxVector(), and GetTypeId().
|
private |
Exponential decay coefficient, Hz.
Definition at line 117 of file thompson-sampling-wifi-manager.h.
Referenced by Decay(), and GetTypeId().
|
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().