Go to the source code of this file.
Data Structures | |
struct | ast_timing_interface |
Timing module interface. More... | |
Defines | |
#define | ast_register_timing_interface(i) _ast_register_timing_interface(i, ast_module_info->self) |
Register a set of timing functions. | |
Enumerations | |
enum | ast_timer_event { AST_TIMING_EVENT_EXPIRED = 1, AST_TIMING_EVENT_CONTINUOUS = 2 } |
Functions | |
void * | _ast_register_timing_interface (struct ast_timing_interface *funcs, struct ast_module *mod) |
void | ast_timer_ack (const struct ast_timer *handle, unsigned int quantity) |
Acknowledge a timer event. | |
void | ast_timer_close (struct ast_timer *handle) |
Close an opened timing handle. | |
int | ast_timer_disable_continuous (const struct ast_timer *handle) |
Disable continuous mode. | |
int | ast_timer_enable_continuous (const struct ast_timer *handle) |
Enable continuous mode. | |
int | ast_timer_fd (const struct ast_timer *handle) |
Get a poll()-able file descriptor for a timer. | |
enum ast_timer_event | ast_timer_get_event (const struct ast_timer *handle) |
Retrieve timing event. | |
unsigned int | ast_timer_get_max_rate (const struct ast_timer *handle) |
Get maximum rate supported for a timer. | |
ast_timer * | ast_timer_open (void) |
Open a timer. | |
int | ast_timer_set_rate (const struct ast_timer *handle, unsigned int rate) |
Set the timing tick rate. | |
int | ast_unregister_timing_interface (void *handle) |
Unregister a previously registered timing interface. |
Russell Bryant <russell@digium.com>
The timing source used by Asterisk must provide the following features:
1) Periodic triggers, with a configurable interval (specified as number of triggers per second).
2) Multiple outstanding triggers, each of which must be 'acked' to clear it. Triggers must also be 'ackable' in quantity.
3) Continuous trigger mode, which when enabled causes every call to poll() on the timer handle to immediately return.
4) Multiple 'event types', so that the code using the timer can know whether the wakeup it received was due to a periodic trigger or a continuous trigger.
Definition in file timing.h.
#define ast_register_timing_interface | ( | i | ) | _ast_register_timing_interface(i, ast_module_info->self) |
Register a set of timing functions.
funcs | An instance of the ast_timing_interfaces structure with pointers to the functions provided by the timing implementation. |
NULL | failure | |
non-Null | handle to be passed to ast_unregister_timing_interface() on success |
Definition at line 94 of file timing.h.
Referenced by load_module().
enum ast_timer_event |
Definition at line 57 of file timing.h.
00057 { 00058 AST_TIMING_EVENT_EXPIRED = 1, 00059 AST_TIMING_EVENT_CONTINUOUS = 2, 00060 };
void* _ast_register_timing_interface | ( | struct ast_timing_interface * | funcs, | |
struct ast_module * | mod | |||
) |
Definition at line 71 of file timing.c.
References ast_calloc, ast_heap_push(), ast_heap_unlock(), ast_heap_wrlock(), timing_holder::mod, ast_timing_interface::timer_ack, ast_timing_interface::timer_close, ast_timing_interface::timer_disable_continuous, ast_timing_interface::timer_enable_continuous, ast_timing_interface::timer_get_event, ast_timing_interface::timer_get_max_rate, ast_timing_interface::timer_open, ast_timing_interface::timer_set_rate, and timing_interfaces.
00073 { 00074 struct timing_holder *h; 00075 00076 if (!funcs->timer_open || 00077 !funcs->timer_close || 00078 !funcs->timer_set_rate || 00079 !funcs->timer_ack || 00080 !funcs->timer_get_event || 00081 !funcs->timer_get_max_rate || 00082 !funcs->timer_enable_continuous || 00083 !funcs->timer_disable_continuous) { 00084 return NULL; 00085 } 00086 00087 if (!(h = ast_calloc(1, sizeof(*h)))) { 00088 return NULL; 00089 } 00090 00091 h->iface = funcs; 00092 h->mod = mod; 00093 00094 ast_heap_wrlock(timing_interfaces); 00095 ast_heap_push(timing_interfaces, h); 00096 ast_heap_unlock(timing_interfaces); 00097 00098 return h; 00099 }
void ast_timer_ack | ( | const struct ast_timer * | handle, | |
unsigned int | quantity | |||
) |
Acknowledge a timer event.
handle | timer handle returned from timer_open() | |
quantity | number of timer events to acknowledge |
Definition at line 167 of file timing.c.
References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_ack.
Referenced by __ast_read(), timing_read(), and timing_test().
void ast_timer_close | ( | struct ast_timer * | handle | ) |
Close an opened timing handle.
handle | timer handle returned from timer_open() |
Definition at line 146 of file timing.c.
References ast_free, ast_module_unref(), ast_timer::fd, ast_timer::holder, timing_holder::iface, timing_holder::mod, and ast_timing_interface::timer_close.
Referenced by __unload_module(), ast_channel_alloc(), ast_channel_free(), and timing_test().
00147 { 00148 handle->holder->iface->timer_close(handle->fd); 00149 ast_module_unref(handle->holder->mod); 00150 ast_free(handle); 00151 }
int ast_timer_disable_continuous | ( | const struct ast_timer * | handle | ) |
Disable continuous mode.
handle | timer handle returned from timer_close() |
-1 | failure, with errno set | |
0 | success |
Definition at line 181 of file timing.c.
References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_disable_continuous.
Referenced by __ast_read().
00182 { 00183 int res = -1; 00184 00185 res = handle->holder->iface->timer_disable_continuous(handle->fd); 00186 00187 return res; 00188 }
int ast_timer_enable_continuous | ( | const struct ast_timer * | handle | ) |
Enable continuous mode.
handle | timer handle returned from timer_open() |
-1 | failure, with errno set | |
0 | success |
Definition at line 172 of file timing.c.
References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_enable_continuous.
Referenced by __ast_queue_frame().
00173 { 00174 int res = -1; 00175 00176 res = handle->holder->iface->timer_enable_continuous(handle->fd); 00177 00178 return res; 00179 }
int ast_timer_fd | ( | const struct ast_timer * | handle | ) |
Get a poll()-able file descriptor for a timer.
handle | timer handle returned from timer_open() |
Definition at line 153 of file timing.c.
References ast_timer::fd.
Referenced by ast_channel_alloc(), network_thread(), and timing_test().
00154 { 00155 return handle->fd; 00156 }
enum ast_timer_event ast_timer_get_event | ( | const struct ast_timer * | handle | ) |
Retrieve timing event.
handle | timer handle returned by timer_open() |
Definition at line 190 of file timing.c.
References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_get_event.
Referenced by __ast_read().
00191 { 00192 enum ast_timer_event res = -1; 00193 00194 res = handle->holder->iface->timer_get_event(handle->fd); 00195 00196 return res; 00197 }
unsigned int ast_timer_get_max_rate | ( | const struct ast_timer * | handle | ) |
Get maximum rate supported for a timer.
handle | timer handle returned by timer_open() |
Definition at line 199 of file timing.c.
References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_get_max_rate.
Referenced by ast_settimeout().
00200 { 00201 unsigned int res = 0; 00202 00203 res = handle->holder->iface->timer_get_max_rate(handle->fd); 00204 00205 return res; 00206 }
struct ast_timer* ast_timer_open | ( | void | ) |
Open a timer.
NULL | on error, with errno set | |
non-NULL | timer handle on success |
Definition at line 119 of file timing.c.
References ast_calloc, ast_heap_peek(), ast_heap_rdlock(), ast_heap_unlock(), ast_module_ref(), ast_timer::fd, timing_holder::iface, timing_holder::mod, ast_timing_interface::timer_close, ast_timing_interface::timer_open, and timing_interfaces.
Referenced by ast_channel_alloc(), load_module(), and timing_test().
00120 { 00121 int fd = -1; 00122 struct timing_holder *h; 00123 struct ast_timer *t = NULL; 00124 00125 ast_heap_rdlock(timing_interfaces); 00126 00127 if ((h = ast_heap_peek(timing_interfaces, 1))) { 00128 fd = h->iface->timer_open(); 00129 ast_module_ref(h->mod); 00130 } 00131 00132 if (fd != -1) { 00133 if (!(t = ast_calloc(1, sizeof(*t)))) { 00134 h->iface->timer_close(fd); 00135 } else { 00136 t->fd = fd; 00137 t->holder = h; 00138 } 00139 } 00140 00141 ast_heap_unlock(timing_interfaces); 00142 00143 return t; 00144 }
int ast_timer_set_rate | ( | const struct ast_timer * | handle, | |
unsigned int | rate | |||
) |
Set the timing tick rate.
handle | timer handle returned from timer_open() | |
rate | ticks per second, 0 turns the ticks off if needed |
-1 | error, with errno set | |
0 | success |
Definition at line 158 of file timing.c.
References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_set_rate.
Referenced by __ast_read(), ast_settimeout(), load_module(), and timing_test().
00159 { 00160 int res = -1; 00161 00162 res = handle->holder->iface->timer_set_rate(handle->fd, rate); 00163 00164 return res; 00165 }
int ast_unregister_timing_interface | ( | void * | handle | ) |
Unregister a previously registered timing interface.
handle | The handle returned from a prior successful call to ast_register_timing_interface(). |
0 | success | |
non-zero | failure |
Definition at line 101 of file timing.c.
References ast_free, ast_heap_remove(), ast_heap_unlock(), ast_heap_wrlock(), and timing_interfaces.
Referenced by unload_module().
00102 { 00103 struct timing_holder *h = handle; 00104 int res = -1; 00105 00106 ast_heap_wrlock(timing_interfaces); 00107 h = ast_heap_remove(timing_interfaces, h); 00108 ast_heap_unlock(timing_interfaces); 00109 00110 if (h) { 00111 ast_free(h); 00112 h = NULL; 00113 res = 0; 00114 } 00115 00116 return res; 00117 }