A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
ns3::AdvancedEmlsrManager Class Reference
Wifi Models

AdvancedEmlsrManager is an advanced EMLSR manager. More...

#include "advanced-emlsr-manager.h"

+ Inheritance diagram for ns3::AdvancedEmlsrManager:
+ Collaboration diagram for ns3::AdvancedEmlsrManager:

Public Member Functions

 AdvancedEmlsrManager ()
 
 ~AdvancedEmlsrManager () override
 
std::optional< WifiIcfDrop > CheckMainPhyTakesOverDlTxop (uint8_t linkId) const override
 This method is called when an aux PHY has completed reception of an ICF to determine whether there is any reason preventing the main PHY from switching link and be on the aux PHY link by the time the ICF reception is completed to take over the DL TXOP.
 
void InterruptSwitchMainPhyBackTimerIfNeeded ()
 This method is called by the PHY listener attached to the main PHY when a switch main PHY back timer is started to notify of events that may delay the channel access for the main PHY on the current link.
 
- Public Member Functions inherited from ns3::DefaultEmlsrManager
 DefaultEmlsrManager ()
 
 ~DefaultEmlsrManager () override
 
void NotifyRtsSent (uint8_t linkId, Ptr< const WifiPsdu > rts, const WifiTxVector &txVector) override
 Notify that RTS transmission is starting on the given link.
 
