Complete the documentation for the timing API.
[asterisk/asterisk.git] / include / asterisk / timing.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2008, Digium, Inc.
5  *
6  * Kevin P. Fleming <kpfleming@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*!
20   \file timing.h
21   \brief Timing source management
22   \author Kevin P. Fleming <kpfleming@digium.com>
23
24   Portions of Asterisk require a timing source, a periodic trigger
25   for media handling activities. The functions in this file allow
26   a loadable module to provide a timing source for Asterisk and its
27   modules, so that those modules can request a 'timing handle' when
28   they require one. These handles are file descriptors, which can be
29   used with select() or poll().
30
31   The timing source used by Asterisk must provide the following
32   features:
33
34   1) Periodic triggers, with a configurable interval (specified as
35      number of triggers per second).
36
37   2) Multiple outstanding triggers, each of which must be 'acked'
38      to clear it. Triggers must also be 'ackable' in quantity.
39
40   3) Continuous trigger mode, which when enabled causes every call
41      to poll() on the timer handle to immediately return.
42
43   4) Multiple 'event types', so that the code using the timer can
44      know whether the wakeup it received was due to a periodic trigger
45      or a continuous trigger.
46  */
47
48 #ifndef _ASTERISK_TIMING_H
49 #define _ASTERISK_TIMING_H
50
51 #if defined(__cplusplus) || defined(c_plusplus)
52 extern "C" {
53 #endif
54
55 enum ast_timing_event {
56         AST_TIMING_EVENT_EXPIRED = 1,
57         AST_TIMING_EVENT_CONTINUOUS = 2,
58 };
59
60 /*!
61  * \brief Timing module interface
62  *
63  * The public API calls for the timing API directly map to this interface.
64  * So, the behavior of these calls should match the documentation of the
65  * public API calls.
66  */
67 struct ast_timing_functions {
68         int (*timer_open)(unsigned int rate);
69         void (*timer_close)(int handle);
70         void (*timer_ack)(int handle, unsigned int quantity);
71         int (*timer_enable_continuous)(int handle);
72         int (*timer_disable_continuous)(int handle);
73         enum ast_timing_event (*timer_get_event)(int handle);
74 };
75
76 /*!
77  * \brief Install a set of timing functions.
78  *
79  * \param funcs An instance of the \c ast_timing_functions structure with pointers
80  *        to the functions provided by the timing implementation.
81  *
82  * \retval NULL failure 
83  * \retval non-Null handle to be passed to ast_uninstall_timing_functions() on success
84  */
85 void *ast_install_timing_functions(struct ast_timing_functions *funcs);
86
87 /*!
88  * \brief Uninstall a previously-installed set of timing functions.
89  *
90  * \param handle The handle returned from a prior successful call to
91  *        ast_install_timing_functions().
92  *
93  * \return nothing
94  */
95 void ast_uninstall_timing_functions(void *handle);
96
97 /*!
98  * \brief Open a timing fd
99  *
100  * \arg rate number of timer ticks per second
101  *
102  * \retval -1 error, with errno set
103  * \retval >=0 success
104  */
105 int ast_timer_open(unsigned int rate);
106
107 /*!
108  * \brief Close an opened timing handle
109  *
110  * \arg handle timing fd returned from timer_open()
111  *
112  * \return nothing
113  */
114 void ast_timer_close(int handle);
115
116 /*!
117  * \brief Acknowledge a timer event
118  *
119  * \arg handle timing fd returned from timer_open()
120  * \arg quantity number of timer events to acknowledge
121  *
122  * \note This function should only be called if timer_get_event()
123  *       returned AST_TIMING_EVENT_EXPIRED.
124  *
125  * \return nothing
126  */
127 void ast_timer_ack(int handle, unsigned int quantity);
128
129 /*!
130  * \brief Enable continuous mode
131  *
132  * \arg handle timing fd returned from timer_open()
133  *
134  * Continuous mode causes poll() on the timing fd to immediately return
135  * always until continuous mode is disabled.
136  *
137  * \retval -1 failure, with errno set
138  * \retval 0 success
139  */
140 int ast_timer_enable_continuous(int handle);
141
142 /*!
143  * \brief Disable continuous mode
144  *
145  * \arg handle timing fd returned from timer_close()
146  *
147  * \retval -1 failure, with errno set
148  * \retval 0 success
149  */
150 int ast_timer_disable_continous(int handle);
151
152 /*!
153  * \brief Determine timing event
154  *
155  * \arg handle timing fd returned by timer_open()
156  *
157  * After poll() indicates that there is input on the timing fd, this will
158  * be called to find out what triggered it.
159  *
160  * \return which event triggered the timing fd
161  */
162 enum ast_timing_event ast_timer_get_event(int handle);
163
164 #if defined(__cplusplus) || defined(c_plusplus)
165 }
166 #endif
167
168 #endif /* _ASTERISK_TIMING_H */