WifiProtectionManager is an abstract base class. More...

#include "wifi-protection-manager.h"

Inheritance diagram for ns3::WifiProtectionManager:

Collaboration diagram for ns3::WifiProtectionManager:

Public Member Functions
	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.

virtual std::unique_ptr< WifiProtection >	TryAddMpdu (Ptr< const WifiMpdu > mpdu, const WifiTxParameters &txParams)=0
	Determine the protection method to use if the given MPDU is added to the current frame.

virtual std::unique_ptr< WifiProtection >	TryAggregateMsdu (Ptr< const WifiMpdu > msdu, const WifiTxParameters &txParams)=0
	Determine the protection method to use if the given MSDU is aggregated to the current frame.

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

Protected Attributes
uint8_t	m_linkId
	ID of the link this Protection Manager is operating on.

Ptr< WifiMac >	m_mac
	MAC which is using this Protection Manager.

Additional Inherited Members
Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

Detailed Description

WifiProtectionManager is an abstract base class.

Each subclass defines a logic to select the protection method for a given frame.

Definition at line 32 of file wifi-protection-manager.h.

Constructor & Destructor Documentation

◆ WifiProtectionManager()

ns3::WifiProtectionManager::WifiProtectionManager ( )

Definition at line 31 of file wifi-protection-manager.cc.

References NS_LOG_FUNCTION.

◆ ~WifiProtectionManager()

ns3::WifiProtectionManager::~WifiProtectionManager ( )

override

Definition at line 37 of file wifi-protection-manager.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ AddUserInfoToMuRts()

void ns3::WifiProtectionManager::AddUserInfoToMuRts	(	CtrlTriggerHeader &	muRts,
		MHz_u	txWidth,
		const Mac48Address &	receiver ) const

protected

Add a User Info field to the given MU-RTS Trigger Frame to solicit a CTS from the station with the given MAC address.

The MU-RTS is intended to protect a data frame having the given TX width. The TX width of the solicited CTS is the minimum between the TX width of the protected data frame and the maximum width supported by the solicited station.

Parameters

muRts	the MU-RTS Trigger Frame
txWidth	the TX width of the protected data frame
receiver	the MAC address of the solicited station

Definition at line 71 of file wifi-protection-manager.cc.

References ns3::CtrlTriggerHeader::AddUserInfoField(), ns3::AP, GetWifiRemoteStationManager(), m_linkId, m_mac, NS_ABORT_MSG, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, ns3::CtrlTriggerUserInfoField::SetAid12(), ns3::CtrlTriggerUserInfoField::SetMuRtsRuAllocation(), and ns3::StaticCast().

Referenced by ns3::WifiDefaultProtectionManager::TryAddMpduToMuPpdu(), and ns3::WifiDefaultProtectionManager::TryUlMuTransmission().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoDispose()

void ns3::WifiProtectionManager::DoDispose ( )

overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

It is safe to call GetObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 43 of file wifi-protection-manager.cc.

References ns3::Object::DoDispose(), m_mac, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::WifiProtectionManager::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 24 of file wifi-protection-manager.cc.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ GetWifiRemoteStationManager()

Ptr< WifiRemoteStationManager > ns3::WifiProtectionManager::GetWifiRemoteStationManager ( ) const

protected

Returns: the remote station manager operating on our link

Definition at line 58 of file wifi-protection-manager.cc.

References m_linkId, and m_mac.

Referenced by AddUserInfoToMuRts(), ns3::WifiDefaultProtectionManager::GetPsduProtection(), ns3::WifiDefaultProtectionManager::TryAddMpdu(), ns3::WifiDefaultProtectionManager::TryAddMpduToMuPpdu(), and ns3::WifiDefaultProtectionManager::TryUlMuTransmission().

Here is the caller graph for this function:

◆ SetLinkId()

void ns3::WifiProtectionManager::SetLinkId ( uint8_t linkId )

Set the ID of the link this Protection Manager is associated with.

Parameters

linkId the ID of the link this Protection Manager is associated with

Definition at line 64 of file wifi-protection-manager.cc.

References m_linkId, and NS_LOG_FUNCTION.

◆ SetWifiMac()

void ns3::WifiProtectionManager::SetWifiMac ( Ptr< WifiMac > mac )

Set the MAC which is using this Protection Manager.

Parameters

mac	a pointer to the MAC

Definition at line 51 of file wifi-protection-manager.cc.

References m_mac, and NS_LOG_FUNCTION.

Referenced by ns3::WifiMacHelper::Create().

Here is the caller graph for this function:

◆ TryAddMpdu()

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

pure virtual

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

mpdu	the MPDU to be added to the current frame
txParams	the current TX parameters for the current frame

Returns: a null pointer if the protection method is unchanged or the new protection method otherwise

Implemented in ns3::WifiDefaultProtectionManager.

◆ TryAggregateMsdu()

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

pure virtual

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

msdu	the MSDU to be aggregated to the current frame
txParams	the current TX parameters for the current frame

Returns: a null pointer if the protection method is unchanged or the new protection method otherwise

Implemented in ns3::WifiDefaultProtectionManager.

Member Data Documentation

◆ m_linkId

uint8_t ns3::WifiProtectionManager::m_linkId

protected

ID of the link this Protection Manager is operating on.

Definition at line 106 of file wifi-protection-manager.h.

Referenced by AddUserInfoToMuRts(), ns3::WifiDefaultProtectionManager::GetPsduProtection(), GetWifiRemoteStationManager(), SetLinkId(), ns3::WifiDefaultProtectionManager::TryAddMpduToMuPpdu(), and ns3::WifiDefaultProtectionManager::TryUlMuTransmission().

◆ m_mac

Ptr<WifiMac> ns3::WifiProtectionManager::m_mac

protected

MAC which is using this Protection Manager.

Definition at line 105 of file wifi-protection-manager.h.

Referenced by AddUserInfoToMuRts(), DoDispose(), ns3::WifiDefaultProtectionManager::GetPsduProtection(), GetWifiRemoteStationManager(), SetWifiMac(), ns3::WifiDefaultProtectionManager::TryAddMpduToMuPpdu(), and ns3::WifiDefaultProtectionManager::TryUlMuTransmission().

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

src/wifi/model/wifi-protection-manager.h
src/wifi/model/wifi-protection-manager.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WifiProtectionManager()

◆ ~WifiProtectionManager()

Member Function Documentation

◆ AddUserInfoToMuRts()

◆ DoDispose()

◆ GetTypeId()

◆ GetWifiRemoteStationManager()

◆ SetLinkId()

◆ SetWifiMac()

◆ TryAddMpdu()

◆ TryAggregateMsdu()

Member Data Documentation

◆ m_linkId

◆ m_mac