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	LastTxInfo
	Type for the information about the last 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 ()

	~MultiUserScheduler () override

Time	GetAccessReqInterval () const

DlMuInfo &	GetDlMuInfo (uint8_t linkId)
	Get the information required to perform a DL MU transmission on the given link.

virtual Time	GetExtraTimeForBsrpTfDurationId (uint8_t linkId) const
	When the TXOP limit is zero and the TXOP continues a SIFS after receiving a response to a BSRP TF, the Duration/ID field of the BSRP TF should be extended to reserve the medium for the frame exchange following the BSRP TF.

UlMuInfo &	GetUlMuInfo (uint8_t linkId)
	Get the information required to solicit an UL MU transmission on the given link.

TxFormat	NotifyAccessGranted (Ptr< QosTxop > edca, Time availableTime, bool initialFrame, MHz_u allowedWidth, uint8_t linkId)
	Notify the Multi-user Scheduler that the given AC of the AP gained channel access.

void	NotifyProtectionCompleted (uint8_t linkId, WifiPsduMap &psduMap, WifiTxParameters &txParams)
	This method is called when a protection mechanism for an MU transmission is completed and gives the MU scheduler the opportunity to modify the MU PPDU or the TX parameters before the actual MU transmission.

void	SetAccessReqInterval (Time interval)
	Set the duration of the interval between two consecutive requests for channel access made by the MultiUserScheduler.

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::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	DoDispose () override
	Destructor implementation.

void	DoInitialize () override
	Initialize() implementation.

Ptr< HeFrameExchangeManager >	GetHeFem (uint8_t linkId) const
	Get the HE Frame Exchange Manager attached to the AP on the given link.

TxFormat	GetLastTxFormat (uint8_t linkId) const
	Get the format of the last transmission on the given link, as determined by the last call to NotifyAccessGranted that did not return NO_TX.

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.

Ptr< WifiMpdu >	GetTriggerFrame (const CtrlTriggerHeader &trigger, uint8_t linkId) const
	Get an MPDU containing the given Trigger Frame.

Ptr< WifiRemoteStationManager >	GetWifiRemoteStationManager (uint8_t linkId) const
	Get the station manager attached to the AP on the given link.

void	NotifyNewAggregate () override
	Notify all Objects aggregated to this one of a new Object being aggregated.

void	RemoveRecipientsFromDlMu (uint8_t linkId, WifiPsduMap &psduMap, WifiTxParameters &txParams, std::function< bool(uint8_t, Mac48Address)> predicate) const
	Remove PSDUs for which the given predicate is true from the given PSDU map.

void	RemoveRecipientsFromTf (uint8_t linkId, CtrlTriggerHeader &trigger, WifiTxParameters &txParams, std::function< bool(uint8_t, Mac48Address)> predicate) const
	Remove the User Info fields for which the given predicate is true from the given Trigger Frame.

virtual void	UpdateDlMuAfterProtection (uint8_t linkId, WifiPsduMap &psduMap, WifiTxParameters &txParams) const
	Update the given PSDU map after protection is completed on the given link.

virtual void	UpdateTriggerFrameAfterProtection (uint8_t linkId, CtrlTriggerHeader &trigger, WifiTxParameters &txParams) const
	Update the given Trigger Frame after protection is completed on the given link.

Protected Member Functions inherited from ns3::Object
	Object (const Object &o)
	Copy an Object.

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
MHz_u	m_allowedWidth
	the allowed width for the current transmission

Ptr< ApWifiMac >	m_apMac
	the AP wifi MAC

Time	m_availableTime
	the time available for frame exchange

Time	m_defaultTbPpduDuration
	the default duration of TB PPDUs solicited by Basic TFs

Ptr< QosTxop >	m_edca
	the AC that gained channel access

bool	m_initialFrame
	true if a TXOP is being started

const std::function< bool(uint8_t, Mac48Address)>	m_isUnprotectedEmlsrClient
	predicate returning true if the device with the given (link) address is an EMLSR client that is not protected on the given link

uint8_t	m_linkId
	the ID of the link over which channel access has been granted

Private Member Functions
void	AccessReqTimeout (uint8_t linkId)
	Perform actions required on expiration of the channel access request timer associated with the given link, such as requesting channel access (if not requested already) and restarting the channel access request timer.

void	CheckTriggerFrame ()
	Ensure that the Trigger Frame returned in case of UL MU transmission is correct.

