DefaultEmlsrManager is the default EMLSR manager. More...

#include "default-emlsr-manager.h"

Inheritance diagram for ns3::DefaultEmlsrManager:

Collaboration diagram for ns3::DefaultEmlsrManager:

Public Member Functions
	DefaultEmlsrManager ()

	~DefaultEmlsrManager () override

Public Member Functions inherited from ns3::EmlsrManager
	EmlsrManager ()

	~EmlsrManager () override

bool	GetCamStateReset () const

const std::set< uint8_t > &	GetEmlsrLinks () const

uint8_t	GetMainPhyId () const

std::optional< Time >	GetTransitionTimeout () const

void	NotifyIcfReceived (uint8_t linkId)
	Notify the reception of an initial Control frame on the given link.

void	NotifyMgtFrameReceived (Ptr< const WifiMpdu > mpdu, uint8_t linkId)
	Notify the reception of a management frame addressed to us.

void	NotifyTxopEnd (uint8_t linkId)
	Notify the end of a TXOP on the given link.

void	NotifyUlTxopStart (uint8_t linkId)
	Notify the start of an UL TXOP on the given link.

void	SetCamStateReset (bool enable)
	Set the member variable indicating whether the state of the CAM should be reset when the main PHY switches channel and operates on the link associated with the CAM.

void	SetEmlsrLinks (const std::set< uint8_t > &linkIds)
	Take actions to enable EMLSR mode on the given set of links, if non-empty, or disable EMLSR mode, otherwise.

void	SetMainPhyId (uint8_t mainPhyId)
	Set the ID of main PHY (position in the vector of PHYs held by WifiNetDevice).

void	SetTransitionTimeout (Time timeout)
	Set the Transition Timeout advertised by the associated AP with EMLSR activated.

void	SetWifiMac (Ptr< StaWifiMac > mac)
	Set the wifi MAC.

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.

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) 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.

virtual TypeId	GetInstanceTypeId () const =0
	Get the most derived TypeId for this Object.

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::EmlsrManager
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
uint8_t	GetLinkToSendEmlOmn () override

std::optional< uint8_t >	ResendNotification (Ptr< const WifiMpdu > mpdu) override
	A previous EML Operating Mode Notification frame was dropped.

Protected Member Functions inherited from ns3::EmlsrManager
void	DoDispose () override
	Destructor implementation.

const WifiPhyOperatingChannel &	GetChannelForAuxPhy (uint8_t linkId) const

const WifiPhyOperatingChannel &	GetChannelForMainPhy (uint8_t linkId) const

Ptr< EhtFrameExchangeManager >	GetEhtFem (uint8_t linkId) const

MgtEmlOmn	GetEmlOmn ()

virtual uint8_t	GetLinkToSendEmlOmn ()=0

Ptr< StaWifiMac >	GetStaMac () const

virtual std::optional< uint8_t >	ResendNotification (Ptr< const WifiMpdu > mpdu)=0
	A previous EML Operating Mode Notification frame was dropped.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

virtual void	DoDispose ()
	Destructor implementation.

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
void	DoNotifyMgtFrameReceived (Ptr< const WifiMpdu > mpdu, uint8_t linkId) override
	Notify the subclass of the reception of a management frame addressed to us.

void	NotifyEmlsrModeChanged () override
	Notify subclass that EMLSR mode changed.

void	NotifyMainPhySwitch (uint8_t currLinkId, uint8_t nextLinkId) override
	Notify subclass that the main PHY is switching channel to operate on another link.

Private Attributes
bool	m_switchAuxPhy
	whether Aux PHY should switch channel to operate on the link on which the Main PHY was operating before moving to the link of the Aux PHY

Additional Inherited Members
Protected Attributes inherited from ns3::EmlsrManager
uint16_t	m_auxPhyMaxWidth
	max channel width (MHz) supported by aux PHYs

Time	m_emlsrPaddingDelay
	EMLSR Padding delay.

Time	m_emlsrTransitionDelay
	EMLSR Transition delay.

uint8_t	m_mainPhyId
	ID of main PHY (position in the vector of PHYs held by WifiNetDevice)

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

Detailed Description

DefaultEmlsrManager is the default EMLSR manager.

Introspection did not find any typical Config paths.

Attributes

SwitchAuxPhy: Whether Aux PHY should switch channel to operate on the link on which the Main PHY was operating before moving to the link of the Aux PHY.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread

Attributes defined in parent class ns3::EmlsrManager

AuxPhyChannelWidth: The maximum channel width (MHz) supported by Aux PHYs
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 20:160
- Initial value: 20
- Flags: constructwriteread
EmlsrLinkSet: IDs of the links on which EMLSR mode will be enabled. An empty set indicates to disable EMLSR.
- Set with class: ns3::AttributeContainerValue<N3ns313UintegerValueE, St4listIN3ns33PtrINS0_13UintegerValueEEESaIS3_EE>
- Underlying type: ns3::Ptr<N3ns313UintegerValueE>
- Initial value:
- Flags: constructwrite
EmlsrPaddingDelay: The EMLSR Paddind Delay (not used by AP MLDs). Possible values are 0 us, 32 us, 64 us, 128 us or 256 us.
- Set with class: ns3::TimeValue
- Underlying type: Time +0ns:+256000ns
- Initial value: +0ns
- Flags: constructwriteread
EmlsrTransitionDelay: The EMLSR Transition Delay (not used by AP MLDs). Possible values are 0 us, 16 us, 32 us, 64 us, 128 us or 256 us.
- Set with class: ns3::TimeValue
- Underlying type: Time +0ns:+256000ns
- Initial value: +0ns
- Flags: constructwriteread
MainPhyId: The ID of the main PHY (position in the vector of PHYs held by WifiNetDevice). This attribute cannot be set after initialization.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 0
- Flags: constructwriteread
ResetCamState: Whether to reset the state of the ChannelAccessManager associated with the link on which the main PHY has just switched to.
- Set with class: ns3::BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: constructwriteread