- Public Member Functions inherited from ns3::EmlsrManager
 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, Time > CheckPossiblyReceivingIcf (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, Time > GetDelayUntilAccessRequest (uint8_t linkId, AcIndex aci)
 Notify that an UL TXOP is gained on the given link by the given AC.
 
std::optional< Time > GetElapsedMediumSyncDelayTimer (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< Time > GetTransitionTimeout () const
 
bool MediumSyncDelayNTxopsExceeded (uint8_t linkId)
 Return whether no more TXOP attempt is allowed on the given link.
 
void NotifyDlTxopStart (uint8_t linkId)
 Notify the start of a DL TXOP 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.
 
void NotifyTxopEnd (uint8_t linkId, Ptr< QosTxop > edca=nullptr)
 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< Object > GetObject () const
 Specialization of () for objects of type ns3::Object.
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId.
 
template<>
Ptr< Object > GetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object.
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one.
 
bool IsInitialized () const
 Check if the object has been initialized.
 
void UnidirectionalAggregateObject (Ptr< Object > other)
 Aggregate an Object to another Object.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCount & operator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor.
 
void GetAttribute (std::string name, AttributeValue &value, bool permissive=false) const
 Get the value of an attribute, raising fatal errors if unsuccessful.
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors.
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful.
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors.
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context.
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context.
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context.
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context.
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::DefaultEmlsrManager
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::EmlsrManager
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type.
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID.
 

Protected Member Functions

void CheckNavAndCcaLastPifs (Ptr< WifiPhy > phy, uint8_t linkId, Ptr< QosTxop > edca)
 Use information from NAV and CCA performed by the given PHY on the given link in the last PIFS interval to determine whether the given EDCAF can start a TXOP.
 
void DoDispose () override
 Destructor implementation.
 
std::pair< bool, Time > DoGetDelayUntilAccessRequest (uint8_t linkId) override
 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.
 
void DoSetWifiMac (Ptr< StaWifiMac > mac) override
 Allow subclasses to take actions when the MAC is set.
 
std::pair< bool, Time > GetDelayUnlessMainPhyTakesOverUlTxop (uint8_t linkId) override
 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.
 
void NotifyEmlsrModeChanged () override
 Notify subclass that EMLSR mode changed.
 
void ReceivedMacHdr (Ptr< WifiPhy > phy, const WifiMacHeader &macHdr, const WifiTxVector &txVector, Time psduDuration)
 Possibly take actions when notified of the MAC header of the MPDU being received by the given PHY.
 
void RegisterListener (Ptr< WifiPhy > phy)
 Register a PHY listener so that this EMLSR Manager is notified of PHY events generated by the given PHY.
 
bool RequestMainPhyToSwitch (uint8_t linkId, AcIndex aci, const Time &delay)
 Determine whether the main PHY shall be requested to switch to the link of an aux PHY that is expected to gain channel access through the given AC in the given delay but it is not TX capable.
 
void SwitchMainPhyBackDelayExpired (uint8_t linkId, std::optional< WifiExpectedAccessReason > stopReason)
 This method is called when the switch main PHY back timer (which is started when the main PHY switches to the link of an aux PHY that does not switch and is not TX capable) expires and decides whether to delay the request to switch the main PHY back to the preferred link or to execute it immediately.
 
void SwitchMainPhyBackToPreferredLink (uint8_t linkId, EmlsrMainPhySwitchTrace &&traceInfo) override
 This method can only be called when aux PHYs do not switch link.
 
void SwitchMainPhyIfTxopGainedByAuxPhy (uint8_t linkId, AcIndex aci) override
 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.
 
void SwitchMainPhyIfTxopToBeGainedByAuxPhy (uint8_t linkId, AcIndex aci, const Time &delay)
 This method is called when the given AC of the EMLSR client is expected to get channel access in the given delay on the given link, on which an aux PHY that is not TX capable is operating.
 
void UnregisterListener ()
 Disconnect the PHY listener from the PHY it is connected to (if any)
 
- Protected Member Functions inherited from ns3::DefaultEmlsrManager
std::pair< bool, Time > DoGetDelayUntilAccessRequest (uint8_t linkId) override
 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.
 
std::pair< bool, Time > GetDelayUnlessMainPhyTakesOverUlTxop (uint8_t linkId) override
 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.
 
uint8_t GetLinkToSendEmlOmn () override
 
Time GetTimeToCtsEnd (uint8_t linkId) const
 This function is intended to be called when an aux PHY is about to transmit an RTS on the given link to calculate the time remaining to the end of the CTS reception.
 
Time GetTimeToCtsEnd (uint8_t linkId, const WifiTxVector &rtsTxVector) const
 This function is intended to be called when an aux PHY is about to transmit an RTS on the given link to calculate the time remaining to the end of the CTS reception.
 
void NotifyEmlsrModeChanged () override
 Notify subclass that EMLSR mode changed.
 
std::optional< uint8_t > ResendNotification (Ptr< const WifiMpdu > mpdu) override
 A previous EML Operating Mode Notification frame was dropped.
 
void SwitchMainPhyIfTxopGainedByAuxPhy (uint8_t linkId, AcIndex aci) override
 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::EmlsrManager
void CancelAllSleepEvents ()
 Cancel all pending events to put aux PHYs into sleep/awake state.
 
void DoDispose () override
 Destructor implementation.
 
virtual void EmlsrLinkSwitchCallback (uint8_t linkId, Ptr< WifiPhy > phy, bool connected)
 Callback connected to the EmlsrLinkSwitch trace source of StaWifiMac.
 
const WifiPhyOperatingChannel & GetChannelForAuxPhy (uint8_t linkId) const
 
const WifiPhyOperatingChannel & GetChannelForMainPhy (uint8_t linkId) const
 
Ptr< EhtFrameExchangeManager > GetEhtFem (uint8_t linkId) const
 
MgtEmlOmn GetEmlOmn ()
 
Ptr< StaWifiMac > GetStaMac () const
 
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 requestAccess, EmlsrMainPhySwitchTrace &&traceInfo)
 Switch channel on the Main PHY so that it operates on the given link.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Private Member Functions

void DoNotifyDlTxopStart (uint8_t linkId) override
 Notify the subclass of the reception of an initial Control frame on the given link.
 
void DoNotifyTxopEnd (uint8_t linkId, Ptr< QosTxop > edca) override
 Notify the subclass of the end of a TXOP on the given link.
 
void DoNotifyUlTxopStart (uint8_t linkId) override
 Notify the subclass of the start of an UL TXOP on the given link.
 

Private Attributes

bool m_allowUlTxopInRx
 whether a (main or aux) PHY is allowed to start an UL TXOP if another PHY is receiving a PPDU
 
Ptr< WifiPhy > m_auxPhyWithListener
 aux PHY which a PHY listener is connected to
 
EventId m_ccaLastPifs
 event scheduled in case of non-TX capable aux PHY to determine whether TX can be started based on whether the medium has been idle during the last PIFS interval
 
bool m_checkAccessOnMainPhyLink
 in case aux PHYs are not TX capable and an Access Category, say it AC X, is about to gain channel access on an aux PHY link, determine whether the time the ACs with priority higher than or equal to AC X and with frames to send on the main PHY link are expected to gain access on the main PHY link should be taken into account when taking the decision to switch the main PHY to the aux PHY link
 
bool m_interruptSwitching
 whether a main PHY switching can be interrupted to start switching to another link
 
bool m_keepMainPhyAfterDlTxop
 whether the main PHY must stay, for a switch main PHY back delay, on an aux PHY link after a DL TXOP, in case aux PHYs are not TX capable and do not switch
 
AcIndex m_minAcToSkipCheckAccess
 if m_checkAccessOnMainPhyLink is set to false, indicate the minimum priority AC for which it is allowed to skip the check related to the expected channel access time on the main PHY link
 
std::shared_ptr< WifiPhyListener > m_phyListener
 PHY listener connected to an aux PHY (that is not TX capable and does not switch link) while the main PHY attempts to gain access on the aux PHY link.
 
Time m_switchMainPhyBackDelay
 duration of the timer started in case of non-TX capable aux PHY when medium is sensed busy during the PIFS interval preceding/following the main PHY switch end
 
EventId m_switchMainPhyBackEvent
 event scheduled in case of non-TX capable aux PHY when medium is sensed busy during the PIFS interval preceding/following the main PHY switch end
 
bool m_useAuxPhyCca
 whether the CCA performed in the last PIFS interval by a non-TX capable aux PHY should be used when the main PHY ends switching to the aux PHY's link to determine whether TX can start or not
 

Friends

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

Additional Inherited Members

- Static Public Attributes inherited from ns3::EmlsrManager
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 Attributes inherited from ns3::DefaultEmlsrManager
EventId m_auxPhySwitchEvent
 event scheduled for an aux PHY to switch link
 
Ptr< WifiPhy > m_auxPhyToReconnect
 Aux PHY the ChannelAccessManager of the link on which the main PHY is operating has to connect a listener to when the main PHY is back operating on its previous link.
 
std::map< uint8_t, std::pair< Time, bool > > m_rtsStartingUlTxop
 link ID-indexed map indicating the time when an UL TXOP is going to start and whether it is starting with an RTS
 
bool m_switchAuxPhy
 whether Aux PHY should switch channel to operate on the link on which the Main PHY was operating before moving to the link of the Aux PHY
 
- Protected Attributes inherited from ns3::EmlsrManager
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, EventId > m_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, Time > m_startSleep
 PHY ID-indexed map of last time sleep mode started.
 
std::map< uint8_t, EventId > m_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 inherited from ns3::EmlsrManager
static constexpr bool DONT_REQUEST_ACCESS
 do not request channel access when PHY switch ends
 
static constexpr bool REQUEST_ACCESS = true
 request channel access when PHY switch ends
 
- Related Symbols inherited from ns3::ObjectBase
 Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.
 

Detailed Description

AdvancedEmlsrManager is an advanced EMLSR manager.

Introspection did not find any typical Config paths.


Attributes

  • AllowUlTxopInRx: Whether a (main or aux) PHY is allowed to start an UL TXOP if another PHY is receiving a PPDU (possibly starting a DL TXOP). If this attribute is true, the PPDU may be dropped.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • CheckAccessOnMainPhyLink: In case aux PHYs are not TX capable and an Access Category, say it AC X, is about to gain channel access on an aux PHY link, determine whether the time the ACs with priority higher than or equal to AC X and with frames to send on the main PHY link are expected to gain access on the main PHY link should be taken into account when taking the decision to switch the main PHY to the aux PHY link.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • InterruptSwitch: Whether the main PHY can be interrupted while switching to start switching to another link.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • KeepMainPhyAfterDlTxop: In case aux PHYs are not TX capable and do not switch link, after the end of a DL TXOP carried out on an aux PHY link, the main PHY stays on that link for a switch main PHY back delay, if this attribute is true, or it returns to the preferred link, otherwise.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • MinAcToSkipCheckAccess: If the CheckAccessOnMainPhyLink attribute is set to false, indicate the minimum priority AC for which it is allowed to skip the check related to the expected channel access time on the main PHY link.
    • Set with class: ns3::EnumValue<ns3::AcIndex>
    • Underlying type: AC_BE|AC_VI|AC_VO|AC_BK
    • Initial value: AC_BK
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • SwitchMainPhyBackDelay: Duration of the timer started in case of non-TX capable aux PHY (that does not switch link) when medium is sensed busy during the PIFS interval preceding/following the main PHY switch end. When the timer expires, the main PHY is switched back to the preferred link.
    • Set with class: ns3::TimeValue
    • Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
    • Initial value: +5e+06ns
    • Flags: constructwriteread
    • Support level: SUPPORTED
  • UseAuxPhyCca: Whether the CCA performed in the last PIFS interval by a non-TX capable aux PHY should be used when the main PHY ends switching to the aux PHY's link to determine whether TX can start or not (and what bandwidth can be used for transmission) independently of whether the aux PHY bandwidth is smaller than the main PHY bandwidth or not.
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: false
    • Flags: constructwriteread
    • Support level: SUPPORTED

Attributes defined in parent class ns3::DefaultEmlsrManager

  • SwitchAuxPhy: Whether Aux PHY should switch channel to operate on the link on which the Main PHY was operating before moving to the link of the Aux PHY. Note that, if the Aux PHY does not switch channel, the main PHY will switch back to its previous link once the TXOP terminates (otherwise, no PHY will be listening on that EMLSR link).
    • Set with class: ns3::BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: constructwriteread
    • Support level: SUPPORTED

Attributes defined in parent class ns3::EmlsrManager

  • AuxPhyChannelWidth: The maximum channel width (MHz) supported by Aux PHYs.
    • 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

No TraceSources are defined for this type.

TraceSources defined in parent class ns3::EmlsrManager

  • 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 928 bytes (on a 64-bit architecture).

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

Constructor & Destructor Documentation

◆ AdvancedEmlsrManager()

ns3::AdvancedEmlsrManager::AdvancedEmlsrManager ( )

Definition at line 182 of file advanced-emlsr-manager.cc.

References m_phyListener, and NS_LOG_FUNCTION.

◆ ~AdvancedEmlsrManager()

ns3::AdvancedEmlsrManager::~AdvancedEmlsrManager ( )
override

Definition at line 188 of file advanced-emlsr-manager.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ CheckMainPhyTakesOverDlTxop()

std::optional< WifiIcfDrop > ns3::AdvancedEmlsrManager::CheckMainPhyTakesOverDlTxop ( uint8_t linkId) const
overridevirtual

This method is called when an aux PHY has completed reception of an ICF to determine whether there is any reason preventing the main PHY from switching link and be on the aux PHY link by the time the ICF reception is completed to take over the DL TXOP.

Parameters
linkIdthe ID of the link on which ICF has been received
Returns
the reason, if any, preventing the main PHY from switching link

Reimplemented from ns3::EmlsrManager.

Definition at line 469 of file advanced-emlsr-manager.cc.

References ns3::EmlsrManager::CheckMainPhyTakesOverDlTxop(), m_interruptSwitching, and ns3::NOT_ENOUGH_TIME_SWITCH.

+ Here is the call graph for this function:

◆ CheckNavAndCcaLastPifs()

void ns3::AdvancedEmlsrManager::CheckNavAndCcaLastPifs ( Ptr< WifiPhy > phy,
uint8_t linkId,
Ptr< QosTxop > edca )
protected

Use information from NAV and CCA performed by the given PHY on the given link in the last PIFS interval to determine whether the given EDCAF can start a TXOP.

This function is intended to be used when the main PHY switches channel to start an UL TXOP on a link where channel access was obtained by a non-TX capable aux PHY.

Parameters
phythe PHY that performed CCA in the last PIFS interval
linkIdthe ID of the given link
edcathe given EDCAF

Definition at line 518 of file advanced-emlsr-manager.cc.

References ns3::ACCESS_EXPECTED, ns3::Txop::CHECK_MEDIUM_BUSY, ns3::Txop::DIDNT_HAVE_FRAMES_TO_TRANSMIT, ns3::EmlsrManager::GetChannelForMainPhy(), ns3::Simulator::GetDelayLeft(), ns3::EmlsrManager::GetEhtFem(), ns3::EmlsrManager::GetMainPhyId(), ns3::EmlsrManager::GetStaMac(), ns3::EventId::IsPending(), m_ccaLastPifs, ns3::DefaultEmlsrManager::m_switchAuxPhy, m_switchMainPhyBackEvent, ns3::EmlsrManager::NotifyUlTxopStart(), ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), and SwitchMainPhyBackDelayExpired().