virtual DlMuInfo	ComputeDlMuInfo ()=0
	Compute the information required to perform a DL MU transmission.

virtual UlMuInfo	ComputeUlMuInfo ()=0
	Prepare the information required to solicit an UL MU transmission.

virtual TxFormat	SelectTxFormat ()=0
	Select the format of the next transmission.

void	SetWifiMac (Ptr< ApWifiMac > mac)
	Set the wifi MAC.

Private Attributes
AcIndex	m_accessReqAc
	AC we request channel access for.

Time	m_accessReqInterval
	duration of the interval between channel access requests

std::vector< EventId >	m_accessReqTimers
	the per-link timer controlling additional channel access requests

std::map< uint8_t, LastTxInfo >	m_lastTxInfo
	Information about the last transmission.

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

Additional Inherited Members
Related Symbols inherited from ns3::ObjectBase
static TypeId	GetObjectIid ()
	Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly.

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

AccessReqAc: The Access Category for which the MultiUserScheduler makes requests for channel access.
- Set with class: ns3::EnumValue<ns3::AcIndex>
- Underlying type: AC_BE|AC_VI|AC_VO|AC_BK
- Initial value: AC_BE
- Flags: constructwriteread
- Support level: SUPPORTED
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: constructwriteread
- Support level: SUPPORTED
DefaultTbPpduDuration: Default duration of TB PPDUs solicited via a Basic Trigger Frame. This value is used to compute the Duration/ID field of BSRP Trigger Frames sent when the TXOP Limit is zero and the FrameExchangeManager continues the TXOP a SIFS after receiving response to the BSRP TF. This value shall also be used by subclasses when they have no other information available to determine the TX duration of solicited PPDUs. The default value roughly corresponds to half the maximum PPDU TX duration.
- Set with class: ns3::TimeValue
- Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
- Initial value: +2e+06ns
- Flags: constructwriteread
- Support level: SUPPORTED
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: ns3::BooleanValue
- Underlying type: bool
- Initial value: true
- Flags: constructwriteread
- Support level: SUPPORTED

No TraceSources are defined for this type.
Group: Wifi

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

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

Member Enumeration Documentation

◆ TxFormat

enum ns3::MultiUserScheduler::TxFormat

Enumeration of the possible transmission formats.

Enumerator
NO_TX
SU_TX
DL_MU_TX
UL_MU_TX

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

Constructor & Destructor Documentation

◆ MultiUserScheduler()

ns3::MultiUserScheduler::MultiUserScheduler ( )

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

References m_apMac.

◆ ~MultiUserScheduler()

ns3::MultiUserScheduler::~MultiUserScheduler ( )

override

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ AccessReqTimeout()

void ns3::MultiUserScheduler::AccessReqTimeout ( uint8_t linkId )

private

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

Parameters

linkId the ID of the given link

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

References AccessReqTimeout(), ns3::Time::IsStrictlyPositive(), m_accessReqAc, m_accessReqInterval, m_accessReqTimers, m_apMac, ns3::Txop::NOT_REQUESTED, NS_ASSERT, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CheckTriggerFrame()

void ns3::MultiUserScheduler::CheckTriggerFrame ( )

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 347 of file multi-user-scheduler.cc.

References GetHeFem(), m_lastTxInfo, m_linkId, and NS_LOG_FUNCTION.

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 ( )

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 ( )

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 ( )

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 97 of file multi-user-scheduler.cc.

References ns3::Object::DoDispose(), m_accessReqTimers, m_apMac, m_edca, m_lastTxInfo, and NS_LOG_FUNCTION.

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 ( )

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 128 of file multi-user-scheduler.cc.

References AccessReqTimeout(), ns3::Time::IsStrictlyPositive(), m_accessReqInterval, m_accessReqTimers, m_apMac, NS_ASSERT, 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:

◆ GetAccessReqInterval()

Time ns3::MultiUserScheduler::GetAccessReqInterval ( ) const

Returns: the duration of the interval between two consecutive requests for channel access

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

References m_accessReqInterval.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ GetDlMuInfo()

MultiUserScheduler::DlMuInfo & ns3::MultiUserScheduler::GetDlMuInfo ( uint8_t linkId )

Get the information required to perform a DL MU transmission on the given link.

Note that this method can only be called if GetTxFormat returns DL_MU_TX on the given link.

