Wed Jan 8 2020 09:50:21

Asterisk developer's documentation


timing.h File Reference

Timing source management. More...

Go to the source code of this file.

Data Structures

struct  ast_timing_interface
 Timing module interface. More...
 

Macros

#define ast_register_timing_interface(i)   _ast_register_timing_interface(i, ast_module_info->self)
 Register a set of timing functions. More...
 

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)
 
int ast_timer_ack (const struct ast_timer *handle, unsigned int quantity)
 Acknowledge a timer event. More...
 
void ast_timer_close (struct ast_timer *handle)
 Close an opened timing handle. More...
 
int ast_timer_disable_continuous (const struct ast_timer *handle)
 Disable continuous mode. More...
 
int ast_timer_enable_continuous (const struct ast_timer *handle)
 Enable continuous mode. More...
 
int ast_timer_fd (const struct ast_timer *handle)
 Get a poll()-able file descriptor for a timer. More...
 
enum ast_timer_event ast_timer_get_event (const struct ast_timer *handle)
 Retrieve timing event. More...
 
unsigned int ast_timer_get_max_rate (const struct ast_timer *handle)
 Get maximum rate supported for a timer. More...
 
const char * ast_timer_get_name (const struct ast_timer *handle)
 Get name of timer in use. More...
 
struct ast_timerast_timer_open (void)
 Open a timer. More...
 
int ast_timer_set_rate (const struct ast_timer *handle, unsigned int rate)
 Set the timing tick rate. More...
 
int ast_unregister_timing_interface (void *handle)
 Unregister a previously registered timing interface. More...
 

Detailed Description

Timing source management.

Author
Kevin P. Fleming kpfle.nosp@m.ming.nosp@m.@digi.nosp@m.um.c.nosp@m.om
Russell Bryant russe.nosp@m.ll@d.nosp@m.igium.nosp@m..com

Portions of Asterisk require a timing source, a periodic trigger for media handling activities. The functions in this file allow a loadable module to provide a timing source for Asterisk and its modules, so that those modules can request a 'timing handle' when they require one. These handles are file descriptors, which can be used with select() or poll().

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.

Macro Definition Documentation

#define ast_register_timing_interface (   i)    _ast_register_timing_interface(i, ast_module_info->self)

Register a set of timing functions.

Parameters
iAn instance of the ast_timing_interfaces structure with pointers to the functions provided by the timing implementation.
Return values
NULLfailure
non-Nullhandle to be passed to ast_unregister_timing_interface() on success
Since
1.6.1

Definition at line 94 of file timing.h.

Referenced by load_module().

Enumeration Type Documentation

Enumerator
AST_TIMING_EVENT_EXPIRED 
AST_TIMING_EVENT_CONTINUOUS 

Definition at line 57 of file timing.h.

Function Documentation

void* _ast_register_timing_interface ( struct ast_timing_interface funcs,
struct ast_module mod 
)

Definition at line 75 of file timing.c.

References ast_calloc, ast_heap_push(), ast_heap_unlock, ast_heap_wrlock, timing_holder::iface, 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, and ast_timing_interface::timer_set_rate.

77 {
78  struct timing_holder *h;
79 
80  if (!funcs->timer_open ||
81  !funcs->timer_close ||
82  !funcs->timer_set_rate ||
83  !funcs->timer_ack ||
84  !funcs->timer_get_event ||
85  !funcs->timer_get_max_rate ||
86  !funcs->timer_enable_continuous ||
87  !funcs->timer_disable_continuous) {
88  return NULL;
89  }
90 
91  if (!(h = ast_calloc(1, sizeof(*h)))) {
92  return NULL;
93  }
94 
95  h->iface = funcs;
96  h->mod = mod;
97 
101 
102  return h;
103 }
struct ast_timing_interface * iface
Definition: timing.c:51
int(* timer_open)(void)
Definition: timing.h:74
#define ast_heap_unlock(h)
Definition: heap.h:252
int ast_heap_push(struct ast_heap *h, void *elm)
Push an element on to a heap.
Definition: heap.c:250
int(* timer_enable_continuous)(int handle)
Definition: timing.h:78
enum ast_timer_event(* timer_get_event)(int handle)
Definition: timing.h:80
void(* timer_close)(int handle)
Definition: timing.h:75
int(* timer_disable_continuous)(int handle)
Definition: timing.h:79
int(* timer_set_rate)(int handle, unsigned int rate)
Definition: timing.h:76
int(* timer_ack)(int handle, unsigned int quantity)
Definition: timing.h:77
unsigned int(* timer_get_max_rate)(int handle)
Definition: timing.h:81
static struct ast_heap * timing_interfaces
Definition: timing.c:54
#define ast_calloc(a, b)
Definition: astmm.h:82
struct ast_module * mod
Definition: timing.c:50
#define ast_heap_wrlock(h)
Definition: heap.h:250
int ast_timer_ack ( const struct ast_timer handle,
unsigned int  quantity 
)

