A Discrete-Event Network Simulator
API
ns3::WifiMacQueue Class Reference

This queue implements the timeout procedure described in (Section 9.19.2.6 "Retransmit procedures" paragraph 6; IEEE 802.11-2012). More...

#include "wifi-mac-queue.h"

+ Inheritance diagram for ns3::WifiMacQueue:
+ Collaboration diagram for ns3::WifiMacQueue:

Public Member Functions

 WifiMacQueue (AcIndex ac=AC_UNDEF)
 Constructor. More...
 
 ~WifiMacQueue () override
 
Ptr< WifiMpduDequeue () override
 Dequeue the packet in the front of the queue. More...
 
void DequeueIfQueued (const std::list< Ptr< const WifiMpdu >> &mpdus)
 Dequeue the given MPDUs if they are stored in this queue. More...
 
bool Enqueue (Ptr< WifiMpdu > item) override
 Enqueue the given Wifi MAC queue item at the end of the queue. More...
 
void ExtractAllExpiredMpdus () const
 Move MPDUs with expired lifetime from all the container queues to the container queue storing MPDUs with expired lifetime. More...
 
void ExtractExpiredMpdus (const WifiContainerQueueId &queueId) const
 Move MPDUs with expired lifetime from the container queue identified by the given queue ID to the container queue storing MPDUs with expired lifetime. More...
 
void Flush ()
 Flush the queue. More...
 
AcIndex GetAc () const
 Get the Access Category of the packets stored in this queue. More...
 
Ptr< WifiMpduGetAlias (Ptr< const WifiMpdu > mpdu, uint8_t linkId)
 
Time GetMaxDelay () const
 Return the maximum delay before the packet is discarded. More...
 
uint32_t GetNBytes (const WifiContainerQueueId &queueId) const
 Get the amount of bytes currently stored in the container queue identified by the given queue ID. More...
 
uint32_t GetNPackets (const WifiContainerQueueId &queueId) const
 Get the number of MPDUs currently stored in the container queue identified by the given queue ID. More...
 
Ptr< WifiMpduGetOriginal (Ptr< WifiMpdu > mpdu)
 Unlike the GetOriginal() method of WifiMpdu, this method returns a non-const pointer to the original copy of the given MPDU. More...
 
Ptr< const WifiMpduPeek () const override
 Peek the packet in the front of the queue. More...
 
Ptr< WifiMpduPeek (std::optional< uint8_t > linkId) const
 Peek the packet in the front of the queue for transmission on the given link (if any). More...
 
Ptr< WifiMpduPeekByQueueId (const WifiContainerQueueId &queueId, Ptr< const WifiMpdu > item=nullptr) const
 Search and return the first packet present in the container queue identified by the given queue ID. More...
 
Ptr< WifiMpduPeekByTidAndAddress (uint8_t tid, Mac48Address dest, Ptr< const WifiMpdu > item=nullptr) const
 Search and return, if present in the queue, the first packet having the receiver address equal to dest, and TID equal to tid. More...
 
Ptr< WifiMpduPeekFirstAvailable (uint8_t linkId, Ptr< const WifiMpdu > item=nullptr) const
 Return first available packet for transmission on the given link. More...
 
Ptr< WifiMpduRemove () override
 Remove the packet in the front of the queue. More...
 
Ptr< WifiMpduRemove (Ptr< const WifiMpdu > item)
 Remove the given item from the queue and return the item following the removed one, if any, or a null pointer otherwise. More...
 
void Replace (Ptr< const WifiMpdu > currentItem, Ptr< WifiMpdu > newItem)
 Replace the given current item with the given new item. More...
 
void SetMaxDelay (Time delay)
 Set the maximum delay before the packet is discarded. More...
 
void SetScheduler (Ptr< WifiMacQueueScheduler > scheduler)
 Set the wifi MAC queue scheduler. More...
 
bool TtlExceeded (Ptr< const WifiMpdu > item, const Time &now)
 Remove the given item if it has been in the queue for too long. More...
 
