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

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

#include "emlsr-manager.h"

+ Inheritance diagram for ns3::EmlsrManager:
+ Collaboration diagram for ns3::EmlsrManager:

Public Member Functions

 EmlsrManager ()
 
 ~EmlsrManager () override
 
bool GetCamStateReset () const
 
const std::set< uint8_t > & GetEmlsrLinks () const
 
uint8_t GetMainPhyId () const
 
std::optional< TimeGetTransitionTimeout () 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< 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::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.
 
const WifiPhyOperatingChannelGetChannelForAuxPhy (uint8_t linkId) const
 
const WifiPhyOperatingChannelGetChannelForMainPhy (uint8_t linkId) const
 
Ptr< EhtFrameExchangeManagerGetEhtFem (uint8_t linkId) const
 
MgtEmlOmn GetEmlOmn ()
 
virtual uint8_t GetLinkToSendEmlOmn ()=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.
 

Protected Attributes

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)
 

Private Member Functions

void ApplyMaxChannelWidthOnAuxPhys ()
 Adjust the operating channel of all the aux PHYs to meet the constraint on the maximum channel width supported by aux PHYs.
 
void ChangeEmlsrMode ()
 This method is called to make an EMLSR mode change effective after the transition delay has elapsed or a notification response has been received from the AP.
 
void ComputeOperatingChannels ()
 Compute the operating channels that the main PHY and the aux PHY(s) must switch to in order to operate on each of the setup links.
 
virtual void DoNotifyMgtFrameReceived (Ptr< const WifiMpdu > mpdu, uint8_t linkId)=0
 Notify the subclass of the reception of a management frame addressed to us.
 
virtual void NotifyEmlsrModeChanged ()=0
 Notify subclass that EMLSR mode changed.
 
virtual void NotifyMainPhySwitch (uint8_t currLinkId, uint8_t nextLinkId)=0
 Notify subclass that the main PHY is switching channel to operate on another link.
 
void SendEmlOmn ()
 Send an EML Operating Mode Notification frame.
 
void SwitchMainPhy (uint8_t linkId, bool noSwitchDelay)
 Switch channel on the Main PHY so that it operates on the given link.
 
void TxDropped (WifiMacDropReason reason, Ptr< const WifiMpdu > mpdu)
 Notify that the given MPDU has been discarded for the given reason.
 
void TxOk (Ptr< const WifiMpdu > mpdu)
 Notify the acknowledgment of the given MPDU.
 

Private Attributes

std::map< uint8_t, WifiPhyOperatingChannelm_auxPhyChannels
 link ID-indexed map of operating channels for the aux PHYs
 
std::set< uint8_t > m_emlsrLinks
 ID of the EMLSR links (empty if EMLSR mode is disabled)
 
std::optional< Timem_emlsrTransitionTimeout
 Transition timeout advertised by APs with EMLSR activated.
 
Time m_lastAdvPaddingDelay
 last advertised padding delay
 
Time m_lastAdvTransitionDelay
 last advertised transition delay
 
std::map< uint8_t, WifiPhyOperatingChannelm_mainPhyChannels
 link ID-indexed map of operating channels for the main PHY
 
std::optional< std::set< uint8_t > > m_nextEmlsrLinks
 ID of the links that will become the EMLSR links when the pending notification frame is acknowledged.
 
bool m_resetCamState
 whether to reset the state of CAM when main PHY switches channel
 
Ptr< StaWifiMacm_staMac
 the MAC of the managed non-AP MLD
 
EventId m_transitionTimeoutEvent
 Timer started after the successful transmission of an EML Operating Mode Notification frame.
 

Additional Inherited Members

Detailed Description

EmlsrManager is an abstract base class defining the API that EHT non-AP MLDs with EMLSR activated can use to handle the operations on the EMLSR links.

Introspection did not find any typical Config paths.


Attributes

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

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

Definition at line 46 of file emlsr-manager.h.

