A Discrete-Event Network Simulator
API
ns3::MultiUserScheduler Class Referenceabstract

MultiUserScheduler is an abstract base class defining the API that APs supporting at least VHT can use to determine the format of their next transmission. More...

#include "multi-user-scheduler.h"

+ Inheritance diagram for ns3::MultiUserScheduler:
+ Collaboration diagram for ns3::MultiUserScheduler:

Classes

struct  DlMuInfo
 Information to be provided in case of DL MU transmission. More...
 
struct  UlMuInfo
 Information to be provided in case of UL MU transmission. More...
 

Public Types

enum  TxFormat { NO_TX = 0 , SU_TX , DL_MU_TX , UL_MU_TX }
 Enumeration of the possible transmission formats. More...
 

Public Member Functions

 MultiUserScheduler ()
 
virtual ~MultiUserScheduler ()
 
DlMuInfoGetDlMuInfo (void)
 Get the information required to perform a DL MU transmission. More...
 
UlMuInfoGetUlMuInfo (void)
 Get the information required to solicit an UL MU transmission. More...
 
TxFormat NotifyAccessGranted (Ptr< QosTxop > edca, Time availableTime, bool initialFrame)
 Notify the Multi-user Scheduler that the given AC of the AP gained channel access. More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
virtual ~Object ()
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose (void)
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator (void) const
 Get an iterator to the Objects aggregated to this one. More...
 
virtual TypeId GetInstanceTypeId (void) const
 Get the most derived TypeId for this 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...
 
template<typename T >
Ptr< T > GetObject (void) const
 Get a pointer to the requested aggregated Object. More...
 
void Initialize (void)
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized (void) 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)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator. More...
 
void Ref (void) const
 Increment the reference count. More...
 
void Unref (void) 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 erros. More...
 
virtual TypeId GetInstanceTypeId (void) const =0
 Get the most derived TypeId for this Object. 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...
 

Static Public Member Functions

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

Protected Member Functions

void DoDispose (void) override
 Destructor implementation. More...
 
void DoInitialize (void) override
 Initialize() implementation. More...
 
TxFormat GetLastTxFormat (void) const
 Get the format of the last transmission, as determined by the last call to NotifyAccessGranted that did not return NO_TX. More...
 
uint32_t GetMaxSizeOfQosNullAmpdu (const CtrlTriggerHeader &trigger) const
 Get the maximum size in bytes among the A-MPDUs containing QoS Null frames and solicited by the given (BSRP) Trigger Frame. More...
 
Ptr< WifiMacQueueItemGetTriggerFrame (const CtrlTriggerHeader &trigger) const
 Get an MPDU containing the given Trigger Frame. More...
 
Ptr< WifiRemoteStationManagerGetWifiRemoteStationManager (void) const
 Get the station manager attached to the AP. More...
 
void NotifyNewAggregate (void) override
 Notify all Objects aggregated to this one of a new Object being aggregated. More...
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object. More...
 
virtual void DoDispose (void)
 Destructor implementation. More...
 
virtual void DoInitialize (void)
 Initialize() implementation. More...
 
virtual void NotifyNewAggregate (void)
 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 (void)
 Notifier called once the ObjectBase is fully constructed. More...
 

Protected Attributes

Ptr< ApWifiMacm_apMac
 the AP wifi MAC More...
 
Time m_availableTime
 the time available for frame exchange More...
 
Ptr< QosTxopm_edca
 the AC that gained channel access More...
 
Ptr< HeFrameExchangeManagerm_heFem
 HE Frame Exchange Manager. More...
 
bool m_initialFrame
 true if a TXOP is being started More...
 

Private Member Functions

void AccessReqTimeout (void)
 Perform actions required on expiration of the channel access request timer, such as requesting channel access (if not requested already) and restarting the channel access request timer. More...
 
void CheckTriggerFrame (void)
 Ensure that the Trigger Frame returned in case of UL MU transmission is correct. More...
 
virtual DlMuInfo ComputeDlMuInfo (void)=0
 Compute the information required to perform a DL MU transmission. More...
 
