A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::ApEmlsrManager Class Referenceabstract

ApEmlsrManager is an abstract base class defining the API that EHT AP MLDs with EMLSR activated can use to handle the operations on the EMLSR links of EMLSR clients. More...

#include "ap-emlsr-manager.h"

+ Inheritance diagram for ns3::ApEmlsrManager:
+ Collaboration diagram for ns3::ApEmlsrManager:

Public Member Functions

 ApEmlsrManager ()
 
 ~ApEmlsrManager () override
 
virtual Time GetDelayOnTxPsduNotForEmlsr (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector, WifiPhyBand band)=0
 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.
 
virtual void NotifyPsduRxError (uint8_t linkId, Ptr< const WifiPsdu > psdu)
 This method is called when the reception of a PSDU fails on the given link.
 
virtual void NotifyPsduRxOk (uint8_t linkId, Ptr< const WifiPsdu > psdu)
 This method is called when the reception of a PSDU succeeds on the given link.
 
void SetWifiMac (Ptr< ApWifiMac > mac)
 Set the wifi MAC.
 
virtual bool UpdateCwAfterFailedIcf ()=0
 
- 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::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.
 
virtual void DoSetWifiMac (Ptr< ApWifiMac > mac)
 Allow subclasses to take actions when the MAC is set.
 
Ptr< ApWifiMacGetApMac () const
 
Ptr< EhtFrameExchangeManagerGetEhtFem (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

Ptr< ApWifiMacm_apMac
 the MAC of the managed AP MLD
 

Additional Inherited Members

Detailed Description

ApEmlsrManager is an abstract base class defining the API that EHT AP MLDs with EMLSR activated can use to handle the operations on the EMLSR links of EMLSR clients.

Introspection did not find any typical Config paths.


No Attributes are defined for this type.
No TraceSources are defined for this type.
Group: Wifi

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

Definition at line 30 of file ap-emlsr-manager.h.

Constructor & Destructor Documentation

◆ ApEmlsrManager()

ns3::ApEmlsrManager::ApEmlsrManager ( )

Definition at line 33 of file ap-emlsr-manager.cc.

References NS_LOG_FUNCTION.

◆ ~ApEmlsrManager()

ns3::ApEmlsrManager::~ApEmlsrManager ( )
override

Definition at line 38 of file ap-emlsr-manager.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ DoDispose()

void ns3::ApEmlsrManager::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 44 of file ap-emlsr-manager.cc.

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

+ Here is the call graph for this function:

◆ DoSetWifiMac()

void ns3::ApEmlsrManager::DoSetWifiMac ( Ptr< ApWifiMac > mac)
protectedvirtual

Allow subclasses to take actions when the MAC is set.

Parameters
macthe wifi MAC

Reimplemented in ns3::AdvancedApEmlsrManager.

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

References NS_LOG_FUNCTION.

Referenced by SetWifiMac().

+ Here is the caller graph for this function:

◆ GetApMac()

Ptr< ApWifiMac > ns3::ApEmlsrManager::GetApMac ( ) const
protected
Returns
the MAC of the AP MLD managed by this AP EMLSR Manager.

Definition at line 72 of file ap-emlsr-manager.cc.

References m_apMac.

Referenced by ns3::AdvancedApEmlsrManager::DoDispose(), ns3::AdvancedApEmlsrManager::DoSetWifiMac(), and ns3::AdvancedApEmlsrManager::NotifyPsduRxError().

+ Here is the caller graph for this function:

◆ GetDelayOnTxPsduNotForEmlsr()

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

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
psduthe PSDU being transmitted
txVectorthe TXVECTOR used to transmit the PSDU
bandthe 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

Implemented in ns3::AdvancedApEmlsrManager, and ns3::DefaultApEmlsrManager.

◆ GetEhtFem()

Ptr< EhtFrameExchangeManager > ns3::ApEmlsrManager::GetEhtFem ( uint8_t linkId) const
protected
Parameters
linkIdthe ID of the given link
Returns
the EHT FrameExchangeManager attached to the AP operating on the given link

Definition at line 78 of file ap-emlsr-manager.cc.

References m_apMac, and ns3::StaticCast().

Referenced by ns3::AdvancedApEmlsrManager::NotifyPsduRxError(), and ns3::AdvancedApEmlsrManager::ReceivedMacHdr().

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

◆ GetTypeId()

TypeId ns3::ApEmlsrManager::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

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

References ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ NotifyPsduRxError()

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

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

Parameters
linkIdthe ID of the given link
psduthe PSDU whose reception failed

Reimplemented in ns3::AdvancedApEmlsrManager.

Definition at line 90 of file ap-emlsr-manager.cc.

References NS_LOG_FUNCTION.

◆ NotifyPsduRxOk()

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

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

Parameters
linkIdthe ID of the given link
psduthe PSDU whose reception succeeded

Reimplemented in ns3::AdvancedApEmlsrManager.

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

References NS_LOG_FUNCTION.

◆ SetWifiMac()

void ns3::ApEmlsrManager::SetWifiMac ( Ptr< ApWifiMac > mac)

Set the wifi MAC.

Note that it must be the MAC of an EHT AP MLD.

Parameters
macthe wifi MAC

Definition at line 52 of file ap-emlsr-manager.cc.

References ns3::AP, DoSetWifiMac(), m_apMac, NS_ABORT_MSG_IF, NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ UpdateCwAfterFailedIcf()

virtual bool ns3::ApEmlsrManager::UpdateCwAfterFailedIcf ( )
pure virtual
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

Implemented in ns3::AdvancedApEmlsrManager, and ns3::DefaultApEmlsrManager.

Member Data Documentation

◆ m_apMac

Ptr<ApWifiMac> ns3::ApEmlsrManager::m_apMac
private

the MAC of the managed AP MLD

Definition at line 106 of file ap-emlsr-manager.h.

Referenced by DoDispose(), GetApMac(), GetEhtFem(), and SetWifiMac().


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