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:

Classes

struct  MainPhySwitchInfo
 Store information about a main PHY switch. More...
 
struct  MediumSyncDelayStatus
 Information about the status of the MediumSyncDelay timer associated with a link. More...
 

Public Member Functions

 EmlsrManager ()
 
 ~EmlsrManager () override
 
void CancelMediumSyncDelayTimer (uint8_t linkId)
 Cancel the MediumSyncDelay timer associated with the given link and take the appropriate actions.
 
std::pair< bool, TimeCheckPossiblyReceivingIcf (uint8_t linkId) const
 Check whether a PPDU that may be an ICF is being received on the given link.
 
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::pair< bool, TimeGetDelayUntilAccessRequest (uint8_t linkId, AcIndex aci)
 Notify that an UL TXOP is gained on the given link by the given AC.
 
std::optional< TimeGetElapsedMediumSyncDelayTimer (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
 
bool GetInDeviceInterference () const
 
uint8_t GetMainPhyId () const
 
Time GetMediumSyncDuration () const
 
std::optional< uint8_t > GetMediumSyncMaxNTxops () const
 
int8_t GetMediumSyncOfdmEdThreshold () const
 
std::optional< TimeGetTransitionTimeout () 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.
 
virtual void NotifyInDeviceInterferenceStart (uint8_t linkId, Time duration)
 Notify that an STA affiliated with the EMLSR client is causing in-device interference for the given amount of time.
 
void NotifyMgtFrameReceived (Ptr< const WifiMpdu > mpdu, uint8_t linkId)
 Notify the reception of a management frame addressed to us.
 
void NotifyProtectionCompleted (uint8_t linkId)
 Notify that protection (if required) is completed and data frame exchange can start on the given link.
 
virtual void NotifyRtsSent (uint8_t linkId, Ptr< const WifiPsdu > rts, const WifiTxVector &txVector)
 Notify that RTS transmission is starting on the given link.
 
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)
 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 SetInDeviceInterference (bool enable)
 Set the member variable indicating whether in-device interference is such that a PHY cannot decode anything and cannot decrease the backoff counter when another PHY is transmitting.
 
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 final
 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.
 

Static Public Attributes

static constexpr uint16_t MEDIUM_SYNC_THRESHOLD_USEC = 72
 The aMediumSyncThreshold defined by Sec. 35.3.16.18.1 of 802.11be D4.0.
 

Protected Member Functions

void CancelAllSleepEvents ()
 Cancel all pending events to put aux PHYs into sleep/awake state.
 
void DoDispose () override
 Destructor implementation.
 
virtual std::pair< bool, TimeDoGetDelayUntilAccessRequest (uint8_t linkId)=0
 Subclasses have to provide an implementation for this method, that is called by the base class when the EMLSR client gets channel access on the given link.
 
virtual void DoSetWifiMac (Ptr< StaWifiMac > mac)
 Allow subclasses to take actions when the MAC is set.
 
virtual void EmlsrLinkSwitchCallback (uint8_t linkId, Ptr< WifiPhy > phy)
 Callback connected to the EmlsrLinkSwitch trace source of StaWifiMac.
 
const WifiPhyOperatingChannelGetChannelForAuxPhy (uint8_t linkId) const
 
const WifiPhyOperatingChannelGetChannelForMainPhy (uint8_t linkId) const
 
virtual std::pair< bool, TimeGetDelayUnlessMainPhyTakesOverUlTxop (uint8_t linkId)=0
 Subclasses have to provide an implementation for this method, that is called by the base class when the EMLSR client gets channel access on the given link, on which an aux PHY that is TX capable is operating.
 
Ptr< EhtFrameExchangeManagerGetEhtFem (uint8_t linkId) const
 
MgtEmlOmn GetEmlOmn ()
 
bool GetExpectedAccessWithinDelay (uint8_t linkId, const Time &delay) const
 Get whether channel access is expected to be granted on the given link within the given delay to an Access Category that has traffic to send on the given link.
 
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.
 
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 SetSleepStateForAllAuxPhys (bool sleep)
 Set sleep state or awake state for all aux PHYs.
 
void SwitchAuxPhy (Ptr< WifiPhy > auxPhy, 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, EmlsrMainPhySwitchTrace &&traceInfo)
 Switch channel on the Main PHY so that it operates on the given link.
 
virtual void SwitchMainPhyIfTxopGainedByAuxPhy (uint8_t linkId, AcIndex aci)=0
 Subclasses have to provide an implementation for this method, that is called by the base class when the given AC of the EMLSR client gets channel access on the given link, on which an aux PHY that is not TX capable is operating.
 
- 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.
 

Protected Attributes

WifiModulationClass m_auxPhyMaxModClass
 max modulation class supported by aux PHYs
 
MHz_u m_auxPhyMaxWidth
 max channel width supported by aux PHYs
 
bool m_auxPhyToSleep
 whether Aux PHYs should be put into sleep mode while the Main PHY is carrying out a (DL or UL) TXOP
 
std::map< uint8_t, EventIdm_auxPhyToSleepEvents
 PHY ID-indexed map of events scheduled to put an Aux PHY to sleep.
 
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)
 
MainPhySwitchInfo m_mainPhySwitchInfo
 main PHY switch info
 
std::map< uint8_t, Timem_startSleep
 PHY ID-indexed map of last time sleep mode started.
 
std::map< uint8_t, EventIdm_ulMainPhySwitch
 link ID-indexed map of timers started when an aux PHY gains an UL TXOP and schedules a channel switch for the main PHY
 
bool m_useNotifiedMacHdr
 whether to use the information about the MAC header of the MPDU being received (if notified by the PHY)
 

Static Protected Attributes

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
 

Private Types

