A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::DefaultEmlsrManager Class Reference

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
 
const std::set< uint8_t > & GetEmlsrLinks () const
 
std::optional< TimeGetTransitionTimeout () const
 
void NotifyMgtFrameReceived (Ptr< const WifiMpdu > mpdu, uint8_t linkId)
 Notify the reception of a management frame addressed to us.
 
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 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< 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.
 
- 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) 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 GetLinkToSendEmlNotification () 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.
 
Ptr< EhtFrameExchangeManagerGetEhtFem (uint8_t linkId) const
 
virtual uint8_t GetLinkToSendEmlNotification ()=0
 
Ptr< StaWifiMacGetStaMac () 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.
 

Private Attributes

std::optional< uint8_t > m_assocLinkId
 ID of the link on which Association Response was received.
 

Additional Inherited Members

- Protected Attributes inherited from ns3::EmlsrManager
Time m_emlsrPaddingDelay
 EMLSR Padding delay.
 
Time m_emlsrTransitionDelay
 EMLSR Transition delay.
 

Detailed Description

DefaultEmlsrManager is the default EMLSR manager.

Introspection did not find any typical Config paths.


No Attributes are defined for this type.

Attributes defined in parent class ns3::EmlsrManager

  • EmlsrLinkSet: IDs of the links on which EMLSR mode will be enabled. An empty set indicates to disable EMLSR.
  • 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

No TraceSources are defined for this type.
Size of this type is 224 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ DefaultEmlsrManager()

ns3::DefaultEmlsrManager::DefaultEmlsrManager ( )

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

References NS_LOG_FUNCTION.

◆ ~DefaultEmlsrManager()

ns3::DefaultEmlsrManager::~DefaultEmlsrManager ( )
override

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ 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
mpduthe received MPDU
linkIdthe ID of the link over which the MPDU was received

Implements ns3::EmlsrManager.

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

References ns3::EmlsrManager::GetStaMac(), ns3::EmlsrManager::GetTransitionTimeout(), m_assocLinkId, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ GetLinkToSendEmlNotification()

uint8_t ns3::DefaultEmlsrManager::GetLinkToSendEmlNotification ( )
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 64 of file default-emlsr-manager.cc.

References m_assocLinkId, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

◆ GetTypeId()

TypeId ns3::DefaultEmlsrManager::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

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

References 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 80 of file default-emlsr-manager.cc.

References NS_LOG_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
mpduthe 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 72 of file default-emlsr-manager.cc.

References m_assocLinkId, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Member Data Documentation

◆ m_assocLinkId

std::optional<uint8_t> ns3::DefaultEmlsrManager::m_assocLinkId
private

ID of the link on which Association Response was received.

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

Referenced by DoNotifyMgtFrameReceived(), GetLinkToSendEmlNotification(), and ResendNotification().


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