Parameters

linkId the ID of the given link

Returns: the information required to perform a DL MU transmission

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

References DL_MU_TX, GetWifiRemoteStationManager(), m_apMac, m_lastTxInfo, and NS_ABORT_MSG_IF.

Here is the call graph for this function:

◆ GetExtraTimeForBsrpTfDurationId()

Time ns3::MultiUserScheduler::GetExtraTimeForBsrpTfDurationId ( uint8_t linkId ) const

virtual

When the TXOP limit is zero and the TXOP continues a SIFS after receiving a response to a BSRP TF, the Duration/ID field of the BSRP TF should be extended to reserve the medium for the frame exchange following the BSRP TF.

This method is intended to return the estimated duration of the frame exchange following the BSRP TF (including the SIFS after the responses to the BSRP TF). Specifically, the base class method simply returns the default duration of TB PPDUs solicited via a Basic Trigger Frame. Subclasses can override this method to return a more accurate estimate of the time required by the following frame exchange.

This method should only be called when the MU scheduler has determined that a BSRP TF has to be sent on the given link.

Parameters

linkId the ID of the given link

Returns: the estimated duration of the frame exchange following the BSRP TF

Reimplemented in ns3::RrMultiUserScheduler.

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

References m_defaultTbPpduDuration.

◆ GetHeFem()

Ptr< HeFrameExchangeManager > ns3::MultiUserScheduler::GetHeFem ( uint8_t linkId ) const

protected

Get the HE Frame Exchange Manager attached to the AP on the given link.

Parameters

linkId the ID of the given link

Returns: the HE Frame Exchange Manager attached to the AP on the given link

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

References m_apMac, and ns3::StaticCast().

Referenced by CheckTriggerFrame(), GetTriggerFrame(), NotifyProtectionCompleted(), TestMultiUserScheduler::SelectTxFormat(), ns3::RrMultiUserScheduler::TrySendingBasicTf(), ns3::RrMultiUserScheduler::TrySendingBsrpTf(), and ns3::RrMultiUserScheduler::TrySendingDlMuPpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetLastTxFormat()

MultiUserScheduler::TxFormat ns3::MultiUserScheduler::GetLastTxFormat ( uint8_t linkId ) const

protected

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

Parameters

linkId the ID of the given link

Returns: the format of the last transmission on the given link

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

References m_lastTxInfo, and NO_TX.

Referenced by NotifyProtectionCompleted(), and 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

trigger the 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 495 of file multi-user-scheduler.cc.

References ns3::WifiMacHeader::GetSerializedSize(), ns3::MpduAggregator::GetSizeIfAggregated(), m_apMac, NS_ASSERT_MSG, 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< WifiMpdu > ns3::MultiUserScheduler::GetTriggerFrame	(	const CtrlTriggerHeader &	trigger,
		uint8_t	linkId ) const

protected

Get an MPDU containing the given Trigger Frame.

Parameters

trigger	the given Trigger Frame
linkId	the ID of the link on which the Trigger Frame has to be sent

Returns: an MPDU containing the given Trigger Frame

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

References ns3::CtrlTriggerHeader::begin(), ns3::Create(), ns3::Mac48Address::GetBroadcast(), GetHeFem(), 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 NotifyProtectionCompleted(), 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 ( )

static

Get the type ID.

Returns: the object TypeId

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