virtual UlMuInfo ComputeUlMuInfo (void)=0
 Prepare the information required to solicit an UL MU transmission. More...
 
virtual TxFormat SelectTxFormat (void)=0
 Select the format of the next transmission. More...
 
void SetWifiMac (Ptr< ApWifiMac > mac)
 Set the wifi MAC. More...
 

Private Attributes

AcIndex m_accessReqAc
 AC we request channel access for. More...
 
Time m_accessReqInterval
 duration of the interval between channel access requests More...
 
EventId m_accessReqTimer
 the timer controlling additional channel access requests More...
 
DlMuInfo m_dlInfo
 information required to perform a DL MU transmission More...
 
TxFormat m_lastTxFormat {NO_TX}
 the format of last transmission More...
 
bool m_restartTimerUponAccess
 whether the channel access timer has to be restarted upon channel access More...
 
UlMuInfo m_ulInfo
 information required to solicit an UL MU transmission More...
 

Additional Inherited Members

Detailed Description

MultiUserScheduler is an abstract base class defining the API that APs supporting at least VHT can use to determine the format of their next transmission.

Introspection did not find any typical Config paths.

VHT APs can only transmit DL MU PPDUs by using MU-MIMO, while HE APs can transmit both DL MU PPDUs and UL MU PPDUs by using OFDMA in addition to MU-MIMO.

However, given that DL MU-MIMO is not yet supported, a MultiUserScheduler can only be aggregated to HE APs.


Attributes

  • AccessReqInterval: Duration of the interval between two consecutive requests for channel access made by the MultiUserScheduler. Such requests are made independently of the presence of frames in the queues of the AP and are intended to allow the AP to coordinate UL MU transmissions even without DL traffic. A null duration indicates that such requests shall not be made.
    • Set with class: ns3::TimeValue
    • Underlying type: Time +9.22337e+18ns:+9.22337e+18ns
    • Initial value: +0ns
    • Flags: construct write read
  • AccessReqAc: The Access Category for which the MultiUserScheduler makes requests for channel access.
    • Set with class: ns3::EnumValue
    • Underlying type:
    • Initial value: AC_BE
    • Flags: construct write read
  • DelayAccessReqUponAccess: If enabled, the access request interval is measured starting from the last time an EDCA function obtained channel access. Otherwise, the access request interval is measured starting from the last time the MultiUserScheduler made a request for channel access.
    • Set with class: BooleanValue
    • Underlying type: bool
    • Initial value: true
    • Flags: construct write read

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

Definition at line 50 of file multi-user-scheduler.h.

Member Enumeration Documentation

◆ TxFormat

Enumeration of the possible transmission formats.

Enumerator
NO_TX 
SU_TX 
DL_MU_TX 
UL_MU_TX 

Definition at line 62 of file multi-user-scheduler.h.

Constructor & Destructor Documentation

◆ MultiUserScheduler()

ns3::MultiUserScheduler::MultiUserScheduler ( )

Definition at line 75 of file multi-user-scheduler.cc.

◆ ~MultiUserScheduler()

ns3::MultiUserScheduler::~MultiUserScheduler ( )
virtual

Definition at line 79 of file multi-user-scheduler.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ AccessReqTimeout()

void ns3::MultiUserScheduler::AccessReqTimeout ( void  )
private

Perform actions required on expiration of the channel access request timer, such as requesting channel access (if not requested already) and restarting the channel access request timer.

Definition at line 148 of file multi-user-scheduler.cc.

References AccessReqTimeout(), m_accessReqAc, m_accessReqInterval, m_accessReqTimer, m_apMac, ns3::Txop::NOT_REQUESTED, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::SINGLE_LINK_OP_ID.

Referenced by AccessReqTimeout(), DoInitialize(), and NotifyAccessGranted().

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

◆ CheckTriggerFrame()

void ns3::MultiUserScheduler::CheckTriggerFrame ( void  )
private

Ensure that the Trigger Frame returned in case of UL MU transmission is correct.

Currently, this method sets the CS Required, the AP Tx Power and the UL Target Receive Power subfields.

Definition at line 259 of file multi-user-scheduler.cc.