void WipeAllExpiredMpdus ()
 Remove all MPDUs with expired lifetime from this WifiMacQueue object. More...
 
- Public Member Functions inherited from ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >
 Queue ()
 
 ~Queue () override
 
void Flush ()
 Flush the queue by calling Remove() on each item enqueued. More...
 
- Public Member Functions inherited from ns3::QueueBase
 QueueBase ()
 
 ~QueueBase () override
 
QueueSize GetCurrentSize () const
 
QueueSize GetMaxSize () const
 
uint32_t GetNBytes () const
 
uint32_t GetNPackets () const
 
uint32_t GetTotalDroppedBytes () const
 
uint32_t GetTotalDroppedBytesAfterDequeue () const
 
uint32_t GetTotalDroppedBytesBeforeEnqueue () const
 
uint32_t GetTotalDroppedPackets () const
 
uint32_t GetTotalDroppedPacketsAfterDequeue () const
 
uint32_t GetTotalDroppedPacketsBeforeEnqueue () const
 
uint32_t GetTotalReceivedBytes () const
 
uint32_t GetTotalReceivedPackets () const
 
bool IsEmpty () const
 
void ResetStatistics ()
 Resets the counts for dropped packets, dropped bytes, received packets, and received bytes. More...
 
void SetMaxSize (QueueSize size)
 Set the maximum size of this queue. More...
 
bool WouldOverflow (uint32_t nPackets, uint32_t nBytes) const
 Check if the queue would overflow with additional bytes or packets Note: the check is performed according to the queue's operating mode (bytes or packets). More...
 
- Public Member Functions inherited from ns3::Object
 Object ()
 Constructor. More...
 
 ~Object () override
 Destructor. More...
 
void AggregateObject (Ptr< Object > other)
 Aggregate two Objects together. More...
 
void Dispose ()
 Dispose of this Object. More...
 
AggregateIterator GetAggregateIterator () const
 Get an iterator to the Objects aggregated to this one. More...
 
TypeId GetInstanceTypeId () const override
 Get the most derived TypeId for this Object. More...
 
template<typename T >
Ptr< T > GetObject () const
 Get a pointer to the requested aggregated Object. More...
 
template<>
Ptr< ObjectGetObject () const
 Specialization of () for objects of type ns3::Object. More...
 
template<typename T >
Ptr< T > GetObject (TypeId tid) const
 Get a pointer to the requested aggregated Object by TypeId. More...
 
template<>
Ptr< ObjectGetObject (TypeId tid) const
 Specialization of (TypeId tid) for objects of type ns3::Object. More...
 
void Initialize ()
 Invoke DoInitialize on all Objects aggregated to this one. More...
 
bool IsInitialized () const
 Check if the object has been initialized. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
 Copy constructor. More...
 
uint32_t GetReferenceCount () const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (const SimpleRefCount &o[[maybe_unused]])
 Assignment operator. More...
 
void Ref () const
 Increment the reference count. More...
 
void Unref () const
 Decrement the reference count. More...
 
- Public Member Functions inherited from ns3::ObjectBase
virtual ~ObjectBase ()
 Virtual destructor. More...
 
void GetAttribute (std::string name, AttributeValue &value) const
 Get the value of an attribute, raising fatal errors if unsuccessful. More...
 
bool GetAttributeFailSafe (std::string name, AttributeValue &value) const
 Get the value of an attribute without raising errors. More...
 
void SetAttribute (std::string name, const AttributeValue &value)
 Set a single attribute, raising fatal errors if unsuccessful. More...
 
bool SetAttributeFailSafe (std::string name, const AttributeValue &value)
 Set a single attribute without raising errors. More...
 
bool TraceConnect (std::string name, std::string context, const CallbackBase &cb)
 Connect a TraceSource to a Callback with a context. More...
 
bool TraceConnectWithoutContext (std::string name, const CallbackBase &cb)
 Connect a TraceSource to a Callback without a context. More...
 
