timer

Name

timer -- 

Synopsis



#define     timer_t
#define     timer_expire                    (timer)
#define     timer_data                      (timer)
#define     timer_func                      (timer)
#define     timer_set_expire                (timer, x)
#define     timer_set_data                  (timer, x)
#define     timer_set_callback              (timer, x)
void        timer_init                      (timer_t *timer);
void        timer_destroy_current           (void);
void        timer_reset_current             (void);
void        timer_reset                     (timer_t *timer);
void        timer_destroy                   (timer_t *timer);
void        timer_elapsed                   (timer_t *timer,
                                             struct timeval *tv);
void        wake_up_timer                   (void);

Description

Details

timer_t

#define timer_t _timer_t


timer_expire()

#define timer_expire(timer) (timer)->expire

timer : 


timer_data()

#define timer_data(timer) (timer)->data

timer : 


timer_func()

#define timer_func(timer) (timer)->function

timer : 


timer_set_expire()

#define timer_set_expire(timer, x) timer_expire((timer)) = (x)

timer : 
x : 


timer_set_data()

#define timer_set_data(timer, x) timer_data((timer)) = (unsigned long) (x)

timer : 
x : 


timer_set_callback()

#define timer_set_callback(timer, x) timer_func((timer)) = (x)

timer : 
x : 


timer_init ()

void        timer_init                      (timer_t *timer);

Initialize a timer (add it to the timer list).

timer : timer to initialize.


timer_destroy_current ()

void        timer_destroy_current           (void);

Destroy currently expiring timer, this is only to be called from a timer expire callback.


timer_reset_current ()

void        timer_reset_current             (void);

Reset currently expiring timer, this is only to be called from a timer expire callback.


timer_reset ()

void        timer_reset                     (timer_t *timer);

Reset timer 'timer', as if it was just started.

timer : the timer to reset.


timer_destroy ()

void        timer_destroy                   (timer_t *timer);

Destroy the timer 'timer', this remove it from the active timer list.

timer : the timer to destroy.


timer_elapsed ()

void        timer_elapsed                   (timer_t *timer,
                                             struct timeval *tv);

Give the time elapsed by timer 'timer' from the last time it was reset'd or from the time it was started. The result is stored in a timeval structure given as argument.

timer : the timer to get elapsed time from.
tv : a timeval structure to store the result in.


wake_up_timer ()

void        wake_up_timer                   (void);

Wake up time that need it. This function should be called every second to work properly.