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

void	CancelMediumSyncDelayTimer (uint8_t linkId)
	Cancel the MediumSyncDelay timer associated with the given link and take the appropriate actions.

void	DecrementMediumSyncDelayNTxops (uint8_t linkId)
	Decrement the counter indicating the number of TXOP attempts left while the MediumSyncDelay timer is running.

bool	GetAuxPhyTxCapable () const

bool	GetCamStateReset () const

std::optional< Time >	GetElapsedMediumSyncDelayTimer (uint8_t linkId) const
	Check whether the MediumSyncDelay timer is running for the STA operating on the given link.

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

uint8_t	GetMainPhyId () const

Time	GetMediumSyncDuration () const

std::optional< uint8_t >	GetMediumSyncMaxNTxops () const

int8_t	GetMediumSyncOfdmEdThreshold () const

std::optional< Time >	GetTransitionTimeout () const

bool	MediumSyncDelayNTxopsExceeded (uint8_t linkId)
	Return whether no more TXOP attempt is allowed on the given link.

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, bool ulTxopNotStarted=false, bool ongoingDlTxop=false)
	Notify the end of a TXOP on the given link.

void	NotifyUlTxopStart (uint8_t linkId, std::optional< Time > timeToCtsEnd)
	Notify the start of an UL TXOP on the given link.

void	ResetMediumSyncDelayNTxops (uint8_t linkId)
	Reset the counter indicating the number of TXOP attempts left while the MediumSyncDelay timer is running, so as to remove the limit on the number of attempts that can be made while the MediumSyncDelay timer is running.

void	SetAuxPhyTxCapable (bool capable)
	Set the member variable indicating whether Aux PHYs are capable of transmitting PPDUs.

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	SetMediumSyncDuration (Time duration)
	Set the duration of the MediumSyncDelay timer.

void	SetMediumSyncMaxNTxops (std::optional< uint8_t > nTxops)
	Set the maximum number of TXOPs a non-AP STA is allowed to attempt to initiate while the MediumSyncDelay timer is running.

void	SetMediumSyncOfdmEdThreshold (int8_t threshold)
	Set the Medium Synchronization OFDM ED threshold (dBm) to use while the MediumSyncDelay timer is running.

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.

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

void	SetCcaEdThresholdOnLinkSwitch (Ptr< WifiPhy > phy, uint8_t linkId)
	Set the CCA ED threshold (if needed) on the given PHY that is switching channel to operate on the given link.

void	SwitchAuxPhy (uint8_t currLinkId, uint8_t nextLinkId)
	Switch channel on the Aux PHY operating on the given current link so that it operates on the given next link.

void	SwitchMainPhy (uint8_t linkId, bool noSwitchDelay, bool resetBackoff, bool requestAccess)
	Switch channel on the Main PHY so that it operates on the given link.

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	DoNotifyIcfReceived (uint8_t linkId) override
	Notify the subclass of the reception of an initial Control frame on the given link.

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

void	DoNotifyTxopEnd (uint8_t linkId) override
	Notify the subclass of the end of a TXOP on the given link.

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

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
Ptr< WifiPhy >	m_auxPhyToReconnect
	Aux PHY the ChannelAccessManager of the link on which the main PHY is operating has to connect a listener to when the main PHY is back operating on its previous link.

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
WifiModulationClass	m_auxPhyMaxModClass
	max modulation class supported by aux PHYs

uint16_t	m_auxPhyMaxWidth
	max channel width (MHz) supported by aux PHYs

bool	m_auxPhyTxCapable
	whether Aux PHYs are capable of transmitting PPDUs

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)

Static Protected Attributes inherited from ns3::EmlsrManager
static constexpr bool	DONT_REQUEST_ACCESS
	do not request channel access when PHY switch ends

static constexpr bool	DONT_RESET_BACKOFF = false
	do not reset backoff on main PHY switch

static constexpr bool	REQUEST_ACCESS = true
	request channel access when PHY switch ends

static constexpr bool	RESET_BACKOFF = true
	reset backoff on main PHY switch

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.

Definition at line 35 of file default-emlsr-manager.h.

Constructor & Destructor Documentation

◆ DefaultEmlsrManager()

ns3::DefaultEmlsrManager::DefaultEmlsrManager ( )

Definition at line 58 of file default-emlsr-manager.cc.

References NS_LOG_FUNCTION.

◆ ~DefaultEmlsrManager()

ns3::DefaultEmlsrManager::~DefaultEmlsrManager ( )

override

Definition at line 63 of file default-emlsr-manager.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ DoNotifyIcfReceived()

void ns3::DefaultEmlsrManager::DoNotifyIcfReceived ( uint8_t linkId )

overrideprivatevirtual

Notify the subclass of the reception of an initial Control frame on the given link.

Parameters

linkId the ID of the link on which the initial Control frame was received

Implements ns3::EmlsrManager.

Definition at line 132 of file default-emlsr-manager.cc.

References NS_LOG_FUNCTION.

◆ DoNotifyMgtFrameReceived()

void ns3::DefaultEmlsrManager::DoNotifyMgtFrameReceived	(	Ptr< const WifiMpdu >	mpdu,
		uint8_t	linkId
	)

overrideprivatevirtual

Notify the subclass of the reception of a management frame addressed to us.

Parameters

mpdu	the received MPDU
linkId	the ID of the link over which the MPDU was received

Implements ns3::EmlsrManager.

Definition at line 69 of file default-emlsr-manager.cc.

References NS_LOG_FUNCTION.

◆ DoNotifyTxopEnd()