References ns3::CtrlTriggerHeader::GetUlLength(), m_heFem, m_ulInfo, NS_LOG_FUNCTION, ns3::CtrlTriggerHeader::SetCsRequired(), and ns3::MultiUserScheduler::UlMuInfo::trigger.

Referenced by NotifyAccessGranted().

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

◆ ComputeDlMuInfo()

virtual DlMuInfo ns3::MultiUserScheduler::ComputeDlMuInfo ( void  )
privatepure virtual

Compute the information required to perform a DL MU transmission.

Returns
the information required to perform a DL MU transmission

Implemented in ns3::RrMultiUserScheduler, and TestMultiUserScheduler.

Referenced by NotifyAccessGranted().

+ Here is the caller graph for this function:

◆ ComputeUlMuInfo()

virtual UlMuInfo ns3::MultiUserScheduler::ComputeUlMuInfo ( void  )
privatepure virtual

Prepare the information required to solicit an UL MU transmission.

Returns
the information required to solicit an UL MU transmission

Implemented in ns3::RrMultiUserScheduler, and TestMultiUserScheduler.

Referenced by NotifyAccessGranted().

+ Here is the caller graph for this function:

◆ DoDispose()

void ns3::MultiUserScheduler::DoDispose ( void  )
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.

Reimplemented in ns3::RrMultiUserScheduler.

Definition at line 85 of file multi-user-scheduler.cc.

References ns3::EventId::Cancel(), ns3::WifiTxParameters::Clear(), ns3::Object::DoDispose(), m_accessReqTimer, m_apMac, m_dlInfo, m_edca, m_heFem, m_ulInfo, NS_LOG_FUNCTION, ns3::MultiUserScheduler::DlMuInfo::psduMap, ns3::MultiUserScheduler::DlMuInfo::txParams, and ns3::MultiUserScheduler::UlMuInfo::txParams.

Referenced by ns3::RrMultiUserScheduler::DoDispose().

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

◆ DoInitialize()

void ns3::MultiUserScheduler::DoInitialize ( void  )
overrideprotectedvirtual

Initialize() implementation.

This method is called only once by Initialize(). If the user calls Initialize() multiple times, DoInitialize() is called only the first time.

Subclasses are expected to override this method and chain up to their parent's implementation once they are done. It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Reimplemented in ns3::RrMultiUserScheduler.

Definition at line 116 of file multi-user-scheduler.cc.

References AccessReqTimeout(), ns3::Time::IsStrictlyPositive(), m_accessReqInterval, m_accessReqTimer, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

Referenced by ns3::RrMultiUserScheduler::DoInitialize().

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

◆ GetDlMuInfo()

MultiUserScheduler::DlMuInfo & ns3::MultiUserScheduler::GetDlMuInfo ( void  )

Get the information required to perform a DL MU transmission.

Note that this method can only be called if GetTxFormat returns DL_MU_TX.

Returns
the information required to perform a DL MU transmission

Definition at line 208 of file multi-user-scheduler.cc.

References DL_MU_TX, GetWifiRemoteStationManager(), m_dlInfo, m_lastTxFormat, NS_ABORT_MSG_IF, and ns3::MultiUserScheduler::DlMuInfo::psduMap.

+ Here is the call graph for this function:

◆ GetLastTxFormat()

MultiUserScheduler::TxFormat ns3::MultiUserScheduler::GetLastTxFormat ( void  ) const
protected

Get the format of the last transmission, as determined by the last call to NotifyAccessGranted that did not return NO_TX.

Returns
the format of the last transmission

Definition at line 202 of file multi-user-scheduler.cc.

References m_lastTxFormat.

Referenced by ns3::RrMultiUserScheduler::SelectTxFormat().

+ Here is the caller graph for this function:

◆ GetMaxSizeOfQosNullAmpdu()

uint32_t ns3::MultiUserScheduler::GetMaxSizeOfQosNullAmpdu ( const CtrlTriggerHeader trigger) const
protected

Get the maximum size in bytes among the A-MPDUs containing QoS Null frames and solicited by the given (BSRP) Trigger Frame.