Referenced by SwitchMainPhyIfTxopGainedByAuxPhy(), and SwitchMainPhyIfTxopToBeGainedByAuxPhy().

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

◆ DoDispose()

void ns3::AdvancedEmlsrManager::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 194 of file advanced-emlsr-manager.cc.

References ns3::Object::DoDispose(), ns3::EmlsrManager::GetStaMac(), m_phyListener, ns3::MakeCallback(), NS_LOG_FUNCTION, ReceivedMacHdr(), and UnregisterListener().

+ Here is the call graph for this function:

◆ DoGetDelayUntilAccessRequest()

std::pair< bool, Time > ns3::AdvancedEmlsrManager::DoGetDelayUntilAccessRequest ( uint8_t linkId)
overrideprotectedvirtual

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

Implements ns3::EmlsrManager.

Definition at line 272 of file advanced-emlsr-manager.cc.

References ns3::EmlsrManager::CheckPossiblyReceivingIcf(), ns3::EmlsrManager::GetStaMac(), ns3::EventId::IsPending(), m_allowUlTxopInRx, ns3::EmlsrManager::m_auxPhyTxCapable, m_ccaLastPifs, ns3::EmlsrManager::m_mainPhyId, ns3::DefaultEmlsrManager::m_rtsStartingUlTxop, ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Referenced by SwitchMainPhyIfTxopToBeGainedByAuxPhy().

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