Constructor & Destructor Documentation

◆ EmlsrManager()

ns3::EmlsrManager::EmlsrManager ( )

Definition at line 88 of file emlsr-manager.cc.

References NS_LOG_FUNCTION.

◆ ~EmlsrManager()

ns3::EmlsrManager::~EmlsrManager ( )
override

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ ApplyMaxChannelWidthOnAuxPhys()

void ns3::EmlsrManager::ApplyMaxChannelWidthOnAuxPhys ( )
private

Adjust the operating channel of all the aux PHYs to meet the constraint on the maximum channel width supported by aux PHYs.

Definition at line 544 of file emlsr-manager.cc.

References ns3::WifiMac::GetChannelAccessManager(), GetChannelForAuxPhy(), ns3::WifiMac::GetLinkForPhy(), ns3::WifiMac::GetLinkIds(), ns3::WifiMac::GetWifiPhy(), ns3::StaWifiMac::IsEmlsrLink(), m_mainPhyId, m_staMac, ns3::ChannelAccessManager::NotifySwitchingEmlsrLink(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), and ns3::WifiPhy::SetOperatingChannel().

Referenced by ChangeEmlsrMode().

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

◆ ChangeEmlsrMode()

void ns3::EmlsrManager::ChangeEmlsrMode ( )
private

This method is called to make an EMLSR mode change effective after the transition delay has elapsed or a notification response has been received from the AP.

Definition at line 519 of file emlsr-manager.cc.

References ApplyMaxChannelWidthOnAuxPhys(), m_emlsrLinks, m_nextEmlsrLinks, m_staMac, NotifyEmlsrModeChanged(), ns3::StaWifiMac::NotifyEmlsrModeChanged(), NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by TxOk().

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

◆ ComputeOperatingChannels()

void ns3::EmlsrManager::ComputeOperatingChannels ( )
private

Compute the operating channels that the main PHY and the aux PHY(s) must switch to in order to operate on each of the setup links.

The operating channels may be different due to limited channel width capabilities of the aux PHY(s). This method shall be called upon completion of ML setup.

Definition at line 578 of file emlsr-manager.cc.

References ns3::WifiPhyOperatingChannel::FindFirst(), ns3::WifiPhy::GetOperatingChannel(), ns3::StaWifiMac::GetSetupLinkIds(), ns3::WifiMac::GetWifiPhy(), m_auxPhyChannels, m_auxPhyMaxWidth, ns3::WifiPhyOperatingChannel::m_frequencyChannels, m_mainPhyChannels, m_staMac, NS_ASSERT_MSG, NS_LOG_FUNCTION, and ns3::WIFI_STANDARD_UNSPECIFIED.

Referenced by NotifyMgtFrameReceived().

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

◆ DoDispose()

void ns3::EmlsrManager::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 99 of file emlsr-manager.cc.

References ns3::EventId::Cancel(), ns3::Object::DoDispose(), m_staMac, m_transitionTimeoutEvent, ns3::MakeCallback(), NS_LOG_FUNCTION, ns3::ObjectBase::TraceDisconnectWithoutContext(), TxDropped(), and TxOk().

+ Here is the call graph for this function:

◆ DoNotifyMgtFrameReceived()

virtual void ns3::EmlsrManager::DoNotifyMgtFrameReceived ( Ptr< const WifiMpdu mpdu,
uint8_t  linkId 
)
privatepure virtual

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

Implemented in ns3::DefaultEmlsrManager.

Referenced by NotifyMgtFrameReceived().

+ Here is the caller graph for this function:

◆ GetCamStateReset()

bool ns3::EmlsrManager::GetCamStateReset ( ) const
Returns
the value of 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.

Definition at line 148 of file emlsr-manager.cc.

References m_resetCamState.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetChannelForAuxPhy()

