AdvancedApEmlsrManager is an advanced AP EMLSR manager. More...

#include "advanced-ap-emlsr-manager.h"

Inheritance diagram for ns3::AdvancedApEmlsrManager:

Collaboration diagram for ns3::AdvancedApEmlsrManager:

Public Member Functions
	AdvancedApEmlsrManager ()

	~AdvancedApEmlsrManager () override

Time	GetDelayOnTxPsduNotForEmlsr (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, WifiPhyBand band) override
	This method is intended to be called when the AP MLD starts transmitting an SU frame that is not addressed to EMLSR clients that were previously involved in the ongoing DL TXOP.

void	NotifyPsduRxError (uint8_t linkId, Ptr< const WifiPsdu > psdu) override
	This method is called when the reception of a PSDU fails on the given link.

void	NotifyPsduRxOk (uint8_t linkId, Ptr< const WifiPsdu > psdu) override
	This method is called when the reception of a PSDU succeeds on the given link.

bool	UpdateCwAfterFailedIcf () override

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

	~DefaultApEmlsrManager () override

Time	GetDelayOnTxPsduNotForEmlsr (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, WifiPhyBand band) override
	This method is intended to be called when the AP MLD starts transmitting an SU frame that is not addressed to EMLSR clients that were previously involved in the ongoing DL TXOP.

bool	UpdateCwAfterFailedIcf () override

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

	~ApEmlsrManager () override