References ns3::AC_BE, ns3::AC_BK, ns3::AC_VI, ns3::AC_VO, GetAccessReqInterval(), m_accessReqAc, m_defaultTbPpduDuration, m_restartTimerUponAccess, ns3::MakeBooleanAccessor(), ns3::MakeBooleanChecker(), ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MilliSeconds(), ns3::Seconds(), SetAccessReqInterval(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ GetUlMuInfo()

MultiUserScheduler::UlMuInfo & ns3::MultiUserScheduler::GetUlMuInfo ( uint8_t linkId )

Get the information required to solicit an UL MU transmission on the given link.

Note that this method can only be called if GetTxFormat returns UL_MU_TX on the given link.

Parameters

linkId the ID of the given link

Returns: the information required to solicit an UL MU transmission

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

References m_lastTxInfo, NS_ABORT_MSG_IF, and UL_MU_TX.

Referenced by NotifyProtectionCompleted().

Here is the caller graph for this function:

◆ GetWifiRemoteStationManager()

Ptr< WifiRemoteStationManager > ns3::MultiUserScheduler::GetWifiRemoteStationManager ( uint8_t linkId ) const

protected

Get the station manager attached to the AP on the given link.

Parameters

linkId the ID of the given link

Returns: the station manager attached to the AP on the given link

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

References m_apMac.

Referenced by ns3::RrMultiUserScheduler::CanSolicitStaInBsrpTf(), TestMultiUserScheduler::ComputeWifiTxVector(), GetDlMuInfo(), ns3::RrMultiUserScheduler::GetExtraTimeForBsrpTfDurationId(), ns3::RrMultiUserScheduler::GetTxVectorForUlMu(), and ns3::RrMultiUserScheduler::TrySendingDlMuPpdu().

Here is the caller graph for this function:

◆ NotifyAccessGranted()

MultiUserScheduler::TxFormat ns3::MultiUserScheduler::NotifyAccessGranted	(	Ptr< QosTxop >	edca,
		Time	availableTime,
		bool	initialFrame,
		MHz_u	allowedWidth,
		uint8_t	linkId )

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

edca	the EDCAF which has been granted the opportunity to transmit
availableTime	the amount of time allowed for the frame exchange. Pass Time::Min() in case the TXOP limit is null
initialFrame	true if the frame being transmitted is the initial frame of the TXOP. This is used to determine whether the TXOP limit can be exceeded
allowedWidth	the allowed width for the next transmission
linkId	the ID of the link over which channel access was gained

Returns: the format of the next transmission

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

References AccessReqTimeout(), CheckTriggerFrame(), ComputeDlMuInfo(), ComputeUlMuInfo(), DL_MU_TX, ns3::Time::IsStrictlyPositive(), m_accessReqInterval, m_accessReqTimers, m_allowedWidth, m_availableTime, m_edca, m_initialFrame, m_lastTxInfo, m_linkId, m_restartTimerUponAccess, NO_TX, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), SelectTxFormat(), and UL_MU_TX.

Here is the call graph for this function:

◆ NotifyNewAggregate()

void ns3::MultiUserScheduler::NotifyNewAggregate ( )

overrideprotectedvirtual

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

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 111 of file multi-user-scheduler.cc.

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

Here is the call graph for this function:

◆ NotifyProtectionCompleted()

void ns3::MultiUserScheduler::NotifyProtectionCompleted	(	uint8_t	linkId,
		WifiPsduMap &	psduMap,
		WifiTxParameters &	txParams )

This method is called when a protection mechanism for an MU transmission is completed and gives the MU scheduler the opportunity to modify the MU PPDU or the TX parameters before the actual MU transmission.

Parameters

linkId	ID of the link on which protection was completed
psduMap	the PSDU map to be transmitted
txParams	the TX parameters for the MU transmission

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

References DL_MU_TX, GetHeFem(), GetLastTxFormat(), GetTriggerFrame(), GetUlMuInfo(), ns3::WifiTxVector::IsDlMu(), ns3::IsTrigger(), ns3::WifiTxParameters::m_txVector, ns3::MultiUserScheduler::UlMuInfo::macHdr, NS_ASSERT, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::SU_STA_ID, UL_MU_TX, UpdateDlMuAfterProtection(), and UpdateTriggerFrameAfterProtection().

Here is the call graph for this function:

◆ RemoveRecipientsFromDlMu()

void ns3::MultiUserScheduler::RemoveRecipientsFromDlMu	(	uint8_t	linkId,
		WifiPsduMap &	psduMap,
		WifiTxParameters &	txParams,
		std::function< bool(uint8_t, Mac48Address)>	predicate ) const

protected

Remove PSDUs for which the given predicate is true from the given PSDU map.

Entries in the TXVECTOR corresponding to such PSDUs are also removed.

Parameters

linkId	the ID of the link on which the PSDU map has to be sent
psduMap	the given PSDU map
txParams	the TX parameters for the DL MU transmission
predicate	the given predicate (input parameters are link ID and device link address)

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

References ns3::WifiAcknowledgment::DL_MU_AGGREGATE_TF, ns3::WifiAcknowledgment::DL_MU_BAR_BA_SEQUENCE, ns3::WifiAcknowledgment::DL_MU_TF_MU_BAR, ns3::WifiTxVector::GetHeMuUserInfoMap(), ns3::WifiTxParameters::m_acknowledgment, m_apMac, ns3::WifiTxParameters::m_txVector, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::WifiDlMuAggregateTf::stationsReplyingWithBlockAck, ns3::WifiDlMuTfMuBar::stationsReplyingWithBlockAck, and ns3::WifiDlMuBarBaSequence::stationsReplyingWithNormalAck.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveRecipientsFromTf()