const WifiPhyOperatingChannel & ns3::EmlsrManager::GetChannelForAuxPhy ( uint8_t  linkId) const
protected
Parameters
linkIdthe ID of the given link
Returns
the operating channel an aux PHY must switch to in order to operate on the given link

Definition at line 630 of file emlsr-manager.cc.

References m_auxPhyChannels, and NS_ASSERT_MSG.

Referenced by ApplyMaxChannelWidthOnAuxPhys(), and ns3::DefaultEmlsrManager::NotifyMainPhySwitch().

+ Here is the caller graph for this function:

◆ GetChannelForMainPhy()

const WifiPhyOperatingChannel & ns3::EmlsrManager::GetChannelForMainPhy ( uint8_t  linkId) const
protected
Parameters
linkIdthe ID of the given link
Returns
the operating channel the main PHY must switch to in order to operate on the given link

Definition at line 621 of file emlsr-manager.cc.

References m_mainPhyChannels, and NS_ASSERT_MSG.

Referenced by SwitchMainPhy().

+ Here is the caller graph for this function:

◆ GetEhtFem()

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

Definition at line 166 of file emlsr-manager.cc.

References ns3::WifiMac::GetFrameExchangeManager(), and m_staMac.

Referenced by SendEmlOmn(), and TxDropped().

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

◆ GetEmlOmn()

◆ GetEmlsrLinks()

const std::set< uint8_t > & ns3::EmlsrManager::GetEmlsrLinks ( ) const
Returns
the set of links on which EMLSR mode is enabled

Definition at line 154 of file emlsr-manager.cc.

References m_emlsrLinks.

◆ GetLinkToSendEmlOmn()

virtual uint8_t ns3::EmlsrManager::GetLinkToSendEmlOmn ( )
protectedpure virtual
Returns
the ID of the link on which the EML Operating Mode Notification frame has to be sent

Implemented in ns3::DefaultEmlsrManager.

Referenced by SendEmlOmn().

+ Here is the caller graph for this function:

◆ GetMainPhyId()

uint8_t ns3::EmlsrManager::GetMainPhyId ( ) const
Returns
the ID of main PHY (position in the vector of PHYs held by WifiNetDevice)

Definition at line 136 of file emlsr-manager.cc.

References m_mainPhyId.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ GetStaMac()

Ptr< StaWifiMac > ns3::EmlsrManager::GetStaMac ( ) const
protected
Returns
the MAC of the non-AP MLD managed by this EMLSR Manager.

Definition at line 160 of file emlsr-manager.cc.

References m_staMac.

Referenced by ns3::DefaultEmlsrManager::GetLinkToSendEmlOmn(), ns3::DefaultEmlsrManager::NotifyMainPhySwitch(), NotifyMgtFrameReceived(), ns3::DefaultEmlsrManager::ResendNotification(), and SetEmlsrLinks().

+ Here is the caller graph for this function:

◆ GetTransitionTimeout()

std::optional< Time > ns3::EmlsrManager::GetTransitionTimeout ( ) const
Returns
the Transition Timeout, if advertised by the associated AP

Definition at line 179 of file emlsr-manager.cc.

References m_emlsrTransitionTimeout.

Referenced by NotifyMgtFrameReceived(), and SetEmlsrLinks().

+ Here is the caller graph for this function:

◆ GetTypeId()

◆ NotifyEmlsrModeChanged()

virtual void ns3::EmlsrManager::NotifyEmlsrModeChanged ( )
privatepure virtual

Notify subclass that EMLSR mode changed.

Implemented in ns3::DefaultEmlsrManager.

Referenced by ChangeEmlsrMode().

+ Here is the caller graph for this function:

◆ NotifyIcfReceived()

void ns3::EmlsrManager::NotifyIcfReceived ( uint8_t  linkId)

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

Parameters
linkIdthe ID of the link on which the initial Control frame was received

Definition at line 243 of file emlsr-manager.cc.

