DefaultEmlsrManager is the default EMLSR manager. More...
#include "default-emlsr-manager.h"
Classes | |
struct | MainPhySwitchInfo |
Store information about a main PHY switch. More... | |
Public Member Functions | |
DefaultEmlsrManager () | |
~DefaultEmlsrManager () override | |
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. | |
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 | NotifyIcfReceived (uint8_t linkId) |
Notify the reception of an initial Control frame on the given link. | |
void | NotifyMgtFrameReceived (Ptr< const WifiMpdu > mpdu, uint8_t linkId) |
Notify the reception of a management frame addressed to us. | |
void | NotifyTxopEnd (uint8_t linkId, 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 override |
Get the most derived TypeId for this Object. | |
template<typename T > | |
Ptr< T > | GetObject () const |
Get a pointer to the requested aggregated Object. | |
template<> | |
Ptr< 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::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 | |
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. | |
std::optional< uint8_t > | ResendNotification (Ptr< const WifiMpdu > mpdu) override |
A previous EML Operating Mode Notification frame was dropped. | |
void | SwitchMainPhyBackToPrimaryLink (uint8_t linkId) |
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. | |
Protected Member Functions inherited from ns3::EmlsrManager | |
void | DoDispose () override |
Destructor implementation. | |
virtual void | DoSetWifiMac (Ptr< StaWifiMac > mac) |
Allow subclasses to take actions when the MAC is set. | |
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 | 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) |
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. | |
Protected Attributes | |
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. | |
bool | m_auxPhyToSleep |
whether Aux PHY should be put into sleep mode while the Main PHY is operating on the same link as the Aux PHY | |
EventId | m_auxPhyToSleepEvent |
the event scheduled to put an Aux PHY into sleep mode | |
MainPhySwitchInfo | m_mainPhySwitchInfo |
main PHY switch info | |
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_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) | |
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 | |
Private Member Functions | |
void | DoNotifyIcfReceived (uint8_t linkId) override |
Notify the subclass of the reception of an initial Control frame on the given link. | |
void | DoNotifyMgtFrameReceived (Ptr< const WifiMpdu > mpdu, uint8_t linkId) override |
Notify the subclass of the reception of a management frame addressed to us. | |
void | DoNotifyTxopEnd (uint8_t linkId) 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. | |
void | NotifyEmlsrModeChanged () override |
Notify subclass that EMLSR mode changed. | |
void | NotifyMainPhySwitch (std::optional< uint8_t > currLinkId, uint8_t nextLinkId, Time duration) override |
Notify subclass that the main PHY is switching channel to operate on another link. | |
Additional Inherited Members | |
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 | 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 | |
Related Symbols inherited from ns3::ObjectBase | |
static TypeId | GetObjectIid () |
Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. | |
DefaultEmlsrManager is the default EMLSR manager.
Definition at line 24 of file default-emlsr-manager.h.
ns3::DefaultEmlsrManager::DefaultEmlsrManager | ( | ) |
Definition at line 55 of file default-emlsr-manager.cc.
References NS_LOG_FUNCTION.
|
override |
Definition at line 61 of file default-emlsr-manager.cc.
References NS_LOG_FUNCTION_NOARGS.
|
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.
linkId | the ID of the given link |
Implements ns3::EmlsrManager.
Definition at line 175 of file default-emlsr-manager.cc.
References NS_LOG_FUNCTION.
|
overrideprivatevirtual |
Notify the subclass of the reception of an initial Control frame on the given link.
linkId | the ID of the link on which the initial Control frame was received |
Implements ns3::EmlsrManager.
Definition at line 182 of file default-emlsr-manager.cc.
References NS_LOG_FUNCTION.
|
overrideprivatevirtual |
Notify the subclass of the reception of a management frame addressed to us.
mpdu | the received MPDU |
linkId | the ID of the link over which the MPDU was received |
Implements ns3::EmlsrManager.
Definition at line 67 of file default-emlsr-manager.cc.
References NS_LOG_FUNCTION.
|
overrideprivatevirtual |
Notify the subclass of the end of a TXOP on the given link.
linkId | the ID of the given link |
Implements ns3::EmlsrManager.
Definition at line 194 of file default-emlsr-manager.cc.
References m_switchAuxPhy, NS_LOG_FUNCTION, and SwitchMainPhyBackToPrimaryLink().
|
overrideprivatevirtual |
Notify the subclass of the start of an UL TXOP on the given link.
linkId | the ID of the given link |
Implements ns3::EmlsrManager.
Definition at line 188 of file default-emlsr-manager.cc.
References NS_LOG_FUNCTION.
|
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.
linkId | the ID of the given link |
Implements ns3::EmlsrManager.
Definition at line 275 of file default-emlsr-manager.cc.
References NS_ABORT_MSG, NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.
|
overrideprotectedvirtual |
Implements ns3::EmlsrManager.
Definition at line 73 of file default-emlsr-manager.cc.
References ns3::EmlsrManager::GetStaMac(), ns3::EmlsrManager::m_mainPhyId, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
|
protected |
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.
linkId | the ID of the given link |
Definition at line 252 of file default-emlsr-manager.cc.
References ns3::GetCtsSize(), ns3::GetRtsSize(), ns3::MicroSeconds(), NS_ASSERT_MSG, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 29 of file default-emlsr-manager.cc.
References m_auxPhyToSleep, m_switchAuxPhy, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), and ns3::TypeId::SetParent().
|
overrideprivatevirtual |
Notify subclass that EMLSR mode changed.
Implements ns3::EmlsrManager.
Definition at line 91 of file default-emlsr-manager.cc.
References NS_LOG_FUNCTION.
|
overrideprivatevirtual |
Notify subclass that the main PHY is switching channel to operate on another link.
currLinkId | the ID of the link on which the main PHY is operating (if any) |
nextLinkId | the ID of the link on which the main PHY will be operating |
duration | the channel switch duration |
Implements ns3::EmlsrManager.
Definition at line 97 of file default-emlsr-manager.cc.
References ns3::Time::As(), ns3::EventId::Cancel(), ns3::DefaultEmlsrManager::MainPhySwitchInfo::end, ns3::DefaultEmlsrManager::MainPhySwitchInfo::from, ns3::EmlsrManager::GetMainPhyId(), ns3::EmlsrManager::GetStaMac(), m_auxPhySwitchEvent, m_auxPhyToReconnect, m_auxPhyToSleep, m_auxPhyToSleepEvent, m_mainPhySwitchInfo, m_switchAuxPhy, ns3::Simulator::Now(), NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::WifiPhy::ResumeFromSleep(), ns3::Simulator::Schedule(), ns3::Seconds(), ns3::EmlsrManager::SetCcaEdThresholdOnLinkSwitch(), ns3::WifiPhy::SetSleepMode(), and ns3::Time::US.
|
overrideprotectedvirtual |
A previous EML Operating Mode Notification frame was dropped.
Ask the subclass whether the frame needs to be re-sent on the given link (if any).
mpdu | the dropped MPDU that includes the EML Operating Mode Notification frame |
Implements ns3::EmlsrManager.
Definition at line 82 of file default-emlsr-manager.cc.
References ns3::EmlsrManager::GetStaMac(), ns3::EmlsrManager::m_mainPhyId, NS_ASSERT_MSG, and NS_LOG_FUNCTION.
|
protected |
This method can only be called when aux PHYs do not switch link.
Switch the main PHY back to the primary link and reconnect the aux PHY that was operating on the link left by the main PHY.
linkId | the ID of the link that the main PHY is leaving |
Definition at line 206 of file default-emlsr-manager.cc.
References ns3::EventId::Cancel(), ns3::EmlsrManager::DONT_RESET_BACKOFF, ns3::EmlsrManager::GetMainPhyId(), ns3::EmlsrManager::GetStaMac(), m_auxPhyToReconnect, m_auxPhyToSleepEvent, ns3::EmlsrManager::m_mainPhyId, m_switchAuxPhy, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, ns3::EmlsrManager::REQUEST_ACCESS, ns3::Simulator::Schedule(), and ns3::EmlsrManager::SwitchMainPhy().
Referenced by DoNotifyTxopEnd().
|
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.
linkId | the ID of the given link |
aci | the index of the given AC |
Implements ns3::EmlsrManager.
Definition at line 245 of file default-emlsr-manager.cc.
References NS_LOG_DEBUG, and NS_LOG_FUNCTION.
|
protected |
event scheduled for an aux PHY to switch link
Definition at line 76 of file default-emlsr-manager.h.
Referenced by NotifyMainPhySwitch().
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.
Definition at line 73 of file default-emlsr-manager.h.
Referenced by ns3::AdvancedEmlsrManager::DoNotifyTxopEnd(), NotifyMainPhySwitch(), and SwitchMainPhyBackToPrimaryLink().
|
protected |
whether Aux PHY should be put into sleep mode while the Main PHY is operating on the same link as the Aux PHY
Definition at line 70 of file default-emlsr-manager.h.
Referenced by GetTypeId(), and NotifyMainPhySwitch().
|
protected |
the event scheduled to put an Aux PHY into sleep mode
Definition at line 72 of file default-emlsr-manager.h.
Referenced by ns3::AdvancedEmlsrManager::DoNotifyTxopEnd(), NotifyMainPhySwitch(), and SwitchMainPhyBackToPrimaryLink().
|
protected |
main PHY switch info
Definition at line 77 of file default-emlsr-manager.h.
Referenced by ns3::AdvancedEmlsrManager::DoNotifyTxopEnd(), and NotifyMainPhySwitch().
|
protected |
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
Definition at line 68 of file default-emlsr-manager.h.
Referenced by ns3::AdvancedEmlsrManager::DoNotifyTxopEnd(), DoNotifyTxopEnd(), GetTypeId(), NotifyMainPhySwitch(), and SwitchMainPhyBackToPrimaryLink().