kamailio.cfg: removed sample db_mode parameter for domain module
[sip-router] / timer.h
diff --git a/timer.h b/timer.h
index a14c342..f64dcc4 100644 (file)
--- a/timer.h
+++ b/timer.h
@@ -6,19 +6,14 @@
  *
  * Copyright (C) 2001-2003 FhG Fokus
  *
- * This file is part of ser, a free SIP server.
+ * This file is part of SIP-router, a free SIP server.
  *
- * ser is free software; you can redistribute it and/or modify
+ * SIP-router 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
  *
- * For a license to use the ser software under conditions
- * other than those described here, or to purchase support for this
- * software, please contact iptel.org by e-mail at the following addresses:
- *    info@iptel.org
- *
- * ser is distributed in the hope that it will be useful,
+ * SIP-router 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.
  */
 /* History:
  * --------
- *  2005-07-27  complete re-design/re-implemnetation (andrei)
+ *  2005-07-27  complete re-design/re-implementation (andrei)
+ */
+
+/**
+ * @file
+ * @brief SIP-router core :: timer related functions (public interface)
+ * @ingroup core
+ *
+ * Module: \ref core
+ *
+ * - \ref TimerDoc
+ */
+
+
+/**
+ * @page TimerDoc SIP-router's timer documentation
+ * @verbinclude timers.txt
+ *
  */
 
 
@@ -61,9 +73,11 @@ typedef void (timer_function)(unsigned int ticks, void* param);
 /* deprecated, old, kept for compatibility 
        get_ticks()*TIMER_TICK used to be the time in s
        for new code, use get_ticks_raw() and one of the macros defined in
-       time_ticks.h (.e.g TICKS_TO_S(tick) to convert to s or ms )*/
+       timer_ticks.h (.e.g TICKS_TO_S(tick) to convert to s or ms )*/
 #define TIMER_TICK 1 /* 1 s, kept for compatibility */
 
+/*function prototype to execute on mili-second based basic timers */
+typedef void (utimer_function)(unsigned int uticks, void* param);
 
 struct timer_ln; /* forward decl */
 /* new 
@@ -118,20 +132,20 @@ struct timer_ln{ /* timer_link already used in tm */
 
 
 
-void timer_main(); /* timer main loop, never exists */
+void timer_main(void); /* timer main loop, never exists */
 
 
-int init_timer();
-int arm_timer();
-void destroy_timer();
+int init_timer(void);
+int arm_timer(void);
+void destroy_timer(void);
 
 #ifdef USE_SLOW_TIMER
-int arm_slow_timer();
-void slow_timer_main();
+int arm_slow_timer(void);
+void slow_timer_main(void);
 #endif
 
 
-struct timer_ln* timer_alloc();
+struct timer_ln* timer_alloc(void);
 void timer_free(struct timer_ln* t);
 
 #ifdef TIMER_DEBUG
@@ -174,7 +188,7 @@ int timer_del_safe(struct timer_ln *tl);
 #define timer_del timer_del_safe
 #endif
 
-void timer_allow_del();
+void timer_allow_del(void);
 
 /* old timer compatibility functions & structure */
 
@@ -189,7 +203,7 @@ struct sr_timer{
 /*register a periodic timer;
  * ret: <0 on error*/
 int register_timer(timer_function f, void* param, unsigned int interval);
-ticks_t get_ticks();
-ticks_t get_ticks_raw();
+ticks_t get_ticks(void);
+ticks_t get_ticks_raw(void);
 
 #endif