bool TraceDisconnect (std::string name, std::string context, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected with a context. More...
 
bool TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb)
 Disconnect from a TraceSource a Callback previously connected without a context. More...
 

Static Public Member Functions

static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::QueueBase
static void AppendItemTypeIfNotPresent (std::string &typeId, const std::string &itemType)
 Append the item type to the provided type ID if the latter does not end with '>'. More...
 
static TypeId GetTypeId ()
 Get the type ID. More...
 
- Static Public Member Functions inherited from ns3::Object
static TypeId GetTypeId ()
 Register this type. More...
 
- Static Public Member Functions inherited from ns3::ObjectBase
static TypeId GetTypeId ()
 Get the type ID. More...
 

Protected Member Functions

void DoDispose () override
 Destructor implementation. More...
 
- Protected Member Functions inherited from ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >
Ptr< WifiMpduDoDequeue (ConstIterator pos)
 Pull the item to dequeue from the queue. More...
 
void DoDispose () override
 Destructor implementation. More...
 
bool DoEnqueue (ConstIterator pos, Ptr< WifiMpdu > item)
 Push an item in the queue. More...
 
bool DoEnqueue (ConstIterator pos, Ptr< WifiMpdu > item, Iterator &ret)
 Push an item in the queue. More...
 
Ptr< const WifiMpduDoPeek (ConstIterator pos) const
 Peek the front item in the queue. More...
 
Ptr< WifiMpduDoRemove (ConstIterator pos)
 Pull the item to drop from the queue. More...
 
void DropAfterDequeue (Ptr< WifiMpdu > item)
 Drop a packet after dequeue. More...
 
void DropBeforeEnqueue (Ptr< WifiMpdu > item)
 Drop a packet before enqueue. More...
 
const ns3::WifiMacQueueContainerGetContainer () const
 Get a const reference to the container of queue items. 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

void DoDequeue (const std::list< ConstIterator > &iterators)
 Wrapper for the DoDequeue method provided by the base class that additionally resets the iterator field of the dequeued items and notifies the scheduler, if any item was dequeued. More...
 
bool DoEnqueue (ConstIterator pos, Ptr< WifiMpdu > item)
 Wrapper for the DoEnqueue method provided by the base class that additionally sets the iterator field of the item and updates internal statistics, if insertion succeeded. More...
 
Ptr< WifiMpduDoRemove (ConstIterator pos)
 Wrapper for the DoRemove method provided by the base class that additionally resets the iterator field of the item and notifies the scheduleer, if an item was dropped. More...
 
Iterator GetIt (Ptr< const WifiMpdu > mpdu) const
 
bool Insert (ConstIterator pos, Ptr< WifiMpdu > item)
 Enqueue the given Wifi MAC queue item before the given position. More...
 

Private Attributes

AcIndex m_ac
 the access category More...
 
Time m_maxDelay
 Time to live for packets in the queue. More...
 
Ptr< WifiMacQueueSchedulerm_scheduler
 the MAC queue scheduler More...
 
TracedCallback< Ptr< const WifiMpdu > > m_traceExpired
 Traced callback: fired when a packet is dropped due to lifetime expiration. More...
 
 NS_LOG_TEMPLATE_DECLARE
 redefinition of the log component More...
 

Additional Inherited Members

- Public Types inherited from ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >
typedef WifiMpdu ItemType
 Define ItemType as the type of the stored elements. More...
 
- Protected Types inherited from ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >
typedef Container::const_iterator ConstIterator
 Const iterator. More...
 
typedef Container::iterator Iterator
 Iterator. More...
 
- Protected Attributes inherited from ns3::QueueBase
QueueSize m_maxSize
 max queue size More...
 
TracedValue< uint32_t > m_nBytes
 Number of bytes in the queue. More...
 
TracedValue< uint32_t > m_nPackets
 Number of packets in the queue. More...
 
uint32_t m_nTotalDroppedBytes
 Total dropped bytes. More...
 
uint32_t m_nTotalDroppedBytesAfterDequeue
 Total dropped bytes after dequeue. More...
 
