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

WifiDefaultProtectionManager is the default protection manager, which selects the protection method for a frame based on its size. More...

#include "wifi-default-protection-manager.h"

+ Inheritance diagram for ns3::WifiDefaultProtectionManager:
+ Collaboration diagram for ns3::WifiDefaultProtectionManager:

Public Member Functions

 WifiDefaultProtectionManager ()
 
 ~WifiDefaultProtectionManager () override
 
std::unique_ptr< WifiProtectionTryAddMpdu (Ptr< const WifiMpdu > mpdu, const WifiTxParameters &txParams) override
 Determine the protection method to use if the given MPDU is added to the current frame.
 
std::unique_ptr< WifiProtectionTryAggregateMsdu (Ptr< const WifiMpdu > msdu, const WifiTxParameters &txParams) override
 Determine the protection method to use if the given MSDU is aggregated to the current frame.
 
- Public Member Functions inherited from ns3::WifiProtectionManager
 WifiProtectionManager ()
 
 ~WifiProtectionManager () override
 
void SetLinkId (uint8_t linkId)
 Set the ID of the link this Protection Manager is associated with.
 
void SetWifiMac (Ptr< WifiMac > mac)
 Set the MAC which is using this Protection Manager.
 
- 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::WifiProtectionManager
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.
 

Protected Member Functions

virtual std::unique_ptr< WifiProtectionGetPsduProtection (const WifiMacHeader &hdr, const WifiTxParameters &txParams) const
 Select the protection method for a single PSDU.
 
- Protected Member Functions inherited from ns3::WifiProtectionManager
void AddUserInfoToMuRts (CtrlTriggerHeader &muRts, MHz_u txWidth, const Mac48Address &receiver) const
 Add a User Info field to the given MU-RTS Trigger Frame to solicit a CTS from the station with the given MAC address.
 
void DoDispose () override
 Destructor implementation.
 
Ptr< WifiRemoteStationManagerGetWifiRemoteStationManager () const
 
- 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.
 

Private Member Functions

virtual std::unique_ptr< WifiProtectionTryAddMpduToMuPpdu (Ptr< const WifiMpdu > mpdu, const WifiTxParameters &txParams)
 Calculate the protection method to use if the given MPDU is added to the current DL MU PPDU (represented by the given TX parameters).
 
virtual std::unique_ptr< WifiProtectionTryUlMuTransmission (Ptr< const WifiMpdu > mpdu, const WifiTxParameters &txParams)
 Calculate the protection method for the UL MU transmission solicited by the given Trigger Frame.
 

Private Attributes

bool m_sendMuRts
 true for sending an MU-RTS to protect DL MU PPDUs
 
bool m_singleRtsPerTxop
 true for using protection only once in a TXOP
 
bool m_skipMuRtsBeforeBsrp
 whether to skip MU-RTS before BSRP TF
 

Additional Inherited Members

- Protected Attributes inherited from ns3::WifiProtectionManager
uint8_t m_linkId
 ID of the link this Protection Manager is operating on.
 
Ptr< WifiMacm_mac
 MAC which is using this Protection Manager.
 

Detailed Description

WifiDefaultProtectionManager is the default protection manager, which selects the protection method for a frame based on its size.

Introspection did not find any typical Config paths.


Attributes

  • EnableMuRts: If enabled, always protect a DL/UL MU frame exchange with MU-RTS/CTS.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • SingleRtsPerTxop: If enabled, a protection mechanism (RTS or MU-RTS) is normally used no more than once in a TXOP, regardless of the destination of the data frame (unless required for specific purposes, such as transmitting an Initial Control Frame to an EMLSR client).
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • SkipMuRtsBeforeBsrp: If enabled, MU-RTS is not used to protect the transmission of a BSRP Trigger Frame.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
    • Support level: SUPPORTED

No TraceSources are defined for this type.
Group: Wifi

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

Definition at line 27 of file wifi-default-protection-manager.h.

Constructor & Destructor Documentation

◆ WifiDefaultProtectionManager()

ns3::WifiDefaultProtectionManager::WifiDefaultProtectionManager ( )

Definition at line 61 of file wifi-default-protection-manager.cc.

References NS_LOG_FUNCTION.

◆ ~WifiDefaultProtectionManager()

ns3::WifiDefaultProtectionManager::~WifiDefaultProtectionManager ( )
override

Definition at line 66 of file wifi-default-protection-manager.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ GetPsduProtection()

std::unique_ptr< WifiProtection > ns3::WifiDefaultProtectionManager::GetPsduProtection ( const WifiMacHeader & hdr,
const WifiTxParameters & txParams ) const
protectedvirtual