typedef void(* MainPhySwitchCallback) (const EmlsrMainPhySwitchTrace &info)
 TracedCallback signature for main PHY switch events.
 
using MainPhySwitchTracedCallback = TracedCallback<const EmlsrMainPhySwitchTrace&>
 TracedCallback for main PHY switch events typedef.
 

Private Member Functions

void ApplyMaxChannelWidthAndModClassOnAuxPhys ()
 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 DoNotifyIcfReceived (uint8_t linkId)=0
 Notify the subclass of the reception of an initial Control frame on the given link.
 
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 DoNotifyTxopEnd (uint8_t linkId)=0
 Notify the subclass of the end of a TXOP on the given link.
 
virtual void DoNotifyUlTxopStart (uint8_t linkId)=0
 Notify the subclass of the start of an UL TXOP on the given link.
 
void MediumSyncDelayTimerExpired (uint8_t linkId)
 Take the appropriate actions when the MediumSyncDelay timer expires or is cancelled.
 
virtual void NotifyEmlsrModeChanged ()=0
 Notify subclass that EMLSR mode changed.
 
virtual void NotifyMainPhySwitch (std::optional< uint8_t > currLinkId, uint8_t nextLinkId, Ptr< WifiPhy > auxPhy, Time duration)=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 SetMainPhyId (uint8_t mainPhyId)
 Set the ID of main PHY (position in the vector of PHYs held by WifiNetDevice).
 
void StartMediumSyncDelayTimer (uint8_t linkId)
 Start the MediumSyncDelay timer and take the appropriate actions.
 
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.
 
bool m_inDeviceInterference
 whether in-device interference is such that a PHY cannot decode anything and cannot decrease the backoff counter when another PHY is transmitting
 
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
 
MainPhySwitchTracedCallback m_mainPhySwitchTrace
 main PHY switch trace source
 
std::map< uint8_t, MediumSyncDelayStatusm_mediumSyncDelayStatus
 the status of MediumSyncDelay timers (link ID-indexed)
 
Time m_mediumSyncDuration
 duration of the MediumSyncDelay timer
 
std::optional< uint8_t > m_msdMaxNTxops
 MediumSyncDelay max number of TXOPs.
 
int8_t m_msdOfdmEdThreshold
 MediumSyncDelay OFDM ED threshold.
 
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.
 
std::map< uint8_t, Timem_noPhySince
 link ID-indexed map of the time since no PHY is operating on the link
 
std::map< Ptr< WifiPhy >, dBm_um_prevCcaEdThreshold
 the CCA sensitivity threshold to restore once the MediumSyncDelay timer expires or the PHY moves to a link on which the timer is not running
 
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.
 

Friends

class ::EmlsrCcaBusyTest
 Allow test cases to access private members.
 

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. Note that the maximum channel width is capped to the maximum channel width supported by the configured maximum modulation class supported.
    • Set with class: ns3::UintegerValue
    • Underlying type: double 20:160
    • Initial value: 20
    • Flags: constructread
    • Support level: SUPPORTED
  • AuxPhyMaxModClass: The maximum modulation class supported by Aux PHYs. Use WIFI_MOD_CLASS_OFDM for non-HT.
  • AuxPhyTxCapable: Whether Aux PHYs are capable of transmitting PPDUs.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • 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
    • Support level: SUPPORTED
  • 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
    • Support level: SUPPORTED
  • InDeviceInterference: Whether in-device interference is such that a PHY cannot decode anything and cannot decrease the backoff counter when another PHY of the same device is transmitting.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • MainPhyId: The ID of the main PHY (position in the vector of PHYs held by WifiNetDevice). This attribute cannot be set after construction.
    • Set with class: ns3::UintegerValue
    • Underlying type: uint8_t 0:255
    • Initial value: 0
    • Flags: constructread
    • Support level: SUPPORTED
  • PutAuxPhyToSleep: Whether Aux PHYs should be put into sleep mode while the Main PHY is carrying out a (DL or UL) TXOP. Specifically, for DL TXOPs, aux PHYs are put to sleep after receiving the ICF; for UL TXOPs, aux PHYs are put to sleep when the CTS frame is received, if RTS/CTS is used, or when the transmission of the data frame starts, otherwise. Aux PHYs are resumed from sleep when the TXOP ends.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • 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
    • Support level: SUPPORTED
  • UseNotifiedMacHdr: Whether to use the information about the MAC header of the MPDU being received, if notified by the PHY.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
    • Support level: SUPPORTED

TraceSources

  • MainPhySwitch: This trace source is fired when the main PHY switches channel to operate on another link. Information associated with the main PHY switch is provided through a struct that is inherited from struct EmlsrMainPhySwitchTrace (use the GetName() method to get the type of the provided object).

Group: Wifi

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

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

Member Typedef Documentation

◆ MainPhySwitchCallback

typedef void(* ns3::EmlsrManager::MainPhySwitchCallback) (const EmlsrMainPhySwitchTrace &info)
private

TracedCallback signature for main PHY switch events.

Parameters
infothe information associated with the main PHY switch event

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

◆ MainPhySwitchTracedCallback

TracedCallback for main PHY switch events typedef.

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

Constructor & Destructor Documentation

◆ EmlsrManager()

ns3::EmlsrManager::EmlsrManager ( )

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

References NS_LOG_FUNCTION.

◆ ~EmlsrManager()

ns3::EmlsrManager::~EmlsrManager ( )
override

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ ApplyMaxChannelWidthAndModClassOnAuxPhys()

void ns3::EmlsrManager::ApplyMaxChannelWidthAndModClassOnAuxPhys ( )
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 1242 of file emlsr-manager.cc.

References NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::wifiAcList.

◆ CancelAllSleepEvents()

void ns3::EmlsrManager::CancelAllSleepEvents ( )
protected

