Convert the PBX core to use read/write locks. This yields a nifty performance improve...
[asterisk/asterisk.git] / include / asterisk / pbx.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@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 /*! \file
20  * \brief Core PBX routines and definitions.
21  */
22
23 #ifndef _ASTERISK_PBX_H
24 #define _ASTERISK_PBX_H
25
26 #include "asterisk/sched.h"
27 #include "asterisk/channel.h"
28 #include "asterisk/linkedlists.h"
29
30 #if defined(__cplusplus) || defined(c_plusplus)
31 extern "C" {
32 #endif
33
34 #define AST_MAX_APP     32      /*!< Max length of an application */
35
36 #define AST_PBX_KEEP    0
37 #define AST_PBX_REPLACE 1
38
39 /*! \brief Special return values from applications to the PBX { */
40 #define AST_PBX_KEEPALIVE       10      /*!< Destroy the thread, but don't hang up the channel */
41 #define AST_PBX_NO_HANGUP_PEER  11
42 /*! } */
43
44 #define PRIORITY_HINT   -1      /*!< Special Priority for a hint */
45
46 /*! \brief Extension states 
47         \note States can be combined 
48         - \ref AstExtState
49 */
50 enum ast_extension_states {
51         AST_EXTENSION_REMOVED = -2,     /*!< Extension removed */
52         AST_EXTENSION_DEACTIVATED = -1, /*!< Extension hint removed */
53         AST_EXTENSION_NOT_INUSE = 0,    /*!< No device INUSE or BUSY  */
54         AST_EXTENSION_INUSE = 1 << 0,   /*!< One or more devices INUSE */
55         AST_EXTENSION_BUSY = 1 << 1,    /*!< All devices BUSY */
56         AST_EXTENSION_UNAVAILABLE = 1 << 2, /*!< All devices UNAVAILABLE/UNREGISTERED */
57         AST_EXTENSION_RINGING = 1 << 3, /*!< All devices RINGING */
58         AST_EXTENSION_ONHOLD = 1 << 4,  /*!< All devices ONHOLD */
59 };
60
61
62 struct ast_context;
63 struct ast_exten;     
64 struct ast_include;
65 struct ast_ignorepat;
66 struct ast_sw;
67
68 /*! \brief Typedef for devicestate and hint callbacks */
69 typedef int (*ast_state_cb_type)(char *context, char* id, enum ast_extension_states state, void *data);
70
71 /*! \brief Data structure associated with a custom dialplan function */
72 struct ast_custom_function {
73         const char *name;               /*!< Name */
74         const char *synopsis;           /*!< Short description for "show functions" */
75         const char *desc;               /*!< Help text that explains it all */
76         const char *syntax;             /*!< Syntax description */
77         int (*read)(struct ast_channel *, const char *, char *, char *, size_t);        /*!< Read function, if read is supported */
78         int (*write)(struct ast_channel *, const char *, char *, const char *);         /*!< Write function, if write is supported */
79         AST_RWLIST_ENTRY(ast_custom_function) acflist;
80 };
81
82 /*! \brief All switch functions have the same interface, so define a type for them */
83 typedef int (ast_switch_f)(struct ast_channel *chan, const char *context,
84         const char *exten, int priority, const char *callerid, const char *data);
85
86 /*!< Data structure associated with an Asterisk switch */
87 struct ast_switch {
88         AST_LIST_ENTRY(ast_switch) list;
89         const char *name;                       /*!< Name of the switch */
90         const char *description;                /*!< Description of the switch */
91         
92         ast_switch_f *exists;
93         ast_switch_f *canmatch;
94         ast_switch_f *exec;
95         ast_switch_f *matchmore;
96 };
97
98 struct ast_timing {
99         int hastime;                            /*!< If time construct exists */
100         unsigned int monthmask;                 /*!< Mask for month */
101         unsigned int daymask;                   /*!< Mask for date */
102         unsigned int dowmask;                   /*!< Mask for day of week (mon-sun) */
103         unsigned int minmask[24];               /*!< Mask for minute */
104 };
105
106 int ast_build_timing(struct ast_timing *i, const char *info);
107 int ast_check_timing(const struct ast_timing *i);
108
109 struct ast_pbx {
110         int dtimeout;                           /*!< Timeout between digits (seconds) */
111         int rtimeout;                           /*!< Timeout for response (seconds) */
112 };
113
114
115 /*!
116  * \brief Register an alternative dialplan switch
117  *
118  * \param sw switch to register
119  *
120  * This function registers a populated ast_switch structure with the
121  * asterisk switching architecture.
122  *
123  * \return 0 on success, and other than 0 on failure
124  */
125 int ast_register_switch(struct ast_switch *sw);
126
127 /*!
128  * \brief Unregister an alternative switch
129  *
130  * \param sw switch to unregister
131  * 
132  * Unregisters a switch from asterisk.
133  *
134  * \return nothing
135  */
136 void ast_unregister_switch(struct ast_switch *sw);
137
138 /*!
139  * \brief Look up an application
140  *
141  * \param app name of the app
142  *
143  * This function searches for the ast_app structure within
144  * the apps that are registered for the one with the name
145  * you passed in.
146  *
147  * \return the ast_app structure that matches on success, or NULL on failure
148  */
149 struct ast_app *pbx_findapp(const char *app);
150
151 /*!
152  * \brief Execute an application
153  *
154  * \param c channel to execute on
155  * \param app which app to execute
156  * \param data the data passed into the app
157  *
158  * This application executes an application on a given channel.  It
159  * saves the stack and executes the given application passing in
160  * the given data.
161  *
162  * \return 0 on success, and -1 on failure
163  */
164 int pbx_exec(struct ast_channel *c, struct ast_app *app, void *data);
165
166 /*!
167  * \brief Register a new context
168  *
169  * \param extcontexts pointer to the ast_context structure pointer
170  * \param name name of the new context
171  * \param registrar registrar of the context
172  *
173  * This will first search for a context with your name.  If it exists already, it will not
174  * create a new one.  If it does not exist, it will create a new one with the given name
175  * and registrar.
176  *
177  * \return NULL on failure, and an ast_context structure on success
178  */
179 struct ast_context *ast_context_create(struct ast_context **extcontexts, const char *name, const char *registrar);
180
181 /*!
182  * \brief Register a new context or find an existing one
183  *
184  * \param extcontexts pointer to the ast_context structure pointer
185  * \param name name of the new context
186  * \param registrar registrar of the context
187  *
188  * This will first search for a context with your name.  If it exists already, it will not
189  * create a new one.  If it does not exist, it will create a new one with the given name
190  * and registrar.
191  *
192  * \return NULL on failure, and an ast_context structure on success
193  */
194 struct ast_context *ast_context_find_or_create(struct ast_context **extcontexts, const char *name, const char *registrar);
195
196 /*!
197  * \brief Merge the temporary contexts into a global contexts list and delete from the 
198  *        global list the ones that are being added
199  *
200  * \param extcontexts pointer to the ast_context structure pointer
201  * \param registrar of the context; if it's set the routine will delete all contexts 
202  *        that belong to that registrar; if NULL only the contexts that are specified 
203  *        in extcontexts
204  */
205 void ast_merge_contexts_and_delete(struct ast_context **extcontexts, const char *registrar);
206
207 /*!
208  * \brief Destroy a context (matches the specified context (or ANY context if NULL)
209  *
210  * \param con context to destroy
211  * \param registrar who registered it
212  *
213  * You can optionally leave out either parameter.  It will find it
214  * based on either the ast_context or the registrar name.
215  *
216  * \return nothing
217  */
218 void ast_context_destroy(struct ast_context *con, const char *registrar);
219
220 /*!
221  * \brief Find a context
222  *
223  * \param name name of the context to find
224  *
225  * Will search for the context with the given name.
226  *
227  * \return the ast_context on success, NULL on failure.
228  */
229 struct ast_context *ast_context_find(const char *name);
230
231 /*! \brief The result codes when starting the PBX on a channel
232         with \ref ast_pbx_start()
233
234         AST_PBX_CALL_LIMIT refers to the maxcalls call limit in asterisk.conf
235  */
236 enum ast_pbx_result {
237         AST_PBX_SUCCESS = 0,
238         AST_PBX_FAILED = -1,
239         AST_PBX_CALL_LIMIT = -2,
240 };
241
242 /*!
243  * \brief Create a new thread and start the PBX
244  *
245  * \param c channel to start the pbx on
246  *
247  * See ast_pbx_run for a synchronous function to run the PBX in the
248  * current thread, as opposed to starting a new one.
249  *
250  * \return Zero on success, non-zero on failure
251  */
252 enum ast_pbx_result ast_pbx_start(struct ast_channel *c);
253
254 /*!
255  * \brief Execute the PBX in the current thread
256  *
257  * \param c channel to run the pbx on
258  *
259  * This executes the PBX on a given channel. It allocates a new
260  * PBX structure for the channel, and provides all PBX functionality.
261  * See ast_pbx_start for an asynchronous function to run the PBX in a
262  * new thread as opposed to the current one.
263  * 
264  * \return Zero on success, non-zero on failure
265  */
266 enum ast_pbx_result ast_pbx_run(struct ast_channel *c);
267
268 /*! 
269  * \brief Add and extension to an extension context.  
270  * 
271  * \param context context to add the extension to
272  * \param replace
273  * \param extension extension to add
274  * \param priority priority level of extension addition
275  * \param label extension label
276  * \param callerid pattern to match CallerID, or NULL to match any CallerID
277  * \param application application to run on the extension with that priority level
278  * \param data data to pass to the application
279  * \param datad
280  * \param registrar who registered the extension
281  *
282  * \retval 0 success 
283  * \retval -1 failure
284  */
285 int ast_add_extension(const char *context, int replace, const char *extension, 
286         int priority, const char *label, const char *callerid,
287         const char *application, void *data, void (*datad)(void *), const char *registrar);
288
289 /*! 
290  * \brief Add an extension to an extension context, this time with an ast_context *.
291  *
292  * \note For details about the arguments, check ast_add_extension()
293  */
294 int ast_add_extension2(struct ast_context *con, int replace, const char *extension,
295         int priority, const char *label, const char *callerid, 
296         const char *application, void *data, void (*datad)(void *), const char *registrar);
297
298
299 /*! 
300  * \brief Register an application.
301  *
302  * \param app Short name of the application
303  * \param execute a function callback to execute the application. It should return
304  *                non-zero if the channel needs to be hung up.
305  * \param synopsis a short description (one line synopsis) of the application
306  * \param description long description with all of the details about the use of 
307  *                    the application
308  * 
309  * This registers an application with Asterisk's internal application list. 
310  * \note The individual applications themselves are responsible for registering and unregistering
311  *       and unregistering their own CLI commands.
312  * 
313  * \retval 0 success 
314  * \retval -1 failure.
315  */
316 int ast_register_application(const char *app, int (*execute)(struct ast_channel *, void *),
317                              const char *synopsis, const char *description);
318
319 /*! 
320  * \brief Unregister an application
321  * 
322  * \param app name of the application (does not have to be the same string as the one that was registered)
323  * 
324  * This unregisters an application from Asterisk's internal application list.
325  * 
326  * \retval 0 success 
327  * \retval -1 failure
328  */
329 int ast_unregister_application(const char *app);
330
331 /*! 
332  * \brief Uses hint and devicestate callback to get the state of an extension
333  *
334  * \param c this is not important
335  * \param context which context to look in
336  * \param exten which extension to get state
337  *
338  * \return extension state as defined in the ast_extension_states enum
339  */
340 int ast_extension_state(struct ast_channel *c, const char *context, const char *exten);
341
342 /*! 
343  * \brief Return string representation of the state of an extension
344  * 
345  * \param extension_state is the numerical state delivered by ast_extension_state
346  *
347  * \return the state of an extension as string
348  */
349 const char *ast_extension_state2str(int extension_state);
350
351 /*!
352  * \brief Registers a state change callback
353  * 
354  * \param context which context to look in
355  * \param exten which extension to get state
356  * \param callback callback to call if state changed
357  * \param data to pass to callback
358  *
359  * The callback is called if the state of an extension is changed.
360  *
361  * \retval -1 on failure
362  * \retval ID on success
363  */ 
364 int ast_extension_state_add(const char *context, const char *exten, 
365                             ast_state_cb_type callback, void *data);
366
367 /*! 
368  * \brief Deletes a registered state change callback by ID
369  * 
370  * \param id of the callback to delete
371  * \param callback callback
372  *
373  * Removes the callback from list of callbacks
374  *
375  * \retval 0 success 
376  * \retval -1 failure
377  */
378 int ast_extension_state_del(int id, ast_state_cb_type callback);
379
380 /*! 
381  * \brief If an extension hint exists, return non-zero
382  * 
383  * \param hint buffer for hint
384  * \param maxlen size of hint buffer
385  * \param name buffer for name portion of hint
386  * \param maxnamelen size of name buffer
387  * \param c this is not important
388  * \param context which context to look in
389  * \param exten which extension to search for
390  *
391  * \return If an extension within the given context with the priority PRIORITY_HINT
392  * is found a non zero value will be returned.
393  * Otherwise, 0 is returned.
394  */
395 int ast_get_hint(char *hint, int maxlen, char *name, int maxnamelen, 
396         struct ast_channel *c, const char *context, const char *exten);
397
398 /*!
399  * \brief Determine whether an extension exists
400  *
401  * \param c this is not important
402  * \param context which context to look in
403  * \param exten which extension to search for
404  * \param priority priority of the action within the extension
405  * \param callerid callerid to search for
406  *
407  * \return If an extension within the given context(or callerid) with the given priority 
408  *         is found a non zero value will be returned. Otherwise, 0 is returned.
409  */
410 int ast_exists_extension(struct ast_channel *c, const char *context, const char *exten, 
411         int priority, const char *callerid);
412
413 /*! 
414  * \brief Find the priority of an extension that has the specified label
415  * 
416  * \param c this is not important
417  * \param context which context to look in
418  * \param exten which extension to search for
419  * \param label label of the action within the extension to match to priority
420  * \param callerid callerid to search for
421  *
422  * \return the priority which matches the given label in the extension or -1 if not found.
423  */
424 int ast_findlabel_extension(struct ast_channel *c, const char *context, 
425         const char *exten, const char *label, const char *callerid);
426
427 /*!
428  * \brief Find the priority of an extension that has the specified label
429  *
430  * \note This function is the same as ast_findlabel_extension, except that it accepts
431  * a pointer to an ast_context structure to specify the context instead of the
432  * name of the context. Otherwise, the functions behave the same.
433  */
434 int ast_findlabel_extension2(struct ast_channel *c, struct ast_context *con, 
435         const char *exten, const char *label, const char *callerid);
436
437 /*! 
438  * \brief Looks for a valid matching extension
439  * 
440  * \param c not really important
441  * \param context context to serach within
442  * \param exten extension to check
443  * \param priority priority of extension path
444  * \param callerid callerid of extension being searched for
445  *
446  * \return If "exten" *could be* a valid extension in this context with or without
447  * some more digits, return non-zero.  Basically, when this returns 0, no matter
448  * what you add to exten, it's not going to be a valid extension anymore
449  */
450 int ast_canmatch_extension(struct ast_channel *c, const char *context, 
451         const char *exten, int priority, const char *callerid);
452
453 /*! 
454  * \brief Looks to see if adding anything to this extension might match something. (exists ^ canmatch)
455  *
456  * \param c not really important XXX
457  * \param context context to serach within
458  * \param exten extension to check
459  * \param priority priority of extension path
460  * \param callerid callerid of extension being searched for
461  *
462  * \return If "exten" *could match* a valid extension in this context with
463  * some more digits, return non-zero.  Does NOT return non-zero if this is
464  * an exact-match only.  Basically, when this returns 0, no matter
465  * what you add to exten, it's not going to be a valid extension anymore
466  */
467 int ast_matchmore_extension(struct ast_channel *c, const char *context, 
468         const char *exten, int priority, const char *callerid);
469
470 /*! 
471  * \brief Determine if a given extension matches a given pattern (in NXX format)
472  * 
473  * \param pattern pattern to match
474  * \param extension extension to check against the pattern.
475  *
476  * Checks whether or not the given extension matches the given pattern.
477  *
478  * \retval 1 on match
479  * \retval 0 on failure
480  */
481 int ast_extension_match(const char *pattern, const char *extension);
482
483 int ast_extension_close(const char *pattern, const char *data, int needmore);
484
485 /*! 
486  * \brief Launch a new extension (i.e. new stack)
487  * 
488  * \param c not important
489  * \param context which context to generate the extension within
490  * \param exten new extension to add
491  * \param priority priority of new extension
492  * \param callerid callerid of extension
493  *
494  * This adds a new extension to the asterisk extension list.
495  *
496  * \retval 0 on success 
497  * \retval -1 on failure.
498  */
499 int ast_spawn_extension(struct ast_channel *c, const char *context, 
500         const char *exten, int priority, const char *callerid);
501
502 /*! 
503  * \brief Add a context include
504  *
505  * \param context context to add include to
506  * \param include new include to add
507  * \param registrar who's registering it
508  *
509  * Adds an include taking a char * string as the context parameter
510  *
511  * \retval 0 on success 
512  * \retval -1 on error
513 */
514 int ast_context_add_include(const char *context, const char *include, 
515         const char *registrar);
516
517 /*! 
518  * \brief Add a context include
519  * 
520  * \param con context to add the include to
521  * \param include include to add
522  * \param registrar who registered the context
523  *
524  * Adds an include taking a struct ast_context as the first parameter
525  *
526  * \retval 0 on success 
527  * \retval -1 on failure
528  */
529 int ast_context_add_include2(struct ast_context *con, const char *include, 
530         const char *registrar);
531
532 /*! 
533  * \brief Remove a context include
534  * 
535  * \note See ast_context_add_include for information on arguments
536  *
537  * \retval 0 on success
538  * \retval -1 on failure
539  */
540 int ast_context_remove_include(const char *context, const char *include, 
541         const char *registrar);
542
543 /*! 
544  * \brief Removes an include by an ast_context structure 
545  * 
546  * \note See ast_context_add_include2 for information on arguments
547  *
548  * \retval 0 on success
549  * \retval -1 on success
550  */
551 int ast_context_remove_include2(struct ast_context *con, const char *include, 
552         const char *registrar);
553
554 /*! 
555  * \brief Verifies includes in an ast_contect structure
556  * 
557  * \param con context in which to verify the includes
558  *
559  * \retval 0 if no problems found 
560  * \retval -1 if there were any missing context
561  */
562 int ast_context_verify_includes(struct ast_context *con);
563           
564 /*! 
565  * \brief Add a switch
566  * 
567  * \param context context to which to add the switch
568  * \param sw switch to add
569  * \param data data to pass to switch
570  * \param eval whether to evaluate variables when running switch
571  * \param registrar whoever registered the switch
572  *
573  * This function registers a switch with the asterisk switch architecture
574  *
575  * \retval 0 on success 
576  * \retval -1 on failure
577  */
578 int ast_context_add_switch(const char *context, const char *sw, const char *data, 
579         int eval, const char *registrar);
580
581 /*! 
582  * \brief Adds a switch (first param is a ast_context)
583  * 
584  * \note See ast_context_add_switch() for argument information, with the exception of
585  *       the first argument. In this case, it's a pointer to an ast_context structure
586  *       as opposed to the name.
587  */
588 int ast_context_add_switch2(struct ast_context *con, const char *sw, const char *data, 
589         int eval, const char *registrar);
590
591 /*! 
592  * \brief Remove a switch
593  * 
594  * Removes a switch with the given parameters
595  *
596  * \retval 0 on success 
597  * \retval -1 on failure
598  */
599 int ast_context_remove_switch(const char *context, const char *sw, 
600         const char *data, const char *registrar);
601
602 int ast_context_remove_switch2(struct ast_context *con, const char *sw, 
603         const char *data, const char *registrar);
604
605 /*! 
606  * \brief Simply remove extension from context
607  * 
608  * \param context context to remove extension from
609  * \param extension which extension to remove
610  * \param priority priority of extension to remove
611  * \param registrar registrar of the extension
612  *
613  * This function removes an extension from a given context.
614  *
615  * \retval 0 on success 
616  * \retval -1 on failure
617  */
618 int ast_context_remove_extension(const char *context, const char *extension, int priority,
619         const char *registrar);
620
621 int ast_context_remove_extension2(struct ast_context *con, const char *extension,
622         int priority, const char *registrar);
623
624 /*! 
625  * \brief Add an ignorepat
626  * 
627  * \param context which context to add the ignorpattern to
628  * \param ignorepat ignorepattern to set up for the extension
629  * \param registrar registrar of the ignore pattern
630  *
631  * Adds an ignore pattern to a particular context.
632  *
633  * \retval 0 on success 
634  * \retval -1 on failure
635  */
636 int ast_context_add_ignorepat(const char *context, const char *ignorepat, const char *registrar);
637
638 int ast_context_add_ignorepat2(struct ast_context *con, const char *ignorepat, const char *registrar);
639
640 /* 
641  * \brief Remove an ignorepat
642  * 
643  * \param context context from which to remove the pattern
644  * \param ignorepat the pattern to remove
645  * \param registrar the registrar of the ignore pattern
646  *
647  * This removes the given ignorepattern
648  *
649  * \retval 0 on success 
650  * \retval -1 on failure
651  */
652 int ast_context_remove_ignorepat(const char *context, const char *ignorepat, const char *registrar);
653
654 int ast_context_remove_ignorepat2(struct ast_context *con, const char *ignorepat, const char *registrar);
655
656 /*! 
657  * \brief Checks to see if a number should be ignored
658  * 
659  * \param context context to search within
660  * \param pattern to check whether it should be ignored or not
661  *
662  * Check if a number should be ignored with respect to dialtone cancellation.
663  *
664  * \retval 0 if the pattern should not be ignored 
665  * \retval non-zero if the pattern should be ignored 
666  */
667 int ast_ignore_pattern(const char *context, const char *pattern);
668
669 /* Locking functions for outer modules, especially for completion functions */
670
671 /*! 
672  * \brief Write locks the context list
673  *
674  * \retval 0 on success 
675  * \retval -1 on error
676  */
677 int ast_wrlock_contexts(void);
678
679 /*!
680  * \brief Read locks the context list
681  *
682  * \retval 0 on success
683  * \retval -1 on error
684  */
685 int ast_rdlock_contexts(void);
686
687 /*! 
688  * \brief Unlocks contexts
689  * 
690  * \retval 0 on success 
691  * \retval -1 on failure
692  */
693 int ast_unlock_contexts(void);
694
695 /*! 
696  * \brief Write locks a given context
697  * 
698  * \param con context to lock
699  *
700  * \retval 0 on success 
701  * \retval -1 on failure
702  */
703 int ast_wrlock_context(struct ast_context *con);
704
705 /*!
706  * \brief Read locks a given context
707  *
708  * \param con context to lock
709  *
710  * \retval 0 on success
711  * \retval -1 on failure
712  */
713 int ast_rdlock_context(struct ast_context *con);
714
715 /*! 
716  * \retval Unlocks the given context
717  * 
718  * \param con context to unlock
719  *
720  * \retval 0 on success 
721  * \retval -1 on failure
722  */
723 int ast_unlock_context(struct ast_context *con);
724
725 /*! 
726  * \brief locks the macrolock in the given given context
727  *
728  * \param macrocontext name of the macro-context to lock
729  *
730  * Locks the given macro-context to ensure only one thread (call) can execute it at a time
731  *
732  * \retval 0 on success
733  * \retval -1 on failure
734  */
735 int ast_context_lockmacro(const char *macrocontext);
736
737 /*!
738  * \brief Unlocks the macrolock in the given context
739  *
740  * \param macrocontext name of the macro-context to unlock
741  *
742  * Unlocks the given macro-context so that another thread (call) can execute it
743  *
744  * \retval 0 on success
745  * \retval -1 on failure
746  */
747 int ast_context_unlockmacro(const char *macrocontext);
748
749 int ast_async_goto(struct ast_channel *chan, const char *context, const char *exten, int priority);
750
751 int ast_async_goto_by_name(const char *chan, const char *context, const char *exten, int priority);
752
753 /*! Synchronously or asynchronously make an outbound call and send it to a
754    particular extension */
755 int ast_pbx_outgoing_exten(const char *type, int format, void *data, int timeout, const char *context, const char *exten, int priority, int *reason, int sync, const char *cid_num, const char *cid_name, struct ast_variable *vars, const char *account, struct ast_channel **locked_channel);
756
757 /*! Synchronously or asynchronously make an outbound call and send it to a
758    particular application with given extension */
759 int ast_pbx_outgoing_app(const char *type, int format, void *data, int timeout, const char *app, const char *appdata, int *reason, int sync, const char *cid_num, const char *cid_name, struct ast_variable *vars, const char *account, struct ast_channel **locked_channel);
760
761 /*!
762  * \brief Evaluate a condition
763  *
764  * \retval 0 if the condition is NULL or of zero length
765  * \retval int If the string is an integer, the integer representation of
766  *             the integer is returned
767  * \retval 1 Any other non-empty string
768  */
769 int pbx_checkcondition(const char *condition);
770
771 /*! @name 
772  * Functions for returning values from structures */
773 /*! @{ */
774 const char *ast_get_context_name(struct ast_context *con);
775 const char *ast_get_extension_name(struct ast_exten *exten);
776 struct ast_context *ast_get_extension_context(struct ast_exten *exten);
777 const char *ast_get_include_name(struct ast_include *include);
778 const char *ast_get_ignorepat_name(struct ast_ignorepat *ip);
779 const char *ast_get_switch_name(struct ast_sw *sw);
780 const char *ast_get_switch_data(struct ast_sw *sw);
781 /*! @} */
782
783 /*! @name Other Extension stuff */
784 /*! @{ */
785 int ast_get_extension_priority(struct ast_exten *exten);
786 int ast_get_extension_matchcid(struct ast_exten *e);
787 const char *ast_get_extension_cidmatch(struct ast_exten *e);
788 const char *ast_get_extension_app(struct ast_exten *e);
789 const char *ast_get_extension_label(struct ast_exten *e);
790 void *ast_get_extension_app_data(struct ast_exten *e);
791 /*! @} */
792
793 /*! @name Registrar info functions ... */
794 /*! @{ */
795 const char *ast_get_context_registrar(struct ast_context *c);
796 const char *ast_get_extension_registrar(struct ast_exten *e);
797 const char *ast_get_include_registrar(struct ast_include *i);
798 const char *ast_get_ignorepat_registrar(struct ast_ignorepat *ip);
799 const char *ast_get_switch_registrar(struct ast_sw *sw);
800 /*! @} */
801
802 /* Walking functions ... */
803 struct ast_context *ast_walk_contexts(struct ast_context *con);
804 struct ast_exten *ast_walk_context_extensions(struct ast_context *con,
805         struct ast_exten *priority);
806 struct ast_exten *ast_walk_extension_priorities(struct ast_exten *exten,
807         struct ast_exten *priority);
808 struct ast_include *ast_walk_context_includes(struct ast_context *con,
809         struct ast_include *inc);
810 struct ast_ignorepat *ast_walk_context_ignorepats(struct ast_context *con,
811         struct ast_ignorepat *ip);
812 struct ast_sw *ast_walk_context_switches(struct ast_context *con, struct ast_sw *sw);
813
814 int pbx_builtin_serialize_variables(struct ast_channel *chan, struct ast_str **buf);
815 const char *pbx_builtin_getvar_helper(struct ast_channel *chan, const char *name);
816 void pbx_builtin_pushvar_helper(struct ast_channel *chan, const char *name, const char *value);
817 void pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value);
818 void pbx_retrieve_variable(struct ast_channel *c, const char *var, char **ret, char *workspace, int workspacelen, struct varshead *headp);
819 void pbx_builtin_clear_globals(void);
820 int pbx_builtin_setvar(struct ast_channel *chan, void *data);
821 void pbx_substitute_variables_helper(struct ast_channel *c,const char *cp1,char *cp2,int count);
822 void pbx_substitute_variables_varshead(struct varshead *headp, const char *cp1, char *cp2, int count);
823
824 int ast_extension_patmatch(const char *pattern, const char *data);
825
826 /*! Set "autofallthrough" flag, if newval is <0, does not acutally set.  If
827   set to 1, sets to auto fall through.  If newval set to 0, sets to no auto
828   fall through (reads extension instead).  Returns previous value. */
829 int pbx_set_autofallthrough(int newval);
830 int ast_goto_if_exists(struct ast_channel *chan, const char *context, const char *exten, int priority);
831 /* I can find neither parsable nor parseable at dictionary.com, but google gives me 169000 hits for parseable and only 49,800 for parsable */
832 int ast_parseable_goto(struct ast_channel *chan, const char *goto_string);
833 int ast_explicit_goto(struct ast_channel *chan, const char *context, const char *exten, int priority);
834 int ast_async_goto_if_exists(struct ast_channel *chan, const char *context, const char *exten, int priority);
835
836 struct ast_custom_function* ast_custom_function_find(const char *name);
837
838 /*!
839  * \brief Unregister a custom function
840  */
841 int ast_custom_function_unregister(struct ast_custom_function *acf);
842
843 /*!
844  * \brief Reigster a custom function
845  */
846 int ast_custom_function_register(struct ast_custom_function *acf);
847
848 /*! 
849  * \brief Retrieve the number of active calls
850  */
851 int ast_active_calls(void);
852         
853 /*!
854  * \brief executes a read operation on a function 
855  *
856  * \param chan Channel to execute on
857  * \param function Data containing the function call string (will be modified)
858  * \param workspace A pointer to safe memory to use for a return value 
859  * \param len the number of bytes in workspace
860  *
861  * This application executes a function in read mode on a given channel.
862  *
863  * \return zero on success, non-zero on failure
864  */
865 int ast_func_read(struct ast_channel *chan, const char *function, char *workspace, size_t len);
866
867 /*!
868  * \brief executes a write operation on a function
869  *
870  * \param chan Channel to execute on
871  * \param function Data containing the function call string (will be modified)
872  * \param value A value parameter to pass for writing
873  *
874  * This application executes a function in write mode on a given channel.
875  *
876  * \return zero on success, non-zero on failure
877  */
878 int ast_func_write(struct ast_channel *chan, const char *function, const char *value);
879
880 void ast_hint_state_changed(const char *device);
881
882 #if defined(__cplusplus) || defined(c_plusplus)
883 }
884 #endif
885
886 #endif /* _ASTERISK_PBX_H */