References ns3::StaWifiMac::BlockTxOnLink(), ns3::WifiMac::GetChannelAccessManager(), ns3::WifiMac::GetDevice(), ns3::WifiMac::GetLinkIds(), ns3::WifiNetDevice::GetPhy(), ns3::WifiMac::GetWifiPhy(), ns3::StaWifiMac::IsEmlsrLink(), m_mainPhyId, m_staMac, ns3::ChannelAccessManager::NotifyStartUsingOtherEmlsrLink(), NS_ASSERT, NS_LOG_FUNCTION, SwitchMainPhy(), and ns3::USING_OTHER_EMLSR_LINK.

+ Here is the call graph for this function:

◆ NotifyMainPhySwitch()

virtual void ns3::EmlsrManager::NotifyMainPhySwitch ( uint8_t  currLinkId,
uint8_t  nextLinkId 
)
privatepure virtual

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

Parameters
currLinkIdthe ID of the link on which the main PHY is operating
nextLinkIdthe ID of the link on which the main PHY will be operating

Implemented in ns3::DefaultEmlsrManager.

Referenced by SwitchMainPhy().

+ Here is the caller graph for this function:

◆ NotifyMgtFrameReceived()

void ns3::EmlsrManager::NotifyMgtFrameReceived ( Ptr< const WifiMpdu mpdu,
uint8_t  linkId 
)

◆ NotifyTxopEnd()

void ns3::EmlsrManager::NotifyTxopEnd ( uint8_t  linkId)

Notify the end of a TXOP on the given link.

Parameters
linkIdthe ID of the given link

Definition at line 315 of file emlsr-manager.cc.

References ns3::WifiMac::GetChannelAccessManager(), ns3::WifiMac::GetLinkIds(), ns3::StaWifiMac::IsEmlsrLink(), m_staMac, ns3::ChannelAccessManager::NotifyStopUsingOtherEmlsrLink(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::StaWifiMac::UnblockTxOnLink(), and ns3::USING_OTHER_EMLSR_LINK.

+ Here is the call graph for this function:

◆ NotifyUlTxopStart()

◆ ResendNotification()

virtual std::optional< uint8_t > ns3::EmlsrManager::ResendNotification ( Ptr< const WifiMpdu mpdu)
protectedpure virtual

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

Implemented in ns3::DefaultEmlsrManager.

Referenced by TxDropped().

+ Here is the caller graph for this function:

◆ SendEmlOmn()

void ns3::EmlsrManager::SendEmlOmn ( )
private

Send an EML Operating Mode Notification frame.

Definition at line 429 of file emlsr-manager.cc.

References ns3::WifiMac::GetBssid(), GetEhtFem(), GetEmlOmn(), GetLinkToSendEmlOmn(), m_emlsrTransitionTimeout, m_nextEmlsrLinks, m_staMac, NS_ABORT_MSG_IF, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by NotifyMgtFrameReceived(), and SetEmlsrLinks().

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

◆ SetCamStateReset()

void ns3::EmlsrManager::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.

Parameters
enablewhether the CAM state should be reset

Definition at line 142 of file emlsr-manager.cc.

References m_resetCamState.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetEmlsrLinks()

void ns3::EmlsrManager::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.

Parameters
linkIdsthe IDs of the links on which EMLSR mode should be enabled (empty to disable EMLSR mode)

Definition at line 185 of file emlsr-manager.cc.

References GetStaMac(), GetTransitionTimeout(), m_emlsrLinks, m_nextEmlsrLinks, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, and SendEmlOmn().

Referenced by GetTypeId().

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

◆ SetMainPhyId()

void ns3::EmlsrManager::SetMainPhyId ( uint8_t  mainPhyId)

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

This method cannot be called during or after initialization.

Parameters
mainPhyIdthe ID of the main PHY

Definition at line 128 of file emlsr-manager.cc.

References ns3::Object::IsInitialized(), m_mainPhyId, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

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

◆ SetTransitionTimeout()

void ns3::EmlsrManager::SetTransitionTimeout ( Time  timeout)

Set the Transition Timeout advertised by the associated AP with EMLSR activated.

Parameters
timeoutthe advertised Transition Timeout

Definition at line 172 of file emlsr-manager.cc.

References ns3::Time::As(), m_emlsrTransitionTimeout, NS_LOG_FUNCTION, timeout, and ns3::Time::US.

+ Here is the call graph for this function:

◆ SetWifiMac()

void ns3::EmlsrManager::SetWifiMac ( Ptr< StaWifiMac mac)

Set the wifi MAC.

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

Parameters
macthe wifi MAC

Definition at line 111 of file emlsr-manager.cc.

References ns3::WifiMac::GetEhtConfiguration(), ns3::WifiMac::GetNLinks(), ns3::WifiMac::GetTypeOfStation(), m_staMac, ns3::MakeCallback(), NS_ABORT_MSG_IF, NS_ASSERT, NS_LOG_FUNCTION, ns3::STA, ns3::ObjectBase::TraceConnectWithoutContext(), TxDropped(), and TxOk().

+ Here is the call graph for this function:

◆ SwitchMainPhy()

void ns3::EmlsrManager::SwitchMainPhy ( uint8_t  linkId,
bool  noSwitchDelay 
)
private

Switch channel on the Main PHY so that it operates on the given link.

Parameters
linkIdthe ID of the link on which the main PHY has to operate
noSwitchDelaywhether switching delay should be zero

Definition at line 337 of file emlsr-manager.cc.

References ns3::Time::As(), ns3::WifiMac::GetChannelAccessManager(), GetChannelForMainPhy(), ns3::WifiMac::GetDevice(), ns3::WifiMac::GetLinkForPhy(), ns3::WifiNetDevice::GetPhy(), ns3::WifiMac::GetWifiPhy(), m_lastAdvTransitionDelay, m_mainPhyId, m_staMac, NotifyMainPhySwitch(), ns3::ChannelAccessManager::NotifySwitchingEmlsrLink(), NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), ns3::Seconds(), and ns3::Time::US.

