reSIProcate
SIP stack, Dialog Usage Manager and related libraries
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
resip::ValueFifo< T > Class Template Reference

#include <ValueFifo.hxx>

Inheritance diagram for resip::ValueFifo< T >:
[legend]

Public Types

typedef CancelableTimerQueue< T >::Id TimerId
 

Public Member Functions

 ValueFifo (const Data &name)
 
 ~ValueFifo ()
 
void add (const T &t)
 
TimerId addDelayMs (const T &t, int offsetInMs)
 
bool cancel (TimerId id)
 
T getNext ()
 
void clear ()
 
unsigned int size () const
 
bool empty () const
 
bool messageAvailable ()
 
virtual size_t getCountDepth () const
 Returns the number of elements in the FIFO.
 
virtual time_t getTimeDepth () const
 Returns the difference in time between the youngest and oldest item in the FIFO in seconds.
 
virtual time_t expectedWaitTimeMilliSec () const
 Returns the expected time it will take to service all messages currently in the queue (in milli-seconds)
 
virtual time_t averageServiceTimeMicroSec () const
 Returns the average time it takes for individual messages to be serviced (in micro-seconds)
 
- Public Member Functions inherited from resip::FifoStatsInterface
 FifoStatsInterface ()
 
virtual ~FifoStatsInterface ()
 
uint8_t getRole () const
 
void setRole (uint8_t role)
 
void setDescription (const resip::Data &description)
 Sets the description for this fifo.
 
virtual const resip::Data & getDescription () const
 Gets the description for this fifo.
 

Additional Inherited Members

- Protected Attributes inherited from resip::FifoStatsInterface
Data mDescription
 
uint8_t mRole
 

Detailed Description

template<class T>
class resip::ValueFifo< T >

Definition at line 23 of file ValueFifo.hxx.

Member Typedef Documentation

◆ TimerId

template<class T >
typedef CancelableTimerQueue<T>::Id resip::ValueFifo< T >::TimerId

Definition at line 26 of file ValueFifo.hxx.

Constructor & Destructor Documentation

◆ ValueFifo()

template<class T >
resip::ValueFifo< T >::ValueFifo ( const Data &  name)
inline

Definition at line 28 of file ValueFifo.hxx.

◆ ~ValueFifo()

template<class T >
resip::ValueFifo< T >::~ValueFifo ( )
inline

Definition at line 34 of file ValueFifo.hxx.

Member Function Documentation

◆ add()

template<class T >
void resip::ValueFifo< T >::add ( const T &  t)
inline

Definition at line 38 of file ValueFifo.hxx.

◆ addDelayMs()

template<class T >
TimerId resip::ValueFifo< T >::addDelayMs ( const T &  t,
int  offsetInMs 
)
inline

Definition at line 46 of file ValueFifo.hxx.

◆ averageServiceTimeMicroSec()

template<class T >
virtual time_t resip::ValueFifo< T >::averageServiceTimeMicroSec ( ) const
inlinevirtual

Returns the average time it takes for individual messages to be serviced (in micro-seconds)

Implements resip::FifoStatsInterface.

Definition at line 160 of file ValueFifo.hxx.

◆ cancel()

template<class T >
bool resip::ValueFifo< T >::cancel ( TimerId  id)
inline

Definition at line 74 of file ValueFifo.hxx.

◆ clear()

template<class T >
void resip::ValueFifo< T >::clear ( )
inline

Definition at line 118 of file ValueFifo.hxx.

◆ empty()

template<class T >
bool resip::ValueFifo< T >::empty ( ) const
inline

Definition at line 134 of file ValueFifo.hxx.

◆ expectedWaitTimeMilliSec()

template<class T >
virtual time_t resip::ValueFifo< T >::expectedWaitTimeMilliSec ( ) const
inlinevirtual

Returns the expected time it will take to service all messages currently in the queue (in milli-seconds)

Implements resip::FifoStatsInterface.

Definition at line 155 of file ValueFifo.hxx.

◆ getCountDepth()

template<class T >
virtual size_t resip::ValueFifo< T >::getCountDepth ( ) const
inlinevirtual

Returns the number of elements in the FIFO.

Implements resip::FifoStatsInterface.

Definition at line 145 of file ValueFifo.hxx.

◆ getNext()

template<class T >
T resip::ValueFifo< T >::getNext ( )
inline

Definition at line 85 of file ValueFifo.hxx.

◆ getTimeDepth()

template<class T >
virtual time_t resip::ValueFifo< T >::getTimeDepth ( ) const
inlinevirtual

Returns the difference in time between the youngest and oldest item in the FIFO in seconds.

Implements resip::FifoStatsInterface.

Definition at line 150 of file ValueFifo.hxx.

◆ messageAvailable()

template<class T >
bool resip::ValueFifo< T >::messageAvailable ( )
inline

Definition at line 139 of file ValueFifo.hxx.

◆ size()

template<class T >
unsigned int resip::ValueFifo< T >::size ( ) const
inline

Definition at line 128 of file ValueFifo.hxx.

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