void ns3::DefaultEmlsrManager::DoNotifyTxopEnd ( uint8_t linkId )

overrideprivatevirtual

Notify the subclass of the end of a TXOP on the given link.

Parameters

linkId the ID of the given link

Implements ns3::EmlsrManager.

Definition at line 144 of file default-emlsr-manager.cc.

References ns3::EmlsrManager::DONT_RESET_BACKOFF, ns3::WifiMac::GetDevice(), ns3::EmlsrManager::GetMainPhyId(), ns3::WifiNetDevice::GetPhy(), ns3::EmlsrManager::GetStaMac(), m_auxPhyToReconnect, ns3::EmlsrManager::m_mainPhyId, m_switchAuxPhy, NS_LOG_FUNCTION, ns3::EmlsrManager::REQUEST_ACCESS, ns3::Simulator::Schedule(), and ns3::EmlsrManager::SwitchMainPhy().

Here is the call graph for this function:

◆ DoNotifyUlTxopStart()

void ns3::DefaultEmlsrManager::DoNotifyUlTxopStart ( uint8_t linkId )

overrideprivatevirtual

Notify the subclass of the start of an UL TXOP on the given link.

Parameters

linkId the ID of the given link

Implements ns3::EmlsrManager.

Definition at line 138 of file default-emlsr-manager.cc.

References NS_LOG_FUNCTION.

◆ GetLinkToSendEmlOmn()

uint8_t ns3::DefaultEmlsrManager::GetLinkToSendEmlOmn ( )

overrideprotectedvirtual

Returns: the ID of the link on which the EML Operating Mode Notification frame has to be sent

Implements ns3::EmlsrManager.

Definition at line 75 of file default-emlsr-manager.cc.

References ns3::WifiMac::GetLinkForPhy(), ns3::EmlsrManager::GetStaMac(), ns3::EmlsrManager::m_mainPhyId, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::DefaultEmlsrManager::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 39 of file default-emlsr-manager.cc.

References m_switchAuxPhy, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ NotifyEmlsrModeChanged()

void ns3::DefaultEmlsrManager::NotifyEmlsrModeChanged ( )

overrideprivatevirtual

Notify subclass that EMLSR mode changed.

Implements ns3::EmlsrManager.

Definition at line 93 of file default-emlsr-manager.cc.

References NS_LOG_FUNCTION.

◆ NotifyMainPhySwitch()

void ns3::DefaultEmlsrManager::NotifyMainPhySwitch	(	uint8_t	currLinkId,
		uint8_t	nextLinkId
	)

overrideprivatevirtual

Notify subclass that the main PHY is switching channel to operate on another link.

Parameters

currLinkId	the ID of the link on which the main PHY is operating
nextLinkId	the ID of the link on which the main PHY will be operating

Implements ns3::EmlsrManager.

Definition at line 99 of file default-emlsr-manager.cc.

References ns3::EmlsrManager::GetMainPhyId(), ns3::EmlsrManager::GetStaMac(), ns3::WifiMac::GetWifiPhy(), m_auxPhyToReconnect, m_switchAuxPhy, ns3::StaWifiMac::NotifySwitchingEmlsrLink(), NS_ASSERT_MSG, NS_LOG_FUNCTION, ns3::Seconds(), ns3::EmlsrManager::SetCcaEdThresholdOnLinkSwitch(), and ns3::EmlsrManager::SwitchAuxPhy().

Here is the call graph for this function:

◆ ResendNotification()

std::optional< uint8_t > ns3::DefaultEmlsrManager::ResendNotification ( Ptr< const WifiMpdu > mpdu )

overrideprotectedvirtual

A previous EML Operating Mode Notification frame was dropped.

Ask the subclass whether the frame needs to be re-sent on the given link (if any).

Parameters

mpdu	the dropped MPDU that includes the EML Operating Mode Notification frame

Returns: the ID of the link over which to re-send the frame, if needed

Implements ns3::EmlsrManager.

Definition at line 84 of file default-emlsr-manager.cc.

References ns3::WifiMac::GetLinkForPhy(), ns3::EmlsrManager::GetStaMac(), ns3::EmlsrManager::m_mainPhyId, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Data Documentation

◆ m_auxPhyToReconnect

Ptr<WifiPhy> ns3::DefaultEmlsrManager::m_auxPhyToReconnect

private

Aux PHY the ChannelAccessManager of the link on which the main PHY is operating has to connect a listener to when the main PHY is back operating on its previous link.

Definition at line 61 of file default-emlsr-manager.h.

Referenced by DoNotifyTxopEnd(), and NotifyMainPhySwitch().

◆ m_switchAuxPhy

bool ns3::DefaultEmlsrManager::m_switchAuxPhy

private

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

Definition at line 59 of file default-emlsr-manager.h.

Referenced by DoNotifyTxopEnd(), GetTypeId(), and NotifyMainPhySwitch().

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

src/wifi/model/eht/default-emlsr-manager.h
src/wifi/model/eht/default-emlsr-manager.cc

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DefaultEmlsrManager()

◆ ~DefaultEmlsrManager()

Member Function Documentation

◆ DoNotifyIcfReceived()

◆ DoNotifyMgtFrameReceived()

◆ DoNotifyTxopEnd()

◆ DoNotifyUlTxopStart()

◆ GetLinkToSendEmlOmn()

◆ GetTypeId()

◆ NotifyEmlsrModeChanged()

◆ NotifyMainPhySwitch()

◆ ResendNotification()

Member Data Documentation

◆ m_auxPhyToReconnect

◆ m_switchAuxPhy