/*
 * $Id$
 *
 * timer related functions
 *
 * Copyright (C) 2001-2003 FhG Fokus
 * Copyright (C) 2007 Voice Sistem SRL
 *
 * This file is part of opensips, a free SIP server.
 *
 * opensips is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version
 *
 * opensips is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * History:
 * --------
 *  2007-02-02  timer with resolution of microseconds added (bogdan)
 */


/*!
 * \file
 * \brief Timer related functions
 */


#ifndef timer_h
#define timer_h

typedef unsigned long long utime_t;

typedef void (timer_function)(unsigned int ticks, void* param);
typedef void (utimer_function)(utime_t uticks, void* param);

/* define internal timer to 10 miliseconds */
#define ITIMER_TICK 10000

struct sr_timer{
	/* unique ID in the list of timer handlers - not really used */
	int id;
	/* string label identifying the handler (what module and what for was registered) */
	char *label;
	/* handler function */
	union {
		timer_function* timer_f;
		utimer_function* utimer_f;
	}u;
	/* parameter to the handler function (does not change during runtime) */
	void* t_param;
	/* triggering interval for the handler (does not change during runtime) */
	unsigned int interval;
	/* internal time for the next triggering */
	utime_t expires;
	/* next element in the timer list (per timer process) */
	struct sr_timer* next;
};

struct sr_timer_process {
	unsigned int flags;
	struct sr_timer *timer_list;
	struct sr_timer *utimer_list;
	struct sr_timer_process *next;
};

#define TIMER_PROC_INIT_FLAG  (1<<0)

extern struct sr_timer_process *timer_proc_list;

int init_timer(void);

void destroy_timer(void);

/*! \brief Counts the timer processes that needs to be created */
int count_timer_procs(void);

int start_timer_processes(void);

/*! \brief register a periodic timer;
 * ret: <0 on error*/
int register_timer(char *label, timer_function f, void* param, unsigned int interval);

int register_utimer(char *label, utimer_function f, void* param, unsigned int interval);

void* register_timer_process(char *label, timer_function f, void* param,
	unsigned int interval, unsigned int flags);

int append_timer_to_process(char *label, timer_function f, void* param,
	unsigned int interval, void *timer);

int append_utimer_to_process(char *label, utimer_function f, void* param,
	unsigned int interval, void *timer);

unsigned int get_ticks(void);

utime_t get_uticks(void);

int register_route_timers(void);

#endif