A Discrete-Event Network Simulator
API
ChannelAccessManagerStub Class Reference

ChannelAccessManager Stub. More...

+ Inheritance diagram for ChannelAccessManagerStub:
+ Collaboration diagram for ChannelAccessManagerStub:

Public Member Functions

 ChannelAccessManagerStub ()
 
void SetEifsNoDifs (Time eifsNoDifs)
 Set the duration of EIFS - DIFS. More...
 
void SetSifs (Time sifs)
 Set the Short Interframe Space (SIFS). More...
 
void SetSlot (Time slot)
 Set the slot duration. More...
 
- Public Member Functions inherited from ns3::ChannelAccessManager
 ChannelAccessManager ()
 
 ~ChannelAccessManager () override
 
void Add (Ptr< Txop > txop)
 
void DeactivatePhyListener (Ptr< WifiPhy > phy)
 Deactivate current registered listener for PHY events on the given PHY. More...
 
void DisableEdcaFor (Ptr< Txop > qosTxop, Time duration)
 
Time GetAccessGrantStart (bool ignoreNav=false) const
 Access will never be granted to the medium before the time returned by this method. More...
 
bool GetGenerateBackoffOnNoTx () const
 
uint16_t GetLargestIdlePrimaryChannel (Time interval, Time end)
 Return the width of the largest primary channel that has been idle for the given time interval before the given time, if any primary channel has been idle, or zero, otherwise. More...
 
bool GetPer20MHzBusy (const std::set< uint8_t > &indices) const
 
bool IsBusy () const
 Check if the device is busy sending or receiving, or NAV or CCA busy. More...
 
bool NeedBackoffUponAccess (Ptr< Txop > txop, bool hadFramesToTransmit, bool checkMediumBusy)
 Determine if a new backoff needs to be generated as per letter a) of Section 10.23.2.2 of IEEE 802.11-2020 ("EDCA backoff procedure"). More...
 
void NotifyAckTimeoutResetNow ()
 Notify that ack timer has reset. More...
 
void NotifyAckTimeoutStartNow (Time duration)
 Notify that ack timer has started for the given duration. More...
 
void NotifyCcaBusyStartNow (Time duration, WifiChannelListType channelType, const std::vector< Time > &per20MhzDurations)
 
void NotifyCtsTimeoutResetNow ()
 Notify that CTS timer has reset. More...
 
void NotifyCtsTimeoutStartNow (Time duration)
 Notify that CTS timer has started for the given duration. More...
 
void NotifyNavResetNow (Time duration)
 
void NotifyNavStartNow (Time duration)
 
void NotifyOffNow ()
 Notify the Txop that the device has been put in off mode. More...
 
void NotifyOnNow ()
 Notify the Txop that the device has been resumed from off mode. More...
 
void NotifyRxEndErrorNow ()
 Notify the Txop that a packet reception was just completed unsuccessfuly. More...
 
void NotifyRxEndOkNow ()
 Notify the Txop that a packet reception was just completed successfully. More...
 
void NotifyRxStartNow (Time duration)
 
void NotifySleepNow ()
 Notify the Txop that the device has been put in sleep mode. More...
 
void NotifyStartUsingOtherEmlsrLink ()
 Notify that another EMLSR link is being used, hence medium access should be disabled. More...
 
void NotifyStopUsingOtherEmlsrLink ()
 Notify that another EMLSR link is no longer being used, hence medium access can be resumed. More...
 
void NotifySwitchingEmlsrLink (Ptr< WifiPhy > phy, const WifiPhyOperatingChannel &channel, uint8_t linkId)
 Notify that the given PHY is about to switch to the given operating channel, which is used by the given link. More...
 
void NotifySwitchingStartNow (PhyListener *phyListener, Time duration)
 
void NotifyTxStartNow (Time duration)
 
void NotifyWakeupNow ()
 Notify the Txop that the device has been resumed from sleep mode. More...
 
void RemovePhyListener (Ptr< WifiPhy > phy)
 Remove current registered listener for PHY events on the given PHY. More...
 
void RequestAccess (Ptr< Txop > txop)
 
void ResetAllBackoffs ()
 Reset the backoff for all the DCF/EDCAF. More...
 