void ns3::MultiUserScheduler::RemoveRecipientsFromTf	(	uint8_t	linkId,
		CtrlTriggerHeader &	trigger,
		WifiTxParameters &	txParams,
		std::function< bool(uint8_t, Mac48Address)>	predicate ) const

protected

Remove the User Info fields for which the given predicate is true from the given Trigger Frame.

Parameters

linkId	the ID of the link on which the Trigger Frame has to be sent
trigger	the given Trigger Frame
txParams	the TX parameters for the UL MU transmission
predicate	the given predicate (input parameters are link ID and device link address)

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

References ns3::CtrlTriggerHeader::begin(), ns3::CtrlTriggerHeader::end(), ns3::WifiTxParameters::m_acknowledgment, m_apMac, NS_ASSERT_MSG, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::CtrlTriggerHeader::RemoveUserInfoField(), ns3::WifiUlMuMultiStaBa::stationsReceivingMultiStaBa, and ns3::WifiAcknowledgment::UL_MU_MULTI_STA_BA.

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SelectTxFormat()

virtual TxFormat ns3::MultiUserScheduler::SelectTxFormat ( )

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:

◆ SetAccessReqInterval()

void ns3::MultiUserScheduler::SetAccessReqInterval ( Time interval )

Set the duration of the interval between two consecutive requests for channel access made by the MultiUserScheduler.

Parameters

interval the duration of the interval between two consecutive requests for channel access

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

References AccessReqTimeout(), ns3::Time::As(), ns3::Object::IsInitialized(), ns3::Time::IsStrictlyPositive(), m_accessReqInterval, m_accessReqTimers, m_apMac, ns3::Time::MS, NS_LOG_FUNCTION, and ns3::Simulator::Schedule().

Referenced by GetTypeId().

Here is the call graph for this function:

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

mac	the AP wifi MAC

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

References ns3::DynamicCast(), m_apMac, NS_ABORT_MSG_IF, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by NotifyNewAggregate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UpdateDlMuAfterProtection()

virtual void ns3::MultiUserScheduler::UpdateDlMuAfterProtection	(	uint8_t	linkId,
		WifiPsduMap &	psduMap,
		WifiTxParameters &	txParams ) const

inlineprotectedvirtual

Update the given PSDU map after protection is completed on the given link.

Parameters

linkId	the ID of the given link
psduMap	the given PSDU map
txParams	the TX parameters for the DL MU transmission

Reimplemented in ns3::RrMultiUserScheduler.

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

Referenced by NotifyProtectionCompleted().

Here is the caller graph for this function:

◆ UpdateTriggerFrameAfterProtection()

virtual void ns3::MultiUserScheduler::UpdateTriggerFrameAfterProtection	(	uint8_t	linkId,
		CtrlTriggerHeader &	trigger,
		WifiTxParameters &	txParams ) const

inlineprotectedvirtual

Update the given Trigger Frame after protection is completed on the given link.

Parameters

linkId	the ID of the given link
trigger	the given Trigger Frame
txParams	the TX parameters for the UL MU transmission

Reimplemented in ns3::RrMultiUserScheduler.

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

Referenced by NotifyProtectionCompleted().

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 333 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 332 of file multi-user-scheduler.h.

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

◆ m_accessReqTimers

std::vector<EventId> ns3::MultiUserScheduler::m_accessReqTimers

private

the per-link timer controlling additional channel access requests

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

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

◆ m_allowedWidth

MHz_u ns3::MultiUserScheduler::m_allowedWidth

protected

the allowed width for the current transmission

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

Referenced by ns3::RrMultiUserScheduler::GetTxVectorForUlMu(), NotifyAccessGranted(), TestMultiUserScheduler::SelectTxFormat(), ns3::RrMultiUserScheduler::TrySendingBasicTf(), ns3::RrMultiUserScheduler::TrySendingBsrpTf(), and ns3::RrMultiUserScheduler::TrySendingDlMuPpdu().

◆ m_apMac

Ptr<ApWifiMac> ns3::MultiUserScheduler::m_apMac