uint32_t m_nTotalDroppedBytesBeforeEnqueue
 Total dropped bytes before enqueue. More...
 
uint32_t m_nTotalDroppedPackets
 Total dropped packets. More...
 
uint32_t m_nTotalDroppedPacketsAfterDequeue
 Total dropped packets after dequeue. More...
 
uint32_t m_nTotalDroppedPacketsBeforeEnqueue
 Total dropped packets before enqueue. More...
 
uint32_t m_nTotalReceivedBytes
 Total received bytes. More...
 
uint32_t m_nTotalReceivedPackets
 Total received packets. More...
 

Detailed Description

This queue implements the timeout procedure described in (Section 9.19.2.6 "Retransmit procedures" paragraph 6; IEEE 802.11-2012).

When a packet is received by the MAC, to be sent to the PHY, it is queued in the internal queue after being tagged by the current time.

When a packet is dequeued, the queue checks its timestamp to verify whether or not it should be dropped. If dot11EDCATableMSDULifetime has elapsed, it is dropped. Otherwise, it is returned to the caller.

Compiling python bindings fails if the namespace (ns3) is not specified for WifiMacQueueContainerT.

Definition at line 66 of file wifi-mac-queue.h.

Constructor & Destructor Documentation

◆ WifiMacQueue()

ns3::WifiMacQueue::WifiMacQueue ( AcIndex  ac = AC_UNDEF)

Constructor.

Parameters
acthe Access Category of the packets stored in this queue

Definition at line 65 of file wifi-mac-queue.cc.

◆ ~WifiMacQueue()

ns3::WifiMacQueue::~WifiMacQueue ( )
override

Definition at line 71 of file wifi-mac-queue.cc.

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ Dequeue()

Ptr< WifiMpdu > ns3::WifiMacQueue::Dequeue ( void  )
overridevirtual

Dequeue the packet in the front of the queue.

Returns
the packet

Implements ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >.

Definition at line 273 of file wifi-mac-queue.cc.

References NS_ABORT_MSG.

◆ DequeueIfQueued()

void ns3::WifiMacQueue::DequeueIfQueued ( const std::list< Ptr< const WifiMpdu >> &  mpdus)

Dequeue the given MPDUs if they are stored in this queue.

Parameters
mpdusthe given MPDUs

Definition at line 282 of file wifi-mac-queue.cc.

References DoDequeue(), GetIt(), m_ac, NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoDequeue()

void ns3::WifiMacQueue::DoDequeue ( const std::list< ConstIterator > &  iterators)
private

Wrapper for the DoDequeue method provided by the base class that additionally resets the iterator field of the dequeued items and notifies the scheduler, if any item was dequeued.

Parameters
iteratorsthe list of iterators pointing to the items to dequeue

Definition at line 504 of file wifi-mac-queue.cc.

References ns3::QueueBase::GetMaxSize(), m_ac, m_scheduler, NS_LOG_FUNCTION, and ns3::QueueBase::SetMaxSize().

Referenced by DequeueIfQueued(), and Replace().

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

◆ DoDispose()

void ns3::WifiMacQueue::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.

Definition at line 77 of file wifi-mac-queue.cc.

References ns3::Queue< Item, Container >::DoDispose(), m_scheduler, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ DoEnqueue()

bool ns3::WifiMacQueue::DoEnqueue ( ConstIterator  pos,
Ptr< WifiMpdu item 
)
private

Wrapper for the DoEnqueue method provided by the base class that additionally sets the iterator field of the item and updates internal statistics, if insertion succeeded.

Parameters
posthe position before where the item will be inserted
itemthe item to enqueue
Returns
true if success, false if the packet has been dropped.

Definition at line 455 of file wifi-mac-queue.cc.

References DoRemove(), ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >::GetContainer(), GetIt(), ns3::QueueBase::GetMaxSize(), ns3::WifiMacQueueContainer::GetQueueId(), m_ac, m_maxDelay, m_scheduler, ns3::Time::Max(), ns3::Simulator::Now(), NS_LOG_FUNCTION, and ns3::QueueBase::SetMaxSize().

