core: Make sure that responses to requests received on a WebSocket are sent on existi...
[sip-router] / timer_proc.h
1 /* 
2  * Copyright (C) 2009 iptelorg GmbH
3  *
4  * Permission to use, copy, modify, and distribute this software for any
5  * purpose with or without fee is hereby granted, provided that the above
6  * copyright notice and this permission notice appear in all copies.
7  *
8  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15  */
16
17 /*
18  * History:
19  * --------
20  *  2009-03-10  initial version (andrei)
21 */
22
23 /**
24  * @file
25  * @brief SIP-router core :: timer_proc.h - separate process timers
26  *
27  * (unrelated to the main fast and slow timers)
28  * @ingroup core
29  * Module: @ref core
30  */
31
32 #ifndef __timer_proc_h
33 #define __timer_proc_h
34
35 #include "local_timer.h"
36
37 /**
38  * \brief update internal counters for running new basic sec. timers
39  * @param timers number of basic timer processes
40  * @return 0 on success; -1 on error
41  */
42 int register_basic_timers(int timers);
43
44 #define register_dummy_timers register_basic_timers
45
46 #define register_basic_utimers register_basic_utimers
47
48 /**
49  * \brief Forks a separate simple sleep() periodic timer
50  * 
51  * Forks a very basic periodic timer process, that just sleep()s for 
52  * the specified interval and then calls the timer function.
53  * The new "basic timer" process execution start immediately, the sleep()
54  * is called first (so the first call to the timer function will happen
55  * \<interval\> seconds after the call to fork_basic_timer)
56  * @param child_id  @see fork_process()
57  * @param desc      @see fork_process()
58  * @param make_sock @see fork_process()
59  * @param f         timer function/callback
60  * @param param     parameter passed to the timer function
61  * @param interval  interval in seconds.
62  * @return pid of the new process on success, -1 on error
63  * (doesn't return anything in the child process)
64  */
65 int fork_basic_timer(int child_id, char* desc, int make_sock,
66                                                 timer_function* f, void* param, int interval);
67
68 #define fork_dummy_timer fork_basic_timer
69
70 /**
71  * \brief Forks a separate simple milisecond-sleep() periodic timer
72  * 
73  * Forks a very basic periodic timer process, that just ms-sleep()s for 
74  * the specified interval and then calls the timer function.
75  * The new "basic timer" process execution start immediately, the ms-sleep()
76  * is called first (so the first call to the timer function will happen
77  * \<interval\> seconds after the call to fork_basic_utimer)
78  * @param child_id  @see fork_process()
79  * @param desc      @see fork_process()
80  * @param make_sock @see fork_process()
81  * @param f         timer function/callback
82  * @param param     parameter passed to the timer function
83  * @param uinterval  interval in mili-seconds.
84  * @return pid of the new process on success, -1 on error
85  * (doesn't return anything in the child process)
86  */
87 int fork_basic_utimer(int child_id, char* desc, int make_sock,
88                                                 timer_function* f, void* param, int uinterval);
89 /**
90  * \brief Forks a timer process based on the local timer
91  * 
92  * Forks a separate timer process running a local_timer.h type of timer
93  * A pointer to the local_timer handle (allocated in shared memory) is
94  * returned in lt_h. It can be used to add/delete more timers at runtime
95  * (via local_timer_add()/local_timer_del() a.s.o).
96  * If timers are added from separate processes, some form of locking must be
97  * used (all the calls to local_timer* must be enclosed by locks if it
98  * cannot be guaranteed that they cannot execute in the same time)
99  * The timer "engine" must be run manually from the child process. For
100  * example a very simple local timer process that just runs a single 
101  * periodic timer can be started in the following way:
102  * struct local_timer* lt_h;
103  * 
104  * pid=fork_local_timer_process(...., &lt_h);
105  * if (pid==0){
106  *          timer_init(&my_timer, my_timer_f, 0, 0);
107  *          local_timer_add(&lt_h, &my_timer, S_TO_TICKS(10), get_ticks_raw());
108  *          while(1) { sleep(1); local_timer_run(lt, get_ticks_raw()); }
109  * }
110  *
111  * @param child_id  @see fork_process()
112  * @param desc      @see fork_process()
113  * @param make_sock @see fork_process()
114  * @param lt_h      local_timer handler
115  * @return pid to the parent, 0 to the child, -1 if error.
116  */
117 int fork_local_timer_process(int child_id, char* desc, int make_sock,
118                                                 struct local_timer** lt_h);
119
120 /**
121  * sync timers
122  */
123 int register_sync_timers(int timers);
124
125 int fork_sync_timer(int child_id, char* desc, int make_sock,
126                                                 timer_function* f, void* param, int interval);
127
128 int fork_sync_utimer(int child_id, char* desc, int make_sock,
129                                                 utimer_function* f, void* param, int uinterval);
130
131 #endif /*__timer_proc_h*/
132
133 /* vi: set ts=4 sw=4 tw=79:ai:cindent: */