Referenced by NotifyIcfReceived(), and NotifyUlTxopStart().

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

◆ TxDropped()

void ns3::EmlsrManager::TxDropped ( WifiMacDropReason  reason,
Ptr< const WifiMpdu mpdu 
)
private

Notify that the given MPDU has been discarded for the given reason.

Parameters
reasonthe reason why the MPDU was dropped
mpduthe dropped MPDU

Definition at line 487 of file emlsr-manager.cc.

References ns3::WifiMac::GetBssid(), GetEhtFem(), m_nextEmlsrLinks, m_staMac, NS_LOG_FUNCTION, ns3::WifiActionHeader::PROTECTED_EHT, ns3::WifiActionHeader::PROTECTED_EHT_EML_OPERATING_MODE_NOTIFICATION, ns3::WifiActionHeader::Remove(), and ResendNotification().

Referenced by DoDispose(), and SetWifiMac().

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

◆ TxOk()

void ns3::EmlsrManager::TxOk ( Ptr< const WifiMpdu mpdu)
private

Notify the acknowledgment of the given MPDU.

Parameters
mpduthe acknowledged MPDU

Definition at line 452 of file emlsr-manager.cc.

References ChangeEmlsrMode(), m_emlsrTransitionTimeout, m_lastAdvPaddingDelay, m_lastAdvTransitionDelay, m_transitionTimeoutEvent, NS_ASSERT_MSG, NS_LOG_FUNCTION, ns3::WifiActionHeader::Peek(), ns3::WifiActionHeader::PROTECTED_EHT, ns3::WifiActionHeader::PROTECTED_EHT_EML_OPERATING_MODE_NOTIFICATION, and ns3::Simulator::Schedule().

Referenced by DoDispose(), and SetWifiMac().

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

Member Data Documentation

◆ m_auxPhyChannels