Referenced by Insert().

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

◆ DoRemove()

Ptr< WifiMpdu > ns3::WifiMacQueue::DoRemove ( ConstIterator  pos)
private

Wrapper for the DoRemove method provided by the base class that additionally resets the iterator field of the item and notifies the scheduleer, if an item was dropped.

Parameters
posthe position of the item to drop
Returns
the dropped item.

Definition at line 531 of file wifi-mac-queue.cc.

References ns3::Queue< Item, Container >::DoRemove(), ns3::QueueBase::GetMaxSize(), m_ac, m_scheduler, NS_LOG_FUNCTION, and ns3::QueueBase::SetMaxSize().

Referenced by DoEnqueue(), Remove(), and TtlExceeded().

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

◆ Enqueue()

bool ns3::WifiMacQueue::Enqueue ( Ptr< WifiMpdu item)
overridevirtual

Enqueue the given Wifi MAC queue item at the end of the queue.

Parameters
itemthe Wifi MAC queue item to be enqueued at the end
Returns
true if success, false if the packet has been dropped

Implements ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >.

Definition at line 231 of file wifi-mac-queue.cc.

References ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >::GetContainer(), ns3::WifiMacQueueContainer::GetQueueId(), Insert(), and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ ExtractAllExpiredMpdus()

void ns3::WifiMacQueue::ExtractAllExpiredMpdus ( ) const

Move MPDUs with expired lifetime from all the container queues to the container queue storing MPDUs with expired lifetime.

Each MPDU that is found to have an expired lifetime feeds the "Expired" trace source and is notified to the scheduler.

Note
that such MPDUs are not removed from the WifiMacQueue (and hence are still accounted for in the overall statistics kept by the Queue base class) in order to make this method const.

Definition at line 143 of file wifi-mac-queue.cc.

References ns3::WifiMacQueueContainer::ExtractAllExpiredMpdus(), ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >::GetContainer(), m_ac, m_scheduler, m_traceExpired, NS_LOG_FUNCTION, and ns3::Simulator::ScheduleNow().

Referenced by WipeAllExpiredMpdus().

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

◆ ExtractExpiredMpdus()

void ns3::WifiMacQueue::ExtractExpiredMpdus ( const WifiContainerQueueId queueId) const

Move MPDUs with expired lifetime from the container queue identified by the given queue ID to the container queue storing MPDUs with expired lifetime.

Each MPDU that is found to have an expired lifetime feeds the "Expired" trace source and is notified to the scheduler.

Note
that such MPDUs are not removed from the WifiMacQueue (and hence are still accounted for in the overall statistics kept by the Queue base class) in order to make this method const.
Parameters
queueIdthe given queue ID

Definition at line 119 of file wifi-mac-queue.cc.

References ns3::WifiMacQueueContainer::ExtractExpiredMpdus(), ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >::GetContainer(), m_ac, m_scheduler, m_traceExpired, NS_LOG_FUNCTION, and ns3::Simulator::ScheduleNow().

Referenced by PeekByQueueId().

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

◆ Flush()

void ns3::WifiMacQueue::Flush ( )

Flush the queue.

Definition at line 412 of file wifi-mac-queue.cc.

References ns3::Queue< Item, Container >::Flush(), NS_LOG_FUNCTION, and WipeAllExpiredMpdus().

+ Here is the call graph for this function:

◆ GetAc()

AcIndex ns3::WifiMacQueue::GetAc ( ) const

Get the Access Category of the packets stored in this queue.

Returns
the Access Category of the packets stored in this queue

Definition at line 85 of file wifi-mac-queue.cc.

References m_ac.

◆ GetAlias()

Ptr< WifiMpdu > ns3::WifiMacQueue::GetAlias ( Ptr< const WifiMpdu mpdu,
uint8_t  linkId 
)
Parameters
mpduthe given MPDU
linkIdthe ID of the given link
Returns
the alias of the given MPDU that is inflight on the given link, if any, or a null pointer, otherwise

