A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::FcfsWifiQueueScheduler Class Reference

FcfsWifiQueueScheduler is a wifi queue scheduler that serves data frames in a first come first serve fashion. More...

#include "fcfs-wifi-queue-scheduler.h"

+ Inheritance diagram for ns3::FcfsWifiQueueScheduler:
+ Collaboration diagram for ns3::FcfsWifiQueueScheduler:

Public Types

enum  DropPolicy { DROP_NEWEST , DROP_OLDEST }
 drop policy More...
 
- Public Types inherited from ns3::WifiMacQueueScheduler
using Mask = std::bitset<static_cast<std::size_t>(WifiQueueBlockedReason::REASONS_COUNT)>
 Bitset identifying the reasons to block individual links for a container queue.
 

Public Member Functions

 FcfsWifiQueueScheduler ()
 
- Public Member Functions inherited from ns3::WifiMacQueueSchedulerImpl< FcfsPrio >
 WifiMacQueueSchedulerImpl ()
 Constructor.
 
void BlockQueues (WifiQueueBlockedReason reason, AcIndex ac, const std::list< WifiContainerQueueType > &types, const Mac48Address &rxAddress, const Mac48Address &txAddress, const std::set< uint8_t > &tids, const std::set< uint8_t > &linkIds) final
 Block the given set of links for the container queues of the given types and Access Category that hold frames having the given Receiver Address (RA), Transmitter Address (TA) and TID (if needed) for the given reason, such that frames in these queues are not transmitted on the given set of links.
 
std::list< uint8_t > GetLinkIds (AcIndex ac, Ptr< const WifiMpdu > mpdu, const std::list< WifiQueueBlockedReason > &ignoredReasons) final
 Get the list of the IDs of the links the given MPDU (belonging to the given Access Category) can be sent over.
 
std::optional< WifiContainerQueueIdGetNext (AcIndex ac, std::optional< uint8_t > linkId) final
 Get the next queue to serve, which is guaranteed to contain at least an MPDU whose lifetime has not expired.
 
std::optional< WifiContainerQueueIdGetNext (AcIndex ac, std::optional< uint8_t > linkId, const WifiContainerQueueId &prevQueueId) final
 Get the next queue to serve after the given one.
 
std::optional< MaskGetQueueLinkMask (AcIndex ac, const WifiContainerQueueId &queueId, uint8_t linkId) final
 Get the mask associated with the given container queue indicating whether the given link is blocked and for which reason, provided that the given container queue exists and has a mask for the given link.
 
Ptr< WifiMpduHasToDropBeforeEnqueue (AcIndex ac, Ptr< WifiMpdu > mpdu) final
 Check whether an MPDU has to be dropped before enqueuing the given MPDU.
 
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.
 
void NotifyEnqueue (AcIndex ac, Ptr< WifiMpdu > mpdu) final
 Notify the scheduler that the given MPDU has been enqueued by the given Access Category.
 
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.
 
void SetWifiMac (Ptr< WifiMac > mac) final
 Set the wifi MAC.
 
void UnblockQueues (WifiQueueBlockedReason reason, AcIndex ac, const std::list< WifiContainerQueueType > &types, const Mac48Address &rxAddress, const Mac48Address &txAddress, const std::set< uint8_t > &tids, const std::set< uint8_t > &linkIds) final
 Unblock the given set of links for the container queues of the given types and Access Category that hold frames having the given Receiver Address (RA), Transmitter Address (TA) and TID (if needed) for the given reason, such that frames in these queues can be transmitted on the given set of links.
 
