EMANE  1.2.1
EMANE::Models::IEEE80211ABG::DownstreamQueue Class Reference

class used to define the mac downstream packet queue More...

#include <downstreamqueue.h>

Public Member Functions

 DownstreamQueue (EMANE::NEMId id)
 queue constructor More...
 
 ~DownstreamQueue ()
 queue destructor More...
 
void setMaxCapacity (size_t)
 set the max number of entries for all queues More...
 
void setMaxCapacity (size_t, std::uint8_t u8Category)
 set the max number of entries for a given queue index More...
 
void setMaxEntrySize (size_t)
 set the max entry size for all queues More...
 
void setMaxEntrySize (size_t, std::uint8_t u8Category)
 set the max entry size for a given queue index More...
 
size_t getMaxCapacity ()
 get the max number of entries for all queues More...
 
size_t getMaxCapacity (std::uint8_t u8Category)
 get the max number of entries for a given queue index More...
 
size_t getAvailableSpace ()
 
size_t getAvailableSpace (std::uint8_t u8Category)
 
size_t getDepth ()
 get the number of entries for all active queues More...
 
size_t getDepth (std::uint8_t u8Category)
 get the number of entries for a given queue index More...
 
size_t getNumOverFlow (bool bClear)
 
size_t getNumOverFlow (std::uint8_t u8Category, bool bClear)
 
void setCategories (std::uint8_t u8Category)
 set the number of categories (queues) More...
 
std::pair< DownstreamQueueEntry, bool > dequeue ()
 blocking dequeue, returns highest priority item first More...
 
std::vector< DownstreamQueueEntryenqueue (DownstreamQueueEntry &entry)
 enqueue, inserts items by priority, signals on success. More...
 
void registerStatistics (StatisticRegistrar &statisticRegistrar)
 

Detailed Description

class used to define the mac downstream packet queue

Definition at line 55 of file ieee80211abg/downstreamqueue.h.

Constructor & Destructor Documentation

◆ DownstreamQueue()

EMANE::Models::IEEE80211ABG::DownstreamQueue::DownstreamQueue ( EMANE::NEMId  id)

queue constructor

Definition at line 45 of file ieee80211abg/downstreamqueue.cc.

◆ ~DownstreamQueue()

EMANE::Models::IEEE80211ABG::DownstreamQueue::~DownstreamQueue ( )

queue destructor

Definition at line 65 of file ieee80211abg/downstreamqueue.cc.

Member Function Documentation

◆ dequeue()

std::pair< EMANE::Models::IEEE80211ABG::DownstreamQueueEntry, bool > EMANE::Models::IEEE80211ABG::DownstreamQueue::dequeue ( )

blocking dequeue, returns highest priority item first

Return values
queueentry

Definition at line 334 of file ieee80211abg/downstreamqueue.cc.

◆ enqueue()

std::vector< EMANE::Models::IEEE80211ABG::DownstreamQueueEntry > EMANE::Models::IEEE80211ABG::DownstreamQueue::enqueue ( DownstreamQueueEntry entry)

enqueue, inserts items by priority, signals on success.

Definition at line 360 of file ieee80211abg/downstreamqueue.cc.

◆ getAvailableSpace() [1/2]

size_t EMANE::Models::IEEE80211ABG::DownstreamQueue::getAvailableSpace ( )

Definition at line 282 of file ieee80211abg/downstreamqueue.cc.

◆ getAvailableSpace() [2/2]

size_t EMANE::Models::IEEE80211ABG::DownstreamQueue::getAvailableSpace ( std::uint8_t  u8Category)

Definition at line 268 of file ieee80211abg/downstreamqueue.cc.

◆ getDepth() [1/2]

size_t EMANE::Models::IEEE80211ABG::DownstreamQueue::getDepth ( )

get the number of entries for all active queues

Return values
numberof entries

Definition at line 253 of file ieee80211abg/downstreamqueue.cc.

◆ getDepth() [2/2]

size_t EMANE::Models::IEEE80211ABG::DownstreamQueue::getDepth ( std::uint8_t  u8Category)

get the number of entries for a given queue index

Parameters
u8Categoryqueue index
Return values
numberof entries

Definition at line 233 of file ieee80211abg/downstreamqueue.cc.

◆ getMaxCapacity() [1/2]

size_t EMANE::Models::IEEE80211ABG::DownstreamQueue::getMaxCapacity ( )

get the max number of entries for all queues

Return values
maxnumber of entries

Definition at line 209 of file ieee80211abg/downstreamqueue.cc.

◆ getMaxCapacity() [2/2]

size_t EMANE::Models::IEEE80211ABG::DownstreamQueue::getMaxCapacity ( std::uint8_t  u8Category)

get the max number of entries for a given queue index

Parameters
u8Categoryqueue index
Return values
maxnumber of entries

Definition at line 189 of file ieee80211abg/downstreamqueue.cc.

◆ getNumOverFlow() [1/2]

size_t EMANE::Models::IEEE80211ABG::DownstreamQueue::getNumOverFlow ( bool  bClear)

Definition at line 462 of file ieee80211abg/downstreamqueue.cc.

◆ getNumOverFlow() [2/2]

size_t EMANE::Models::IEEE80211ABG::DownstreamQueue::getNumOverFlow ( std::uint8_t  u8Category,
bool  bClear 
)

Definition at line 443 of file ieee80211abg/downstreamqueue.cc.

◆ registerStatistics()

void EMANE::Models::IEEE80211ABG::DownstreamQueue::registerStatistics ( StatisticRegistrar statisticRegistrar)

Definition at line 70 of file ieee80211abg/downstreamqueue.cc.

◆ setCategories()

void EMANE::Models::IEEE80211ABG::DownstreamQueue::setCategories ( std::uint8_t  u8NumCategories)

set the number of categories (queues)

Parameters
u8NumCategories

Definition at line 306 of file ieee80211abg/downstreamqueue.cc.

◆ setMaxCapacity() [1/2]

void EMANE::Models::IEEE80211ABG::DownstreamQueue::setMaxCapacity ( size_t  maxEntries)

set the max number of entries for all queues

Parameters
maxEntriesmax number of entrie size

Definition at line 127 of file ieee80211abg/downstreamqueue.cc.

◆ setMaxCapacity() [2/2]

void EMANE::Models::IEEE80211ABG::DownstreamQueue::setMaxCapacity ( size_t  maxEntries,
std::uint8_t  u8Category 
)

set the max number of entries for a given queue index

Parameters
maxEntriesmax number of entrie size
u8Categoryqueue index

Definition at line 102 of file ieee80211abg/downstreamqueue.cc.

◆ setMaxEntrySize() [1/2]

void EMANE::Models::IEEE80211ABG::DownstreamQueue::setMaxEntrySize ( size_t  maxEntrySize)

set the max entry size for all queues

Parameters
maxEntrySizemax entry size

Definition at line 169 of file ieee80211abg/downstreamqueue.cc.

◆ setMaxEntrySize() [2/2]

void EMANE::Models::IEEE80211ABG::DownstreamQueue::setMaxEntrySize ( size_t  maxEntrySize,
std::uint8_t  u8Category 
)

set the max entry size for a given queue index

Parameters
maxEntrySizemax entry size
u8Categoryqueue index

Definition at line 153 of file ieee80211abg/downstreamqueue.cc.


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