Allow Gosub to recognize quote delimiters without consuming them.
[asterisk/asterisk.git] / include / asterisk / app.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2005, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  * See http://www.asterisk.org for more information about
8  * the Asterisk project. Please do not directly contact
9  * any of the maintainers of this project for assistance;
10  * the project provides a web site, mailing lists and IRC
11  * channels for your use.
12  *
13  * This program is free software, distributed under the terms of
14  * the GNU General Public License Version 2. See the LICENSE file
15  * at the top of the source tree.
16  */
17
18 /*! \file
19  * \brief Application convenience functions, designed to give consistent
20  *        look and feel to Asterisk apps.
21  */
22
23 #ifndef _ASTERISK_APP_H
24 #define _ASTERISK_APP_H
25
26 #include "asterisk/strings.h"
27 #include "asterisk/threadstorage.h"
28
29 struct ast_flags64;
30
31 #if defined(__cplusplus) || defined(c_plusplus)
32 extern "C" {
33 #endif
34
35 AST_THREADSTORAGE_EXTERNAL(ast_str_thread_global_buf);
36
37 /* IVR stuff */
38
39 /*! \brief Callback function for IVR
40     \return returns 0 on completion, -1 on hangup or digit if interrupted
41   */
42 typedef int (*ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata);
43
44 typedef enum {
45         AST_ACTION_UPONE,       /*!< adata is unused */
46         AST_ACTION_EXIT,        /*!< adata is the return value for ast_ivr_menu_run if channel was not hungup */
47         AST_ACTION_CALLBACK,    /*!< adata is an ast_ivr_callback */
48         AST_ACTION_PLAYBACK,    /*!< adata is file to play */
49         AST_ACTION_BACKGROUND,  /*!< adata is file to play */
50         AST_ACTION_PLAYLIST,    /*!< adata is list of files, separated by ; to play */
51         AST_ACTION_MENU,        /*!< adata is a pointer to an ast_ivr_menu */
52         AST_ACTION_REPEAT,      /*!< adata is max # of repeats, cast to a pointer */
53         AST_ACTION_RESTART,     /*!< adata is like repeat, but resets repeats to 0 */
54         AST_ACTION_TRANSFER,    /*!< adata is a string with exten\verbatim[@context]\endverbatim */
55         AST_ACTION_WAITOPTION,  /*!< adata is a timeout, or 0 for defaults */
56         AST_ACTION_NOOP,        /*!< adata is unused */
57         AST_ACTION_BACKLIST,    /*!< adata is list of files separated by ; allows interruption */
58 } ast_ivr_action;
59
60 /*!
61     Special "options" are:
62    \arg "s" - "start here (one time greeting)"
63    \arg "g" - "greeting/instructions"
64    \arg "t" - "timeout"
65    \arg "h" - "hangup"
66    \arg "i" - "invalid selection"
67
68 */
69 struct ast_ivr_option {
70         char *option;
71         ast_ivr_action action;
72         void *adata;
73 };
74
75 struct ast_ivr_menu {
76         char *title;            /*!< Title of menu */
77         unsigned int flags;     /*!< Flags */
78         struct ast_ivr_option *options; /*!< All options */
79 };
80
81 #define AST_IVR_FLAG_AUTORESTART (1 << 0)
82
83 #define AST_IVR_DECLARE_MENU(holder, title, flags, foo...) \
84         static struct ast_ivr_option __options_##holder[] = foo;\
85         static struct ast_ivr_menu holder = { title, flags, __options_##holder }
86
87
88 /*!     \brief Runs an IVR menu
89         \return returns 0 on successful completion, -1 on hangup, or -2 on user error in menu */
90 int ast_ivr_menu_run(struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata);
91
92 /*! \brief Plays a stream and gets DTMF data from a channel
93  * \param c Which channel one is interacting with
94  * \param prompt File to pass to ast_streamfile (the one that you wish to play).
95  *        It is also valid for this to be multiple files concatenated by "&".
96  *        For example, "file1&file2&file3".
97  * \param s The location where the DTMF data will be stored
98  * \param maxlen Max Length of the data
99  * \param timeout Timeout length waiting for data(in milliseconds).  Set to 0 for standard timeout(six seconds), or -1 for no time out.
100  *
101  *  This function was designed for application programmers for situations where they need
102  *  to play a message and then get some DTMF data in response to the message.  If a digit
103  *  is pressed during playback, it will immediately break out of the message and continue
104  *  execution of your code.
105  */
106 int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout);
107
108 /*! \brief Full version with audiofd and controlfd.  NOTE: returns '2' on ctrlfd available, not '1' like other full functions */
109 int ast_app_getdata_full(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd);
110
111 /*!
112  * \since 1.6.3
113  * \brief Run a macro on a channel, placing a second channel into autoservice.
114  *
115  * This is a shorthand method that makes it very easy to run a macro on any given 
116  * channel. It is perfectly reasonable to supply a NULL autoservice_chan here in case
117  * there is no channel to place into autoservice. It is very important that the 
118  * autoservice_chan parameter is not locked prior to calling ast_app_run_macro. A 
119  * deadlock could result, otherwise.
120  *
121  * \param autoservice_chan A channel to place into autoservice while the macro is run
122  * \param macro_chan The channel to run the macro on
123  * \param macro_name The name of the macro to run
124  * \param macro_args The arguments to pass to the macro
125  * \retval 0 success
126  * \retval -1 failure
127  */
128 int ast_app_run_macro(struct ast_channel *autoservice_chan, struct ast_channel 
129                 *macro_chan, const char * const macro_name, const char * const macro_args);
130
131 /*!
132  * \brief Set voicemail function callbacks
133  * \param[in] inboxcount2_func set function pointer
134  * \param[in] sayname_func set function pointer
135  * \param[in] inboxcount_func set function pointer
136  * \param[in] messagecount_func set function pointer
137  * \version 1.6.1 Added inboxcount2_func, sayname_func
138  */
139 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
140                               int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs),
141                               int (*inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs),
142                               int (*messagecount_func)(const char *context, const char *mailbox, const char *folder),
143                               int (*sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context));
144
145 void ast_uninstall_vm_functions(void);
146
147 /*! \brief Determine if a given mailbox has any voicemail */
148 int ast_app_has_voicemail(const char *mailbox, const char *folder);
149
150 /*! \brief Determine number of new/old messages in a mailbox */
151 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs);
152
153 /*!
154  * \brief Determine number of urgent/new/old messages in a mailbox
155  * \param[in] mailbox the mailbox context to use
156  * \param[out] urgentmsgs the urgent message count
157  * \param[out] newmsgs the new message count
158  * \param[out] oldmsgs the old message count
159  * \return Returns 0 for success, negative upon error
160  * \since 1.6.1
161  */
162 int ast_app_inboxcount2(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs);
163
164 /*!
165  * \brief Given a mailbox and context, play that mailbox owner's name to the channel specified
166  * \param[in] chan channel to announce name to
167  * \param[in] mailbox mailbox to retrieve name for
168  * \param[in] context context to retrieve name for
169  * \return Returns 0 for success, negative upon error
170  * \since 1.6.1
171  */
172 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context);
173
174 /*! \brief Determine number of messages in a given mailbox and folder */
175 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder);
176
177 /*! \brief Safely spawn an external program while closing file descriptors
178         \note This replaces the \b system call in all Asterisk modules
179 */
180 int ast_safe_system(const char *s);
181
182 /*!
183  * \brief Replace the SIGCHLD handler
184  *
185  * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie
186  * processes from forking elsewhere in Asterisk.  However, if you want to
187  * wait*() on the process to retrieve information about it's exit status,
188  * then this signal handler needs to be temporarily replaced.
189  *
190  * Code that executes this function *must* call ast_unreplace_sigchld()
191  * after it is finished doing the wait*().
192  */
193 void ast_replace_sigchld(void);
194
195 /*!
196  * \brief Restore the SIGCHLD handler
197  *
198  * This function is called after a call to ast_replace_sigchld.  It restores
199  * the SIGCHLD handler that cleans up any zombie processes.
200  */
201 void ast_unreplace_sigchld(void);
202
203 /*!
204   \brief Send DTMF to a channel
205
206   \param chan    The channel that will receive the DTMF frames
207   \param peer    (optional) Peer channel that will be autoserviced while the
208                  primary channel is receiving DTMF
209   \param digits  This is a string of characters representing the DTMF digits
210                  to be sent to the channel.  Valid characters are
211                  "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
212                  'F', if you want to Flash the channel (if supported by the
213                  channel), or 'w' to add a 500 millisecond pause to the DTMF
214                  sequence.
215   \param between This is the number of milliseconds to wait in between each
216                  DTMF digit.  If zero milliseconds is specified, then the
217                  default value of 100 will be used.
218   \param duration This is the duration that each DTMF digit should have.
219 */
220 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration);
221
222 /*! \brief Stream a filename (or file descriptor) as a generator. */
223 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
224
225 /*!
226  * \brief Stream a file with fast forward, pause, reverse, restart.
227  * \param chan
228  * \param file filename
229  * \param fwd, rev, stop, pause, restart, skipms, offsetms
230  *
231  * Before calling this function, set this to be the number
232  * of ms to start from the beginning of the file.  When the function
233  * returns, it will be the number of ms from the beginning where the
234  * playback stopped.  Pass NULL if you don't care.
235  */
236 int ast_control_streamfile(struct ast_channel *chan, const char *file, const char *fwd, const char *rev, const char *stop, const char *pause, const char *restart, int skipms, long *offsetms);
237
238 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */
239 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
240
241 int ast_play_and_record_full(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int silencethreshold, int maxsilence_ms, const char *path, const char *acceptdtmf, const char *canceldtmf);
242
243 /*! \brief Record a file for a max amount of time (in seconds), in a given list of formats separated by '|', outputting the duration of the recording, and with a maximum
244  \n
245  permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults.
246      calls ast_unlock_path() on 'path' if passed */
247 int ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int silencethreshold, int maxsilence_ms, const char *path);
248
249 /*! \brief Record a message and prepend the message to the given record file after
250     playing the optional playfile (or a beep), storing the duration in
251     'duration' and with a maximum permitted silence time in milliseconds of 'maxsilence' under
252     'silencethreshold' or use '-1' for either or both parameters for defaults. */
253 int ast_play_and_prepend(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime_sec, char *fmt, int *duration, int beep, int silencethreshold, int maxsilence_ms);
254
255 enum ast_getdata_result {
256         AST_GETDATA_FAILED = -1,
257         AST_GETDATA_COMPLETE = 0,
258         AST_GETDATA_TIMEOUT = 1,
259         AST_GETDATA_INTERRUPTED = 2,
260         /*! indicates a user terminated empty string rather than an empty string resulting 
261          * from a timeout or other factors */
262         AST_GETDATA_EMPTY_END_TERMINATED = 3,
263 };
264
265 enum AST_LOCK_RESULT {
266         AST_LOCK_SUCCESS = 0,
267         AST_LOCK_TIMEOUT = -1,
268         AST_LOCK_PATH_NOT_FOUND = -2,
269         AST_LOCK_FAILURE = -3,
270 };
271
272 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */
273 enum AST_LOCK_TYPE {
274         AST_LOCK_TYPE_LOCKFILE = 0,
275         AST_LOCK_TYPE_FLOCK = 1,
276 };
277
278 /*!
279  * \brief Set the type of locks used by ast_lock_path()
280  * \param type the locking type to use
281  */
282 void ast_set_lock_type(enum AST_LOCK_TYPE type);
283
284 /*!
285  * \brief Lock a filesystem path.
286  * \param path the path to be locked
287  * \return one of \ref AST_LOCK_RESULT values
288  */
289 enum AST_LOCK_RESULT ast_lock_path(const char *path);
290
291 /*! \brief Unlock a path */
292 int ast_unlock_path(const char *path);
293
294 /*! \brief Read a file into asterisk*/
295 char *ast_read_textfile(const char *file);
296
297 struct ast_group_info;
298
299 /*! \brief Split a group string into group and category, returning a default category if none is provided. */
300 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
301
302 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */
303 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
304
305 /*! \brief Get the current channel count of the specified group and category. */
306 int ast_app_group_get_count(const char *group, const char *category);
307
308 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */
309 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
310
311 /*! \brief Discard all group counting for a channel */
312 int ast_app_group_discard(struct ast_channel *chan);
313
314 /*! \brief Update all group counting for a channel to a new one */
315 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan);
316
317 /*! \brief Write Lock the group count list */
318 int ast_app_group_list_wrlock(void);
319
320 /*! \brief Read Lock the group count list */
321 int ast_app_group_list_rdlock(void);
322
323 /*! \brief Get the head of the group count list */
324 struct ast_group_info *ast_app_group_list_head(void);
325
326 /*! \brief Unlock the group count list */
327 int ast_app_group_list_unlock(void);
328
329 /*!
330   \brief Define an application argument
331   \param name The name of the argument
332 */
333 #define AST_APP_ARG(name) char *name
334
335 /*!
336   \brief Declare a structure to hold an application's arguments.
337   \param name The name of the structure
338   \param arglist The list of arguments, defined using AST_APP_ARG
339
340   This macro declares a structure intended to be used in a call
341   to ast_app_separate_args(). The structure includes all the
342   arguments specified, plus an argv array that overlays them and an
343   argc argument counter. The arguments must be declared using AST_APP_ARG,
344   and they will all be character pointers (strings).
345
346   \note The structure is <b>not</b> initialized, as the call to
347   ast_app_separate_args() will perform that function before parsing
348   the arguments.
349  */
350 #define AST_DECLARE_APP_ARGS(name, arglist) AST_DEFINE_APP_ARGS_TYPE(, arglist) name
351
352 /*!
353   \brief Define a structure type to hold an application's arguments.
354   \param type The name of the structure type
355   \param arglist The list of arguments, defined using AST_APP_ARG
356
357   This macro defines a structure type intended to be used in a call
358   to ast_app_separate_args(). The structure includes all the
359   arguments specified, plus an argv array that overlays them and an
360   argc argument counter. The arguments must be declared using AST_APP_ARG,
361   and they will all be character pointers (strings).
362
363   \note This defines a structure type, but does not declare an instance
364   of the structure. That must be done separately.
365  */
366 #define AST_DEFINE_APP_ARGS_TYPE(type, arglist) \
367         struct type { \
368                 unsigned int argc; \
369                 char *argv[0]; \
370                 arglist \
371         }
372
373 /*!
374   \brief Performs the 'standard' argument separation process for an application.
375   \param args An argument structure defined using AST_DECLARE_APP_ARGS
376   \param parse A modifiable buffer containing the input to be parsed
377
378   This function will separate the input string using the standard argument
379   separator character ',' and fill in the provided structure, including
380   the argc argument counter field.
381  */
382 #define AST_STANDARD_APP_ARGS(args, parse) \
383         args.argc = __ast_app_separate_args(parse, ',', 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
384 #define AST_STANDARD_RAW_ARGS(args, parse) \
385         args.argc = __ast_app_separate_args(parse, ',', 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
386
387 /*!
388   \brief Performs the 'nonstandard' argument separation process for an application.
389   \param args An argument structure defined using AST_DECLARE_APP_ARGS
390   \param parse A modifiable buffer containing the input to be parsed
391   \param sep A nonstandard separator character
392
393   This function will separate the input string using the nonstandard argument
394   separator character and fill in the provided structure, including
395   the argc argument counter field.
396  */
397 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
398         args.argc = __ast_app_separate_args(parse, sep, 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
399 #define AST_NONSTANDARD_RAW_ARGS(args, parse, sep) \
400         args.argc = __ast_app_separate_args(parse, sep, 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
401
402 /*!
403   \brief Separate a string into arguments in an array
404   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
405   \param delim The character to be used to delimit arguments
406   \param remove_chars Remove backslashes and quote characters, while parsing
407   \param array An array of 'char *' to be filled in with pointers to the found arguments
408   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
409
410   Note: if there are more arguments in the string than the array will hold, the last element of
411   the array will contain the remaining arguments, not separated.
412
413   The array will be completely zeroed by this function before it populates any entries.
414
415   \return The number of arguments found, or zero if the function arguments are not valid.
416 */
417 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen);
418 #define ast_app_separate_args(a,b,c,d)  __ast_app_separate_args(a,b,1,c,d)
419
420 /*!
421   \brief A structure to hold the description of an application 'option'.
422
423   Application 'options' are single-character flags that can be supplied
424   to the application to affect its behavior; they can also optionally
425   accept arguments enclosed in parenthesis.
426
427   These structures are used by the ast_app_parse_options function, uses
428   this data to fill in a flags structure (to indicate which options were
429   supplied) and array of argument pointers (for those options that had
430   arguments supplied).
431  */
432 struct ast_app_option {
433         /*! \brief The flag bit that represents this option. */
434         uint64_t flag;
435         /*! \brief The index of the entry in the arguments array
436           that should be used for this option's argument. */
437         unsigned int arg_index;
438 };
439
440 #define BEGIN_OPTIONS {
441 #define END_OPTIONS }
442
443 /*!
444   \brief Declares an array of options for an application.
445   \param holder The name of the array to be created
446   \param options The actual options to be placed into the array
447   \sa ast_app_parse_options
448
449   This macro declares a 'static const' array of \c struct \c ast_option
450   elements to hold the list of available options for an application.
451   Each option must be declared using either the AST_APP_OPTION()
452   or AST_APP_OPTION_ARG() macros.
453
454   Example usage:
455   \code
456   enum my_app_option_flags {
457         OPT_JUMP = (1 << 0),
458         OPT_BLAH = (1 << 1),
459         OPT_BLORT = (1 << 2),
460   };
461
462   enum my_app_option_args {
463         OPT_ARG_BLAH = 0,
464         OPT_ARG_BLORT,
465         !! this entry tells how many possible arguments there are,
466            and must be the last entry in the list
467         OPT_ARG_ARRAY_SIZE,
468   };
469
470   AST_APP_OPTIONS(my_app_options, {
471         AST_APP_OPTION('j', OPT_JUMP),
472         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
473         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
474   });
475
476   static int my_app_exec(struct ast_channel *chan, void *data)
477   {
478         char *options;
479         struct ast_flags opts = { 0, };
480         char *opt_args[OPT_ARG_ARRAY_SIZE];
481
482         ... do any argument parsing here ...
483
484         if (ast_parseoptions(my_app_options, &opts, opt_args, options)) {
485                 ast_module_user_remove(u);
486                 return -1;
487         }
488   }
489   \endcode
490  */
491 #define AST_APP_OPTIONS(holder, options...) \
492         static const struct ast_app_option holder[128] = options
493
494 /*!
495   \brief Declares an application option that does not accept an argument.
496   \param option The single character representing the option
497   \param flagno The flag index to be set if this option is present
498   \sa AST_APP_OPTIONS, ast_app_parse_options
499  */
500 #define AST_APP_OPTION(option, flagno) \
501         [option] = { .flag = flagno }
502
503 /*!
504   \brief Declares an application option that accepts an argument.
505   \param option The single character representing the option
506   \param flagno The flag index to be set if this option is present
507   \param argno The index into the argument array where the argument should
508   be placed
509   \sa AST_APP_OPTIONS, ast_app_parse_options
510  */
511 #define AST_APP_OPTION_ARG(option, flagno, argno) \
512         [option] = { .flag = flagno, .arg_index = argno + 1 }
513
514 /*!
515   \brief Parses a string containing application options and sets flags/arguments.
516   \param options The array of possible options declared with AST_APP_OPTIONS
517   \param flags The flag structure to have option flags set
518   \param args The array of argument pointers to hold arguments found
519   \param optstr The string containing the options to be parsed
520   \return zero for success, non-zero if an error occurs
521   \sa AST_APP_OPTIONS
522  */
523 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
524
525         /*!
526   \brief Parses a string containing application options and sets flags/arguments.
527   \param options The array of possible options declared with AST_APP_OPTIONS
528   \param flags The 64-bit flag structure to have option flags set
529   \param args The array of argument pointers to hold arguments found
530   \param optstr The string containing the options to be parsed
531   \return zero for success, non-zero if an error occurs
532   \sa AST_APP_OPTIONS
533  */
534 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr);
535
536 /*! \brief Given a list of options array, return an option string based on passed flags
537         \param options The array of possible options declared with AST_APP_OPTIONS
538         \param flags The flags of the options that you wish to populate the buffer with
539         \param buf The buffer to fill with the string of options
540         \param len The maximum length of buf
541 */
542 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len);
543
544 /*! \brief Present a dialtone and collect a certain length extension.
545     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension.
546 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
547 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
548
549 /*! \brief Allow to record message and have a review option */
550 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
551
552 /*! \brief Decode an encoded control or extended ASCII character 
553     \return Returns a pointer to the result string
554 */
555 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed);
556
557 /*! \brief Decode a stream of encoded control or extended ASCII characters */
558 char *ast_get_encoded_str(const char *stream, char *result, size_t result_len);
559
560 /*! \brief Decode a stream of encoded control or extended ASCII characters */
561 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream);
562
563 /*!
564  * \brief Common routine for child processes, to close all fds prior to exec(2)
565  * \param[in] n starting file descriptor number for closing all higher file descriptors
566  * \since 1.6.1
567  */
568 void ast_close_fds_above_n(int n);
569
570 /*!
571  * \brief Common routine to safely fork without a chance of a signal handler firing badly in the child
572  * \param[in] stop_reaper flag to determine if sigchld handler is replaced or not
573  * \since 1.6.1
574  */
575 int ast_safe_fork(int stop_reaper);
576
577 /*!
578  * \brief Common routine to cleanup after fork'ed process is complete (if reaping was stopped)
579  * \since 1.6.1
580  */
581 void ast_safe_fork_cleanup(void);
582
583 #if defined(__cplusplus) || defined(c_plusplus)
584 }
585 #endif
586
587 #endif /* _ASTERISK_APP_H */