- 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< ObjectGetObject () 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< ObjectGetObject (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.
 
SimpleRefCountoperator= (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::WifiMacQueueSchedulerImpl< FcfsPrio >
static TypeId GetTypeId ()
 Get the type ID.
 
- Static Public Member Functions inherited from ns3::WifiMacQueueScheduler
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.
 

Private Member Functions

void DoNotifyDequeue (AcIndex ac, const std::list< Ptr< WifiMpdu > > &mpdus) override
 Notify the scheduler that the given list of MPDUs have been dequeued by the given Access Category.
 
void DoNotifyEnqueue (AcIndex ac, Ptr< WifiMpdu > mpdu) override
 Notify the scheduler that the given MPDU has been enqueued by the given Access Category.
 
void DoNotifyRemove (AcIndex ac, const std::list< Ptr< WifiMpdu > > &mpdus) override
 Notify the scheduler that the given list of MPDUs have been removed by the given Access Category.
 
Ptr< WifiMpduHasToDropBeforeEnqueuePriv (AcIndex ac, Ptr< WifiMpdu > mpdu) override
 Check whether an MPDU has to be dropped before enqueuing the given MPDU.
 

Private Attributes

DropPolicy m_dropPolicy
 Drop behavior of queue.
 
 NS_LOG_TEMPLATE_DECLARE
 redefinition of the log component
 

Additional Inherited Members

- Protected Types inherited from ns3::WifiMacQueueSchedulerImpl< FcfsPrio >
using QueueInfoMap
 Map identifiers (QueueIds) to information associated with container queues.
 
using QueueInfoPair
 typedef for a QueueInfoMap element
 
using SortedQueues
 List of container queues sorted in decreasing order of priority.
 
- Protected Member Functions inherited from ns3::WifiMacQueueSchedulerImpl< FcfsPrio >
void DoDispose () override
 Destructor implementation.
 
const SortedQueuesGetSortedQueues (AcIndex ac) const
 Get a const reference to the sorted list of container queues for the given Access Category.
 
Ptr< WifiMacQueueGetWifiMacQueue (AcIndex ac) const
 Get the wifi MAC queue associated with the given Access Category.
 
void SetPriority (AcIndex ac, const WifiContainerQueueId &queueId, const FcfsPrio &priority)
 Set the priority for the given container queue belonging to the given Access Category.
 
- Protected Member Functions inherited from ns3::WifiMacQueueScheduler
Ptr< WifiMacGetMac () const
 Get the wifi MAC.
 
- Protected Member Functions inherited from ns3::Object
 Object (const Object &o)
 Copy an Object.
 
virtual void DoInitialize ()
 Initialize() implementation.
 
virtual void NotifyNewAggregate ()
 Notify all Objects aggregated to this one of a new Object being aggregated.
 
- Protected Member Functions inherited from ns3::ObjectBase
void ConstructSelf (const AttributeConstructionList &attributes)
 Complete construction of ObjectBase; invoked by derived classes.
 
virtual void NotifyConstructionCompleted ()
 Notifier called once the ObjectBase is fully constructed.
 

Detailed Description

FcfsWifiQueueScheduler is a wifi queue scheduler that serves data frames in a first come first serve fashion.

Introspection did not find any typical Config paths.

Control frames have the highest priority. Management frames have the second highest priority. Hence, data frames are served after control and management frames.


Attributes

  • DropPolicy: Upon enqueue with full queue, drop oldest (DropOldest) or newest (DropNewest) packet

No TraceSources are defined for this type.
Group: Wifi

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

Definition at line 53 of file fcfs-wifi-queue-scheduler.h.

Member Enumeration Documentation

◆ DropPolicy

drop policy

Enumerator
DROP_NEWEST 
DROP_OLDEST 

Definition at line 65 of file fcfs-wifi-queue-scheduler.h.

Constructor & Destructor Documentation

◆ FcfsWifiQueueScheduler()

ns3::FcfsWifiQueueScheduler::FcfsWifiQueueScheduler ( )

Definition at line 75 of file fcfs-wifi-queue-scheduler.cc.

Member Function Documentation

◆ DoNotifyDequeue()

void ns3::FcfsWifiQueueScheduler::DoNotifyDequeue ( AcIndex ac,
const std::list< Ptr< WifiMpdu > > & mpdus )
overrideprivatevirtual

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
acthe Access Category of the dequeued MPDUs
mpdusthe list of dequeued MPDUs

Implements ns3::WifiMacQueueSchedulerImpl< FcfsPrio >.

Definition at line 133 of file fcfs-wifi-queue-scheduler.cc.

References ns3::WifiMacQueueContainer::GetQueueId(), ns3::WifiMacQueueSchedulerImpl< FcfsPrio >::GetWifiMacQueue(), NS_LOG_FUNCTION, and ns3::WifiMacQueueSchedulerImpl< FcfsPrio >::SetPriority().

+ Here is the call graph for this function:

◆ DoNotifyEnqueue()

void ns3::FcfsWifiQueueScheduler::DoNotifyEnqueue ( AcIndex ac,
Ptr< WifiMpdu > mpdu )
overrideprivatevirtual

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
acthe Access Category of the enqueued MPDU
mpduthe enqueued MPDU

Implements ns3::WifiMacQueueSchedulerImpl< FcfsPrio >.

Definition at line 119 of file fcfs-wifi-queue-scheduler.cc.

References ns3::WifiMacQueueContainer::GetQueueId(), ns3::WifiMacQueueSchedulerImpl< FcfsPrio >::GetWifiMacQueue(), NS_ASSERT, NS_LOG_FUNCTION, and ns3::WifiMacQueueSchedulerImpl< FcfsPrio >::SetPriority().

+ Here is the call graph for this function:

◆ DoNotifyRemove()

void ns3::FcfsWifiQueueScheduler::DoNotifyRemove ( AcIndex ac,
const std::list< Ptr< WifiMpdu > > & mpdus )
overrideprivatevirtual

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
acthe Access Category of the removed MPDUs
mpdusthe list of removed MPDUs

Implements ns3::WifiMacQueueSchedulerImpl< FcfsPrio >.

Definition at line 156 of file fcfs-wifi-queue-scheduler.cc.

References ns3::WifiMacQueueContainer::GetQueueId(), ns3::WifiMacQueueSchedulerImpl< FcfsPrio >::GetWifiMacQueue(), NS_LOG_FUNCTION, and ns3::WifiMacQueueSchedulerImpl< FcfsPrio >::SetPriority().

+ Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::FcfsWifiQueueScheduler::GetTypeId ( )
static

Get the type ID.

Returns
the object TypeId

Definition at line 56 of file fcfs-wifi-queue-scheduler.cc.

References DROP_NEWEST, DROP_OLDEST, m_dropPolicy, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), and ns3::TypeId::SetParent().

+ Here is the call graph for this function:

◆ HasToDropBeforeEnqueuePriv()

Ptr< WifiMpdu > ns3::FcfsWifiQueueScheduler::HasToDropBeforeEnqueuePriv ( AcIndex ac,
Ptr< WifiMpdu > mpdu )
overrideprivatevirtual

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

Parameters
acthe Access Category of the MPDU being enqueued
mpduthe MPDU to enqueue
Returns
a pointer to the MPDU to drop, if any, or a null pointer, otherwise

Implements ns3::WifiMacQueueSchedulerImpl< FcfsPrio >.

Definition at line 81 of file fcfs-wifi-queue-scheduler.cc.

References DROP_OLDEST, ns3::WifiMacQueueSchedulerImpl< FcfsPrio >::GetSortedQueues(), ns3::WifiMacQueueSchedulerImpl< FcfsPrio >::GetWifiMacQueue(), m_dropPolicy, NS_LOG_DEBUG, ns3::WIFI_CTL_QUEUE, and ns3::WIFI_MGT_QUEUE.

+ Here is the call graph for this function:

Member Data Documentation

◆ m_dropPolicy

DropPolicy ns3::FcfsWifiQueueScheduler::m_dropPolicy
private

Drop behavior of queue.

Definition at line 77 of file fcfs-wifi-queue-scheduler.h.

Referenced by GetTypeId(), and HasToDropBeforeEnqueuePriv().

◆ NS_LOG_TEMPLATE_DECLARE

ns3::FcfsWifiQueueScheduler::NS_LOG_TEMPLATE_DECLARE
private

redefinition of the log component

Definition at line 78 of file fcfs-wifi-queue-scheduler.h.


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