◆ DoNotifyDlTxopStart()

void ns3::AdvancedEmlsrManager::DoNotifyDlTxopStart ( uint8_t linkId)
overrideprivatevirtual

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

Implements ns3::EmlsrManager.

Definition at line 725 of file advanced-emlsr-manager.cc.

References ns3::EventId::Cancel(), m_ccaLastPifs, m_switchMainPhyBackEvent, NS_LOG_FUNCTION, and UnregisterListener().

+ Here is the call graph for this function:

◆ DoNotifyTxopEnd()

void ns3::AdvancedEmlsrManager::DoNotifyTxopEnd ( uint8_t linkId,
Ptr< QosTxop > edca )
overrideprivatevirtual

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

Parameters
linkIdthe ID of the given link
edcathe EDCAF that carried out the TXOP, in case of UL TXOP, or a null pointer, in case of DL TXOP

Implements ns3::EmlsrManager.

Definition at line 371 of file advanced-emlsr-manager.cc.

References ns3::ACCESS_EXPECTED, ns3::EmlsrManager::MainPhySwitchInfo::disconnected, ns3::EmlsrManager::MainPhySwitchInfo::from, ns3::EmlsrManager::GetEhtFem(), ns3::EmlsrManager::GetMainPhyId(), ns3::EmlsrManager::GetStaMac(), ns3::EventId::IsPending(), ns3::DefaultEmlsrManager::m_auxPhyToReconnect, ns3::EmlsrManager::m_auxPhyTxCapable, m_interruptSwitching, m_keepMainPhyAfterDlTxop, ns3::EmlsrManager::m_mainPhyId, ns3::EmlsrManager::m_mainPhySwitchInfo, ns3::DefaultEmlsrManager::m_rtsStartingUlTxop, ns3::DefaultEmlsrManager::m_switchAuxPhy, m_switchMainPhyBackDelay, m_switchMainPhyBackEvent, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, RegisterListener(), ns3::EmlsrManager::REQUEST_ACCESS, ns3::Simulator::Schedule(), ns3::EmlsrManager::SwitchMainPhy(), and SwitchMainPhyBackDelayExpired().

+ Here is the call graph for this function:

◆ DoNotifyUlTxopStart()

void ns3::AdvancedEmlsrManager::DoNotifyUlTxopStart ( uint8_t linkId)
overrideprivatevirtual

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

Parameters
linkIdthe ID of the given link

Implements ns3::EmlsrManager.

Definition at line 734 of file advanced-emlsr-manager.cc.

References ns3::EventId::Cancel(), m_ccaLastPifs, m_switchMainPhyBackEvent, NS_LOG_FUNCTION, and UnregisterListener().

+ Here is the call graph for this function:

◆ DoSetWifiMac()

void ns3::AdvancedEmlsrManager::DoSetWifiMac ( Ptr< StaWifiMac > mac)
overrideprotectedvirtual

Allow subclasses to take actions when the MAC is set.

Parameters
macthe wifi MAC

Reimplemented from ns3::EmlsrManager.

Definition at line 235 of file advanced-emlsr-manager.cc.

References ns3::EmlsrManager::GetStaMac(), ns3::MakeCallback(), NS_LOG_FUNCTION, and ReceivedMacHdr().

+ Here is the call graph for this function:

◆ GetDelayUnlessMainPhyTakesOverUlTxop()

