libs/timeout.h

   1 /* -*-c-*- */
   2
   3 #ifndef TIMEOUT_H
   4 #define TIMEOUT_H
   5
   6 /* ---------------------------- included header files ---------------------- */
   7
   8 /* ---------------------------- global definitions ------------------------- */
   9
  10 #define TIMEOUT_MAX_TIMEOUTS 32
  11
  12 /* ---------------------------- global macros ------------------------------ */
  13
  14 /* ---------------------------- type definitions --------------------------- */
  15
  16 typedef int timeout_time_t;
  17 typedef unsigned int timeout_mask_t;
  18 typedef struct
  19 {
  20         int n_timeouts;
  21         timeout_time_t *timeouts;
  22 } timeout_t;
  23
  24 /* ---------------------------- forward declarations ----------------------- */
  25
  26 /* ---------------------------- exported variables (globals) --------------- */
  27
  28 /* ---------------------------- interface functions ------------------------ */
  29
  30 timeout_t *timeout_create(
  31         int n_timeouts);
  32 void timeout_destroy(
  33         timeout_t *to);
  34 timeout_mask_t timeout_tick(
  35         timeout_t *to, timeout_time_t n_ticks);
  36 void timeout_rewind(
  37         timeout_t *to, timeout_mask_t mask, timeout_time_t ticks_before_alarm);
  38
  39 #endif /* TIMEOUT_H */