std::map<uint8_t, WifiPhyOperatingChannel> ns3::EmlsrManager::m_auxPhyChannels
private

link ID-indexed map of operating channels for the aux PHYs

Definition at line 283 of file emlsr-manager.h.

Referenced by ComputeOperatingChannels(), and GetChannelForAuxPhy().

◆ m_auxPhyMaxWidth

uint16_t ns3::EmlsrManager::m_auxPhyMaxWidth
protected

max channel width (MHz) supported by aux PHYs

Definition at line 196 of file emlsr-manager.h.

Referenced by ComputeOperatingChannels(), and GetTypeId().

◆ m_emlsrLinks

std::set<uint8_t> ns3::EmlsrManager::m_emlsrLinks
private

ID of the EMLSR links (empty if EMLSR mode is disabled)

Definition at line 271 of file emlsr-manager.h.

Referenced by ChangeEmlsrMode(), GetEmlsrLinks(), and SetEmlsrLinks().

◆ m_emlsrPaddingDelay

Time ns3::EmlsrManager::m_emlsrPaddingDelay
protected

EMLSR Padding delay.

Definition at line 193 of file emlsr-manager.h.

Referenced by GetEmlOmn(), and GetTypeId().

◆ m_emlsrTransitionDelay

Time ns3::EmlsrManager::m_emlsrTransitionDelay
protected

EMLSR Transition delay.

Definition at line 194 of file emlsr-manager.h.

Referenced by GetEmlOmn(), and GetTypeId().

◆ m_emlsrTransitionTimeout

std::optional<Time> ns3::EmlsrManager::m_emlsrTransitionTimeout
private

Transition timeout advertised by APs with EMLSR activated.

Definition at line 269 of file emlsr-manager.h.

Referenced by GetTransitionTimeout(), SendEmlOmn(), SetTransitionTimeout(), and TxOk().

◆ m_lastAdvPaddingDelay

Time ns3::EmlsrManager::m_lastAdvPaddingDelay
private

last advertised padding delay

Definition at line 275 of file emlsr-manager.h.

Referenced by GetEmlOmn(), and TxOk().

◆ m_lastAdvTransitionDelay

Time ns3::EmlsrManager::m_lastAdvTransitionDelay
private

last advertised transition delay

Definition at line 276 of file emlsr-manager.h.

Referenced by GetEmlOmn(), SwitchMainPhy(), and TxOk().

◆ m_mainPhyChannels

std::map<uint8_t, WifiPhyOperatingChannel> ns3::EmlsrManager::m_mainPhyChannels
private

link ID-indexed map of operating channels for the main PHY

Definition at line 281 of file emlsr-manager.h.

Referenced by ComputeOperatingChannels(), and GetChannelForMainPhy().

◆ m_mainPhyId

uint8_t ns3::EmlsrManager::m_mainPhyId
protected

◆ m_nextEmlsrLinks

std::optional<std::set<uint8_t> > ns3::EmlsrManager::m_nextEmlsrLinks
private

ID of the links that will become the EMLSR links when the pending notification frame is acknowledged.

Definition at line 272 of file emlsr-manager.h.

Referenced by ChangeEmlsrMode(), GetEmlOmn(), NotifyMgtFrameReceived(), SendEmlOmn(), SetEmlsrLinks(), and TxDropped().

◆ m_resetCamState

bool ns3::EmlsrManager::m_resetCamState
private

whether to reset the state of CAM when main PHY switches channel

Definition at line 279 of file emlsr-manager.h.

Referenced by GetCamStateReset(), and SetCamStateReset().

◆ m_staMac

◆ m_transitionTimeoutEvent

EventId ns3::EmlsrManager::m_transitionTimeoutEvent
private

Timer started after the successful transmission of an EML Operating Mode Notification frame.

Definition at line 277 of file emlsr-manager.h.

Referenced by DoDispose(), NotifyMgtFrameReceived(), and TxOk().


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