protected

the AP wifi MAC

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

◆ m_availableTime

Time ns3::MultiUserScheduler::m_availableTime

protected

the time available for frame exchange

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

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

◆ m_defaultTbPpduDuration

Time ns3::MultiUserScheduler::m_defaultTbPpduDuration

protected

the default duration of TB PPDUs solicited by Basic TFs

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

Referenced by GetExtraTimeForBsrpTfDurationId(), ns3::RrMultiUserScheduler::GetExtraTimeForBsrpTfDurationId(), and GetTypeId().

◆ m_edca

Ptr<QosTxop> ns3::MultiUserScheduler::m_edca

protected

the AC that gained channel access

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

Referenced by DoDispose(), NotifyAccessGranted(), ns3::RrMultiUserScheduler::SelectTxFormat(), ns3::RrMultiUserScheduler::TrySendingBasicTf(), and ns3::RrMultiUserScheduler::TrySendingDlMuPpdu().

◆ m_initialFrame

bool ns3::MultiUserScheduler::m_initialFrame

protected

true if a TXOP is being started

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

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

◆ m_isUnprotectedEmlsrClient

const std::function<bool(uint8_t, Mac48Address)> ns3::MultiUserScheduler::m_isUnprotectedEmlsrClient

protected

predicate returning true if the device with the given (link) address is an EMLSR client that is not protected on the given link

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

Referenced by ns3::RrMultiUserScheduler::UpdateDlMuAfterProtection(), and ns3::RrMultiUserScheduler::UpdateTriggerFrameAfterProtection().

◆ m_lastTxInfo

std::map<uint8_t, LastTxInfo> ns3::MultiUserScheduler::m_lastTxInfo

private

Information about the last transmission.

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

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

◆ m_linkId

uint8_t ns3::MultiUserScheduler::m_linkId

protected

the ID of the link over which channel access has been granted

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

Referenced by ns3::RrMultiUserScheduler::CanSolicitStaInBsrpTf(), CheckTriggerFrame(), ns3::RrMultiUserScheduler::GetTxVectorForUlMu(), NotifyAccessGranted(), ns3::RrMultiUserScheduler::SelectTxFormat(), ns3::RrMultiUserScheduler::TrySendingBasicTf(), ns3::RrMultiUserScheduler::TrySendingBsrpTf(), and ns3::RrMultiUserScheduler::TrySendingDlMuPpdu().

◆ m_restartTimerUponAccess

bool ns3::MultiUserScheduler::m_restartTimerUponAccess

private

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

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

Referenced by GetTypeId(), and NotifyAccessGranted().

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

src/wifi/model/he/multi-user-scheduler.h
src/wifi/model/he/multi-user-scheduler.cc

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Attributes

Member Enumeration Documentation

◆ TxFormat

Constructor & Destructor Documentation

◆ MultiUserScheduler()

◆ ~MultiUserScheduler()

Member Function Documentation

◆ AccessReqTimeout()

◆ CheckTriggerFrame()

◆ ComputeDlMuInfo()

◆ ComputeUlMuInfo()

◆ DoDispose()

◆ DoInitialize()

◆ GetAccessReqInterval()

◆ GetDlMuInfo()

◆ GetExtraTimeForBsrpTfDurationId()

◆ GetHeFem()

◆ GetLastTxFormat()

◆ GetMaxSizeOfQosNullAmpdu()

◆ GetTriggerFrame()

◆ GetTypeId()

◆ GetUlMuInfo()

◆ GetWifiRemoteStationManager()

◆ NotifyAccessGranted()

◆ NotifyNewAggregate()

◆ NotifyProtectionCompleted()

◆ RemoveRecipientsFromDlMu()

◆ RemoveRecipientsFromTf()

◆ SelectTxFormat()

◆ SetAccessReqInterval()

◆ SetWifiMac()

◆ UpdateDlMuAfterProtection()

◆ UpdateTriggerFrameAfterProtection()

Member Data Documentation

◆ m_accessReqAc

◆ m_accessReqInterval

◆ m_accessReqTimers

◆ m_allowedWidth

◆ m_apMac

◆ m_availableTime

◆ m_defaultTbPpduDuration

◆ m_edca

◆ m_initialFrame

◆ m_isUnprotectedEmlsrClient

◆ m_lastTxInfo

◆ m_linkId

◆ m_restartTimerUponAccess