A Discrete-Event Network Simulator
API
Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
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:

Public Types

enum  DropPolicy { DROP_NEWEST, DROP_OLDEST }
 drop policy More...
 

Public Member Functions

 WifiMacQueue ()
 
 ~WifiMacQueue ()
 
Ptr< WifiMacQueueItemDequeue (void)
 Dequeue the packet in the front of the queue. More...
 
Ptr< WifiMacQueueItemDequeueByAddress (Mac48Address dest)
 Search and return, if present in the queue, the first packet having the address indicated by type equal to addr. More...
 
Ptr< WifiMacQueueItemDequeueByTidAndAddress (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< WifiMacQueueItemDequeueFirstAvailable (const Ptr< QosBlockedDestinations > blockedPackets)
 Return first available packet for transmission. More...
 
bool Enqueue (Ptr< WifiMacQueueItem > item)
 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 (void)
 
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 IsEmpty (void)
 
Ptr< const WifiMacQueueItemPeek (void) const
 Peek the packet in the front of the queue. More...
 
Ptr< const WifiMacQueueItemPeekByTidAndAddress (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< const WifiMacQueueItemPeekFirstAvailable (const Ptr< QosBlockedDestinations > blockedPackets)
 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...
 
Ptr< WifiMacQueueItemRemove (void)
 Remove the packet in the front of the queue. More...
 
bool Remove (Ptr< const Packet > packet)
 If exists, removes packet from queue and returns true. 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...
 

Private Member Functions

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...
 
Time m_maxDelay
 Time to live for packets in the queue. 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:

Attributes

Attributes defined in parent class ns3::QueueBase

No TraceSources are defined for this type.

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

TraceSources defined in parent class ns3::QueueBase

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

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

Member Enumeration Documentation

◆ DropPolicy

drop policy

Enumerator
DROP_NEWEST 
DROP_OLDEST 

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

Constructor & Destructor Documentation

◆ WifiMacQueue()

ns3::WifiMacQueue::WifiMacQueue ( )

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

◆ ~WifiMacQueue()

ns3::WifiMacQueue::~WifiMacQueue ( )

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

References NS_LOG_FUNCTION_NOARGS.

Member Function Documentation

◆ Dequeue()

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

Dequeue the packet in the front of the queue.

Returns
the packet

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

◆ DequeueByAddress()

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

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

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

Parameters
destthe given destination
Returns
the packet

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

◆ 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
tidthe given TID
destthe given destination
Returns
the packet

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

◆ DequeueFirstAvailable()

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

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
Returns
packet

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

◆ Enqueue()

bool ns3::WifiMacQueue::Enqueue ( Ptr< WifiMacQueueItem item)

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

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

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

◆ GetMaxDelay()

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

Return the maximum delay before the packet is discarded.

Returns
the maximum delay

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

References m_maxDelay.

◆ GetNBytes()

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 398 of file wifi-mac-queue.cc.

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

◆ GetNPackets()

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 383 of file wifi-mac-queue.cc.

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

◆ GetNPacketsByAddress()

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

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

Parameters
destthe given destination
Returns
the number of packets

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

◆ 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.

Parameters
tidthe given TID
destthe given destination
Returns
the number of QoS packets

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

◆ GetTypeId()

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

◆ 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 367 of file wifi-mac-queue.cc.

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

◆ Peek()

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

Peek the packet in the front of the queue.

The packet is not removed.

Returns
the packet

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

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

◆ PeekByTidAndAddress()

Ptr< const WifiMacQueueItem > ns3::WifiMacQueue::PeekByTidAndAddress ( 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 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
Returns
packet

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

◆ PeekFirstAvailable()

Ptr< const WifiMacQueueItem > ns3::WifiMacQueue::PeekFirstAvailable ( const Ptr< QosBlockedDestinations blockedPackets)

Return first available packet for transmission.

The packet is not removed from queue.

Parameters
blockedPackets
Returns
packet

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

◆ PushFront()

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

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

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

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

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

◆ Remove() [1/2]

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

Remove the packet in the front of the queue.

Returns
the packet

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

◆ Remove() [2/2]

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
packetthe packet to be removed
Returns
true if the packet was removed, false otherwise

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

References NS_LOG_DEBUG, NS_LOG_FUNCTION, and TtlExceeded().

◆ SetMaxDelay()

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

Set the maximum delay before the packet is discarded.

Parameters
delaythe maximum delay

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

References m_maxDelay, and NS_LOG_FUNCTION.

Referenced by GetTypeId().

◆ 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
itan iterator pointing to the item
Returns
true if the item is removed, false otherwise

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

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

Referenced by Dequeue(), DequeueByAddress(), DequeueByTidAndAddress(), DequeueFirstAvailable(), Enqueue(), GetNBytes(), GetNPackets(), GetNPacketsByAddress(), GetNPacketsByTidAndAddress(), IsEmpty(), PeekByTidAndAddress(), PeekFirstAvailable(), PushFront(), and Remove().

Member Data Documentation

◆ m_dropPolicy

DropPolicy ns3::WifiMacQueue::m_dropPolicy
private

Drop behavior of queue.

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

Referenced by Enqueue(), GetTypeId(), and PushFront().

◆ m_maxDelay

Time ns3::WifiMacQueue::m_maxDelay
private

Time to live for packets in the queue.

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

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

◆ NS_LOG_TEMPLATE_DECLARE

ns3::WifiMacQueue::NS_LOG_TEMPLATE_DECLARE
private

redefinition of the log component

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


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