Definition at line 104 of file wifi-mac-queue.cc.

References GetIt().

+ Here is the call graph for this function:

◆ GetIt()

WifiMacQueue::Iterator ns3::WifiMacQueue::GetIt ( Ptr< const WifiMpdu mpdu) const
private
Parameters
mpduthe given MPDU
Returns
the queue iterator stored by the given MPDU

Definition at line 91 of file wifi-mac-queue.cc.

References NS_ASSERT.

Referenced by DequeueIfQueued(), DoEnqueue(), GetAlias(), GetOriginal(), PeekByQueueId(), Remove(), Replace(), and TtlExceeded().

+ Here is the caller graph for this function:

◆ GetMaxDelay()

Time ns3::WifiMacQueue::GetMaxDelay ( ) const

Return the maximum delay before the packet is discarded.

Returns
the maximum delay

Definition at line 225 of file wifi-mac-queue.cc.

References m_maxDelay.

◆ GetNBytes()

uint32_t ns3::WifiMacQueue::GetNBytes ( const WifiContainerQueueId queueId) const

Get the amount of bytes currently stored in the container queue identified by the given queue ID.

Parameters
queueIdthe given queue ID
Returns
the amount of bytes currently stored in the container queue

Definition at line 449 of file wifi-mac-queue.cc.

References ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >::GetContainer(), and ns3::WifiMacQueueContainer::GetNBytes().

+ Here is the call graph for this function:

◆ GetNPackets()

uint32_t ns3::WifiMacQueue::GetNPackets ( const WifiContainerQueueId queueId) const

Get the number of MPDUs currently stored in the container queue identified by the given queue ID.

Parameters
queueIdthe given queue ID
Returns
the number of MPDUs currently stored in the container queue

Definition at line 443 of file wifi-mac-queue.cc.

References ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >::GetContainer(), and ns3::WifiMacQueueContainer::GetQueue().

+ Here is the call graph for this function:

◆ GetOriginal()

Ptr< WifiMpdu > ns3::WifiMacQueue::GetOriginal ( Ptr< WifiMpdu mpdu)

Unlike the GetOriginal() method of WifiMpdu, this method returns a non-const pointer to the original copy of the given MPDU.

Parameters
mpduthe given MPDU
Returns
the original copy of the given MPDU

Definition at line 98 of file wifi-mac-queue.cc.

References GetIt().

+ Here is the call graph for this function:

◆ GetTypeId()

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

◆ Insert()

bool ns3::WifiMacQueue::Insert ( ConstIterator  pos,
Ptr< WifiMpdu item 
)
private

Enqueue the given Wifi MAC queue item before the given position.

Parameters
posthe position before which the item is to be inserted
itemthe Wifi MAC queue item to be enqueued
Returns
true if success, false if the packet has been dropped

Definition at line 240 of file wifi-mac-queue.cc.

References DoEnqueue(), ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >::GetContainer(), ns3::QueueBase::GetMaxSize(), ns3::QueueBase::GetNPackets(), ns3::WifiMacQueueContainer::GetQueue(), ns3::WifiMacQueueContainer::GetQueueId(), ns3::Simulator::Now(), NS_ABORT_MSG_IF, NS_ASSERT_MSG, NS_LOG_FUNCTION, ns3::PACKETS, and WipeAllExpiredMpdus().

Referenced by Enqueue(), and Replace().

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

◆ Peek() [1/2]

Ptr< const WifiMpdu > ns3::WifiMacQueue::Peek ( ) const
overridevirtual

Peek the packet in the front of the queue.

The packet is not removed.

Returns
the packet

Implements ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >.

Definition at line 303 of file wifi-mac-queue.cc.

Referenced by Remove().

+ Here is the caller graph for this function:

◆ Peek() [2/2]

Ptr< WifiMpdu > ns3::WifiMacQueue::Peek ( std::optional< uint8_t >  linkId) const

