* $Id$

#ifndef _TIMER_H
#define _TIMER_H

#include "lock.h"
#include "t_funcs.h"

/* timer timestamp value indicating a timer has been 
   deactived and shall not be executed

#define is_in_timer_list2(_tl) ( (_tl)->timer_list )

/* identifiers of timer lists;*/
/* fixed-timer retransmission lists (benefit: fixed timer$
   length allows for appending new items to the list as$
   opposed to inserting them which is costly */
enum lists
	RT_T1_TO_1, RT_T1_TO_2, RT_T1_TO_3, RT_T2,

/* all you need to put a cell in a timer list
   links to neighbours and timer value */
typedef struct timer_link
	struct timer_link *next_tl;
	struct timer_link *prev_tl;
	volatile unsigned int       time_out;
	void              *payload;
	struct timer      *timer_list;
	enum timer_groups  tg;
}timer_link_type ;

/* timer list: includes head, tail and protection semaphore */
typedef struct  timer
	struct timer_link  first_tl;
	struct timer_link  last_tl;
	ser_lock_t*        mutex;
	enum lists         id;
} timer_type;

/* transaction table */
struct timer_table
    /* table of timer lists */
    struct timer   timers[ NR_OF_TIMER_LISTS ];

extern int timer_group[NR_OF_TIMER_LISTS];
extern unsigned int timer_id2timeout[NR_OF_TIMER_LISTS];

struct timer_table * tm_init_timers();
void unlink_timer_lists();
void free_timer_table();
void init_timer_list( enum lists list_id);
void reset_timer_list( enum lists list_id);
void remove_timer_unsafe(  struct timer_link* tl ) ;
void add_timer_unsafe( struct timer*, struct timer_link*, unsigned int);
struct timer_link  *check_and_split_time_list( struct timer*, int);

void reset_timer( struct timer_link* tl );
/* determine timer length and put on a correct timer list */
void set_timer( struct timer_link *new_tl, enum lists list_id );
/* similar to set_timer, except it allows only one-time
   timer setting and all later attempts are ignored */
void set_1timer( struct timer_link *new_tl, enum lists list_id );
void unlink_timers( struct cell *t );
void timer_routine(unsigned int, void*);

struct timer_table *get_timertable();