Cancel all pending events to put aux PHYs into sleep/awake state.

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

References NS_LOG_FUNCTION.

◆ CancelMediumSyncDelayTimer()

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

Cancel the MediumSyncDelay timer associated with the given link and take the appropriate actions.

This function must not be called when the MediumSyncDelay timer is not running on the given link.

Parameters
linkIdthe ID of the link associated with the MediumSyncDelay timer to cancel

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

References NS_ASSERT, and NS_LOG_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 1217 of file emlsr-manager.cc.

References NS_ASSERT_MSG, and NS_LOG_FUNCTION.

◆ CheckPossiblyReceivingIcf()

std::pair< bool, Time > ns3::EmlsrManager::CheckPossiblyReceivingIcf ( uint8_t linkId) const

Check whether a PPDU that may be an ICF is being received on the given link.

If so, return true along with the time to wait to know more information about the PPDU being received. Otherwise, return false.

Parameters
linkIdthe ID of the given link
Returns
a pair indicating whether a PPDU that may be an ICF is being received on the link

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

References ns3::EMLSR_RX_PHY_START_DELAY, GetEhtFem(), GetMainPhyId(), GetStaMac(), m_useNotifiedMacHdr, ns3::Simulator::Now(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::SU_STA_ID, ns3::Time::US, and ns3::WIFI_MOD_CLASS_HT.

Referenced by ns3::AdvancedEmlsrManager::DoGetDelayUntilAccessRequest(), ns3::DefaultEmlsrManager::SwitchAuxPhyAfterMainPhy(), and ns3::AdvancedEmlsrManager::SwitchMainPhyBackDelayExpired().

+ 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 1294 of file emlsr-manager.cc.

References ns3::GetMaximumChannelWidth(), 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:

◆ DecrementMediumSyncDelayNTxops()

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

Decrement the counter indicating the number of TXOP attempts left while the MediumSyncDelay timer is running.

This function must not be called when the MediumSyncDelay timer is not running on the given link.

Parameters
linkIdthe ID of the link on which a new TXOP attempt may be carried out

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

References NS_ASSERT, and NS_LOG_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 164 of file emlsr-manager.cc.

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

+ Here is the call graph for this function:

◆ DoGetDelayUntilAccessRequest()

virtual std::pair< bool, Time > ns3::EmlsrManager::DoGetDelayUntilAccessRequest ( uint8_t linkId)
protectedpure virtual

Subclasses have to provide an implementation for this method, that is called by the base class when the EMLSR client gets channel access on the given link.

This method has to check possible reasons to give up the TXOP that apply to both main PHY and aux PHYs.

Parameters
linkIdthe ID of the given link
Returns
a pair consisting of a boolean value indicating whether the UL TXOP can be started and a Time value indicating the delay after which the EMLSR client must restart channel access (if needed) in case the UL TXOP is not started

Implemented in ns3::AdvancedEmlsrManager, and ns3::DefaultEmlsrManager.

Referenced by GetDelayUntilAccessRequest().

+ Here is the caller graph for this function:

◆ DoNotifyIcfReceived()

virtual void ns3::EmlsrManager::DoNotifyIcfReceived ( uint8_t linkId)
privatepure virtual

Notify the subclass of 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

Implemented in ns3::AdvancedEmlsrManager, and ns3::DefaultEmlsrManager.

Referenced by NotifyIcfReceived().

+ Here is the caller 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:

◆ DoNotifyTxopEnd()

virtual void ns3::EmlsrManager::DoNotifyTxopEnd ( uint8_t linkId)
privatepure virtual

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

Parameters
linkIdthe ID of the given link

Implemented in ns3::AdvancedEmlsrManager, and ns3::DefaultEmlsrManager.

Referenced by NotifyTxopEnd().

+ Here is the caller graph for this function:

◆ DoNotifyUlTxopStart()

virtual void ns3::EmlsrManager::DoNotifyUlTxopStart ( uint8_t linkId)
privatepure virtual

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

Parameters
linkIdthe ID of the given link

Implemented in ns3::AdvancedEmlsrManager, and ns3::DefaultEmlsrManager.

Referenced by NotifyUlTxopStart().

+ Here is the caller graph for this function:

◆ DoSetWifiMac()

void ns3::EmlsrManager::DoSetWifiMac ( Ptr< StaWifiMac > mac)
protectedvirtual

Allow subclasses to take actions when the MAC is set.

Parameters
macthe wifi MAC

Reimplemented in ns3::AdvancedEmlsrManager.

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

References NS_LOG_FUNCTION.

Referenced by SetWifiMac().

+ Here is the caller graph for this function:

◆ EmlsrLinkSwitchCallback()

void ns3::EmlsrManager::EmlsrLinkSwitchCallback ( uint8_t linkId,
Ptr< WifiPhy > phy )
protectedvirtual

Callback connected to the EmlsrLinkSwitch trace source of StaWifiMac.

Parameters
linkIdthe ID of the link involved in the EMLSR link switch event
phya pointer to the PHY involved in the EMLSR link switch event

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

References m_noPhySince, MEDIUM_SYNC_THRESHOLD_USEC, ns3::MicroSeconds(), ns3::Simulator::Now(), NS_ASSERT, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, StartMediumSyncDelayTimer(), and ns3::Time::US.

Referenced by SetWifiMac().

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

◆ GetAuxPhyTxCapable()

bool ns3::EmlsrManager::GetAuxPhyTxCapable ( ) const
Returns
whether Aux PHYs are capable of transmitting PPDUs

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

References m_auxPhyTxCapable.

Referenced by ns3::AdvancedEmlsrManager::DoDispose(), ns3::AdvancedEmlsrManager::DoSetWifiMac(), and GetTypeId().

+ 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 263 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 1348 of file emlsr-manager.cc.

References NS_ASSERT_MSG.

Referenced by ns3::AdvancedEmlsrManager::RequestMainPhyToSwitch(), SwitchAuxPhy(), ns3::AdvancedEmlsrManager::SwitchMainPhyIfTxopGainedByAuxPhy(), and ns3::AdvancedEmlsrManager::SwitchMainPhyIfTxopToBeGainedByAuxPhy().

+ 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 1339 of file emlsr-manager.cc.

References NS_ASSERT_MSG.

Referenced by ns3::AdvancedEmlsrManager::CheckNavAndCcaLastPifs(), ns3::AdvancedEmlsrManager::RequestMainPhyToSwitch(), SwitchMainPhy(), ns3::AdvancedEmlsrManager::SwitchMainPhyIfTxopGainedByAuxPhy(), and ns3::AdvancedEmlsrManager::SwitchMainPhyIfTxopToBeGainedByAuxPhy().

+ Here is the caller graph for this function:

◆ GetDelayUnlessMainPhyTakesOverUlTxop()

virtual std::pair< bool, Time > ns3::EmlsrManager::GetDelayUnlessMainPhyTakesOverUlTxop ( uint8_t linkId)
protectedpure virtual

Subclasses have to provide an implementation for this method, that is called by the base class when the EMLSR client gets channel access on the given link, on which an aux PHY that is TX capable is operating.

This method has to request the main PHY to switch to the given link to take over the TXOP, if possible, or determine the delay after which the EMLSR client restarts channel access on the given link, otherwise.

Parameters
linkIdthe ID of the given link
Returns
a pair consisting of a boolean value indicating whether the UL TXOP can be started and a Time value indicating the delay after which the EMLSR client must restart channel access (if needed) in case the UL TXOP is not started

Implemented in ns3::AdvancedEmlsrManager, and ns3::DefaultEmlsrManager.

Referenced by GetDelayUntilAccessRequest().

+ Here is the caller graph for this function:

◆ GetDelayUntilAccessRequest()

std::pair< bool, Time > ns3::EmlsrManager::GetDelayUntilAccessRequest ( uint8_t linkId,
AcIndex aci )

Notify that an UL TXOP is gained on the given link by the given AC.

This method has to determine whether to start the UL TXOP or release the channel.

Parameters
linkIdthe ID of the given link
acithe index of the given AC
Returns
a pair consisting of a boolean value indicating whether the UL TXOP can be started and a Time value indicating the delay after which the EMLSR client must restart channel access (if needed) in case the UL TXOP is not started

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

References DoGetDelayUntilAccessRequest(), GetDelayUnlessMainPhyTakesOverUlTxop(), m_auxPhyTxCapable, m_mainPhyId, m_staMac, NS_ASSERT_MSG, NS_LOG_DEBUG, and SwitchMainPhyIfTxopGainedByAuxPhy().

+ Here is the call 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 305 of file emlsr-manager.cc.

References m_staMac, and ns3::StaticCast().

Referenced by ns3::AdvancedEmlsrManager::CheckNavAndCcaLastPifs(), CheckPossiblyReceivingIcf(), ns3::AdvancedEmlsrManager::DoNotifyTxopEnd(), ns3::AdvancedEmlsrManager::ReceivedMacHdr(), ns3::AdvancedEmlsrManager::SwitchMainPhyBackDelayExpired(), and ns3::AdvancedEmlsrManager::SwitchMainPhyIfTxopToBeGainedByAuxPhy().

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

◆ GetElapsedMediumSyncDelayTimer()

std::optional< Time > ns3::EmlsrManager::GetElapsedMediumSyncDelayTimer ( uint8_t linkId) const

Check whether the MediumSyncDelay timer is running for the STA operating on the given link.

If so, returns the time elapsed since the timer started.

Parameters
linkIdthe ID of the given link
Returns
the time elapsed since the MediumSyncDelay timer started, if this timer is running for the STA operating on the given link

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

References ns3::Simulator::GetDelayLeft(), m_mediumSyncDelayStatus, and m_mediumSyncDuration.

Referenced by ns3::AdvancedEmlsrManager::RequestMainPhyToSwitch().

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

◆ GetEmlOmn()

MgtEmlOmn ns3::EmlsrManager::GetEmlOmn ( )
protected
Returns
the EML Operating Mode Notification to send

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

References ns3::MgtEmlOmn::EmlControl::emlsrMode, ns3::MgtEmlOmn::EmlControl::emlsrParamUpdateCtrl, ns3::MgtEmlOmn::m_emlControl, ns3::MgtEmlOmn::m_emlsrParamUpdate, NS_LOG_DEBUG, and ns3::MgtEmlOmn::SetLinkIdInBitmap().

+ Here is the call graph for this function:

◆ GetEmlsrLinks()

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

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

References m_emlsrLinks.

Referenced by ns3::AdvancedEmlsrManager::NotifyEmlsrModeChanged().

+ Here is the caller graph for this function:

◆ GetExpectedAccessWithinDelay()

bool ns3::EmlsrManager::GetExpectedAccessWithinDelay ( uint8_t linkId,
const Time & delay ) const
protected

Get whether channel access is expected to be granted on the given link within the given delay to an Access Category that has traffic to send on the given link.

Parameters
linkIdthe ID of the given link
delaythe given delay
Returns
whether channel access is expected to be granted on the given link within the given delay

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

References NS_LOG_DEBUG, and ns3::wifiAcList.

Referenced by ns3::AdvancedEmlsrManager::CheckNavAndCcaLastPifs(), ns3::AdvancedEmlsrManager::InterruptSwitchMainPhyBackTimerIfNeeded(), ns3::AdvancedEmlsrManager::ReceivedMacHdr(), ns3::AdvancedEmlsrManager::SwitchMainPhyBackDelayExpired(), and ns3::AdvancedEmlsrManager::SwitchMainPhyIfTxopToBeGainedByAuxPhy().

+ Here is the caller graph for this function:

◆ GetInDeviceInterference()

bool ns3::EmlsrManager::GetInDeviceInterference ( ) const
Returns
whether in-device interference is such that a PHY cannot decode anything and cannot decrease the backoff counter when another PHY is transmitting

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

References m_inDeviceInterference.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

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

◆ GetMainPhyId()

◆ GetMediumSyncDuration()

Time ns3::EmlsrManager::GetMediumSyncDuration ( ) const
Returns
the duration of the MediumSyncDelay timer

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

References m_mediumSyncDuration.

Referenced by ns3::AdvancedEmlsrManager::RequestMainPhyToSwitch().

+ Here is the caller graph for this function:

◆ GetMediumSyncMaxNTxops()

std::optional< uint8_t > ns3::EmlsrManager::GetMediumSyncMaxNTxops ( ) const
Returns
the maximum number of TXOPs a non-AP STA is allowed to attempt to initiate while the MediumSyncDelay timer is running. No value indicates no limit.

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

References m_msdMaxNTxops.

◆ GetMediumSyncOfdmEdThreshold()

int8_t ns3::EmlsrManager::GetMediumSyncOfdmEdThreshold ( ) const
Returns
the Medium Synchronization OFDM ED threshold (dBm) to use while the MediumSyncDelay timer is running.

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

References m_msdOfdmEdThreshold.

◆ GetStaMac()

Ptr< StaWifiMac > ns3::EmlsrManager::GetStaMac ( ) const
protected

◆ GetTransitionTimeout()

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

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

References m_emlsrTransitionTimeout.

Referenced by NotifyMgtFrameReceived(), and SetEmlsrLinks().

+ Here is the caller graph for this function:

◆ GetTypeId()

◆ MediumSyncDelayNTxopsExceeded()

bool ns3::EmlsrManager::MediumSyncDelayNTxopsExceeded ( uint8_t linkId)

Return whether no more TXOP attempt is allowed on the given link.

This function must not be called when the MediumSyncDelay timer is not running on the given link.

Parameters
linkIdthe ID of the link on which a new TXOP attempt may be carried out
Returns
whether no more TXOP attempt on the given link is allowed

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

References NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::AdvancedEmlsrManager::RequestMainPhyToSwitch().

+ Here is the caller graph for this function:

◆ MediumSyncDelayTimerExpired()

void ns3::EmlsrManager::MediumSyncDelayTimerExpired ( uint8_t linkId)
private

Take the appropriate actions when the MediumSyncDelay timer expires or is cancelled.

Parameters
linkIdthe ID of the link associated with the MediumSyncDelay timer to cancel

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

References NS_ASSERT, NS_ASSERT_MSG, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

◆ NotifyEmlsrModeChanged()

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

Notify subclass that EMLSR mode changed.

Implemented in ns3::AdvancedEmlsrManager, and ns3::DefaultEmlsrManager.

◆ 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 437 of file emlsr-manager.cc.

References DoNotifyIcfReceived(), DONT_REQUEST_ACCESS, GetStaMac(), m_auxPhyToSleep, m_mainPhyId, m_mainPhySwitchInfo, m_staMac, ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, RESET_BACKOFF, SetSleepStateForAllAuxPhys(), ns3::SWITCHING, SwitchMainPhy(), ns3::EmlsrManager::MainPhySwitchInfo::to, and ns3::USING_OTHER_EMLSR_LINK.

+ Here is the call graph for this function:

◆ NotifyInDeviceInterferenceStart()

void ns3::EmlsrManager::NotifyInDeviceInterferenceStart ( uint8_t linkId,
Time duration )
virtual

Notify that an STA affiliated with the EMLSR client is causing in-device interference for the given amount of time.

Parameters
linkIdthe ID of the link on which the STA is operating
durationthe duration of the in-device interference

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

References ns3::Time::As(), m_inDeviceInterference, m_staMac, MEDIUM_SYNC_THRESHOLD_USEC, ns3::MicroSeconds(), NS_ASSERT, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), StartMediumSyncDelayTimer(), and ns3::Time::US.