Select the protection method for a single PSDU.

Parameters
hdrthe MAC header of the PSDU
txParamsthe TX parameters describing the PSDU
Returns
the selected protection method

Definition at line 169 of file wifi-default-protection-manager.cc.

References ns3::DynamicCast(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiTxVector::GetChannelWidth(), ns3::WifiMacHeader::GetFragmentNumber(), ns3::WifiProtectionManager::GetWifiRemoteStationManager(), ns3::WifiMacHeader::IsRetry(), ns3::WifiProtectionManager::m_linkId, ns3::WifiProtectionManager::m_mac, m_singleRtsPerTxop, ns3::WifiTxParameters::m_txVector, and NS_LOG_FUNCTION.

Referenced by TryAddMpdu(), and TryAggregateMsdu().

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

◆ GetTypeId()

TypeId ns3::WifiDefaultProtectionManager::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 32 of file wifi-default-protection-manager.cc.

References m_sendMuRts, m_singleRtsPerTxop, m_skipMuRtsBeforeBsrp, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ TryAddMpdu()

std::unique_ptr< WifiProtection > ns3::WifiDefaultProtectionManager::TryAddMpdu ( Ptr< const WifiMpdu > mpdu,
const WifiTxParameters & txParams )
overridevirtual

Determine the protection method to use if the given MPDU is added to the current frame.

Return a null pointer if the protection method is unchanged or the new protection method otherwise.

Parameters
mpduthe MPDU to be added to the current frame
txParamsthe current TX parameters for the current frame
Returns
a null pointer if the protection method is unchanged or the new protection method otherwise

Implements ns3::WifiProtectionManager.

Definition at line 72 of file wifi-default-protection-manager.cc.

References ns3::WifiProtection::CTS_TO_SELF, ns3::WifiTxParameters::GetPsduInfoMap(), GetPsduProtection(), ns3::WifiProtectionManager::GetWifiRemoteStationManager(), ns3::WifiTxVector::IsDlMu(), ns3::WifiTxVector::IsUlMu(), ns3::WifiTxParameters::m_protection, ns3::WifiTxParameters::m_txVector, ns3::WifiProtection::MU_RTS_CTS, ns3::WifiProtection::NONE, NS_ASSERT, NS_LOG_FUNCTION, ns3::WifiProtection::RTS_CTS, TryAddMpduToMuPpdu(), and TryUlMuTransmission().

+ Here is the call graph for this function:

◆ TryAddMpduToMuPpdu()

std::unique_ptr< WifiProtection > ns3::WifiDefaultProtectionManager::TryAddMpduToMuPpdu ( Ptr< const WifiMpdu > mpdu,
const WifiTxParameters & txParams )
privatevirtual

Calculate the protection method to use if the given MPDU is added to the current DL MU PPDU (represented by the given TX parameters).

If the computed protection method is the same as the current one, a null pointer is returned. Otherwise, the computed protection method is returned. The TX width of the PPDU containing the MU-RTS is the same as the DL MU PPDU being protected. Each non-AP station is solicited to transmit a CTS occupying a bandwidth equal to the minimum between the TX width of the DL MU PPDU and the maximum channel width supported by the non-AP station.

Parameters
mpduthe given MPDU
txParamsthe TX parameters describing the current DL MU PPDU
Returns
the new protection method or a null pointer if the protection method is unchanged

Definition at line 226 of file wifi-default-protection-manager.cc.

References ns3::WifiProtectionManager::AddUserInfoToMuRts(), ns3::AP, ns3::WifiTxVector::GetChannelWidth(), ns3::ErpOfdmPhy::GetErpOfdmRate6Mbps(), ns3::WifiTxVector::GetModulationClass(), ns3::WifiTxParameters::GetPsduInfoMap(), ns3::WifiProtectionManager::GetWifiRemoteStationManager(), ns3::WifiTxVector::IsDlMu(), ns3::WifiTxParameters::LastAddedIsFirstMpdu(), ns3::WifiProtectionManager::m_linkId, ns3::WifiProtectionManager::m_mac, ns3::WifiTxParameters::m_protection, m_sendMuRts, m_singleRtsPerTxop, ns3::WifiTxParameters::m_txVector, ns3::WifiProtection::MU_RTS_CTS, ns3::MU_RTS_TRIGGER, ns3::WifiMuRtsCtsProtection::muRts, ns3::WifiMuRtsCtsProtection::muRtsTxVector, ns3::WifiProtection::NONE, NS_ABORT_MSG_IF, NS_ASSERT, NS_LOG_FUNCTION, ns3::WifiTxVector::SetChannelWidth(), ns3::WifiTxVector::SetMode(), ns3::CtrlTriggerHeader::SetType(), ns3::CtrlTriggerHeader::SetUlBandwidth(), ns3::StaticCast(), ns3::WIFI_MOD_CLASS_DSSS, and ns3::WIFI_MOD_CLASS_HR_DSSS.

Referenced by TryAddMpdu().

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

◆ TryAggregateMsdu()

std::unique_ptr< WifiProtection > ns3::WifiDefaultProtectionManager::TryAggregateMsdu ( Ptr< const WifiMpdu > msdu,
const WifiTxParameters & txParams )
overridevirtual

Determine the protection method to use if the given MSDU is aggregated to the current frame.

Return a null pointer if the protection method is unchanged or the new protection method otherwise.

Parameters
msduthe MSDU to be aggregated to the current frame
txParamsthe current TX parameters for the current frame
Returns
a null pointer if the protection method is unchanged or the new protection method otherwise

Implements ns3::WifiProtectionManager.

Definition at line 131 of file wifi-default-protection-manager.cc.

References ns3::WifiProtection::CTS_TO_SELF, ns3::WifiTxParameters::GetPsduInfoMap(), GetPsduProtection(), ns3::WifiTxVector::IsDlMu(), ns3::WifiTxVector::IsUlMu(), ns3::WifiTxParameters::m_protection, ns3::WifiTxParameters::m_txVector, ns3::WifiProtection::MU_RTS_CTS, ns3::WifiProtection::NONE, NS_ASSERT, NS_LOG_FUNCTION, and ns3::WifiProtection::RTS_CTS.

+ Here is the call graph for this function:

◆ TryUlMuTransmission()

std::unique_ptr< WifiProtection > ns3::WifiDefaultProtectionManager::TryUlMuTransmission ( Ptr< const WifiMpdu > mpdu,
const WifiTxParameters & txParams )
privatevirtual

Calculate the protection method for the UL MU transmission solicited by the given Trigger Frame.

The TX width of the PPDU containing the MU-RTS is the same as the TB PPDUs being solicited by the given Trigger Frame. Each non-AP station is solicited to transmit a CTS occupying a bandwidth equal to the minimum between the TX width of the PPDU containing the MU-RTS and the maximum channel width supported by the non-AP station.

Parameters
mpduthe given Trigger Frame
txParamsthe current TX parameters (just the TXVECTOR needs to be set)
Returns
the protection method for the UL MU transmission solicited by the given Trigger Frame

Definition at line 337 of file wifi-default-protection-manager.cc.

References ns3::WifiProtectionManager::AddUserInfoToMuRts(), ns3::AP, ns3::ErpOfdmPhy::GetErpOfdmRate6Mbps(), ns3::CtrlTriggerHeader::GetNUserInfoFields(), ns3::CtrlTriggerHeader::GetUlBandwidth(), ns3::WifiProtectionManager::GetWifiRemoteStationManager(), ns3::CtrlTriggerHeader::IsBsrp(), ns3::WifiProtectionManager::m_linkId, ns3::WifiProtectionManager::m_mac, m_sendMuRts, m_singleRtsPerTxop, m_skipMuRtsBeforeBsrp, ns3::MU_RTS_TRIGGER, NS_ABORT_MSG_IF, NS_ASSERT, NS_LOG_FUNCTION, ns3::StaticCast(), ns3::WIFI_MOD_CLASS_DSSS, and ns3::WIFI_MOD_CLASS_HR_DSSS.

Referenced by TryAddMpdu().

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

Member Data Documentation

◆ m_sendMuRts

bool ns3::WifiDefaultProtectionManager::m_sendMuRts
private

true for sending an MU-RTS to protect DL MU PPDUs

Definition at line 90 of file wifi-default-protection-manager.h.

Referenced by GetTypeId(), TryAddMpduToMuPpdu(), and TryUlMuTransmission().

◆ m_singleRtsPerTxop

bool ns3::WifiDefaultProtectionManager::m_singleRtsPerTxop
private

true for using protection only once in a TXOP

Definition at line 91 of file wifi-default-protection-manager.h.

Referenced by GetPsduProtection(), GetTypeId(), TryAddMpduToMuPpdu(), and TryUlMuTransmission().

◆ m_skipMuRtsBeforeBsrp

bool ns3::WifiDefaultProtectionManager::m_skipMuRtsBeforeBsrp
private

whether to skip MU-RTS before BSRP TF

Definition at line 92 of file wifi-default-protection-manager.h.

Referenced by GetTypeId(), and TryUlMuTransmission().


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