Peek the packet in the front of the queue for transmission on the given link (if any).

The packet is not removed.

Parameters
linkIdthe ID of the link onto which we can transmit a packet
Returns
the packet

Definition at line 309 of file wifi-mac-queue.cc.

References ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >::GetContainer(), ns3::WifiMacQueueContainer::GetQueue(), m_ac, m_scheduler, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ PeekByQueueId()

Ptr< WifiMpdu > ns3::WifiMacQueue::PeekByQueueId ( const WifiContainerQueueId queueId,
Ptr< const WifiMpdu item = nullptr 
) const

Search and return the first packet present in the container queue identified by the given queue ID.

If item is a null pointer, the search starts from the head of the container queue; MPDUs with expired lifetime at the head of the container queue are ignored (and moved to the container queue storing MPDUs with expired lifetime). If item is not a null pointer, the search starts from the packet following item in the container queue (and we do not check for expired lifetime because we assume that a previous call was made with a null pointer as argument, which removed the MPDUs with expired lifetime).

Parameters
queueIdthe given queue ID
itemthe item after which the search starts from
Returns
the peeked packet or nullptr if no packet was found

Definition at line 334 of file wifi-mac-queue.cc.

References ExtractExpiredMpdus(), ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >::GetContainer(), GetIt(), ns3::WifiMacQueueContainer::GetQueue(), ns3::WifiMacQueueContainer::GetQueueId(), NS_ASSERT, NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by PeekByTidAndAddress(), and PeekFirstAvailable().

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

◆ PeekByTidAndAddress()

Ptr< WifiMpdu > ns3::WifiMacQueue::PeekByTidAndAddress ( uint8_t  tid,
Mac48Address  dest,
Ptr< const WifiMpdu item = nullptr 
) const

Search and return, if present in the queue, the first packet having the receiver address equal to dest, and TID equal to tid.

If item is not a null pointer, the search starts from the packet following item in the queue; otherwise, the search starts from the head of the queue. This method does not remove the packet from the queue. It is typically used by ns3::QosTxop in order to perform correct MSDU aggregation (A-MSDU).

Parameters
tidthe given TID
destthe given destination
itemthe item after which the search starts from
Returns
the peeked packet or nullptr if no packet was found

Definition at line 325 of file wifi-mac-queue.cc.

References ns3::Mac48Address::IsGroup(), NS_ABORT_IF, NS_LOG_FUNCTION, PeekByQueueId(), ns3::WIFI_QOSDATA_QUEUE, and ns3::WIFI_UNICAST.

+ Here is the call graph for this function:

◆ PeekFirstAvailable()

Ptr< WifiMpdu > ns3::WifiMacQueue::PeekFirstAvailable ( uint8_t  linkId,
Ptr< const WifiMpdu item = nullptr 
) const

Return first available packet for transmission on the given link.

If item is not a null pointer, the search starts from the packet following item in the queue; otherwise, the search starts from the head of the queue. The packet is not removed from queue.

Parameters
linkIdthe ID of the given link
itemthe item after which the search starts from
Returns
the peeked packet or nullptr if no packet was found

Definition at line 357 of file wifi-mac-queue.cc.

References ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >::GetContainer(), ns3::WifiMacQueueContainer::GetQueue(), ns3::WifiMacQueueContainer::GetQueueId(), m_ac, m_scheduler, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, and PeekByQueueId().

+ Here is the call graph for this function:

◆ Remove() [1/2]

Ptr< WifiMpdu > ns3::WifiMacQueue::Remove ( )
overridevirtual

Remove the packet in the front of the queue.

Returns
the packet

Implements ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >.

Definition at line 394 of file wifi-mac-queue.cc.

References Peek().

+ Here is the call graph for this function:

◆ Remove() [2/2]

Ptr< WifiMpdu > ns3::WifiMacQueue::Remove ( Ptr< const WifiMpdu item)

Remove the given item from the queue and return the item following the removed one, if any, or a null pointer otherwise.