void	SetWifiMac (Ptr< ApWifiMac > 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, 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::DefaultApEmlsrManager
static TypeId	GetTypeId ()
	Get the type ID.

Static Public Member Functions inherited from ns3::ApEmlsrManager
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	DoDispose () override
	Destructor implementation.

void	DoSetWifiMac (Ptr< ApWifiMac > mac) override
	Allow subclasses to take actions when the MAC is set.

void	ReceivedMacHdr (uint8_t linkId, const WifiMacHeader &macHdr, const WifiTxVector &txVector, Time psduDuration)
	Store information about the MAC header of the MPDU being received on the given link.

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

Ptr< ApWifiMac >	GetApMac () const

Ptr< EhtFrameExchangeManager >	GetEhtFem (uint8_t linkId) 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 Attributes
std::set< uint8_t >	m_blockedLinksOnMacHdrRx
	links that have been blocked upon receiving a MAC header

bool	m_earlySwitchToListening
	Whether the AP MLD assumes that an EMLSR client is able to detect at the end of the MAC header that a PSDU is not addressed to it and immediately starts switching to listening mode.

bool	m_updateCwAfterFailedIcf
	Whether the AP MLD shall double the CW upon CTS timeout.

bool	m_useNotifiedMacHdr
	whether to use the information about the MAC header of the MPDU being received (if notified by the PHY)

bool	m_waitTransDelayOnPsduRxError
	Whether the AP MLD waits for a response timeout after a PSDU reception error before starting the transition delay.

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

AdvancedApEmlsrManager is an advanced AP EMLSR manager.

Definition at line 31 of file advanced-ap-emlsr-manager.h.

Constructor & Destructor Documentation

◆ AdvancedApEmlsrManager()

ns3::AdvancedApEmlsrManager::AdvancedApEmlsrManager ( )

Definition at line 66 of file advanced-ap-emlsr-manager.cc.

References NS_LOG_FUNCTION.

◆ ~AdvancedApEmlsrManager()

ns3::AdvancedApEmlsrManager::~AdvancedApEmlsrManager ( )

override

Definition at line 71 of file advanced-ap-emlsr-manager.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ DoDispose()

void ns3::AdvancedApEmlsrManager::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 77 of file advanced-ap-emlsr-manager.cc.

References ns3::Object::DoDispose(), ns3::ApEmlsrManager::GetApMac(), ns3::MakeCallback(), NS_LOG_FUNCTION, and ReceivedMacHdr().

Here is the call graph for this function:

◆ DoSetWifiMac()

void ns3::AdvancedApEmlsrManager::DoSetWifiMac ( Ptr< ApWifiMac > mac )

overrideprotectedvirtual

Allow subclasses to take actions when the MAC is set.

Parameters

mac	the wifi MAC

Reimplemented from ns3::ApEmlsrManager.

Definition at line 91 of file advanced-ap-emlsr-manager.cc.

References ns3::ApEmlsrManager::GetApMac(), ns3::MakeCallback(), NS_LOG_FUNCTION, and ReceivedMacHdr().

Here is the call graph for this function:

◆ GetDelayOnTxPsduNotForEmlsr()

Time ns3::AdvancedApEmlsrManager::GetDelayOnTxPsduNotForEmlsr	(	Ptr< const WifiPsdu >	psdu,
		const WifiTxVector &	txVector,
		WifiPhyBand	band )

overridevirtual

This method is intended to be called when the AP MLD starts transmitting an SU frame that is not addressed to EMLSR clients that were previously involved in the ongoing DL TXOP.

Parameters

psdu	the PSDU being transmitted
txVector	the TXVECTOR used to transmit the PSDU
band	the PHY band in which the PSDU is being transmitted

Returns: the delay after which the AP MLD starts the transition delay for the EMLSR client

Implements ns3::ApEmlsrManager.

Definition at line 174 of file advanced-ap-emlsr-manager.cc.

References ns3::DataRate::CalculateBytesTxTime(), ns3::WifiMode::GetDataRate(), ns3::DefaultApEmlsrManager::GetDelayOnTxPsduNotForEmlsr(), ns3::WifiTxVector::GetMode(), m_earlySwitchToListening, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::AdvancedApEmlsrManager::GetTypeId ( )

static

Get the type ID.

Returns: the object TypeId

Definition at line 27 of file advanced-ap-emlsr-manager.cc.

References m_earlySwitchToListening, m_updateCwAfterFailedIcf, m_useNotifiedMacHdr, m_waitTransDelayOnPsduRxError, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ NotifyPsduRxError()

void ns3::AdvancedApEmlsrManager::NotifyPsduRxError	(	uint8_t	linkId,
		Ptr< const WifiPsdu >	psdu )

overridevirtual

This method is called when the reception of a PSDU fails on the given link.

Parameters

linkId	the ID of the given link
psdu	the PSDU whose reception failed

Reimplemented from ns3::ApEmlsrManager.

Definition at line 130 of file advanced-ap-emlsr-manager.cc.

References ns3::EMLSR_RX_PHY_START_DELAY, ns3::ApEmlsrManager::GetApMac(), ns3::ApEmlsrManager::GetEhtFem(), m_blockedLinksOnMacHdrRx, m_waitTransDelayOnPsduRxError, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::USING_OTHER_EMLSR_LINK.

Here is the call graph for this function:

◆ NotifyPsduRxOk()

void ns3::AdvancedApEmlsrManager::NotifyPsduRxOk	(	uint8_t	linkId,
		Ptr< const WifiPsdu >	psdu )

overridevirtual

This method is called when the reception of a PSDU succeeds on the given link.

Parameters

linkId	the ID of the given link
psdu	the PSDU whose reception succeeded

Reimplemented from ns3::ApEmlsrManager.

Definition at line 123 of file advanced-ap-emlsr-manager.cc.

References m_blockedLinksOnMacHdrRx, and NS_LOG_FUNCTION.

◆ ReceivedMacHdr()

void ns3::AdvancedApEmlsrManager::ReceivedMacHdr	(	uint8_t	linkId,
		const WifiMacHeader &	macHdr,
		const WifiTxVector &	txVector,
		Time	psduDuration )

protected

Store information about the MAC header of the MPDU being received on the given link.

Parameters

linkId	the ID of the given link
macHdr	the MAC header of the MPDU being received
txVector	the TXVECTOR used to transmit the PSDU
psduDuration	the remaining duration of the PSDU

Definition at line 105 of file advanced-ap-emlsr-manager.cc.

References ns3::Time::As(), ns3::ApEmlsrManager::GetEhtFem(), m_blockedLinksOnMacHdrRx, m_useNotifiedMacHdr, ns3::Time::MS, and NS_LOG_FUNCTION.

Referenced by DoDispose(), and DoSetWifiMac().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateCwAfterFailedIcf()

bool ns3::AdvancedApEmlsrManager::UpdateCwAfterFailedIcf ( )

overridevirtual

Returns: whether the AP MLD shall double the CW upon CTS timeout after an MU-RTS in case all the clients solicited by the MU-RTS are EMLSR clients that have sent (or are sending) a frame to the AP

Implements ns3::ApEmlsrManager.

Definition at line 193 of file advanced-ap-emlsr-manager.cc.

References m_updateCwAfterFailedIcf.

Member Data Documentation

◆ m_blockedLinksOnMacHdrRx

std::set<uint8_t> ns3::AdvancedApEmlsrManager::m_blockedLinksOnMacHdrRx

private

links that have been blocked upon receiving a MAC header

Definition at line 69 of file advanced-ap-emlsr-manager.h.

Referenced by NotifyPsduRxError(), NotifyPsduRxOk(), and ReceivedMacHdr().

◆ m_earlySwitchToListening

bool ns3::AdvancedApEmlsrManager::m_earlySwitchToListening

private

Whether the AP MLD assumes that an EMLSR client is able to detect at the end of the MAC header that a PSDU is not addressed to it and immediately starts switching to listening mode.

Definition at line 72 of file advanced-ap-emlsr-manager.h.

Referenced by GetDelayOnTxPsduNotForEmlsr(), and GetTypeId().