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 Types
enum	DropPolicy { DROP_NEWEST , DROP_OLDEST }
	drop policy More...

Public Member Functions
	WifiMacQueue ()

	~WifiMacQueue ()

Ptr< WifiMacQueueItem >	Dequeue (void) override
	Dequeue the packet in the front of the queue. More...

Ptr< WifiMacQueueItem >	Dequeue (WifiMacQueue::ConstIterator pos)
	Dequeue the item at position pos in the queue. More...

Ptr< WifiMacQueueItem >	DequeueByAddress (Mac48Address dest)
	Search and return, if present in the queue, the first packet (either Data frame or QoS Data frame) having the receiver address equal to addr. More...

Ptr< WifiMacQueueItem >	DequeueByTid (uint8_t tid)
	Search and return, if present in the queue, the first packet having the TID equal to tid. More...

Ptr< WifiMacQueueItem >	DequeueByTidAndAddress (uint8_t tid, Mac48Address dest)
	Search and return, if present in the queue, the first packet having the address indicated by type equal to addr, and TID equal to tid. More...

Ptr< WifiMacQueueItem >	DequeueFirstAvailable (const Ptr< QosBlockedDestinations > blockedPackets=nullptr)
	Return first available packet for transmission. More...

bool	Enqueue (Ptr< WifiMacQueueItem > item) override
	Enqueue the given Wifi MAC queue item at the end of the queue. More...

Time	GetMaxDelay (void) const
	Return the maximum delay before the packet is discarded. More...

uint32_t	GetNBytes (uint8_t tid, Mac48Address dest) const
	Return the number of bytes in the queue having tid equal to tid and destination address equal to dest. More...

uint32_t	GetNBytes (void)

uint32_t	GetNPackets (uint8_t tid, Mac48Address dest) const
	Return the number of QoS packets in the queue having tid equal to tid and destination address equal to dest. More...

uint32_t	GetNPackets (void)

uint32_t	GetNPacketsByAddress (Mac48Address dest)
	Return the number of packets having destination address specified by dest. More...

uint32_t	GetNPacketsByTidAndAddress (uint8_t tid, Mac48Address dest)
	Return the number of QoS packets having TID equal to tid and destination address equal to dest. More...

bool	Insert (ConstIterator pos, Ptr< WifiMacQueueItem > item)
	Enqueue the given Wifi MAC queue item before the given position. More...

bool	IsEmpty (void)

Ptr< const WifiMacQueueItem >	Peek (void) const override
	Peek the packet in the front of the queue. More...

ConstIterator	PeekByAddress (Mac48Address dest, ConstIterator pos=EMPTY) const
	Search and return, if present in the queue, the first packet (either Data frame or QoS Data frame) having the receiver address equal to addr. More...

ConstIterator	PeekByTid (uint8_t tid, ConstIterator pos=EMPTY) const
	Search and return, if present in the queue, the first packet having the TID equal to tid. More...

ConstIterator	PeekByTidAndAddress (uint8_t tid, Mac48Address dest, ConstIterator pos=EMPTY) 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...

ConstIterator	PeekFirstAvailable (const Ptr< QosBlockedDestinations > blockedPackets=nullptr, ConstIterator pos=EMPTY) const
	Return first available packet for transmission. More...

bool	PushFront (Ptr< WifiMacQueueItem > item)
	Enqueue the given Wifi MAC queue item at the front of the queue. More...

ConstIterator	Remove (ConstIterator pos, bool removeExpired=false)
	Remove the item at position pos in the queue and return an iterator pointing to the item following the removed one. More...

bool	Remove (Ptr< const Packet > packet)
	If exists, removes packet from queue and returns true. More...

Ptr< WifiMacQueueItem >	Remove (void) override
	Remove the packet in the front of the queue. More...

void	SetMaxDelay (Time delay)
	Set the maximum delay before the packet is discarded. More...

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

Static Public Attributes
static const ConstIterator	EMPTY = g_emptyWifiMacQueue.end ()
	Invalid iterator to signal an empty queue. More...

Private Member Functions
Ptr< WifiMacQueueItem >	DoDequeue (ConstIterator pos)
	Wrapper for the DoDequeue method provided by the base class that additionally resets the iterator field of the item and updates internal statistics, if an item was dequeued. More...