For each station addressed by the Trigger Frame, the expected response is an A-MPDU containing as many QoS Null frames as the number of TIDs for which a BlockAck agreement has been established between the station and the AP.

Parameters
triggerthe given Trigger Frame
Returns
the maximum size in bytes among the A-MPDUs containing QoS Null frames and solicited by the given Trigger Frame

Definition at line 271 of file multi-user-scheduler.cc.

References ns3::WifiMacHeader::GetSerializedSize(), ns3::MpduAggregator::GetSizeIfAggregated(), m_apMac, m_heFem, max, NS_ASSERT, ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsTo(), ns3::WIFI_MAC_FCS_LENGTH, and ns3::WIFI_MAC_QOSDATA_NULL.

Referenced by TestMultiUserScheduler::SelectTxFormat(), and ns3::RrMultiUserScheduler::TrySendingBsrpTf().

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

◆ GetTriggerFrame()

Ptr< WifiMacQueueItem > ns3::MultiUserScheduler::GetTriggerFrame ( const CtrlTriggerHeader trigger) const
protected

Get an MPDU containing the given Trigger Frame.

Parameters
triggerthe given Trigger Frame
Returns
an MPDU containing the given Trigger Frame

Definition at line 233 of file multi-user-scheduler.cc.

References ns3::Packet::AddHeader(), ns3::CtrlTriggerHeader::begin(), ns3::Mac48Address::GetBroadcast(), ns3::CtrlTriggerHeader::GetNUserInfoFields(), m_apMac, NS_ASSERT, NS_LOG_FUNCTION, ns3::WifiMacHeader::SetAddr1(), ns3::WifiMacHeader::SetAddr2(), ns3::WifiMacHeader::SetDsNotFrom(), ns3::WifiMacHeader::SetDsNotTo(), and ns3::WIFI_MAC_CTL_TRIGGER.

Referenced by ns3::RrMultiUserScheduler::TrySendingBasicTf(), and ns3::RrMultiUserScheduler::TrySendingBsrpTf().

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

◆ GetTypeId()

TypeId ns3::MultiUserScheduler::GetTypeId ( void  )
static

◆ GetUlMuInfo()

MultiUserScheduler::UlMuInfo & ns3::MultiUserScheduler::GetUlMuInfo ( void  )

Get the information required to solicit an UL MU transmission.

Note that this method can only be called if GetTxFormat returns UL_MU_TX.

Returns
the information required to solicit an UL MU transmission

Definition at line 225 of file multi-user-scheduler.cc.

References m_lastTxFormat, m_ulInfo, NS_ABORT_MSG_IF, and UL_MU_TX.

◆ GetWifiRemoteStationManager()

Ptr< WifiRemoteStationManager > ns3::MultiUserScheduler::GetWifiRemoteStationManager ( void  ) const
protected

◆ NotifyAccessGranted()

MultiUserScheduler::TxFormat ns3::MultiUserScheduler::NotifyAccessGranted ( Ptr< QosTxop edca,
Time  availableTime,
bool  initialFrame 
)

Notify the Multi-user Scheduler that the given AC of the AP gained channel access.

The Multi-user Scheduler determines the format of the next transmission.

Parameters
edcathe EDCAF which has been granted the opportunity to transmit
availableTimethe amount of time allowed for the frame exchange. Pass Time::Min() in case the TXOP limit is null
initialFrametrue if the frame being transmitted is the initial frame of the TXOP. This is used to determine whether the TXOP limit can be exceeded
Returns
the format of the next transmission

Definition at line 165 of file multi-user-scheduler.cc.

References AccessReqTimeout(), ns3::EventId::Cancel(), CheckTriggerFrame(), ComputeDlMuInfo(), ComputeUlMuInfo(), DL_MU_TX, ns3::EventId::IsRunning(), m_accessReqInterval, m_accessReqTimer, m_availableTime, m_dlInfo, m_edca, m_heFem, m_initialFrame, m_lastTxFormat, m_restartTimerUponAccess, m_ulInfo, NO_TX, NS_ABORT_MSG_IF, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), SelectTxFormat(), and UL_MU_TX.

+ Here is the call graph for this function:

◆ NotifyNewAggregate()

