WifiMacQueueSchedulerImpl is a template class enabling the definition of different types of priority values for the container queues. More...

#include "wifi-mac-queue-scheduler-impl.h"

Inheritance diagram for ns3::WifiMacQueueSchedulerImpl< Priority, Compare >:

Collaboration diagram for ns3::WifiMacQueueSchedulerImpl< Priority, Compare >:

Classes
struct	PerAcInfo
	Information specific to a wifi MAC queue. More...

struct	QueueInfo
	Information associated with a container queue. More...

Public Member Functions
	WifiMacQueueSchedulerImpl ()
	Constructor. More...

std::list< uint8_t >	GetLinkIds (AcIndex ac, const WifiContainerQueueId &queueId) final
	Get the list of the IDs of the links the given container queue (belonging to the given Access Category) is associated with. More...

std::optional< WifiContainerQueueId >	GetNext (AcIndex ac, uint8_t linkId) final
	Get the next queue to serve, which is guaranteed to contain at least an MPDU whose lifetime has not expired. More...

std::optional< WifiContainerQueueId >	GetNext (AcIndex ac, uint8_t linkId, const WifiContainerQueueId &prevQueueId) final
	Get the next queue to serve after the given one. More...

Ptr< WifiMpdu >	HasToDropBeforeEnqueue (AcIndex ac, Ptr< WifiMpdu > mpdu) final
	Check whether an MPDU has to be dropped before enqueuing the given MPDU. More...

void	NotifyDequeue (AcIndex ac, const std::list< Ptr< WifiMpdu >> &mpdus) final
	Notify the scheduler that the given list of MPDUs have been dequeued by the given Access Category. More...

void	NotifyEnqueue (AcIndex ac, Ptr< WifiMpdu > mpdu) final
	Notify the scheduler that the given MPDU has been enqueued by the given Access Category. More...

void	NotifyRemove (AcIndex ac, const std::list< Ptr< WifiMpdu >> &mpdus) final
	Notify the scheduler that the given list of MPDUs have been removed by the given Access Category. More...

void	SetLinkIds (AcIndex ac, const WifiContainerQueueId &queueId, const std::list< uint8_t > &linkIds) final
	Set the list of the IDs of the links the given container queue (belonging to the given Access Category) is associated with. More...

