reSIProcate
SIP stack, Dialog Usage Manager and related libraries
Loading...
Searching...
No Matches
resip::TimerQueue< T > Class Template Referenceabstract

#include <TimerQueue.hxx>

Public Member Functions

virtual void processTimer (const T &timer)=0
 
virtual ~TimerQueue ()
 deletes the message associated with the timer as well.
 
unsigned int msTillNextTimer ()
 provides the time in milliseconds before the next timer will fire
 
virtual uint64_t process ()
 gets the set of timers that have fired, and inserts TimerMsg into the state machine fifo and application messages into the TU fifo
 
int size () const
 
bool empty () const
 
std::ostream & encode (std::ostream &str) const
 
EncodeStream & encode (EncodeStream &str) const
 

Protected Types

typedef std::vector< T, std::allocator< T > > TimerVector
 

Protected Attributes

std::priority_queue< T, TimerVector, std::greater< T > > mTimers
 

Detailed Description

template<class T>
class resip::TimerQueue< T >

Definition at line 39 of file TimerQueue.hxx.

Member Typedef Documentation

◆ TimerVector

template<class T >
typedef std::vector<T, std::allocator<T> > resip::TimerQueue< T >::TimerVector
protected

Definition at line 152 of file TimerQueue.hxx.

Constructor & Destructor Documentation

◆ ~TimerQueue()

template<class T >
virtual resip::TimerQueue< T >::~TimerQueue ( )
inlinevirtual

deletes the message associated with the timer as well.

Definition at line 47 of file TimerQueue.hxx.

Member Function Documentation

◆ empty()

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

Definition at line 118 of file TimerQueue.hxx.

◆ encode() [1/2]

template<class T >
EncodeStream & resip::TimerQueue< T >::encode ( EncodeStream &  str) const
inline

Definition at line 137 of file TimerQueue.hxx.

◆ encode() [2/2]

template<class T >
std::ostream & resip::TimerQueue< T >::encode ( std::ostream &  str) const
inline

Definition at line 123 of file TimerQueue.hxx.

◆ msTillNextTimer()

template<class T >
unsigned int resip::TimerQueue< T >::msTillNextTimer ( )
inline

provides the time in milliseconds before the next timer will fire

Return values
millisecondstime until the next timer will fire
0implies that timers occur in the past
INT_MAXimplies that there are no timers

Definition at line 62 of file TimerQueue.hxx.

◆ process()

template<class T >
virtual uint64_t resip::TimerQueue< T >::process ( )
inlinevirtual

gets the set of timers that have fired, and inserts TimerMsg into the state machine fifo and application messages into the TU fifo

Definition at line 94 of file TimerQueue.hxx.

◆ processTimer()

template<class T >
virtual void resip::TimerQueue< T >::processTimer ( const T &  timer)
pure virtual

◆ size()

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

Definition at line 113 of file TimerQueue.hxx.

Member Data Documentation

◆ mTimers

template<class T >
std::priority_queue<T, TimerVector, std::greater<T> > resip::TimerQueue< T >::mTimers
protected

Definition at line 153 of file TimerQueue.hxx.


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