std::pair< bool, Time > ns3::AdvancedEmlsrManager::GetDelayUnlessMainPhyTakesOverUlTxop ( uint8_t linkId)
overrideprotectedvirtual

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

Implements ns3::EmlsrManager.

Definition at line 482 of file advanced-emlsr-manager.cc.

References ns3::CCA_BUSY, ns3::DefaultEmlsrManager::GetDelayUnlessMainPhyTakesOverUlTxop(), ns3::EmlsrManager::GetStaMac(), ns3::DefaultEmlsrManager::GetTimeToCtsEnd(), ns3::IDLE, m_interruptSwitching, ns3::EmlsrManager::m_mainPhyId, ns3::DefaultEmlsrManager::m_rtsStartingUlTxop, ns3::Simulator::Now(), NS_ABORT_MSG_UNLESS, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::RX, and ns3::SWITCHING.

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::AdvancedEmlsrManager::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 109 of file advanced-emlsr-manager.cc.

References ns3::AC_BE, ns3::AC_BK, ns3::AC_VI, ns3::AC_VO, m_allowUlTxopInRx, m_checkAccessOnMainPhyLink, m_interruptSwitching, m_keepMainPhyAfterDlTxop, m_minAcToSkipCheckAccess, m_switchMainPhyBackDelay, m_useAuxPhyCca, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MilliSeconds(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ InterruptSwitchMainPhyBackTimerIfNeeded()

void ns3::AdvancedEmlsrManager::InterruptSwitchMainPhyBackTimerIfNeeded ( )

This method is called by the PHY listener attached to the main PHY when a switch main PHY back timer is started to notify of events that may delay the channel access for the main PHY on the current link.

If the expected channel access is beyond the end of the switch main PHY timer expiration plus a channel switch delay, the timer is stopped immediately.

Definition at line 695 of file advanced-emlsr-manager.cc.

References ns3::ACCESS_EXPECTED, ns3::EmlsrManager::MainPhySwitchInfo::disconnected, ns3::Simulator::GetDelayLeft(), ns3::EmlsrManager::GetMainPhyId(), ns3::EmlsrManager::GetStaMac(), ns3::EventId::IsPending(), ns3::EmlsrManager::m_mainPhySwitchInfo, m_switchMainPhyBackEvent, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, SwitchMainPhyBackDelayExpired(), and ns3::EmlsrManager::MainPhySwitchInfo::to.

Referenced by ns3::EmlsrPhyListener::NotifyCcaBusyStart(), ns3::EmlsrPhyListener::NotifyRxEndOk(), and ns3::EmlsrPhyListener::NotifyRxStart().

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

◆ NotifyEmlsrModeChanged()

void ns3::AdvancedEmlsrManager::NotifyEmlsrModeChanged ( )
overrideprotectedvirtual

Notify subclass that EMLSR mode changed.

Implements ns3::EmlsrManager.

Definition at line 209 of file advanced-emlsr-manager.cc.

References ns3::EmlsrManager::GetEmlsrLinks(), ns3::EmlsrManager::GetStaMac(), ns3::MakeCallback(), ns3::DefaultEmlsrManager::NotifyEmlsrModeChanged(), NS_LOG_FUNCTION, and SwitchMainPhyIfTxopToBeGainedByAuxPhy().

+ Here is the call graph for this function:

◆ ReceivedMacHdr()

void ns3::AdvancedEmlsrManager::ReceivedMacHdr ( Ptr< WifiPhy > phy,
const WifiMacHeader & macHdr,
const WifiTxVector & txVector,
Time psduDuration )
protected

Possibly take actions when notified of the MAC header of the MPDU being received by the given PHY.

Parameters
phythe given PHY
macHdrthe MAC header of the MPDU being received
txVectorthe TXVECTOR used to transmit the PSDU
psduDurationthe remaining duration of the PSDU

Definition at line 319 of file advanced-emlsr-manager.cc.

References ns3::ACCESS_EXPECTED, ns3::Time::As(), ns3::EmlsrManager::MainPhySwitchInfo::disconnected, ns3::WifiMacHeader::GetAddr1(), ns3::Simulator::GetDelayLeft(), ns3::EmlsrManager::GetEhtFem(), ns3::EmlsrManager::GetMainPhyId(), ns3::EmlsrManager::GetStaMac(), ns3::Mac48Address::IsBroadcast(), ns3::WifiMacHeader::IsCts(), ns3::EventId::IsPending(), ns3::EmlsrManager::m_mainPhySwitchInfo, m_switchMainPhyBackEvent, ns3::EmlsrManager::m_useNotifiedMacHdr, ns3::Time::MS, ns3::EmlsrManager::NotifyTxopEnd(), NS_LOG_FUNCTION, ns3::Simulator::ScheduleNow(), and ns3::EmlsrManager::MainPhySwitchInfo::to.

Referenced by DoDispose(), and DoSetWifiMac().

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

◆ RegisterListener()

void ns3::AdvancedEmlsrManager::RegisterListener ( Ptr< WifiPhy > phy)
protected

Register a PHY listener so that this EMLSR Manager is notified of PHY events generated by the given PHY.

Parameters
phythe PHY which a listener is connected to

Definition at line 248 of file advanced-emlsr-manager.cc.

References ns3::WifiPhy::GetPhyId(), m_auxPhyWithListener, m_phyListener, NS_ASSERT_MSG, and NS_LOG_FUNCTION.

Referenced by DoNotifyTxopEnd(), SwitchMainPhyIfTxopGainedByAuxPhy(), and SwitchMainPhyIfTxopToBeGainedByAuxPhy().

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

◆ RequestMainPhyToSwitch()

bool ns3::AdvancedEmlsrManager::RequestMainPhyToSwitch ( uint8_t linkId,
AcIndex aci,
const Time & delay )
protected

Determine whether the main PHY shall be requested to switch to the link of an aux PHY that is expected to gain channel access through the given AC in the given delay but it is not TX capable.

Parameters
linkIdthe ID of the link on which the aux PHY is operating
acithe index of the given AC
delaythe delay after which the given AC is expected to gain channel access. Zero indicates that channel access has been actually gained
Returns
whether the main PHY shall be requested to switch to the link of the aux PHY

Definition at line 743 of file advanced-emlsr-manager.cc.

References ns3::Time::As(), ns3::CCA_BUSY, ns3::EmlsrManager::MainPhySwitchInfo::disconnected, ns3::EmlsrManager::GetChannelForAuxPhy(), ns3::EmlsrManager::GetChannelForMainPhy(), ns3::EmlsrManager::GetElapsedMediumSyncDelayTimer(), ns3::EmlsrManager::GetMediumSyncDuration(), ns3::EmlsrManager::GetStaMac(), ns3::IDLE, ns3::EventId::IsPending(), m_ccaLastPifs, m_checkAccessOnMainPhyLink, m_interruptSwitching, ns3::EmlsrManager::m_mainPhyId, ns3::EmlsrManager::m_mainPhySwitchInfo, m_minAcToSkipCheckAccess, m_switchMainPhyBackDelay, m_switchMainPhyBackEvent, m_useAuxPhyCca, ns3::EmlsrManager::MediumSyncDelayNTxopsExceeded(), ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::EmlsrManager::MainPhySwitchInfo::reason, ns3::RX, ns3::SWITCHING, ns3::Time::US, and ns3::wifiAcList.

Referenced by SwitchMainPhyIfTxopGainedByAuxPhy(), and SwitchMainPhyIfTxopToBeGainedByAuxPhy().

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

◆ SwitchMainPhyBackDelayExpired()

void ns3::AdvancedEmlsrManager::SwitchMainPhyBackDelayExpired ( uint8_t linkId,
std::optional< WifiExpectedAccessReason > stopReason )
protected

This method is called when the switch main PHY back timer (which is started when the main PHY switches to the link of an aux PHY that does not switch and is not TX capable) expires and decides whether to delay the request to switch the main PHY back to the preferred link or to execute it immediately.

This method can also be called to terminate a running switch main PHY back timer, in case it is determined that channel access is not expected to be gained before the expiration of the timer plus the channel switch delay.

Parameters
linkIdthe ID of the link that the main PHY is leaving
stopReasonthe reason for terminating the switch main PHY back timer before expiration

Definition at line 585 of file advanced-emlsr-manager.cc.

References ns3::ACCESS_EXPECTED, ns3::EventId::Cancel(), ns3::EmlsrManager::CheckPossiblyReceivingIcf(), ns3::EmlsrManager::GetEhtFem(), ns3::EmlsrManager::GetMainPhyId(), ns3::EmlsrManager::GetStaMac(), ns3::EventImpl::Invoke(), ns3::EventId::IsPending(), ns3::LOG_FUNCTION, m_ccaLastPifs, ns3::EmlsrManager::m_mainPhySwitchInfo, ns3::DefaultEmlsrManager::m_switchAuxPhy, m_switchMainPhyBackEvent, Max, ns3::Simulator::Now(), NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::EventId::PeekEventImpl(), ns3::Simulator::Schedule(), ns3::EmlsrManager::MainPhySwitchInfo::start, SwitchMainPhyBackDelayExpired(), SwitchMainPhyBackToPreferredLink(), UnregisterListener(), and ns3::Time::US.

Referenced by CheckNavAndCcaLastPifs(), DoNotifyTxopEnd(), InterruptSwitchMainPhyBackTimerIfNeeded(), SwitchMainPhyBackDelayExpired(), SwitchMainPhyIfTxopGainedByAuxPhy(), and SwitchMainPhyIfTxopToBeGainedByAuxPhy().

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

◆ SwitchMainPhyBackToPreferredLink()

void ns3::AdvancedEmlsrManager::SwitchMainPhyBackToPreferredLink ( uint8_t linkId,
EmlsrMainPhySwitchTrace && traceInfo )
overrideprotectedvirtual

This method can only be called when aux PHYs do not switch link.

Switch the main PHY back to the preferred link and reconnect the aux PHY that was operating on the link left by the main PHY.

Parameters
linkIdthe ID of the link that the main PHY is leaving
traceInfoinformation to pass to the main PHY switch traced callback (the fromLinkId and toLinkId fields are set by SwitchMainPhy)

Reimplemented from ns3::DefaultEmlsrManager.

Definition at line 668 of file advanced-emlsr-manager.cc.

References ns3::EmlsrManager::GetMainPhyId(), ns3::DefaultEmlsrManager::m_auxPhyToReconnect, m_interruptSwitching, ns3::DefaultEmlsrManager::m_switchAuxPhy, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, ns3::EmlsrManager::REQUEST_ACCESS, ns3::EmlsrManager::SwitchMainPhy(), and ns3::DefaultEmlsrManager::SwitchMainPhyBackToPreferredLink().

Referenced by SwitchMainPhyBackDelayExpired().

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

◆ SwitchMainPhyIfTxopGainedByAuxPhy()

void ns3::AdvancedEmlsrManager::SwitchMainPhyIfTxopGainedByAuxPhy ( uint8_t linkId,
AcIndex aci )
overrideprotectedvirtual

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

Implements ns3::EmlsrManager.

Definition at line 863 of file advanced-emlsr-manager.cc.

References ns3::EventId::Cancel(), ns3::Txop::CHECK_MEDIUM_BUSY, CheckNavAndCcaLastPifs(), ns3::Txop::DIDNT_HAVE_FRAMES_TO_TRANSMIT, ns3::EmlsrManager::DONT_REQUEST_ACCESS, ns3::EmlsrManager::GetChannelForAuxPhy(), ns3::EmlsrManager::GetChannelForMainPhy(), ns3::Simulator::GetDelayLeft(), ns3::EmlsrManager::GetStaMac(), ns3::EventId::IsPending(), ns3::EmlsrManager::m_auxPhyTxCapable, m_ccaLastPifs, ns3::EmlsrManager::m_mainPhyId, ns3::EmlsrManager::m_mainPhySwitchInfo, ns3::DefaultEmlsrManager::m_switchAuxPhy, m_switchMainPhyBackDelay, m_switchMainPhyBackEvent, m_useAuxPhyCca, Max, ns3::Simulator::Now(), ns3::Time::NS, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, RegisterListener(), RequestMainPhyToSwitch(), ns3::Simulator::Schedule(), ns3::EmlsrManager::SwitchMainPhy(), SwitchMainPhyBackDelayExpired(), and ns3::EmlsrManager::MainPhySwitchInfo::to.

+ Here is the call graph for this function:

◆ SwitchMainPhyIfTxopToBeGainedByAuxPhy()

void ns3::AdvancedEmlsrManager::SwitchMainPhyIfTxopToBeGainedByAuxPhy ( uint8_t linkId,
AcIndex aci,
const Time & delay )
protected

This method is called when the given AC of the EMLSR client is expected to get channel access in the given delay on the given link, on which an aux PHY that is not TX capable is operating.

This method has to decide whether to request the main PHY to switch to the given link to try to start a TXOP.

Parameters
linkIdthe ID of the given link
acithe index of the given AC
delaythe delay after which the given AC is expected to gain channel access

use aux PHY CCA in the last PIFS interval before main PHY switch end 

   Backoff    Switch
     end     end (now)

──────────┴─────────┴────────── |-— PIFS -—|

the remaining backoff time (if any) when the main PHY completes the switch is shorter than or equal to a PIFS, thus the main PHY performs CCA in the last PIFS interval after switch end 

   Switch    Backoff                 Backoff    Switch
  end (now)    end                     end     end (now)

──────────┴─────────┴────────── ──────────┴─────────┴────────── |-— PIFS -—| |-— PIFS -—|

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

References ns3::ACCESS_EXPECTED, ns3::Time::As(), ns3::EventId::Cancel(), CheckNavAndCcaLastPifs(), DoGetDelayUntilAccessRequest(), ns3::EmlsrManager::DONT_REQUEST_ACCESS, ns3::EmlsrManager::GetChannelForAuxPhy(), ns3::EmlsrManager::GetChannelForMainPhy(), ns3::Simulator::GetDelayLeft(), ns3::EmlsrManager::GetEhtFem(), ns3::EmlsrManager::GetStaMac(), ns3::WifiPhyOperatingChannel::GetTotalWidth(), ns3::EventId::IsPending(), ns3::Time::IsStrictlyPositive(), ns3::EmlsrManager::m_auxPhyTxCapable, m_ccaLastPifs, ns3::EmlsrManager::m_mainPhyId, ns3::DefaultEmlsrManager::m_switchAuxPhy, m_switchMainPhyBackDelay, m_switchMainPhyBackEvent, m_useAuxPhyCca, Max, ns3::Simulator::Now(), NS_LOG_DEBUG, NS_LOG_FUNCTION, RegisterListener(), RequestMainPhyToSwitch(), ns3::Simulator::Schedule(), ns3::EmlsrManager::SwitchMainPhy(), SwitchMainPhyBackDelayExpired(), SwitchMainPhyIfTxopToBeGainedByAuxPhy(), and ns3::Time::US.

Referenced by NotifyEmlsrModeChanged(), and SwitchMainPhyIfTxopToBeGainedByAuxPhy().

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

◆ UnregisterListener()

void ns3::AdvancedEmlsrManager::UnregisterListener ( )
protected

Disconnect the PHY listener from the PHY it is connected to (if any)

Definition at line 259 of file advanced-emlsr-manager.cc.

References ns3::WifiPhy::GetPhyId(), m_auxPhyWithListener, m_phyListener, NS_LOG_FUNCTION, and ns3::WifiPhy::UnregisterListener().

Referenced by DoDispose(), DoNotifyDlTxopStart(), DoNotifyUlTxopStart(), and SwitchMainPhyBackDelayExpired().

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

Friends And Related Symbol Documentation

◆ ::EmlsrSwitchMainPhyBackTest

friend class ::EmlsrSwitchMainPhyBackTest
friend

Allow test cases to access private members.

Definition at line 33 of file advanced-emlsr-manager.h.

Member Data Documentation

◆ m_allowUlTxopInRx

bool ns3::AdvancedEmlsrManager::m_allowUlTxopInRx
private

whether a (main or aux) PHY is allowed to start an UL TXOP if another PHY is receiving a PPDU

Definition at line 146 of file advanced-emlsr-manager.h.

Referenced by DoGetDelayUntilAccessRequest(), and GetTypeId().

◆ m_auxPhyWithListener

Ptr<WifiPhy> ns3::AdvancedEmlsrManager::m_auxPhyWithListener
private

aux PHY which a PHY listener is connected to

Definition at line 181 of file advanced-emlsr-manager.h.

Referenced by RegisterListener(), and UnregisterListener().

◆ m_ccaLastPifs

EventId ns3::AdvancedEmlsrManager::m_ccaLastPifs
private

event scheduled in case of non-TX capable aux PHY to determine whether TX can be started based on whether the medium has been idle during the last PIFS interval

Definition at line 171 of file advanced-emlsr-manager.h.

Referenced by CheckNavAndCcaLastPifs(), DoGetDelayUntilAccessRequest(), DoNotifyDlTxopStart(), DoNotifyUlTxopStart(), RequestMainPhyToSwitch(), SwitchMainPhyBackDelayExpired(), SwitchMainPhyIfTxopGainedByAuxPhy(), and SwitchMainPhyIfTxopToBeGainedByAuxPhy().

◆ m_checkAccessOnMainPhyLink

bool ns3::AdvancedEmlsrManager::m_checkAccessOnMainPhyLink
private

in case aux PHYs are not TX capable and an Access Category, say it AC X, is about to gain channel access on an aux PHY link, determine whether the time the ACs with priority higher than or equal to AC X and with frames to send on the main PHY link are expected to gain access on the main PHY link should be taken into account when taking the decision to switch the main PHY to the aux PHY link

Definition at line 160 of file advanced-emlsr-manager.h.

Referenced by GetTypeId(), and RequestMainPhyToSwitch().

◆ m_interruptSwitching

bool ns3::AdvancedEmlsrManager::m_interruptSwitching
private

whether a main PHY switching can be interrupted to start switching to another link

Definition at line 148 of file advanced-emlsr-manager.h.

Referenced by CheckMainPhyTakesOverDlTxop(), DoNotifyTxopEnd(), GetDelayUnlessMainPhyTakesOverUlTxop(), GetTypeId(), RequestMainPhyToSwitch(), and SwitchMainPhyBackToPreferredLink().

◆ m_keepMainPhyAfterDlTxop

bool ns3::AdvancedEmlsrManager::m_keepMainPhyAfterDlTxop
private

whether the main PHY must stay, for a switch main PHY back delay, on an aux PHY link after a DL TXOP, in case aux PHYs are not TX capable and do not switch

Definition at line 157 of file advanced-emlsr-manager.h.

Referenced by DoNotifyTxopEnd(), and GetTypeId().

◆ m_minAcToSkipCheckAccess

AcIndex ns3::AdvancedEmlsrManager::m_minAcToSkipCheckAccess
private

if m_checkAccessOnMainPhyLink is set to false, indicate the minimum priority AC for which it is allowed to skip the check related to the expected channel access time on the main PHY link

Definition at line 167 of file advanced-emlsr-manager.h.

Referenced by GetTypeId(), and RequestMainPhyToSwitch().

◆ m_phyListener

std::shared_ptr<WifiPhyListener> ns3::AdvancedEmlsrManager::m_phyListener
private

PHY listener connected to an aux PHY (that is not TX capable and does not switch link) while the main PHY attempts to gain access on the aux PHY link.

Definition at line 178 of file advanced-emlsr-manager.h.

Referenced by AdvancedEmlsrManager(), DoDispose(), RegisterListener(), and UnregisterListener().

◆ m_switchMainPhyBackDelay

Time ns3::AdvancedEmlsrManager::m_switchMainPhyBackDelay
private

duration of the timer started in case of non-TX capable aux PHY when medium is sensed busy during the PIFS interval preceding/following the main PHY switch end

Definition at line 154 of file advanced-emlsr-manager.h.

Referenced by DoNotifyTxopEnd(), GetTypeId(), RequestMainPhyToSwitch(), SwitchMainPhyIfTxopGainedByAuxPhy(), and SwitchMainPhyIfTxopToBeGainedByAuxPhy().

◆ m_switchMainPhyBackEvent

EventId ns3::AdvancedEmlsrManager::m_switchMainPhyBackEvent
private

event scheduled in case of non-TX capable aux PHY when medium is sensed busy during the PIFS interval preceding/following the main PHY switch end

Definition at line 174 of file advanced-emlsr-manager.h.

Referenced by CheckNavAndCcaLastPifs(), DoNotifyDlTxopStart(), DoNotifyTxopEnd(), DoNotifyUlTxopStart(), InterruptSwitchMainPhyBackTimerIfNeeded(), ReceivedMacHdr(), RequestMainPhyToSwitch(), SwitchMainPhyBackDelayExpired(), SwitchMainPhyIfTxopGainedByAuxPhy(), and SwitchMainPhyIfTxopToBeGainedByAuxPhy().

◆ m_useAuxPhyCca

bool ns3::AdvancedEmlsrManager::m_useAuxPhyCca
private

whether the CCA performed in the last PIFS interval by a non-TX capable aux PHY should be used when the main PHY ends switching to the aux PHY's link to determine whether TX can start or not

Definition at line 150 of file advanced-emlsr-manager.h.

Referenced by GetTypeId(), RequestMainPhyToSwitch(), SwitchMainPhyIfTxopGainedByAuxPhy(), and SwitchMainPhyIfTxopToBeGainedByAuxPhy().

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