void	SetWifiMac (Ptr< WifiMac > mac) final
	Set the wifi MAC. 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< Object >	GetObject () 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< Object >	GetObject (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...

SimpleRefCount &	operator= (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...

Static Public Member Functions
static TypeId	GetTypeId ()
	Get the type ID. More...

Static Public Member Functions inherited from ns3::WifiMacQueueScheduler
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 Types
using	QueueInfoMap = std::unordered_map< WifiContainerQueueId, QueueInfo >
	Map identifiers (QueueIds) to information associated with container queues. More...

using	QueueInfoPair = std::pair< const WifiContainerQueueId, QueueInfo >
	typedef for a QueueInfoMap element More...

using	SortedQueues = std::multimap< Priority, std::reference_wrapper< QueueInfoPair >, Compare >
	List of container queues sorted in decreasing order of priority. More...

Protected Member Functions
void	DoDispose () override
	Destructor implementation. More...

const SortedQueues &	GetSortedQueues (AcIndex ac) const
	Get a const reference to the sorted list of container queues for the given Access Category. More...

Ptr< WifiMacQueue >	GetWifiMacQueue (AcIndex ac) const
	Get the wifi MAC queue associated with the given Access Category. More...

void	SetPriority (AcIndex ac, const WifiContainerQueueId &queueId, const Priority &priority)
	Set the priority for the given container queue belonging to the given Access Category. More...

Protected Member Functions inherited from ns3::WifiMacQueueScheduler
void	DoDispose () override
	Destructor implementation. More...

Ptr< WifiMac >	GetMac () const
	Get the wifi MAC. More...

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

virtual void	DoInitialize ()
	Initialize() implementation. 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...

Private Member Functions
std::optional< WifiContainerQueueId >	DoGetNext (AcIndex ac, uint8_t linkId, typename SortedQueues::iterator sortedQueuesIt)
	Get the next queue to serve. More...

virtual void	DoNotifyDequeue (AcIndex ac, const std::list< Ptr< WifiMpdu >> &mpdus)=0
	Notify the scheduler that the given list of MPDUs have been dequeued by the given Access Category. More...

virtual void	DoNotifyEnqueue (AcIndex ac, Ptr< WifiMpdu > mpdu)=0
	Notify the scheduler that the given MPDU has been enqueued by the given Access Category. More...

virtual void	DoNotifyRemove (AcIndex ac, const std::list< Ptr< WifiMpdu >> &mpdus)=0
	Notify the scheduler that the given list of MPDUs have been removed by the given Access Category. More...

virtual Ptr< WifiMpdu >	HasToDropBeforeEnqueuePriv (AcIndex ac, Ptr< WifiMpdu > mpdu)=0
	Check whether an MPDU has to be dropped before enqueuing the given MPDU. More...

QueueInfoMap::iterator	InitQueueInfo (AcIndex ac, const WifiContainerQueueId &queueId)
	Add the information associated with the given container queue (if not already present) to the map corresponding to the given Access Category and Initialize the list of the IDs of the links over which packets contained in the given container queue can be sent over. More...

Private Attributes
std::vector< PerAcInfo >	m_perAcInfo {AC_UNDEF}
	vector of per-AC information More...

	NS_LOG_TEMPLATE_DECLARE
	the log component More...

Friends
class	::WifiMacQueueDropOldestTest
	allow WifiMacQueueDropOldestTest class access More...

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

Detailed Description

template<class Priority, class Compare = std::less<Priority>>
class ns3::WifiMacQueueSchedulerImpl< Priority, Compare >

WifiMacQueueSchedulerImpl is a template class enabling the definition of different types of priority values for the container queues.

Introspection did not find any typical Config paths.

The function to compare priority values can be customized as well.

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

Definition at line 50 of file wifi-mac-queue-scheduler-impl.h.

Member Typedef Documentation

◆ QueueInfoMap

template<class Priority , class Compare = std::less<Priority>>

using ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::QueueInfoMap = std::unordered_map<WifiContainerQueueId, QueueInfo>

protected

Map identifiers (QueueIds) to information associated with container queues.

Empty queues shall be kept in this data structure because queue information (such as the set of link IDs) may be configured just once.

Definition at line 111 of file wifi-mac-queue-scheduler-impl.h.

◆ QueueInfoPair

template<class Priority , class Compare = std::less<Priority>>

using ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::QueueInfoPair = std::pair<const WifiContainerQueueId, QueueInfo>

protected

typedef for a QueueInfoMap element

Definition at line 114 of file wifi-mac-queue-scheduler-impl.h.

◆ SortedQueues

template<class Priority , class Compare = std::less<Priority>>

using ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::SortedQueues = std::multimap<Priority, std::reference_wrapper<QueueInfoPair>, Compare>

protected

List of container queues sorted in decreasing order of priority.

Empty queues shall not be kept in this data structure.

Note: We cannot store iterators to QueueInfoMap because if rehashing occurs due to an insertion, all iterators are invalidated. References are not invalidated instead. Therefore, we store reference wrappers (which can be reassigned).

Definition at line 125 of file wifi-mac-queue-scheduler-impl.h.

Constructor & Destructor Documentation

◆ WifiMacQueueSchedulerImpl()

template<class Priority , class Compare >

ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::WifiMacQueueSchedulerImpl

Constructor.

Implementation of the templates declared above.

Definition at line 240 of file wifi-mac-queue-scheduler-impl.h.

Member Function Documentation

◆ DoDispose()

template<class Priority , class Compare >

void ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::DoDispose

overrideprotectedvirtual

Destructor implementation.

This method is called by Dispose() or by the Object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overridden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.

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

Reimplemented from ns3::Object.

Definition at line 257 of file wifi-mac-queue-scheduler-impl.h.

References ns3::WifiMacQueueScheduler::DoDispose().

Here is the call graph for this function:

◆ DoGetNext()

template<class Priority , class Compare >

std::optional< WifiContainerQueueId > ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::DoGetNext	(	AcIndex	ac,
		uint8_t	linkId,
		typename SortedQueues::iterator	sortedQueuesIt
	)

private

Get the next queue to serve.

The search starts from the given one. The returned queue is guaranteed to contain at least an MPDU whose lifetime has not expired. Queues containing MPDUs that cannot be sent over the given link are ignored.

Parameters

ac	the Access Category that we want to serve
linkId	the ID of the link on which we got channel access
sortedQueuesIt	iterator pointing to the queue we start the search from

Returns: the ID of the selected container queue (if any)

Definition at line 421 of file wifi-mac-queue-scheduler-impl.h.

References ns3::AC_UNDEF, NS_ASSERT, NS_LOG_FUNCTION, and prev.

◆ DoNotifyDequeue()

template<class Priority , class Compare = std::less<Priority>>

virtual void ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::DoNotifyDequeue	(	AcIndex	ac,
		const std::list< Ptr< WifiMpdu >> &	mpdus
	)

privatepure virtual

Notify the scheduler that the given list of MPDUs have been dequeued by the given Access Category.

The container queues which became empty after dequeuing the MPDUs are removed from the sorted list of queues.

Parameters

ac	the Access Category of the dequeued MPDUs
mpdus	the list of dequeued MPDUs

Implemented in ns3::FcfsWifiQueueScheduler.

◆ DoNotifyEnqueue()

template<class Priority , class Compare = std::less<Priority>>

virtual void ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::DoNotifyEnqueue	(	AcIndex	ac,
		Ptr< WifiMpdu >	mpdu
	)

privatepure virtual

Notify the scheduler that the given MPDU has been enqueued by the given Access Category.

The container queue in which the MPDU has been enqueued must be assigned a priority value.

Parameters

ac	the Access Category of the enqueued MPDU
mpdu	the enqueued MPDU

Implemented in ns3::FcfsWifiQueueScheduler.

◆ DoNotifyRemove()

template<class Priority , class Compare = std::less<Priority>>

virtual void ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::DoNotifyRemove	(	AcIndex	ac,
		const std::list< Ptr< WifiMpdu >> &	mpdus
	)

privatepure virtual

Notify the scheduler that the given list of MPDUs have been removed by the given Access Category.

The container queues which became empty after removing the MPDUs are removed from the sorted list of queues.

Parameters

ac	the Access Category of the removed MPDUs
mpdus	the list of removed MPDUs

Implemented in ns3::FcfsWifiQueueScheduler.

◆ GetLinkIds()

template<class Priority , class Compare >

std::list< uint8_t > ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::GetLinkIds	(	AcIndex	ac,
		const WifiContainerQueueId &	queueId
	)

finalvirtual

Get the list of the IDs of the links the given container queue (belonging to the given Access Category) is associated with.

Parameters

ac	the given Access Category
queueId	the given container queue

Returns: the list of the IDs of the links the given container queue is associated with

Implements ns3::WifiMacQueueScheduler.

Definition at line 366 of file wifi-mac-queue-scheduler-impl.h.

References NS_ASSERT.

◆ GetNext() [1/2]

template<class Priority , class Compare >

std::optional< WifiContainerQueueId > ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::GetNext	(	AcIndex	ac,
		uint8_t	linkId
	)

finalvirtual

Get the next queue to serve, which is guaranteed to contain at least an MPDU whose lifetime has not expired.

Queues containing MPDUs that cannot be sent over the given link are ignored.

Parameters

ac	the Access Category that we want to serve
linkId	the ID of the link on which we got channel access

Returns: the ID of the selected container queue (if any)

Implements ns3::WifiMacQueueScheduler.

Definition at line 395 of file wifi-mac-queue-scheduler-impl.h.

References NS_LOG_FUNCTION.

◆ GetNext() [2/2]

template<class Priority , class Compare >

std::optional< WifiContainerQueueId > ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::GetNext	(	AcIndex	ac,
		uint8_t	linkId,
		const WifiContainerQueueId &	prevQueueId
	)

finalvirtual

Get the next queue to serve after the given one.

The returned queue is guaranteed to contain at least an MPDU whose lifetime has not expired. Queues containing MPDUs that cannot be sent over the given link are ignored.

Parameters

ac	the Access Category that we want to serve
linkId	the ID of the link on which we got channel access
prevQueueId	the ID of the container queue served previously

Returns: the ID of the selected container queue (if any)

Implements ns3::WifiMacQueueScheduler.

Definition at line 403 of file wifi-mac-queue-scheduler-impl.h.

References NS_ABORT_IF, and NS_LOG_FUNCTION.

◆ GetSortedQueues()

template<class Priority , class Compare >

const WifiMacQueueSchedulerImpl< Priority, Compare >::SortedQueues & ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::GetSortedQueues ( AcIndex ac ) const

protected

Get a const reference to the sorted list of container queues for the given Access Category.

Parameters

ac	the given Access Category

Returns: a const reference to the sorted list of container queues for the given Access Category

Definition at line 288 of file wifi-mac-queue-scheduler-impl.h.

References ns3::AC_UNDEF, and NS_ASSERT.

◆ GetTypeId()

template<class Priority , class Compare >

TypeId ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::GetTypeId

static

Get the type ID.

Returns: the object TypeId

Definition at line 247 of file wifi-mac-queue-scheduler-impl.h.

References ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ GetWifiMacQueue()

template<class Priority , class Compare >

Ptr< WifiMacQueue > ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::GetWifiMacQueue ( AcIndex ac ) const

protected

Get the wifi MAC queue associated with the given Access Category.

Parameters

ac	the given Access Category

Returns: the wifi MAC queue associated with the given Access Category

Definition at line 280 of file wifi-mac-queue-scheduler-impl.h.

References ns3::AC_UNDEF, and NS_ASSERT.

◆ HasToDropBeforeEnqueue()

template<class Priority , class Compare >

Ptr< WifiMpdu > ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::HasToDropBeforeEnqueue	(	AcIndex	ac,
		Ptr< WifiMpdu >	mpdu
	)

finalvirtual

Check whether an MPDU has to be dropped before enqueuing the given MPDU.

Parameters

ac	the Access Category of the MPDU being enqueued
mpdu	the MPDU to enqueue

Returns: a pointer to the MPDU to drop, if any, or a null pointer, otherwise

Implements ns3::WifiMacQueueScheduler.

Definition at line 472 of file wifi-mac-queue-scheduler-impl.h.

References NS_LOG_FUNCTION.

◆ HasToDropBeforeEnqueuePriv()

template<class Priority , class Compare = std::less<Priority>>

virtual Ptr<WifiMpdu> ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::HasToDropBeforeEnqueuePriv	(	AcIndex	ac,
		Ptr< WifiMpdu >	mpdu
	)

privatepure virtual

Check whether an MPDU has to be dropped before enqueuing the given MPDU.

Parameters

ac	the Access Category of the MPDU being enqueued
mpdu	the MPDU to enqueue

Returns: a pointer to the MPDU to drop, if any, or a null pointer, otherwise

Implemented in ns3::FcfsWifiQueueScheduler.

◆ InitQueueInfo()

template<class Priority , class Compare >

WifiMacQueueSchedulerImpl< Priority, Compare >::QueueInfoMap::iterator ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::InitQueueInfo	(	AcIndex	ac,
		const WifiContainerQueueId &	queueId
	)

private

Add the information associated with the given container queue (if not already present) to the map corresponding to the given Access Category and Initialize the list of the IDs of the links over which packets contained in the given container queue can be sent over.

Parameters

ac	the given Access Category
queueId	the ID of the given container queue

Returns: an iterator to the information associated with the given container queue

Definition at line 296 of file wifi-mac-queue-scheduler-impl.h.

References first::address, NS_ASSERT, NS_LOG_FUNCTION, ns3::WIFI_CTL_QUEUE, ns3::WIFI_MGT_QUEUE, and ns3::WIFI_QOSDATA_BROADCAST_QUEUE.

◆ NotifyDequeue()

template<class Priority , class Compare >

void ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::NotifyDequeue	(	AcIndex	ac,
		const std::list< Ptr< WifiMpdu >> &	mpdus
	)

finalvirtual

Notify the scheduler that the given list of MPDUs have been dequeued by the given Access Category.

The container queues which became empty after dequeuing the MPDUs are removed from the sorted list of queues.

Parameters

ac	the Access Category of the dequeued MPDUs
mpdus	the list of dequeued MPDUs

Implements ns3::WifiMacQueueScheduler.

Definition at line 499 of file wifi-mac-queue-scheduler-impl.h.

References ns3::AC_UNDEF, ns3::WifiMacQueueContainer::GetQueueId(), NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ NotifyEnqueue()

template<class Priority , class Compare >

void ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::NotifyEnqueue	(	AcIndex	ac,
		Ptr< WifiMpdu >	mpdu
	)

finalvirtual

Notify the scheduler that the given MPDU has been enqueued by the given Access Category.

The container queue in which the MPDU has been enqueued must be assigned a priority value.

Parameters

ac	the Access Category of the enqueued MPDU
mpdu	the enqueued MPDU

Implements ns3::WifiMacQueueScheduler.

Definition at line 480 of file wifi-mac-queue-scheduler-impl.h.

References ns3::AC_UNDEF, ns3::WifiMacQueueContainer::GetQueueId(), NS_ABORT_MSG, NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ NotifyRemove()

template<class Priority , class Compare >

void ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::NotifyRemove	(	AcIndex	ac,
		const std::list< Ptr< WifiMpdu >> &	mpdus
	)

finalvirtual

Notify the scheduler that the given list of MPDUs have been removed by the given Access Category.

The container queues which became empty after removing the MPDUs are removed from the sorted list of queues.

Parameters

ac	the Access Category of the removed MPDUs
mpdus	the list of removed MPDUs

Implements ns3::WifiMacQueueScheduler.

Definition at line 533 of file wifi-mac-queue-scheduler-impl.h.

References ns3::AC_UNDEF, ns3::WifiMacQueueContainer::GetQueueId(), NS_ASSERT, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ SetLinkIds()

template<class Priority , class Compare >

void ns3::WifiMacQueueSchedulerImpl< Priority, Compare >::SetLinkIds	(	AcIndex	ac,
		const WifiContainerQueueId &	queueId,
		const std::list< uint8_t > &	linkIds
	)