If removeExpired is true, all the items in the queue from the head to the given position are removed if their lifetime expired.

Parameters
itemthe item to be removed
Returns
the removed item

Definition at line 400 of file wifi-mac-queue.cc.

References DoRemove(), GetIt(), m_ac, NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ Replace()

void ns3::WifiMacQueue::Replace ( Ptr< const WifiMpdu currentItem,
Ptr< WifiMpdu newItem 
)

Replace the given current item with the given new item.

Actually, the current item is dequeued and the new item is enqueued in its place. In this way, statistics about queue size (in terms of bytes) are correctly updated.

Parameters
currentItemthe given current item
newItemthe given new item

Definition at line 423 of file wifi-mac-queue.cc.

References DoDequeue(), GetIt(), Insert(), m_ac, NS_ABORT_IF, NS_ASSERT, and NS_LOG_FUNCTION.

+ Here is the call graph for this function:

◆ SetMaxDelay()

void ns3::WifiMacQueue::SetMaxDelay ( Time  delay)

Set the maximum delay before the packet is discarded.

Parameters
delaythe maximum delay

Definition at line 218 of file wifi-mac-queue.cc.

References m_maxDelay, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

+ Here is the caller graph for this function:

◆ SetScheduler()

void ns3::WifiMacQueue::SetScheduler ( Ptr< WifiMacQueueScheduler scheduler)

Set the wifi MAC queue scheduler.

Parameters
schedulerthe wifi MAC queue scheduler

Definition at line 211 of file wifi-mac-queue.cc.

References m_scheduler, and NS_LOG_FUNCTION.

◆ TtlExceeded()

bool ns3::WifiMacQueue::TtlExceeded ( Ptr< const WifiMpdu item,
const Time now 
)

Remove the given item if it has been in the queue for too long.

Return true if the item is removed, false otherwise.

Parameters
itemthe item whose lifetime is checked
nowa copy of Simulator::Now()
Returns
true if the item is removed, false otherwise

Definition at line 186 of file wifi-mac-queue.cc.

References DoRemove(), GetIt(), m_maxDelay, m_traceExpired, NS_ASSERT, and NS_LOG_DEBUG.

+ Here is the call graph for this function:

◆ WipeAllExpiredMpdus()

void ns3::WifiMacQueue::WipeAllExpiredMpdus ( )

Remove all MPDUs with expired lifetime from this WifiMacQueue object.

Definition at line 167 of file wifi-mac-queue.cc.

References ns3::Queue< Item, Container >::DoRemove(), ExtractAllExpiredMpdus(), ns3::WifiMacQueueContainer::GetAllExpiredMpdus(), ns3::Queue< WifiMpdu, ns3::WifiMacQueueContainer >::GetContainer(), and NS_LOG_FUNCTION.

Referenced by Flush(), and Insert().

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

Member Data Documentation

◆ m_ac

AcIndex ns3::WifiMacQueue::m_ac
private

◆ m_maxDelay

Time ns3::WifiMacQueue::m_maxDelay
private

Time to live for packets in the queue.

Definition at line 350 of file wifi-mac-queue.h.

Referenced by DoEnqueue(), GetMaxDelay(), SetMaxDelay(), and TtlExceeded().

◆ m_scheduler

Ptr<WifiMacQueueScheduler> ns3::WifiMacQueue::m_scheduler
private

◆ m_traceExpired

TracedCallback<Ptr<const WifiMpdu> > ns3::WifiMacQueue::m_traceExpired
private

Traced callback: fired when a packet is dropped due to lifetime expiration.

Definition at line 355 of file wifi-mac-queue.h.

Referenced by ExtractAllExpiredMpdus(), ExtractExpiredMpdus(), GetTypeId(), and TtlExceeded().

◆ NS_LOG_TEMPLATE_DECLARE

ns3::WifiMacQueue::NS_LOG_TEMPLATE_DECLARE
private

redefinition of the log component

Definition at line 357 of file wifi-mac-queue.h.


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