Acknowledge a timer event.

Parameters
handletimer handle returned from timer_open()
quantitynumber of timer events to acknowledge
Note
This function should only be called if timer_get_event() returned AST_TIMING_EVENT_EXPIRED.
Return values
-1failure, with errno set
0success
Since
10.5.2

Definition at line 172 of file timing.c.

References ast_timer::fd, ast_timer::holder, timing_holder::iface, and ast_timing_interface::timer_ack.

Referenced by __ast_read(), monmp3thread(), softmix_bridge_thread(), spandsp_fax_read(), timing_read(), and timing_test().

173 {
174  int res = -1;
175 
176  res = handle->holder->iface->timer_ack(handle->fd, quantity);
177 
178  return res;
179 }
struct ast_timing_interface * iface
Definition: timing.c:51
struct timing_holder * holder
Definition: timing.c:58
int(* timer_ack)(int handle, unsigned int quantity)
Definition: timing.h:77
int fd
Definition: timing.c:57
void ast_timer_close ( struct ast_timer handle)

Close an opened timing handle.

Parameters
handletimer handle returned from timer_open()
Returns
nothing
Since
1.6.1

Definition at line 150 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_destructor(), init_app_class(), load_module(), local_ast_moh_start(), moh_class_destructor(), session_destroy(), softmix_bridge_destroy(), and timing_test().

151 {
152  handle->holder->iface->timer_close(handle->fd);
153  handle->fd = -1;
154  ast_module_unref(handle->holder->mod);
155  ast_free(handle);
156 }
void ast_module_unref(struct ast_module *)
Definition: loader.c:1312
struct ast_timing_interface * iface
Definition: timing.c:51
void(* timer_close)(int handle)
Definition: timing.h:75
struct timing_holder * holder
Definition: timing.c:58
int fd
Definition: timing.c:57
#define ast_free(a)
Definition: astmm.h:97
struct ast_module * mod
Definition: timing.c:50
int ast_timer_disable_continuous ( const struct ast_timer handle)

Disable continuous mode.

Parameters
handletimer handle returned from timer_close()
Return values
-1failure, with errno set
0success
Since
1.6.1

Definition at line 190 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().

191 {
192  int res = -1;
193 
194  res = handle->holder->iface->timer_disable_continuous(handle->fd);
195 
196  return res;
197 }
struct ast_timing_interface * iface
Definition: timing.c:51
int(* timer_disable_continuous)(int handle)
Definition: timing.h:79
struct timing_holder * holder
Definition: timing.c:58
int fd
Definition: timing.c:57
int ast_timer_enable_continuous ( const struct ast_timer handle)

Enable continuous mode.

Parameters
handletimer handle returned from timer_open()

Continuous mode causes poll() on the timer's fd to immediately return always until continuous mode is disabled.

Return values
-1failure, with errno set
0success
Since
1.6.1

Definition at line 181 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().

182 {
183  int res = -1;
184 
185  res = handle->holder->iface->timer_enable_continuous(handle->fd);
186 
187  return res;
188 }
struct ast_timing_interface * iface
Definition: timing.c:51
int(* timer_enable_continuous)(int handle)
Definition: timing.h:78
struct timing_holder * holder
Definition: timing.c:58
int fd
Definition: timing.c:57
int ast_timer_fd ( const struct ast_timer handle)

Get a poll()-able file descriptor for a timer.

Parameters
handletimer handle returned from timer_open()
Returns
file descriptor which can be used with poll() to wait for events
Since
1.6.1

Definition at line 158 of file timing.c.

References ast_timer::fd.

Referenced by __ast_channel_alloc_ap(), monmp3thread(), network_thread(), softmix_bridge_thread(), spandsp_fax_new(), and timing_test().

159 {
160  return handle->fd;
161 }
int fd
Definition: timing.c:57
enum ast_timer_event ast_timer_get_event ( const struct ast_timer handle)

Retrieve timing event.

Parameters
handletimer handle returned by timer_open()

After poll() indicates that there is input on the timer's fd, this will be called to find out what triggered it.

Returns
which event triggered the timer
Since
1.6.1

Definition at line 199 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().

200 {
201  enum ast_timer_event res = -1;
202 
203  res = handle->holder->iface->timer_get_event(handle->fd);
204 
205  return res;
206 }
struct ast_timing_interface * iface
Definition: timing.c:51
ast_timer_event
Definition: timing.h:57
enum ast_timer_event(* timer_get_event)(int handle)
Definition: timing.h:80
struct timing_holder * holder
Definition: timing.c:58
int fd
Definition: timing.c:57
unsigned int ast_timer_get_max_rate ( const struct ast_timer handle)

Get maximum rate supported for a timer.

Parameters
handletimer handle returned by timer_open()
Returns
maximum rate supported by timer
Since
1.6.1

Definition at line 208 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_full().