+ Here is the call graph for this function:

◆ NotifyMainPhySwitch()

virtual void ns3::EmlsrManager::NotifyMainPhySwitch ( std::optional< uint8_t > currLinkId,
uint8_t nextLinkId,
Ptr< WifiPhy > auxPhy,
Time duration )
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 (if any)
nextLinkIdthe ID of the link on which the main PHY will be operating
auxPhythe aux PHY operating on the link on which the main PHY will be operating
durationthe channel switch duration

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 )

Notify the reception of a management frame addressed to us.

Parameters
mpduthe received MPDU
linkIdthe ID of the link over which the MPDU was received

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

References ns3::EventId::Cancel(), ComputeOperatingChannels(), DoNotifyMgtFrameReceived(), GetStaMac(), GetTransitionTimeout(), ns3::EventImpl::Invoke(), ns3::EventId::IsPending(), m_nextEmlsrLinks, m_staMac, m_transitionTimeoutEvent, NS_LOG_FUNCTION, ns3::WifiActionHeader::Peek(), ns3::EventId::PeekEventImpl(), ns3::WifiActionHeader::PROTECTED_EHT, ns3::WifiActionHeader::PROTECTED_EHT_EML_OPERATING_MODE_NOTIFICATION, and SendEmlOmn().

+ Here is the call graph for this function:

