protlib::TimerMsg Class Reference
[Timer Module]

timer message More...

#include <source/ariba/utility/transport/tcpip/protlib/timer_module.h>

Inherits protlib::message.

Collaboration diagram for protlib::TimerMsg:

Collaboration graph
[legend]

List of all members.

Public Types

enum  action_t {
  ac_ignore = 0, ac_start = 1, ac_restart = 2, ac_stop = 3,
  ac_stop_all = 4, ac_elapsed = 5
}
 timer module actions More...
typedef timer_callback_param_t param_t
 timer parameter

Public Member Functions

 TimerMsg (qaddr_t s=qaddr_unknown, bool s_err=false)
 constructor
virtual ~TimerMsg ()
 destructor
void get_time (int32 &sec, int32 &msec)
 get alarm
action_t get_action () const
 get action
const char * get_action_str () const
 get action str
bool set_ok (bool r)
 set result
bool is_ok ()
 get result
bool start_absolute (int32 sec, int32 msec=0, param_t p1=NULL, param_t p2=NULL)
 start absolute timer
bool start_relative (int32 sec, int32 msec=0, param_t p1=NULL, param_t p2=NULL)
 start relative timer
bool start (bool rel, int32 sec, int32 msec=0, param_t p1=NULL, param_t p2=NULL)
 start timer
bool restart_absolute (id_t id, int32 sec, int32 msec=0)
 restart absolute timer
bool restart_relative (id_t id, int32 sec, int32 msec=0)
 restart relative timer
bool restart (bool rel, id_t id, int32 sec, int32 msec=0)
 restart timer
bool stop (id_t id)
 stop timer
bool stop_all ()
 stop all timers
bool set_elapsed ()
 set to elapsed
bool get_send_error () const
 get send_error flag
bool set_send_error (bool f)
 set send_error flag
param_t get_param1 () const
 get timer parameter #1
param_t get_param2 () const
 get timer parameter #2
void get_params (param_t &p1, param_t &p2) const
 get timer parameters
bool is_absolute () const
 Is it an absolute or relative timer?
bool is_relative () const
 Is it an absolute or relative timer?

Private Attributes

int32 time_sec
int32 time_msec
action_t action
param_t param1
param_t param2
bool ok
bool send_error
bool relative


Detailed Description

timer message

This message class is used to control timers managed by the timer module and for replies when a timer goes off. Timers are identified by the message ID.

Definition at line 68 of file timer_module.h.


Member Typedef Documentation

timer parameter

This parameter corresponds to the timer parameters in timer.h and helps managing timers.

Definition at line 87 of file timer_module.h.


Member Enumeration Documentation

timer module actions

Tell the timer module what to do or indicate that a timer elapsed.

Enumerator:
ac_ignore 
ac_start 
ac_restart 
ac_stop 
ac_stop_all 
ac_elapsed 

Definition at line 73 of file timer_module.h.


Member Data Documentation

Definition at line 137 of file timer_module.h.

Referenced by get_action(), get_action_str(), restart(), set_elapsed(), start(), stop(), and stop_all().

bool protlib::TimerMsg::ok [private]

Definition at line 140 of file timer_module.h.

Referenced by is_ok(), restart(), set_elapsed(), set_ok(), start(), stop(), and stop_all().

Definition at line 138 of file timer_module.h.

Referenced by get_param1(), get_params(), start(), stop(), and stop_all().

Definition at line 139 of file timer_module.h.

Referenced by get_param2(), get_params(), start(), stop(), and stop_all().

Definition at line 142 of file timer_module.h.

Referenced by is_absolute(), is_relative(), restart(), start(), stop(), and stop_all().

Definition at line 141 of file timer_module.h.

Referenced by get_send_error(), set_elapsed(), and set_send_error().

Definition at line 136 of file timer_module.h.

Referenced by get_time(), restart(), start(), stop(), and stop_all().

Definition at line 135 of file timer_module.h.

Referenced by get_time(), restart(), start(), stop(), and stop_all().


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

Generated on Fri Aug 14 23:39:54 2009 for Ariba by  doxygen 1.5.8