209 {
210  unsigned int res = 0;
211 
212  res = handle->holder->iface->timer_get_max_rate(handle->fd);
213 
214  return res;
215 }
struct ast_timing_interface * iface
Definition: timing.c:51
struct timing_holder * holder
Definition: timing.c:58
unsigned int(* timer_get_max_rate)(int handle)
Definition: timing.h:81
int fd
Definition: timing.c:57
const char* ast_timer_get_name ( const struct ast_timer handle)

Get name of timer in use.

Parameters
handletimer handle returned by timer_open()
Returns
name of timer
Since
1.6.2

Definition at line 217 of file timing.c.

References ast_timer::holder, timing_holder::iface, and ast_timing_interface::name.

Referenced by __ast_channel_alloc_ap().

218 {
219  return handle->holder->iface->name;
220 }
const char * name
Definition: timing.h:70
struct ast_timing_interface * iface
Definition: timing.c:51
struct timing_holder * holder
Definition: timing.c:58
struct ast_timer* ast_timer_open ( void  )

Open a timer.

Return values
NULLon error, with errno set
non-NULLtimer handle on success
Since
1.6.1

Definition at line 123 of file timing.c.

References ast_calloc, ast_heap_peek(), ast_heap_rdlock, ast_heap_unlock, ast_module_ref(), ast_timer::fd, ast_timer::holder, timing_holder::iface, timing_holder::mod, ast_timing_interface::timer_close, and ast_timing_interface::timer_open.

Referenced by __ast_channel_alloc_ap(), init_app_class(), load_module(), local_ast_moh_start(), softmix_bridge_create(), spandsp_fax_new(), and timing_test().

124 {
125  int fd = -1;
126  struct timing_holder *h;
127  struct ast_timer *t = NULL;
128 
130 
131  if ((h = ast_heap_peek(timing_interfaces, 1))) {
132  fd = h->iface->timer_open();
133  ast_module_ref(h->mod);
134  }
135 
136  if (fd != -1) {
137  if (!(t = ast_calloc(1, sizeof(*t)))) {
138  h->iface->timer_close(fd);
139  } else {
140  t->fd = fd;
141  t->holder = h;
142  }
143  }
144 
146 
147  return t;
148 }
struct ast_timing_interface * iface
Definition: timing.c:51
int(* timer_open)(void)
Definition: timing.h:74
#define ast_heap_unlock(h)
Definition: heap.h:252
void(* timer_close)(int handle)
Definition: timing.h:75
struct timing_holder * holder
Definition: timing.c:58
#define ast_heap_rdlock(h)
Definition: heap.h:251
int fd
Definition: timing.c:57
static struct ast_heap * timing_interfaces
Definition: timing.c:54
#define ast_calloc(a, b)
Definition: astmm.h:82
struct ast_module * mod
Definition: timing.c:50
void * ast_heap_peek(struct ast_heap *h, unsigned int index)
Peek at an element on a heap.
Definition: heap.c:300
struct ast_module * ast_module_ref(struct ast_module *)
Definition: loader.c:1300
int ast_timer_set_rate ( const struct ast_timer handle,
unsigned int  rate 
)

Set the timing tick rate.

Parameters
handletimer handle returned from timer_open()
rateticks per second, 0 turns the ticks off if needed

Use this function if you want the timer to show input at a certain rate. The other alternative use of a timer is the continuous mode.

Return values
-1error, with errno set
0success
Since
1.6.1

Definition at line 163 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_full(), init_app_class(), load_module(), local_ast_moh_start(), set_config(), softmix_bridge_thread(), spandsp_fax_start(), and timing_test().

164 {
165  int res = -1;
166 
167  res = handle->holder->iface->timer_set_rate(handle->fd, rate);
168 
169  return res;
170 }
struct ast_timing_interface * iface
Definition: timing.c:51
int(* timer_set_rate)(int handle, unsigned int rate)
Definition: timing.h:76
struct timing_holder * holder
Definition: timing.c:58
int fd
Definition: timing.c:57
int ast_unregister_timing_interface ( void *  handle)

Unregister a previously registered timing interface.

Parameters
handleThe handle returned from a prior successful call to ast_register_timing_interface().
Return values
0success
non-zerofailure
Since
1.6.1

Definition at line 105 of file timing.c.

References ast_free, ast_heap_remove(), ast_heap_unlock, and ast_heap_wrlock.

Referenced by unload_module().

106 {
107  struct timing_holder *h = handle;
108  int res = -1;
109 
113 
114  if (h) {
115  ast_free(h);
116  h = NULL;
117  res = 0;
118  }
119 
120  return res;
121 }
#define ast_heap_unlock(h)
Definition: heap.h:252
#define ast_free(a)
Definition: astmm.h:97
static struct ast_heap * timing_interfaces
Definition: timing.c:54
void * ast_heap_remove(struct ast_heap *h, void *elm)
Remove a specific element from a heap.
Definition: heap.c:284
#define ast_heap_wrlock(h)
Definition: heap.h:250