SignallingMessageTimer Class Reference

A pending signalling message. More...

#include <yatesig.h>

Inheritance diagram for SignallingMessageTimer:

Public Member Functions
	SignallingMessageTimer (u_int64_t interval, u_int64_t global=0)
virtual	~SignallingMessageTimer ()
SignallingMessage *	message () const
void	message (SignallingMessage *msg)
SignallingTimer &	global ()
const SignallingTimer &	global () const
u_int64_t	fireTime () const
Public Member Functions inherited from GenObject
	GenObject ()
virtual	~GenObject ()
virtual bool	alive () const
virtual void	destruct ()
virtual const String &	toString () const
virtual const String &	traceId () const
virtual void *	getObject (const String &name) const
NamedCounter *	getObjCounter () const
NamedCounter *	setObjCounter (NamedCounter *counter)
Public Member Functions inherited from SignallingTimer
	SignallingTimer (u_int64_t interval, u_int64_t time=0)
void	interval (u_int64_t value)
void	interval (const NamedList &params, const char *param, unsigned int minVal, unsigned int defVal, bool allowDisable, bool sec=false)
u_int64_t	interval () const
u_int64_t	fireTime () const
void	start (u_int64_t time=Time::msecNow())
void	fire (u_int64_t time=Time::msecNow())
void	stop ()
bool	started () const
bool	timeout (u_int64_t time=Time::msecNow()) const

Protected Attributes
SignallingTimer	m_globalTimer
SignallingMessage *	m_msg

Additional Inherited Members
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 NamedCounter *	getObjCounter (const String &name, bool create=true)
static ObjList &	getObjCounters ()
Static Public Member Functions inherited from SignallingTimer
static unsigned int	getInterval (const NamedList &params, const char *param, unsigned int minVal, unsigned int defVal, unsigned int maxVal=0, bool allowDisable=false)

Detailed Description

A pending signalling message.

This class holds a signalling message along with timeout value(s)

Constructor & Destructor Documentation

SignallingMessageTimer()

SignallingMessageTimer ( u_int64_t interval, u_int64_t global = 0 )

inline

Constructor

Parameters

interval	Operation timeout interval
global	Operation global timeout interval

References global(), SignallingTimer::interval(), and SignallingTimer::SignallingTimer().

~SignallingMessageTimer()

virtual ~SignallingMessageTimer ( )

inlinevirtual

Destructor. Release data

Member Function Documentation

fireTime()

u_int64_t fireTime ( ) const

inline

Get the time this message timer will timeout

Returns

The time this message timer will timeout

References SignallingTimer::fireTime().

global() [1/2]

SignallingTimer & global ( )

inline

Get access to the global timer

Returns

A reference to the global timer

References SignallingTimer::SignallingTimer().

Referenced by SignallingMessageTimer().

global() [2/2]

const SignallingTimer & global ( ) const

inline

Get const access to the global timer

Returns

A const reference to the global timer

References SignallingTimer::SignallingTimer().

message() [1/2]

SignallingMessage * message ( ) const

inline

Retrieve stored signaling message

Returns

Pointer to the stored message

message() [2/2]

void message ( SignallingMessage * msg )

inline

Set a new message

Parameters

msg	Message to store in the timer

---

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

• yatesig.h