void ResetBackoff (Ptr< Txop > txop)
 Reset the backoff for the given DCF/EDCAF. More...
 
void ResetState ()
 Reset the state variables of this channel access manager. More...
 
void SetGenerateBackoffOnNoTx (bool enable)
 Set the member variable indicating whether the backoff should be invoked when an AC gains the right to start a TXOP but it does not transmit any frame (e.g., due to constraints associated with EMLSR operations), provided that the queue is not actually empty. More...
 
void SetLinkId (uint8_t linkId)
 Set the ID of the link this Channel Access Manager is associated with. More...
 
void SetupFrameExchangeManager (Ptr< FrameExchangeManager > feManager)
 Set up the Frame Exchange Manager. More...
 
void SetupPhyListener (Ptr< WifiPhy > phy)
 Set up (or reactivate) listener for PHY events on the given PHY. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Private Member Functions

Time GetEifsNoDifs () const override
 Return the EIFS duration minus a DIFS. More...
 
Time GetSifs () const override
 Return the Short Interframe Space (SIFS) for this PHY. More...
 
Time GetSlot () const override
 Return the slot duration for this PHY. More...
 

Private Attributes

Time m_eifsNoDifs
 EIFS duration minus a DIFS. More...
 
Time m_sifs
 SIFS duration. More...
 
Time m_slot
 slot duration More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ns3::ChannelAccessManager
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Protected Member Functions inherited from ns3::ChannelAccessManager
void DoDispose () override
 Destructor implementation. More...
 
void DoInitialize () override
 Initialize() implementation. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes. More...
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed. More...
 

Detailed Description

ChannelAccessManager Stub.

Definition at line 111 of file channel-access-manager-test.cc.

Constructor & Destructor Documentation

◆ ChannelAccessManagerStub()

ChannelAccessManagerStub::ChannelAccessManagerStub ( )
inline

Definition at line 114 of file channel-access-manager-test.cc.

Member Function Documentation

◆ GetEifsNoDifs()

Time ChannelAccessManagerStub::GetEifsNoDifs ( ) const
inlineoverrideprivatevirtual

Return the EIFS duration minus a DIFS.

Returns
the EIFS duration minus a DIFS

Reimplemented from ns3::ChannelAccessManager.

Definition at line 159 of file channel-access-manager-test.cc.

◆ GetSifs()

Time ChannelAccessManagerStub::GetSifs ( ) const
inlineoverrideprivatevirtual

Return the Short Interframe Space (SIFS) for this PHY.

Returns
the SIFS duration

Reimplemented from ns3::ChannelAccessManager.

Definition at line 149 of file channel-access-manager-test.cc.

◆ GetSlot()

Time ChannelAccessManagerStub::GetSlot ( ) const
inlineoverrideprivatevirtual

Return the slot duration for this PHY.

Returns
the slot duration

Reimplemented from ns3::ChannelAccessManager.

Definition at line 154 of file channel-access-manager-test.cc.

◆ SetEifsNoDifs()

void ChannelAccessManagerStub::SetEifsNoDifs ( Time  eifsNoDifs)
inline

Set the duration of EIFS - DIFS.

Parameters
eifsNoDifsthe duration of EIFS - DIFS

Definition at line 143 of file channel-access-manager-test.cc.

◆ SetSifs()

void ChannelAccessManagerStub::SetSifs ( Time  sifs)
inline

Set the Short Interframe Space (SIFS).

Parameters
sifsthe SIFS duration

Definition at line 123 of file channel-access-manager-test.cc.

◆ SetSlot()

void ChannelAccessManagerStub::SetSlot ( Time  slot)
inline

Set the slot duration.

Parameters
slotthe slot duration

Definition at line 133 of file channel-access-manager-test.cc.

Member Data Documentation

◆ m_eifsNoDifs

Time ChannelAccessManagerStub::m_eifsNoDifs
private

EIFS duration minus a DIFS.

Definition at line 166 of file channel-access-manager-test.cc.

◆ m_sifs

Time ChannelAccessManagerStub::m_sifs
private

SIFS duration.

Definition at line 165 of file channel-access-manager-test.cc.

◆ m_slot

Time ChannelAccessManagerStub::m_slot
private

slot duration

Definition at line 164 of file channel-access-manager-test.cc.


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