Yate
SignallingMessageTimerList Class Reference

A pending signalling message list. More...

#include <yatesig.h>

Inheritance diagram for SignallingMessageTimerList:
ObjList GenObject

Public Member Functions

 SignallingMessageTimerList ()
 
SignallingMessageTimeradd (u_int64_t interval, const Time &when=Time())
 
SignallingMessageTimeradd (SignallingMessageTimer *m, const Time &when=Time())
 
SignallingMessageTimertimeout (const Time &when=Time())
 
- Public Member Functions inherited from ObjList
 ObjList ()
 
virtual ~ObjList ()
 
virtual void * getObject (const String &name) const
 
unsigned int length () const
 
unsigned int count () const
 
GenObjectget () const
 
GenObjectset (const GenObject *obj, bool delold=true)
 
ObjListnext () const
 
ObjListlast () const
 
ObjListskipNull () const
 
ObjListskipNext () const
 
GenObjectat (int index) const
 
ObjListoperator+ (int index) const
 
GenObjectoperator[] (signed int index) const
 
GenObjectoperator[] (unsigned int index) const
 
GenObjectoperator[] (const String &str) const
 
ObjListfind (const GenObject *obj) const
 
ObjListfind (const String &str) const
 
int index (const GenObject *obj) const
 
int index (const String &str) const
 
ObjListinsert (const GenObject *obj, bool compact=true)
 
ObjListappend (const GenObject *obj, bool compact=true)
 
ObjListsetUnique (const GenObject *obj, bool compact=true)
 
GenObjectremove (bool delobj=true)
 
GenObjectremove (GenObject *obj, bool delobj=true)
 
GenObjectremove (const String &str, bool delobj=true)
 
void clear ()
 
void compact ()
 
bool autoDelete ()
 
void setDelete (bool autodelete)
 
void sort (int(*callbackCompare)(GenObject *obj1, GenObject *obj2, void *context), void *context=0)
 
- Public Member Functions inherited from GenObject
 GenObject ()
 
virtual ~GenObject ()
 
virtual bool alive () const
 
virtual void destruct ()
 
virtual const StringtoString () const
 
virtual const StringtraceId () const
 
NamedCountergetObjCounter () const
 
NamedCountersetObjCounter (NamedCounter *counter)
 

Additional Inherited Members

- Static Public Member Functions inherited from ObjList
static const ObjListempty ()
 
- Static Public Member Functions inherited from GenObject
static void * getObject (const String &name, const GenObject *obj)
 
static bool getObjCounting ()
 
static void setObjCounting (bool enable)
 
static NamedCountergetObjCounter (const String &name, bool create=true)
 
static ObjListgetObjCounters ()
 

Detailed Description

A pending signalling message list.

This class holds pending signalling messages. The list will keep objects in timeout ascending order

Constructor & Destructor Documentation

◆ SignallingMessageTimerList()

Constructor

Member Function Documentation

◆ add() [1/2]

SignallingMessageTimer * add ( SignallingMessageTimer * m,
const Time & when = Time() )

Add a pending operation to the list. Start its timer

Parameters
mThe Message Timer to add to the pending list
whenCurrent time
Returns
Added message

◆ add() [2/2]

SignallingMessageTimer * add ( u_int64_t interval,
const Time & when = Time() )
inline

Add a pending operation to the list. Start its timer

Parameters
intervalOperation timeout interval
whenCurrent time
Returns
Added operation or 0 on failure

References add().

Referenced by add().

◆ timeout()

SignallingMessageTimer * timeout ( const Time & when = Time())

Check if the first operation timed out. Remove it from list before returning it

Parameters
whenCurrent time
Returns
SignallingMessageTimer pointer or 0 if no timeout occured

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