bool	DoEnqueue (ConstIterator pos, Ptr< WifiMacQueueItem > 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< WifiMacQueueItem >	DoRemove (ConstIterator pos)
	Wrapper for the DoRemove method provided by the base class that additionally resets the iterator field of the item and updates internal statistics, if an item was dropped. More...

bool	TtlExceeded (ConstIterator &it)
	Remove the item pointed to by the iterator it if it has been in the queue for too long. More...

Private Attributes
DropPolicy	m_dropPolicy
	Drop behavior of queue. More...

bool	m_expiredPacketsPresent
	True if expired packets are in the queue. More...

Time	m_maxDelay
	Time to live for packets in the queue. More...

std::unordered_map< WifiAddressTidPair, uint32_t, WifiAddressTidHash >	m_nQueuedBytes
	Per (MAC address, TID) pair queued bytes. More...

std::unordered_map< WifiAddressTidPair, uint32_t, WifiAddressTidHash >	m_nQueuedPackets
	Per (MAC address, TID) pair queued packets. More...

TracedCallback< Ptr< const WifiMacQueueItem > >	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...

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.

Config Paths

ns3::WifiMacQueue is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Mac/$ns3::RegularWifiMac/Txop/Queue"

Attributes

MaxSize: The max queue size
- Set with class: QueueSizeValue
- Underlying type: QueueSize
- Initial value: 500p
- Flags: construct write read
MaxDelay: If a packet stays longer than this delay in the queue, it is dropped.
- Set with class: ns3::TimeValue
- Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
- Initial value: +5e+08ns
- Flags: construct write
DropPolicy: Upon enqueue with full queue, drop oldest (DropOldest) or newest (DropNewest) packet
- Set with class: ns3::EnumValue
- Underlying type:
- Initial value: DropNewest
- Flags: construct write read

TraceSources

Expired: MPDU dropped because its lifetime expired.
Callback signature: ns3::WifiMacQueueItem::TracedCallback

TraceSources defined in parent class ns3::Queue<WifiMacQueueItem>

Enqueue: Enqueue a packet in the queue.
Callback signature: ns3::WifiMacQueueItem::TracedCallback
Dequeue: Dequeue a packet from the queue.
Callback signature: ns3::WifiMacQueueItem::TracedCallback
Drop: Drop a packet (for whatever reason).
Callback signature: ns3::WifiMacQueueItem::TracedCallback
DropBeforeEnqueue: Drop a packet before enqueue.
Callback signature: ns3::WifiMacQueueItem::TracedCallback
DropAfterDequeue: Drop a packet after dequeue.
Callback signature: ns3::WifiMacQueueItem::TracedCallback

TraceSources defined in parent class ns3::QueueBase

PacketsInQueue: Number of packets currently stored in the queue
Callback signature: ns3::TracedValueCallback::Uint32
BytesInQueue: Number of bytes currently stored in the queue
Callback signature: ns3::TracedValueCallback::Uint32

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

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

Member Enumeration Documentation

◆ DropPolicy

enum ns3::WifiMacQueue::DropPolicy

drop policy

Enumerator
DROP_NEWEST
DROP_OLDEST

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

Constructor & Destructor Documentation

◆ WifiMacQueue()

ns3::WifiMacQueue::WifiMacQueue ( )

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

◆ ~WifiMacQueue()

ns3::WifiMacQueue::~WifiMacQueue ( )

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

References m_nQueuedBytes, m_nQueuedPackets, and NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ Dequeue() [1/2]

Ptr< WifiMacQueueItem > ns3::WifiMacQueue::Dequeue ( void )

override

Dequeue the packet in the front of the queue.

Returns: the packet

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

References DoDequeue(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

Referenced by DequeueByAddress(), DequeueByTid(), DequeueByTidAndAddress(), DequeueFirstAvailable(), ns3::FrameExchangeManager::DequeueMpdu(), ns3::HtFrameExchangeManager::DequeuePsdu(), and ns3::FrameExchangeManager::GetFirstFragmentIfNeeded().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Dequeue() [2/2]

Ptr<WifiMacQueueItem> ns3::WifiMacQueue::Dequeue ( WifiMacQueue::ConstIterator pos )

Dequeue the item at position pos in the queue.

Return a null pointer if the given iterator is invalid, the queue is empty or the lifetime of the item pointed to by the given iterator is expired.

Parameters

pos	the position of the item to be dequeued

Returns: the dequeued item, if any

◆ DequeueByAddress()

Ptr< WifiMacQueueItem > ns3::WifiMacQueue::DequeueByAddress ( Mac48Address dest )

Search and return, if present in the queue, the first packet (either Data frame or QoS Data frame) having the receiver address equal to addr.

This method removes the packet from the queue. It is typically used by ns3::Txop during the CF period.

Parameters

dest	the given destination

Returns: the packet

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

References Dequeue(), NS_LOG_FUNCTION, and PeekByAddress().

Here is the call graph for this function:

◆ DequeueByTid()

Ptr< WifiMacQueueItem > ns3::WifiMacQueue::DequeueByTid ( uint8_t tid )

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

This method removes the packet from the queue.

Parameters

tid	the given TID

Returns: the packet

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

References Dequeue(), NS_LOG_FUNCTION, and PeekByTid().

Here is the call graph for this function:

◆ DequeueByTidAndAddress()

Ptr< WifiMacQueueItem > ns3::WifiMacQueue::DequeueByTidAndAddress	(	uint8_t	tid,
		Mac48Address	dest
	)

Search and return, if present in the queue, the first packet having the address indicated by type equal to addr, and TID equal to tid.

This method removes the packet from the queue. It is typically used by ns3::QosTxop in order to perform correct MSDU aggregation (A-MSDU).

Parameters

tid	the given TID
dest	the given destination

Returns: the packet

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

References Dequeue(), NS_LOG_FUNCTION, and PeekByTidAndAddress().

Here is the call graph for this function:

◆ DequeueFirstAvailable()

Ptr< WifiMacQueueItem > ns3::WifiMacQueue::DequeueFirstAvailable ( const Ptr< QosBlockedDestinations > blockedPackets = nullptr )

Return first available packet for transmission.

A packet could be no available if it is a QoS packet with a TID and an address1 fields equal to tid and addr respectively that index a pending agreement in the BlockAckManager object. So that packet must not be transmitted until reception of an ADDBA response frame from station addressed by addr. This method removes the packet from queue.

Parameters

blockedPackets the destination address & TID pairs that are waiting for a BlockAck response

Returns: the packet

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

References Dequeue(), NS_LOG_FUNCTION, and PeekFirstAvailable().

Here is the call graph for this function:

◆ DoDequeue()

Ptr< WifiMacQueueItem > ns3::WifiMacQueue::DoDequeue ( ConstIterator pos )

private

Wrapper for the DoDequeue method provided by the base class that additionally resets the iterator field of the item and updates internal statistics, if an item was dequeued.

Parameters

pos	the position of the item to dequeue

Returns: the item.

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

References ns3::Queue< Item >::DoDequeue(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacQueueItem::GetHeader(), ns3::WifiMacHeader::GetQosTid(), ns3::WifiMacQueueItem::GetSize(), ns3::WifiMacHeader::IsQosData(), m_nQueuedBytes, m_nQueuedPackets, ns3::WifiMacQueueItem::m_queueIts, and NS_ASSERT.

Referenced by Dequeue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoEnqueue()

bool ns3::WifiMacQueue::DoEnqueue	(	ConstIterator	pos,
		Ptr< WifiMacQueueItem >	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

pos	the position before where the item will be inserted
item	the item to enqueue

Returns: true if success, false if the packet has been dropped.

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

References ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacQueueItem::GetHeader(), ns3::WifiMacHeader::GetQosTid(), ns3::WifiMacQueueItem::GetSize(), ns3::WifiMacHeader::IsQosData(), m_nQueuedBytes, m_nQueuedPackets, and ns3::WifiMacQueueItem::m_queueIts.

Referenced by Insert().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoRemove()

Ptr< WifiMacQueueItem > 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 updates internal statistics, if an item was dropped.

Parameters

pos	the position of the item to drop

Returns: the item.

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

References ns3::Queue< Item >::DoRemove(), ns3::WifiMacHeader::GetAddr1(), ns3::WifiMacQueueItem::GetHeader(), ns3::WifiMacHeader::GetQosTid(), ns3::WifiMacQueueItem::GetSize(), ns3::WifiMacHeader::IsQosData(), m_nQueuedBytes, m_nQueuedPackets, ns3::WifiMacQueueItem::m_queueIts, and NS_ASSERT.

Referenced by Insert(), 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< WifiMacQueueItem > item )

override

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

Parameters

item	the Wifi MAC queue item to be enqueued at the end

Returns: true if success, false if the packet has been dropped

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

References Insert(), and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ GetMaxDelay()

Time ns3::WifiMacQueue::GetMaxDelay ( void ) const

Return the maximum delay before the packet is discarded.

Returns: the maximum delay

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

References m_maxDelay.

◆ GetNBytes() [1/2]

uint32_t ns3::WifiMacQueue::GetNBytes	(	uint8_t	tid,
		Mac48Address	dest
	)		const

Return the number of bytes in the queue having tid equal to tid and destination address equal to dest.

The complexity in the average case is constant. However, packets expired since the last non-const operation on the queue are included in the returned count.

Parameters

tid	the given TID
dest	the given destination

Returns: the number of bytes in the queue

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

References m_nQueuedBytes.

◆ GetNBytes() [2/2]

uint32_t ns3::WifiMacQueue::GetNBytes ( void )

Returns: The number of bytes currently occupied by the packets in the Queue

Overrides the GetNBytes method provided by QueueBase

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

References ns3::QueueBase::GetNBytes(), NS_LOG_FUNCTION, and TtlExceeded().

Here is the call graph for this function:

◆ GetNPackets() [1/2]

uint32_t ns3::WifiMacQueue::GetNPackets	(	uint8_t	tid,
		Mac48Address	dest
	)		const

Return the number of QoS packets in the queue having tid equal to tid and destination address equal to dest.

The complexity in the average case is constant. However, packets expired since the last non-const operation on the queue are included in the returned count.

Parameters

tid	the given TID
dest	the given destination

Returns: the number of QoS packets in the queue

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

References m_nQueuedPackets.

◆ GetNPackets() [2/2]

uint32_t ns3::WifiMacQueue::GetNPackets ( void )

Returns: The number of packets currently stored in the Queue

Overrides the GetNPackets method provided by QueueBase

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

References ns3::QueueBase::GetNPackets(), NS_LOG_FUNCTION, and TtlExceeded().

Here is the call graph for this function:

◆ GetNPacketsByAddress()

uint32_t ns3::WifiMacQueue::GetNPacketsByAddress ( Mac48Address dest )

Return the number of packets having destination address specified by dest.

The complexity is linear in the size of the queue.

Parameters

dest	the given destination

Returns: the number of packets

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

Here is the call graph for this function:

◆ GetNPacketsByTidAndAddress()

uint32_t ns3::WifiMacQueue::GetNPacketsByTidAndAddress	(	uint8_t	tid,
		Mac48Address	dest
	)

Return the number of QoS packets having TID equal to tid and destination address equal to dest.

The complexity is linear in the size of the queue.

Parameters

tid	the given TID
dest	the given destination

Returns: the number of QoS packets

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

Here is the call graph for this function:

◆ GetTypeId()

TypeId ns3::WifiMacQueue::GetTypeId ( void )

static

Get the type ID.

Returns: the object TypeId

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

References DROP_NEWEST, DROP_OLDEST, ns3::QueueBase::GetMaxSize(), m_dropPolicy, m_traceExpired, ns3::MakeEnumAccessor(), ns3::MakeEnumChecker(), ns3::MakeQueueSizeAccessor(), ns3::MakeQueueSizeChecker(), ns3::MakeTimeAccessor(), ns3::MakeTimeChecker(), ns3::MakeTraceSourceAccessor(), ns3::MilliSeconds(), SetMaxDelay(), ns3::QueueBase::SetMaxSize(), and ns3::TypeId::SetParent().

Here is the call graph for this function:

◆ Insert()

bool ns3::WifiMacQueue::Insert	(	ConstIterator	pos,
		Ptr< WifiMacQueueItem >	item
	)

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

Parameters

pos	the position before which the item is to be inserted
item	the Wifi MAC queue item to be enqueued

Returns: true if success, false if the packet has been dropped

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

References DoEnqueue(), DoRemove(), DROP_OLDEST, ns3::QueueBase::GetNPackets(), m_dropPolicy, NS_ASSERT_MSG, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::PACKETS, and TtlExceeded().

Referenced by Enqueue(), and PushFront().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsEmpty()

bool ns3::WifiMacQueue::IsEmpty ( void )

Returns: true if the queue is empty; false otherwise

Overrides the IsEmpty method provided by QueueBase

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

Here is the call graph for this function:

◆ Peek()

Ptr< const WifiMacQueueItem > ns3::WifiMacQueue::Peek ( void ) const

override

Peek the packet in the front of the queue.

The packet is not removed.

Returns: the packet

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

References m_expiredPacketsPresent, m_maxDelay, ns3::Simulator::Now(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Here is the call graph for this function:

◆ PeekByAddress()

WifiMacQueue::ConstIterator ns3::WifiMacQueue::PeekByAddress	(	Mac48Address	dest,
		ConstIterator	pos = `EMPTY`
	)		const

Search and return, if present in the queue, the first packet (either Data frame or QoS Data frame) having the receiver address equal to addr.

If pos is a valid iterator, the search starts from the packet pointed to by the given iterator. This method does not remove the packet from the queue.

Parameters

dest	the given destination
pos	the iterator pointing to the packet the search starts from

Returns: an iterator pointing to the peeked packet

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

References EMPTY, m_expiredPacketsPresent, m_maxDelay, ns3::Simulator::Now(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by DequeueByAddress().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PeekByTid()

WifiMacQueue::ConstIterator ns3::WifiMacQueue::PeekByTid	(	uint8_t	tid,
		ConstIterator	pos = `EMPTY`
	)		const

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

If pos is a valid iterator, the search starts from the packet pointed to by the given iterator. This method does not remove the packet from the queue.

Parameters

tid	the given TID
pos	the iterator pointing to the packet the search starts from

Returns: an iterator pointing to the peeked packet

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

References EMPTY, m_expiredPacketsPresent, m_maxDelay, ns3::Simulator::Now(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by DequeueByTid().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PeekByTidAndAddress()

WifiMacQueue::ConstIterator ns3::WifiMacQueue::PeekByTidAndAddress	(	uint8_t	tid,
		Mac48Address	dest,
		ConstIterator	pos = `EMPTY`
	)		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 pos is a valid iterator, the search starts from the packet pointed to by the given iterator. 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

tid	the given TID
dest	the given destination
pos	the iterator pointing to the packet the search starts from

Returns: an iterator pointing to the peeked packet

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

References EMPTY, m_expiredPacketsPresent, m_maxDelay, ns3::Simulator::Now(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by DequeueByTidAndAddress(), ns3::MsduAggregator::GetNextAmsdu(), and ns3::QosTxop::PeekNextMpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PeekFirstAvailable()

WifiMacQueue::ConstIterator ns3::WifiMacQueue::PeekFirstAvailable	(	const Ptr< QosBlockedDestinations >	blockedPackets = `nullptr`,
		ConstIterator	pos = `EMPTY`
	)		const

Return first available packet for transmission.

The packet is not removed from queue.

Parameters

blockedPackets	the destination address & TID pairs that are waiting for a BlockAck response
pos	the iterator pointing to the packet the search starts from

Returns: an iterator pointing to the peeked packet

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

References EMPTY, m_expiredPacketsPresent, m_maxDelay, ns3::Simulator::Now(), NS_LOG_DEBUG, and NS_LOG_FUNCTION.

Referenced by DequeueFirstAvailable(), and ns3::QosTxop::PeekNextMpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ PushFront()

bool ns3::WifiMacQueue::PushFront ( Ptr< WifiMacQueueItem > item )

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

Parameters

item	the Wifi MAC queue item to be enqueued at the front

Returns: true if success, false if the packet has been dropped

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

References Insert(), and NS_LOG_FUNCTION.

Referenced by ns3::FrameExchangeManager::GetFirstFragmentIfNeeded().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Remove() [1/3]

WifiMacQueue::ConstIterator ns3::WifiMacQueue::Remove	(	ConstIterator	pos,
		bool	removeExpired = `false`
	)

Remove the item at position pos in the queue and return an iterator pointing to the item following the removed one.

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

Parameters

pos	the position of the item to be removed
removeExpired	true to remove expired items

Returns: an iterator pointing to the item following the removed one

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

References DoRemove(), m_expiredPacketsPresent, NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

Here is the call graph for this function:

◆ Remove() [2/3]

bool ns3::WifiMacQueue::Remove ( Ptr< const Packet > packet )

If exists, removes packet from queue and returns true.

Otherwise it takes no effects and return false. Deletion of the packet is performed in linear time (O(n)).

Parameters

packet the packet to be removed

Returns: true if the packet was removed, false otherwise

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

References DoRemove(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

Here is the call graph for this function:

◆ Remove() [3/3]

Ptr< WifiMacQueueItem > ns3::WifiMacQueue::Remove ( void )

override

Remove the packet in the front of the queue.

Returns: the packet

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

References DoRemove(), NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

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

delay the maximum delay

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

References m_maxDelay, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

Here is the caller graph for this function:

◆ TtlExceeded()

bool ns3::WifiMacQueue::TtlExceeded ( ConstIterator & it )

private

Remove the item pointed to by the iterator it if it has been in the queue for too long.

If the item is removed, the iterator is updated to point to the item that followed the erased one.

Parameters

it	an iterator pointing to the item

Returns: true if the item is removed, false otherwise

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

References DoRemove(), m_maxDelay, m_traceExpired, ns3::Simulator::Now(), and NS_LOG_DEBUG.

Referenced by Dequeue(), GetNBytes(), GetNPackets(), GetNPacketsByAddress(), GetNPacketsByTidAndAddress(), Insert(), IsEmpty(), and Remove().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ EMPTY

const WifiMacQueue::ConstIterator ns3::WifiMacQueue::EMPTY = g_emptyWifiMacQueue.end ()

static

Invalid iterator to signal an empty queue.

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

Referenced by ns3::BlockAckManager::GetBar(), PeekByAddress(), PeekByTid(), PeekByTidAndAddress(), PeekFirstAvailable(), and ns3::QosTxop::PeekNextMpdu().

◆ m_dropPolicy

DropPolicy ns3::WifiMacQueue::m_dropPolicy

private

Drop behavior of queue.

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

Referenced by GetTypeId(), and Insert().

◆ m_expiredPacketsPresent

bool ns3::WifiMacQueue::m_expiredPacketsPresent

mutableprivate

True if expired packets are in the queue.

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

Referenced by Peek(), PeekByAddress(), PeekByTid(), PeekByTidAndAddress(), PeekFirstAvailable(), and Remove().

◆ m_maxDelay

Time ns3::WifiMacQueue::m_maxDelay

private

Time to live for packets in the queue.

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

Referenced by GetMaxDelay(), Peek(), PeekByAddress(), PeekByTid(), PeekByTidAndAddress(), PeekFirstAvailable(), SetMaxDelay(), and TtlExceeded().

◆ m_nQueuedBytes

std::unordered_map<WifiAddressTidPair, uint32_t, WifiAddressTidHash> ns3::WifiMacQueue::m_nQueuedBytes

private

Per (MAC address, TID) pair queued bytes.

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

Referenced by ~WifiMacQueue(), DoDequeue(), DoEnqueue(), DoRemove(), and GetNBytes().

◆ m_nQueuedPackets

std::unordered_map<WifiAddressTidPair, uint32_t, WifiAddressTidHash> ns3::WifiMacQueue::m_nQueuedPackets

private

Per (MAC address, TID) pair queued packets.

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

Referenced by ~WifiMacQueue(), DoDequeue(), DoEnqueue(), DoRemove(), and GetNPackets().

◆ m_traceExpired

TracedCallback<Ptr<const WifiMacQueueItem> > ns3::WifiMacQueue::m_traceExpired

private

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

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

Referenced by GetTypeId(), and TtlExceeded().

◆ NS_LOG_TEMPLATE_DECLARE

ns3::WifiMacQueue::NS_LOG_TEMPLATE_DECLARE

private

redefinition of the log component

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

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

src/wifi/model/wifi-mac-queue.h
src/wifi/model/wifi-mac-queue.cc

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Detailed Description

Config Paths

Attributes

TraceSources

TraceSources defined in parent class ns3::Queue<WifiMacQueueItem>

TraceSources defined in parent class ns3::QueueBase

Member Enumeration Documentation

◆ DropPolicy

Constructor & Destructor Documentation

◆ WifiMacQueue()

◆ ~WifiMacQueue()

Member Function Documentation

◆ Dequeue() [1/2]

◆ Dequeue() [2/2]

◆ DequeueByAddress()

◆ DequeueByTid()

◆ DequeueByTidAndAddress()

◆ DequeueFirstAvailable()

◆ DoDequeue()

◆ DoEnqueue()

◆ DoRemove()

◆ Enqueue()

◆ GetMaxDelay()

◆ GetNBytes() [1/2]

◆ GetNBytes() [2/2]

◆ GetNPackets() [1/2]

◆ GetNPackets() [2/2]

◆ GetNPacketsByAddress()

◆ GetNPacketsByTidAndAddress()

◆ GetTypeId()

◆ Insert()

◆ IsEmpty()

◆ Peek()

◆ PeekByAddress()

◆ PeekByTid()

◆ PeekByTidAndAddress()

◆ PeekFirstAvailable()

◆ PushFront()

◆ Remove() [1/3]

◆ Remove() [2/3]

◆ Remove() [3/3]

◆ SetMaxDelay()

◆ TtlExceeded()

Member Data Documentation

◆ EMPTY

◆ m_dropPolicy

◆ m_expiredPacketsPresent

◆ m_maxDelay

◆ m_nQueuedBytes

◆ m_nQueuedPackets

◆ m_traceExpired

◆ NS_LOG_TEMPLATE_DECLARE