◆ NotifyProtectionCompleted()

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

Notify that protection (if required) is completed and data frame exchange can start on the given link.

Parameters
linkIdthe ID of the given link

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

References m_auxPhyToSleep, m_mainPhyId, m_staMac, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and SetSleepStateForAllAuxPhys().

+ Here is the call graph for this function:

◆ NotifyRtsSent()

void ns3::EmlsrManager::NotifyRtsSent ( uint8_t linkId,
Ptr< const WifiPsdu > rts,
const WifiTxVector & txVector )
virtual

Notify that RTS transmission is starting on the given link.

Parameters
linkIdthe ID of the given link
rtsthe RTS being transmitted
txVectorthe TXVECTOR used to transmit the RTS

Reimplemented in ns3::DefaultEmlsrManager.

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

References NS_LOG_FUNCTION.

◆ NotifyTxopEnd()

void ns3::EmlsrManager::NotifyTxopEnd ( uint8_t linkId,
bool ulTxopNotStarted = false,
bool ongoingDlTxop = false )

Notify the end of a TXOP on the given link.

Parameters
linkIdthe ID of the given link
ulTxopNotStartedwhether this is a notification of the end of an UL TXOP that did not even start (no frame transmitted)
ongoingDlTxopwhether a DL TXOP is ongoing on the given link (if true, this is a notification of the end of an UL TXOP)

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

