Yate
Public Member Functions | Protected Attributes
SignallingMessageTimer Class Reference

A pending signalling message. More...

#include <yatesig.h>

Inheritance diagram for SignallingMessageTimer:
GenObject SignallingTimer

List of all members.

Public Member Functions

 SignallingMessageTimer (u_int64_t interval, u_int64_t global=0)
virtual ~SignallingMessageTimer ()
SignallingMessagemessage () const
void message (SignallingMessage *msg)
SignallingTimerglobal ()
const SignallingTimerglobal () const
u_int64_t fireTime () const

Protected Attributes

SignallingTimer m_globalTimer
SignallingMessagem_msg

Detailed Description

A pending signalling message.

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


Constructor & Destructor Documentation

SignallingMessageTimer ( u_int64_t  interval,
u_int64_t  global = 0 
) [inline]

Constructor

Parameters:
intervalOperation timeout interval
globalOperation global timeout interval
virtual ~SignallingMessageTimer ( ) [inline, virtual]

Destructor. Release data

References TelEngine::destruct().


Member Function Documentation

u_int64_t fireTime ( ) const [inline]

Get the time this message timer will timeout

Returns:
The time this message timer will timeout

Reimplemented from SignallingTimer.

References SignallingTimer::fireTime().

SignallingTimer& global ( ) [inline]

Get access to the global timer

Returns:
A reference to the global timer
const SignallingTimer& global ( ) const [inline]

Get const access to the global timer

Returns:
A const reference to the global timer
SignallingMessage* message ( ) const [inline]

Retrieve stored signaling message

Returns:
Pointer to the stored message
void message ( SignallingMessage msg) [inline]

Set a new message

Parameters:
msgMessage to store in the timer

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