EMANE  1.2.1
Public Member Functions | List of all members
EMANE::Controls::R2RIQueueMetric Class Reference

R2RI queue metrics are used in conjunction with the R2RIQueueMetricControlMessage to inform an NEM's transport layer of MAC queue state. More...

#include <r2riqueuemetric.h>

Public Member Functions

 R2RIQueueMetric (std::uint32_t u32QueueId, std::uint32_t u32MaxSize, std::uint32_t u32CurrentDepth, std::uint32_t u32NumDiscards, const Microseconds &avgDelay)
 
 ~R2RIQueueMetric ()
 
std::uint32_t getQueueId () const
 
std::uint32_t getMaxSize () const
 
std::uint32_t getCurrentDepth () const
 
std::uint32_t getNumDiscards () const
 
const Microseconds & getAvgDelay () const
 

Detailed Description

R2RI queue metrics are used in conjunction with the R2RIQueueMetricControlMessage to inform an NEM's transport layer of MAC queue state.

Note
Instances are immutable

Definition at line 54 of file r2riqueuemetric.h.

Constructor & Destructor Documentation

◆ R2RIQueueMetric()

EMANE::Controls::R2RIQueueMetric::R2RIQueueMetric ( std::uint32_t  u32QueueId,
std::uint32_t  u32MaxSize,
std::uint32_t  u32CurrentDepth,
std::uint32_t  u32NumDiscards,
const Microseconds &  avgDelay 
)
inline

Creates an R2RIQueueMetric instance

Parameters
u32QueueIdQueue Id, 0 based
u32MaxSizeMax queue size
u32CurrentDepthCurrent Queue depth
u32NumDiscardsNumber of discards
avgDelayAverage queue delay in microseconds
Note
All data is over the report interval
See also
R2RISelfMetricControlMessage for report interval

Definition at line 34 of file r2riqueuemetric.inl.

◆ ~R2RIQueueMetric()

EMANE::Controls::R2RIQueueMetric::~R2RIQueueMetric ( )
inline

Destroys an instance

Definition at line 46 of file r2riqueuemetric.inl.

Member Function Documentation

◆ getAvgDelay()

const EMANE::Microseconds & EMANE::Controls::R2RIQueueMetric::getAvgDelay ( ) const
inline

Gets the average queue delay in microseconds over the report interval

Returns
average queue delay

Definition at line 77 of file r2riqueuemetric.inl.

◆ getCurrentDepth()

std::uint32_t EMANE::Controls::R2RIQueueMetric::getCurrentDepth ( ) const
inline

Gets the current queue depth over the report interval

Returns
current depth

Definition at line 63 of file r2riqueuemetric.inl.

◆ getMaxSize()

std::uint32_t EMANE::Controls::R2RIQueueMetric::getMaxSize ( ) const
inline

Gets the max queue size over the report interval

Returns
max size

Definition at line 56 of file r2riqueuemetric.inl.

◆ getNumDiscards()

std::uint32_t EMANE::Controls::R2RIQueueMetric::getNumDiscards ( ) const
inline

Gets the number of queue discards over the report interval

Returns
number of discards

Definition at line 70 of file r2riqueuemetric.inl.

◆ getQueueId()

std::uint32_t EMANE::Controls::R2RIQueueMetric::getQueueId ( ) const
inline

Gets the queue id

Returns
Queue id

Definition at line 49 of file r2riqueuemetric.inl.

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