References DoNotifyTxopEnd(), m_auxPhyToSleep, m_staMac, m_ulMainPhySwitch, NS_LOG_DEBUG, NS_LOG_FUNCTION, SetSleepStateForAllAuxPhys(), and ns3::USING_OTHER_EMLSR_LINK.

Referenced by ns3::AdvancedEmlsrManager::ReceivedMacHdr().

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

◆ NotifyUlTxopStart()

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

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

Parameters
linkIdthe ID of the given link

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

References DoNotifyUlTxopStart(), m_staMac, NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::USING_OTHER_EMLSR_LINK.

Referenced by ns3::AdvancedEmlsrManager::CheckNavAndCcaLastPifs().

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

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

◆ ResetMediumSyncDelayNTxops()

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

This function is normally called when a TXOP attempt is successful. This function must not be called when the MediumSyncDelay timer is not running on the given link.

Parameters
linkIdthe ID of the link for which the counter of the TXOP attempts is reset

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

References NS_ASSERT, and NS_LOG_FUNCTION.

◆ SendEmlOmn()

void ns3::EmlsrManager::SendEmlOmn ( )
private

Send an EML Operating Mode Notification frame.

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

References NS_ABORT_MSG_IF, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by NotifyMgtFrameReceived(), and SetEmlsrLinks().

+ Here is the caller graph for this function:

◆ SetAuxPhyTxCapable()

void ns3::EmlsrManager::SetAuxPhyTxCapable ( bool capable)

Set the member variable indicating whether Aux PHYs are capable of transmitting PPDUs.

Parameters
capablewhether Aux PHYs are capable of transmitting PPDUs

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

References m_auxPhyTxCapable.

Referenced by GetTypeId().

+ 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 257 of file emlsr-manager.cc.

References m_resetCamState.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetCcaEdThresholdOnLinkSwitch()

void ns3::EmlsrManager::SetCcaEdThresholdOnLinkSwitch ( Ptr< WifiPhy > phy,
uint8_t linkId )
protected

Set the CCA ED threshold (if needed) on the given PHY that is switching channel to operate on the given link.

Parameters
phythe given PHY
linkIdthe ID of the given link

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

References m_mediumSyncDelayStatus, m_msdOfdmEdThreshold, m_prevCcaEdThreshold, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

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

+ 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 374 of file emlsr-manager.cc.

References GetStaMac(), GetTransitionTimeout(), ns3::LOG_FUNCTION, 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:

◆ SetInDeviceInterference()

void ns3::EmlsrManager::SetInDeviceInterference ( bool enable)

Set the member variable indicating whether in-device interference is such that a PHY cannot decode anything and cannot decrease the backoff counter when another PHY is transmitting.

Parameters
enablewhether in-device interference is such that a PHY cannot decode anything and cannot decrease the backoff counter when another PHY is transmitting

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

References m_inDeviceInterference.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetMainPhyId()

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

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 243 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:

◆ SetMediumSyncDuration()

void ns3::EmlsrManager::SetMediumSyncDuration ( Time duration)

Set the duration of the MediumSyncDelay timer.

Parameters
durationthe duration of the MediumSyncDelay timer

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

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

+ Here is the call graph for this function:

◆ SetMediumSyncMaxNTxops()

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

No value indicates no limit.

Parameters
nTxopsthe maximum number of TXOPs a non-AP STA is allowed to attempt to initiate while the MediumSyncDelay timer is running

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

References m_msdMaxNTxops, and NS_LOG_FUNCTION.

◆ SetMediumSyncOfdmEdThreshold()

void ns3::EmlsrManager::SetMediumSyncOfdmEdThreshold ( int8_t threshold)

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

Parameters
thresholdthe threshold in dBm (ranges from -72 to -62 dBm)

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

References m_msdOfdmEdThreshold, and NS_LOG_FUNCTION.

◆ SetSleepStateForAllAuxPhys()

void ns3::EmlsrManager::SetSleepStateForAllAuxPhys ( bool sleep)
protected

Set sleep state or awake state for all aux PHYs.

Parameters
sleepset sleep state, if true, or awake state, otherwise

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

References ns3::MicroSeconds(), NS_ASSERT_MSG, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by NotifyIcfReceived(), NotifyProtectionCompleted(), and NotifyTxopEnd().

+ 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 322 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 180 of file emlsr-manager.cc.

References DoSetWifiMac(), EmlsrLinkSwitchCallback(), m_staMac, ns3::MakeCallback(), NS_ABORT_MSG_IF, NS_ASSERT, NS_LOG_FUNCTION, ns3::STA, TxDropped(), and TxOk().