void ns3::MultiUserScheduler::NotifyNewAggregate ( void  )
overrideprotectedvirtual

Notify all Objects aggregated to this one of a new Object being aggregated.

This function must be implemented in the stack that needs to notify other stacks connected to the node of their presence in the node.

This method is invoked whenever two sets of Objects are aggregated together. It is invoked exactly once for each Object in both sets. This method can be overridden by subclasses who wish to be notified of aggregation events. These subclasses must chain up to their base class NotifyNewAggregate() method.

It is safe to call GetObject() and AggregateObject() from within this method.

Reimplemented from ns3::Object.

Definition at line 99 of file multi-user-scheduler.cc.

References m_apMac, ns3::Object::NotifyNewAggregate(), NS_LOG_FUNCTION, and SetWifiMac().

+ Here is the call graph for this function:

◆ SelectTxFormat()

virtual TxFormat ns3::MultiUserScheduler::SelectTxFormat ( void  )
privatepure virtual

Select the format of the next transmission.

Returns
the format of the next transmission

Implemented in ns3::RrMultiUserScheduler, and TestMultiUserScheduler.

Referenced by NotifyAccessGranted().

+ Here is the caller graph for this function:

◆ SetWifiMac()

void ns3::MultiUserScheduler::SetWifiMac ( Ptr< ApWifiMac mac)
private

Set the wifi MAC.

Note that it must be the MAC of an HE AP.

Parameters
macthe AP wifi MAC

Definition at line 127 of file multi-user-scheduler.cc.

References m_apMac, m_heFem, third::mac, NS_ABORT_MSG_IF, and NS_LOG_FUNCTION.

Referenced by NotifyNewAggregate().

+ Here is the caller graph for this function:

Member Data Documentation

◆ m_accessReqAc

AcIndex ns3::MultiUserScheduler::m_accessReqAc
private

AC we request channel access for.

Definition at line 210 of file multi-user-scheduler.h.

Referenced by AccessReqTimeout(), and GetTypeId().

◆ m_accessReqInterval

Time ns3::MultiUserScheduler::m_accessReqInterval
private

duration of the interval between channel access requests

Definition at line 209 of file multi-user-scheduler.h.

Referenced by AccessReqTimeout(), DoInitialize(), GetTypeId(), and NotifyAccessGranted().

◆ m_accessReqTimer

EventId ns3::MultiUserScheduler::m_accessReqTimer
private

the timer controlling additional channel access requests

Definition at line 208 of file multi-user-scheduler.h.

Referenced by AccessReqTimeout(), DoDispose(), DoInitialize(), and NotifyAccessGranted().

◆ m_apMac

◆ m_availableTime

◆ m_dlInfo

DlMuInfo ns3::MultiUserScheduler::m_dlInfo
private

information required to perform a DL MU transmission

Definition at line 206 of file multi-user-scheduler.h.

Referenced by DoDispose(), GetDlMuInfo(), and NotifyAccessGranted().

◆ m_edca

Ptr<QosTxop> ns3::MultiUserScheduler::m_edca
protected

◆ m_heFem

◆ m_initialFrame

bool ns3::MultiUserScheduler::m_initialFrame
protected

◆ m_lastTxFormat

TxFormat ns3::MultiUserScheduler::m_lastTxFormat {NO_TX}
private

the format of last transmission

Definition at line 205 of file multi-user-scheduler.h.

Referenced by GetDlMuInfo(), GetLastTxFormat(), GetUlMuInfo(), and NotifyAccessGranted().

◆ m_restartTimerUponAccess

bool ns3::MultiUserScheduler::m_restartTimerUponAccess
private

whether the channel access timer has to be restarted upon channel access

Definition at line 211 of file multi-user-scheduler.h.

Referenced by GetTypeId(), and NotifyAccessGranted().

◆ m_ulInfo

UlMuInfo ns3::MultiUserScheduler::m_ulInfo
private

information required to solicit an UL MU transmission

Definition at line 207 of file multi-user-scheduler.h.

Referenced by CheckTriggerFrame(), DoDispose(), GetUlMuInfo(), and NotifyAccessGranted().


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