+ Here is the call graph for this function:

◆ StartMediumSyncDelayTimer()

void ns3::EmlsrManager::StartMediumSyncDelayTimer ( uint8_t linkId)
private

Start the MediumSyncDelay timer and take the appropriate actions.

Parameters
linkIdthe ID of the link on which medium synchronization was lost

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

References NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by EmlsrLinkSwitchCallback(), and NotifyInDeviceInterferenceStart().

+ Here is the caller graph for this function:

◆ SwitchAuxPhy()

void ns3::EmlsrManager::SwitchAuxPhy ( Ptr< WifiPhy > auxPhy,
uint8_t currLinkId,
uint8_t nextLinkId )
protected

Switch channel on the Aux PHY operating on the given current link so that it operates on the given next link.

Parameters
auxPhythe Aux PHY
currLinkIdthe ID of the link on which the aux PHY is currently operating
nextLinkIdthe ID of the link on which the aux PHY will be operating

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

References GetChannelForAuxPhy(), GetStaMac(), m_staMac, ns3::MicroSeconds(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

Referenced by ns3::DefaultEmlsrManager::SwitchAuxPhyAfterMainPhy().

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

◆ SwitchMainPhy()

void ns3::EmlsrManager::SwitchMainPhy ( uint8_t linkId,
bool noSwitchDelay,
bool resetBackoff,
bool requestAccess,
EmlsrMainPhySwitchTrace && traceInfo )
protected

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
resetBackoffwhether backoff should be reset on the link on which the main PHY is operating
requestAccesswhether channel access should be requested on the link on which the main PHY is moving onto
traceInfoinformation to pass to the main PHY switch traced callback (the fromLinkId and toLinkId fields are set by this function)

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

References ns3::Time::As(), ns3::Txop::CHECK_MEDIUM_BUSY, ns3::Txop::DIDNT_HAVE_FRAMES_TO_TRANSMIT, ns3::EmlsrManager::MainPhySwitchInfo::end, ns3::EmlsrManager::MainPhySwitchInfo::from, GetChannelForMainPhy(), GetStaMac(), m_lastAdvTransitionDelay, m_mainPhyId, m_mainPhySwitchInfo, m_mainPhySwitchTrace, m_staMac, ns3::MicroSeconds(), NotifyMainPhySwitch(), ns3::Simulator::Now(), NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::Seconds(), SetCcaEdThresholdOnLinkSwitch(), ns3::EmlsrManager::MainPhySwitchInfo::to, ns3::Time::US, and ns3::wifiAcList.

Referenced by ns3::AdvancedEmlsrManager::DoNotifyTxopEnd(), NotifyIcfReceived(), ns3::DefaultEmlsrManager::SwitchMainPhyBackToPreferredLink(), ns3::AdvancedEmlsrManager::SwitchMainPhyIfTxopGainedByAuxPhy(), and ns3::AdvancedEmlsrManager::SwitchMainPhyIfTxopToBeGainedByAuxPhy().

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

◆ SwitchMainPhyIfTxopGainedByAuxPhy()

virtual void ns3::EmlsrManager::SwitchMainPhyIfTxopGainedByAuxPhy ( uint8_t linkId,
AcIndex aci )
protectedpure virtual

Subclasses have to provide an implementation for this method, that is called by the base class when the given AC of the EMLSR client gets channel access on the given link, on which an aux PHY that is not TX capable is operating.

This method has to request the main PHY to switch to the given link to take over the TXOP, unless it is decided to give up the TXOP.

Parameters
linkIdthe ID of the given link
acithe index of the given AC

Implemented in ns3::AdvancedEmlsrManager, and ns3::DefaultEmlsrManager.

Referenced by GetDelayUntilAccessRequest().

+ 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 1185 of file emlsr-manager.cc.

References NS_LOG_FUNCTION.

Referenced by DoDispose(), and SetWifiMac().

+ 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 1150 of file emlsr-manager.cc.

References NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by DoDispose(), and SetWifiMac().

+ Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ ::EmlsrCcaBusyTest

friend class ::EmlsrCcaBusyTest
friend

Allow test cases to access private members.

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

Member Data Documentation

◆ DONT_REQUEST_ACCESS

bool ns3::EmlsrManager::DONT_REQUEST_ACCESS
staticconstexprprotected

◆ DONT_RESET_BACKOFF

bool ns3::EmlsrManager::DONT_RESET_BACKOFF = false
staticconstexprprotected

◆ 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 699 of file emlsr-manager.h.

◆ m_auxPhyMaxModClass

WifiModulationClass ns3::EmlsrManager::m_auxPhyMaxModClass
protected

max modulation class supported by aux PHYs

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

Referenced by GetTypeId().

◆ m_auxPhyMaxWidth

MHz_u ns3::EmlsrManager::m_auxPhyMaxWidth
protected

max channel width supported by aux PHYs

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

Referenced by GetTypeId().

◆ m_auxPhyToSleep

bool ns3::EmlsrManager::m_auxPhyToSleep
protected

whether Aux PHYs should be put into sleep mode while the Main PHY is carrying out a (DL or UL) TXOP

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

Referenced by GetTypeId(), NotifyIcfReceived(), NotifyProtectionCompleted(), and NotifyTxopEnd().

◆ m_auxPhyToSleepEvents

std::map<uint8_t, EventId> ns3::EmlsrManager::m_auxPhyToSleepEvents
protected

PHY ID-indexed map of events scheduled to put an Aux PHY to sleep.

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

◆ m_auxPhyTxCapable

◆ 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 684 of file emlsr-manager.h.

Referenced by GetEmlsrLinks(), and SetEmlsrLinks().

◆ m_emlsrPaddingDelay

Time ns3::EmlsrManager::m_emlsrPaddingDelay
protected

EMLSR Padding delay.

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

Referenced by GetTypeId().

◆ m_emlsrTransitionDelay

Time ns3::EmlsrManager::m_emlsrTransitionDelay
protected

EMLSR Transition delay.

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

Referenced by GetTypeId().

◆ m_emlsrTransitionTimeout

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

Transition timeout advertised by APs with EMLSR activated.

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

Referenced by GetTransitionTimeout(), and SetTransitionTimeout().

◆ m_inDeviceInterference

bool ns3::EmlsrManager::m_inDeviceInterference
private

whether in-device interference is such that a PHY cannot decode anything and cannot decrease the backoff counter when another PHY is transmitting

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

Referenced by GetInDeviceInterference(), NotifyInDeviceInterferenceStart(), and SetInDeviceInterference().

◆ m_lastAdvPaddingDelay

Time ns3::EmlsrManager::m_lastAdvPaddingDelay
private

last advertised padding delay

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

◆ m_lastAdvTransitionDelay

Time ns3::EmlsrManager::m_lastAdvTransitionDelay
private

last advertised transition delay

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

Referenced by SwitchMainPhy().

◆ 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 697 of file emlsr-manager.h.

◆ m_mainPhyId

◆ m_mainPhySwitchInfo

◆ m_mainPhySwitchTrace

MainPhySwitchTracedCallback ns3::EmlsrManager::m_mainPhySwitchTrace
private

main PHY switch trace source

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

Referenced by GetTypeId(), and SwitchMainPhy().

◆ m_mediumSyncDelayStatus

std::map<uint8_t, MediumSyncDelayStatus> ns3::EmlsrManager::m_mediumSyncDelayStatus
private

the status of MediumSyncDelay timers (link ID-indexed)

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

Referenced by DoDispose(), GetElapsedMediumSyncDelayTimer(), and SetCcaEdThresholdOnLinkSwitch().

◆ m_mediumSyncDuration

Time ns3::EmlsrManager::m_mediumSyncDuration
private

duration of the MediumSyncDelay timer

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

Referenced by GetElapsedMediumSyncDelayTimer(), GetMediumSyncDuration(), and SetMediumSyncDuration().

◆ m_msdMaxNTxops

std::optional<uint8_t> ns3::EmlsrManager::m_msdMaxNTxops
private

MediumSyncDelay max number of TXOPs.

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

Referenced by GetMediumSyncMaxNTxops(), and SetMediumSyncMaxNTxops().

◆ m_msdOfdmEdThreshold

int8_t ns3::EmlsrManager::m_msdOfdmEdThreshold
private

MediumSyncDelay OFDM ED threshold.

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

Referenced by GetMediumSyncOfdmEdThreshold(), SetCcaEdThresholdOnLinkSwitch(), and SetMediumSyncOfdmEdThreshold().

◆ 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 685 of file emlsr-manager.h.

Referenced by NotifyMgtFrameReceived(), and SetEmlsrLinks().

◆ m_noPhySince

std::map<uint8_t, Time> ns3::EmlsrManager::m_noPhySince
private

link ID-indexed map of the time since no PHY is operating on the link

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

Referenced by EmlsrLinkSwitchCallback().

◆ m_prevCcaEdThreshold

std::map<Ptr<WifiPhy>, dBm_u> ns3::EmlsrManager::m_prevCcaEdThreshold
private

the CCA sensitivity threshold to restore once the MediumSyncDelay timer expires or the PHY moves to a link on which the timer is not running

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

Referenced by SetCcaEdThresholdOnLinkSwitch().

◆ m_resetCamState

bool ns3::EmlsrManager::m_resetCamState
private

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

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

Referenced by GetCamStateReset(), and SetCamStateReset().

◆ m_staMac

◆ m_startSleep

std::map<uint8_t, Time> ns3::EmlsrManager::m_startSleep
protected

PHY ID-indexed map of last time sleep mode started.

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

◆ m_transitionTimeoutEvent

EventId ns3::EmlsrManager::m_transitionTimeoutEvent
private

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

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

Referenced by DoDispose(), and NotifyMgtFrameReceived().

◆ m_ulMainPhySwitch

std::map<uint8_t, EventId> ns3::EmlsrManager::m_ulMainPhySwitch
protected

link ID-indexed map of timers started when an aux PHY gains an UL TXOP and schedules a channel switch for the main PHY

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

Referenced by NotifyTxopEnd().

◆ m_useNotifiedMacHdr

bool ns3::EmlsrManager::m_useNotifiedMacHdr
protected

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

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

Referenced by CheckPossiblyReceivingIcf(), GetTypeId(), and ns3::AdvancedEmlsrManager::ReceivedMacHdr().

◆ MEDIUM_SYNC_THRESHOLD_USEC

uint16_t ns3::EmlsrManager::MEDIUM_SYNC_THRESHOLD_USEC = 72
staticconstexpr

The aMediumSyncThreshold defined by Sec. 35.3.16.18.1 of 802.11be D4.0.

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

Referenced by EmlsrLinkSwitchTest::CheckRtsFrame(), EmlsrLinkSwitchCallback(), NotifyInDeviceInterferenceStart(), and EmlsrOperationsTestBase::Transmit().

◆ REQUEST_ACCESS

bool ns3::EmlsrManager::REQUEST_ACCESS = true
staticconstexprprotected

request channel access when PHY switch ends

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

Referenced by ns3::AdvancedEmlsrManager::DoNotifyTxopEnd(), and ns3::DefaultEmlsrManager::SwitchMainPhyBackToPreferredLink().

◆ RESET_BACKOFF

bool ns3::EmlsrManager::RESET_BACKOFF = true
staticconstexprprotected

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