00001 /* 00002 * Asterisk -- An open source telephony toolkit. 00003 * 00004 * Copyright (C) 1999 - 2005, Digium, Inc. 00005 * 00006 * Mark Spencer <markster@digium.com> 00007 * See http://www.asterisk.org for more information about 00008 * the Asterisk project. Please do not directly contact 00009 * any of the maintainers of this project for assistance; 00010 * the project provides a web site, mailing lists and IRC 00011 * channels for your use. 00012 * 00013 * This program is free software, distributed under the terms of 00014 * the GNU General Public License Version 2. See the LICENSE file 00015 * at the top of the source tree. 00016 */ 00017 00018 /*! \file 00019 * \brief Application convenience functions, designed to give consistent 00020 * look and feel to Asterisk apps. 00021 */ 00022 00023 #ifndef _ASTERISK_APP_H 00024 #define _ASTERISK_APP_H 00025 00026 struct ast_flags64; 00027 00028 #if defined(__cplusplus) || defined(c_plusplus) 00029 extern "C" { 00030 #endif 00031 00032 /* IVR stuff */ 00033 00034 /*! \brief Callback function for IVR 00035 \return returns 0 on completion, -1 on hangup or digit if interrupted 00036 */ 00037 typedef int (*ast_ivr_callback)(struct ast_channel *chan, char *option, void *cbdata); 00038 00039 typedef enum { 00040 AST_ACTION_UPONE, /*!< adata is unused */ 00041 AST_ACTION_EXIT, /*!< adata is the return value for ast_ivr_menu_run if channel was not hungup */ 00042 AST_ACTION_CALLBACK, /*!< adata is an ast_ivr_callback */ 00043 AST_ACTION_PLAYBACK, /*!< adata is file to play */ 00044 AST_ACTION_BACKGROUND, /*!< adata is file to play */ 00045 AST_ACTION_PLAYLIST, /*!< adata is list of files, separated by ; to play */ 00046 AST_ACTION_MENU, /*!< adata is a pointer to an ast_ivr_menu */ 00047 AST_ACTION_REPEAT, /*!< adata is max # of repeats, cast to a pointer */ 00048 AST_ACTION_RESTART, /*!< adata is like repeat, but resets repeats to 0 */ 00049 AST_ACTION_TRANSFER, /*!< adata is a string with exten\verbatim[@context]\endverbatim */ 00050 AST_ACTION_WAITOPTION, /*!< adata is a timeout, or 0 for defaults */ 00051 AST_ACTION_NOOP, /*!< adata is unused */ 00052 AST_ACTION_BACKLIST, /*!< adata is list of files separated by ; allows interruption */ 00053 } ast_ivr_action; 00054 00055 /*! 00056 Special "options" are: 00057 \arg "s" - "start here (one time greeting)" 00058 \arg "g" - "greeting/instructions" 00059 \arg "t" - "timeout" 00060 \arg "h" - "hangup" 00061 \arg "i" - "invalid selection" 00062 00063 */ 00064 struct ast_ivr_option { 00065 char *option; 00066 ast_ivr_action action; 00067 void *adata; 00068 }; 00069 00070 struct ast_ivr_menu { 00071 char *title; /*!< Title of menu */ 00072 unsigned int flags; /*!< Flags */ 00073 struct ast_ivr_option *options; /*!< All options */ 00074 }; 00075 00076 #define AST_IVR_FLAG_AUTORESTART (1 << 0) 00077 00078 #define AST_IVR_DECLARE_MENU(holder, title, flags, foo...) \ 00079 static struct ast_ivr_option __options_##holder[] = foo;\ 00080 static struct ast_ivr_menu holder = { title, flags, __options_##holder } 00081 00082 00083 /*! \brief Runs an IVR menu 00084 \return returns 0 on successful completion, -1 on hangup, or -2 on user error in menu */ 00085 int ast_ivr_menu_run(struct ast_channel *c, struct ast_ivr_menu *menu, void *cbdata); 00086 00087 /*! \brief Plays a stream and gets DTMF data from a channel 00088 * \param c Which channel one is interacting with 00089 * \param prompt File to pass to ast_streamfile (the one that you wish to play). 00090 * It is also valid for this to be multiple files concatenated by "&". 00091 * For example, "file1&file2&file3". 00092 * \param s The location where the DTMF data will be stored 00093 * \param maxlen Max Length of the data 00094 * \param timeout Timeout length waiting for data(in milliseconds). Set to 0 for standard timeout(six seconds), or -1 for no time out. 00095 * 00096 * This function was designed for application programmers for situations where they need 00097 * to play a message and then get some DTMF data in response to the message. If a digit 00098 * is pressed during playback, it will immediately break out of the message and continue 00099 * execution of your code. 00100 */ 00101 int ast_app_getdata(struct ast_channel *c, const char *prompt, char *s, int maxlen, int timeout); 00102 00103 /*! \brief Full version with audiofd and controlfd. NOTE: returns '2' on ctrlfd available, not '1' like other full functions */ 00104 int ast_app_getdata_full(struct ast_channel *c, char *prompt, char *s, int maxlen, int timeout, int audiofd, int ctrlfd); 00105 00106 /*! 00107 * \brief Set voicemail function callbacks 00108 * \param[in] inboxcount2_func set function pointer 00109 * \param[in] sayname_func set function pointer 00110 * \param[in] inboxcount_func set function pointer 00111 * \param[in] messagecount_func set function pointer 00112 * \version 1.6.1 Added inboxcount2_func, sayname_func 00113 */ 00114 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder), 00115 int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs), 00116 int (*inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs), 00117 int (*messagecount_func)(const char *context, const char *mailbox, const char *folder), 00118 int (*sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context)); 00119 00120 void ast_uninstall_vm_functions(void); 00121 00122 /*! 00123 * \brief Determine if a given mailbox has any voicemail 00124 * If folder is NULL, defaults to "INBOX". If folder is "INBOX", includes the 00125 * number of messages in the "Urgent" folder. 00126 * \retval 1 Mailbox has voicemail 00127 * \retval 0 No new voicemail in specified mailbox 00128 * \retval -1 Failure 00129 * \since 1.0 00130 */ 00131 int ast_app_has_voicemail(const char *mailbox, const char *folder); 00132 00133 /*! 00134 * \brief Determine number of new/old messages in a mailbox 00135 * \since 1.0 00136 * \param[in] mailbox Mailbox specification in the format mbox[@context][&mbox2[@context2]][...] 00137 * \param[out] newmsgs Number of messages in the "INBOX" folder. Includes number of messages in the "Urgent" folder, if any. 00138 * \param[out] oldmsgs Number of messages in the "Old" folder. 00139 * \retval 0 Success 00140 * \retval -1 Failure 00141 */ 00142 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs); 00143 00144 /*! 00145 * \brief Determine number of urgent/new/old messages in a mailbox 00146 * \param[in] mailbox the mailbox context to use 00147 * \param[out] urgentmsgs the urgent message count 00148 * \param[out] newmsgs the new message count 00149 * \param[out] oldmsgs the old message count 00150 * \return Returns 0 for success, negative upon error 00151 * \since 1.6.1 00152 */ 00153 int ast_app_inboxcount2(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs); 00154 00155 /*! 00156 * \brief Given a mailbox and context, play that mailbox owner's name to the channel specified 00157 * \param[in] chan Channel on which to play the name 00158 * \param[in] mailbox Mailbox number from which to retrieve the recording 00159 * \param[in] context Mailbox context from which to locate the mailbox number 00160 * \retval 0 Name played without interruption 00161 * \retval dtmf ASCII value of the DTMF which interrupted playback. 00162 * \retval -1 Unable to locate mailbox or hangup occurred. 00163 * \since 1.6.1 00164 */ 00165 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context); 00166 00167 /*! 00168 * \brief Check number of messages in a given context, mailbox, and folder 00169 * \since 1.4 00170 * \param[in] context Mailbox context 00171 * \param[in] mailbox Mailbox number 00172 * \param[in] folder Mailbox folder 00173 * \return Number of messages in the given context, mailbox, and folder. If folder is NULL, folder "INBOX" is assumed. If folder is "INBOX", includes number of messages in the "Urgent" folder. 00174 */ 00175 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder); 00176 00177 /*! \brief Safely spawn an external program while closing file descriptors 00178 \note This replaces the \b system call in all Asterisk modules 00179 */ 00180 int ast_safe_system(const char *s); 00181 00182 /*! 00183 * \brief Replace the SIGCHLD handler 00184 * 00185 * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie 00186 * processes from forking elsewhere in Asterisk. However, if you want to 00187 * wait*() on the process to retrieve information about it's exit status, 00188 * then this signal handler needs to be temporarily replaced. 00189 * 00190 * Code that executes this function *must* call ast_unreplace_sigchld() 00191 * after it is finished doing the wait*(). 00192 */ 00193 void ast_replace_sigchld(void); 00194 00195 /*! 00196 * \brief Restore the SIGCHLD handler 00197 * 00198 * This function is called after a call to ast_replace_sigchld. It restores 00199 * the SIGCHLD handler that cleans up any zombie processes. 00200 */ 00201 void ast_unreplace_sigchld(void); 00202 00203 /*! 00204 \brief Send DTMF to a channel 00205 00206 \param chan The channel that will receive the DTMF frames 00207 \param peer (optional) Peer channel that will be autoserviced while the 00208 primary channel is receiving DTMF 00209 \param digits This is a string of characters representing the DTMF digits 00210 to be sent to the channel. Valid characters are 00211 "0123456789*#abcdABCD". Note: You can pass arguments 'f' or 00212 'F', if you want to Flash the channel (if supported by the 00213 channel), or 'w' to add a 500 millisecond pause to the DTMF 00214 sequence. 00215 \param between This is the number of milliseconds to wait in between each 00216 DTMF digit. If zero milliseconds is specified, then the 00217 default value of 100 will be used. 00218 \param duration This is the duration that each DTMF digit should have. 00219 */ 00220 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration); 00221 00222 /*! \brief Stream a filename (or file descriptor) as a generator. */ 00223 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride); 00224 00225 /*! 00226 * \brief Stream a file with fast forward, pause, reverse, restart. 00227 * \param chan 00228 * \param file filename 00229 * \param fwd, rev, stop, pause, restart, skipms, offsetms 00230 * 00231 * Before calling this function, set this to be the number 00232 * of ms to start from the beginning of the file. When the function 00233 * returns, it will be the number of ms from the beginning where the 00234 * playback stopped. Pass NULL if you don't care. 00235 */ 00236 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); 00237 00238 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */ 00239 int ast_play_and_wait(struct ast_channel *chan, const char *fn); 00240 00241 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); 00242 00243 /*! \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 00244 \n 00245 permitted silence time in milliseconds of 'maxsilence' under 'silencethreshold' or use '-1' for either or both parameters for defaults. 00246 calls ast_unlock_path() on 'path' if passed */ 00247 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); 00248 00249 /*! \brief Record a message and prepend the message to the given record file after 00250 playing the optional playfile (or a beep), storing the duration in 00251 'duration' and with a maximum permitted silence time in milliseconds of 'maxsilence' under 00252 'silencethreshold' or use '-1' for either or both parameters for defaults. */ 00253 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); 00254 00255 enum ast_getdata_result { 00256 AST_GETDATA_FAILED = -1, 00257 AST_GETDATA_COMPLETE = 0, 00258 AST_GETDATA_TIMEOUT = 1, 00259 AST_GETDATA_INTERRUPTED = 2, 00260 /*! indicates a user terminated empty string rather than an empty string resulting 00261 * from a timeout or other factors */ 00262 AST_GETDATA_EMPTY_END_TERMINATED = 3, 00263 }; 00264 00265 enum AST_LOCK_RESULT { 00266 AST_LOCK_SUCCESS = 0, 00267 AST_LOCK_TIMEOUT = -1, 00268 AST_LOCK_PATH_NOT_FOUND = -2, 00269 AST_LOCK_FAILURE = -3, 00270 }; 00271 00272 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */ 00273 enum AST_LOCK_TYPE { 00274 AST_LOCK_TYPE_LOCKFILE = 0, 00275 AST_LOCK_TYPE_FLOCK = 1, 00276 }; 00277 00278 /*! 00279 * \brief Set the type of locks used by ast_lock_path() 00280 * \param type the locking type to use 00281 */ 00282 void ast_set_lock_type(enum AST_LOCK_TYPE type); 00283 00284 /*! 00285 * \brief Lock a filesystem path. 00286 * \param path the path to be locked 00287 * \return one of \ref AST_LOCK_RESULT values 00288 */ 00289 enum AST_LOCK_RESULT ast_lock_path(const char *path); 00290 00291 /*! \brief Unlock a path */ 00292 int ast_unlock_path(const char *path); 00293 00294 /*! \brief Read a file into asterisk*/ 00295 char *ast_read_textfile(const char *file); 00296 00297 struct ast_group_info; 00298 00299 /*! \brief Split a group string into group and category, returning a default category if none is provided. */ 00300 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max); 00301 00302 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */ 00303 int ast_app_group_set_channel(struct ast_channel *chan, const char *data); 00304 00305 /*! \brief Get the current channel count of the specified group and category. */ 00306 int ast_app_group_get_count(const char *group, const char *category); 00307 00308 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */ 00309 int ast_app_group_match_get_count(const char *groupmatch, const char *category); 00310 00311 /*! \brief Discard all group counting for a channel */ 00312 int ast_app_group_discard(struct ast_channel *chan); 00313 00314 /*! \brief Update all group counting for a channel to a new one */ 00315 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan); 00316 00317 /*! \brief Write Lock the group count list */ 00318 int ast_app_group_list_wrlock(void); 00319 00320 /*! \brief Read Lock the group count list */ 00321 int ast_app_group_list_rdlock(void); 00322 00323 /*! \brief Get the head of the group count list */ 00324 struct ast_group_info *ast_app_group_list_head(void); 00325 00326 /*! \brief Unlock the group count list */ 00327 int ast_app_group_list_unlock(void); 00328 00329 /*! 00330 \brief Define an application argument 00331 \param name The name of the argument 00332 */ 00333 #define AST_APP_ARG(name) char *name 00334 00335 /*! 00336 \brief Declare a structure to hold an application's arguments. 00337 \param name The name of the structure 00338 \param arglist The list of arguments, defined using AST_APP_ARG 00339 00340 This macro declares a structure intended to be used in a call 00341 to ast_app_separate_args(). The structure includes all the 00342 arguments specified, plus an argv array that overlays them and an 00343 argc argument counter. The arguments must be declared using AST_APP_ARG, 00344 and they will all be character pointers (strings). 00345 00346 \note The structure is <b>not</b> initialized, as the call to 00347 ast_app_separate_args() will perform that function before parsing 00348 the arguments. 00349 */ 00350 #define AST_DECLARE_APP_ARGS(name, arglist) AST_DEFINE_APP_ARGS_TYPE(, arglist) name 00351 00352 /*! 00353 \brief Define a structure type to hold an application's arguments. 00354 \param type The name of the structure type 00355 \param arglist The list of arguments, defined using AST_APP_ARG 00356 00357 This macro defines a structure type intended to be used in a call 00358 to ast_app_separate_args(). The structure includes all the 00359 arguments specified, plus an argv array that overlays them and an 00360 argc argument counter. The arguments must be declared using AST_APP_ARG, 00361 and they will all be character pointers (strings). 00362 00363 \note This defines a structure type, but does not declare an instance 00364 of the structure. That must be done separately. 00365 */ 00366 #define AST_DEFINE_APP_ARGS_TYPE(type, arglist) \ 00367 struct type { \ 00368 unsigned int argc; \ 00369 char *argv[0]; \ 00370 arglist \ 00371 } 00372 00373 /*! 00374 \brief Performs the 'standard' argument separation process for an application. 00375 \param args An argument structure defined using AST_DECLARE_APP_ARGS 00376 \param parse A modifiable buffer containing the input to be parsed 00377 00378 This function will separate the input string using the standard argument 00379 separator character ',' and fill in the provided structure, including 00380 the argc argument counter field. 00381 */ 00382 #define AST_STANDARD_APP_ARGS(args, parse) \ 00383 args.argc = __ast_app_separate_args(parse, ',', 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0]))) 00384 #define AST_STANDARD_RAW_ARGS(args, parse) \ 00385 args.argc = __ast_app_separate_args(parse, ',', 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0]))) 00386 00387 /*! 00388 \brief Performs the 'nonstandard' argument separation process for an application. 00389 \param args An argument structure defined using AST_DECLARE_APP_ARGS 00390 \param parse A modifiable buffer containing the input to be parsed 00391 \param sep A nonstandard separator character 00392 00393 This function will separate the input string using the nonstandard argument 00394 separator character and fill in the provided structure, including 00395 the argc argument counter field. 00396 */ 00397 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \ 00398 args.argc = __ast_app_separate_args(parse, sep, 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0]))) 00399 #define AST_NONSTANDARD_RAW_ARGS(args, parse, sep) \ 00400 args.argc = __ast_app_separate_args(parse, sep, 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0]))) 00401 00402 /*! 00403 \brief Separate a string into arguments in an array 00404 \param buf The string to be parsed (this must be a writable copy, as it will be modified) 00405 \param delim The character to be used to delimit arguments 00406 \param remove_chars Remove backslashes and quote characters, while parsing 00407 \param array An array of 'char *' to be filled in with pointers to the found arguments 00408 \param arraylen The number of elements in the array (i.e. the number of arguments you will accept) 00409 00410 Note: if there are more arguments in the string than the array will hold, the last element of 00411 the array will contain the remaining arguments, not separated. 00412 00413 The array will be completely zeroed by this function before it populates any entries. 00414 00415 \return The number of arguments found, or zero if the function arguments are not valid. 00416 */ 00417 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen); 00418 #define ast_app_separate_args(a,b,c,d) __ast_app_separate_args(a,b,1,c,d) 00419 00420 /*! 00421 \brief A structure to hold the description of an application 'option'. 00422 00423 Application 'options' are single-character flags that can be supplied 00424 to the application to affect its behavior; they can also optionally 00425 accept arguments enclosed in parenthesis. 00426 00427 These structures are used by the ast_app_parse_options function, uses 00428 this data to fill in a flags structure (to indicate which options were 00429 supplied) and array of argument pointers (for those options that had 00430 arguments supplied). 00431 */ 00432 struct ast_app_option { 00433 /*! \brief The flag bit that represents this option. */ 00434 uint64_t flag; 00435 /*! \brief The index of the entry in the arguments array 00436 that should be used for this option's argument. */ 00437 unsigned int arg_index; 00438 }; 00439 00440 #define BEGIN_OPTIONS { 00441 #define END_OPTIONS } 00442 00443 /*! 00444 \brief Declares an array of options for an application. 00445 \param holder The name of the array to be created 00446 \param options The actual options to be placed into the array 00447 \sa ast_app_parse_options 00448 00449 This macro declares a 'static const' array of \c struct \c ast_option 00450 elements to hold the list of available options for an application. 00451 Each option must be declared using either the AST_APP_OPTION() 00452 or AST_APP_OPTION_ARG() macros. 00453 00454 Example usage: 00455 \code 00456 enum { 00457 OPT_JUMP = (1 << 0), 00458 OPT_BLAH = (1 << 1), 00459 OPT_BLORT = (1 << 2), 00460 } my_app_option_flags; 00461 00462 enum { 00463 OPT_ARG_BLAH = 0, 00464 OPT_ARG_BLORT, 00465 !! this entry tells how many possible arguments there are, 00466 and must be the last entry in the list 00467 OPT_ARG_ARRAY_SIZE, 00468 } my_app_option_args; 00469 00470 AST_APP_OPTIONS(my_app_options, { 00471 AST_APP_OPTION('j', OPT_JUMP), 00472 AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH), 00473 AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT), 00474 }); 00475 00476 static int my_app_exec(struct ast_channel *chan, void *data) 00477 { 00478 char *options; 00479 struct ast_flags opts = { 0, }; 00480 char *opt_args[OPT_ARG_ARRAY_SIZE]; 00481 00482 ... do any argument parsing here ... 00483 00484 if (ast_app_parse_options(my_app_options, &opts, opt_args, options)) { 00485 return -1; 00486 } 00487 } 00488 \endcode 00489 */ 00490 #define AST_APP_OPTIONS(holder, options...) \ 00491 static const struct ast_app_option holder[128] = options 00492 00493 /*! 00494 \brief Declares an application option that does not accept an argument. 00495 \param option The single character representing the option 00496 \param flagno The flag index to be set if this option is present 00497 \sa AST_APP_OPTIONS, ast_app_parse_options 00498 */ 00499 #define AST_APP_OPTION(option, flagno) \ 00500 [option] = { .flag = flagno } 00501 00502 /*! 00503 \brief Declares an application option that accepts an argument. 00504 \param option The single character representing the option 00505 \param flagno The flag index to be set if this option is present 00506 \param argno The index into the argument array where the argument should 00507 be placed 00508 \sa AST_APP_OPTIONS, ast_app_parse_options 00509 */ 00510 #define AST_APP_OPTION_ARG(option, flagno, argno) \ 00511 [option] = { .flag = flagno, .arg_index = argno + 1 } 00512 00513 /*! 00514 \brief Parses a string containing application options and sets flags/arguments. 00515 \param options The array of possible options declared with AST_APP_OPTIONS 00516 \param flags The flag structure to have option flags set 00517 \param args The array of argument pointers to hold arguments found 00518 \param optstr The string containing the options to be parsed 00519 \return zero for success, non-zero if an error occurs 00520 \sa AST_APP_OPTIONS 00521 */ 00522 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr); 00523 00524 /*! 00525 \brief Parses a string containing application options and sets flags/arguments. 00526 \param options The array of possible options declared with AST_APP_OPTIONS 00527 \param flags The 64-bit flag structure to have option flags set 00528 \param args The array of argument pointers to hold arguments found 00529 \param optstr The string containing the options to be parsed 00530 \return zero for success, non-zero if an error occurs 00531 \sa AST_APP_OPTIONS 00532 */ 00533 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr); 00534 00535 /*! \brief Given a list of options array, return an option string based on passed flags 00536 \param options The array of possible options declared with AST_APP_OPTIONS 00537 \param flags The flags of the options that you wish to populate the buffer with 00538 \param buf The buffer to fill with the string of options 00539 \param len The maximum length of buf 00540 */ 00541 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len); 00542 00543 /*! \brief Present a dialtone and collect a certain length extension. 00544 \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension. 00545 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */ 00546 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout); 00547 00548 /*! \brief Allow to record message and have a review option */ 00549 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path); 00550 00551 /*! \brief Decode an encoded control or extended ASCII character */ 00552 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed); 00553 00554 /*! \brief Decode a string which may contain multiple encoded control or extended ASCII characters */ 00555 int ast_get_encoded_str(const char *stream, char *result, size_t result_size); 00556 00557 /*! \brief Decode a stream of encoded control or extended ASCII characters */ 00558 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream); 00559 00560 /*! 00561 * \brief Common routine for child processes, to close all fds prior to exec(2) 00562 * \param[in] n starting file descriptor number for closing all higher file descriptors 00563 * \since 1.6.1 00564 */ 00565 void ast_close_fds_above_n(int n); 00566 00567 /*! 00568 * \brief Common routine to safely fork without a chance of a signal handler firing badly in the child 00569 * \param[in] stop_reaper flag to determine if sigchld handler is replaced or not 00570 * \since 1.6.1 00571 */ 00572 int ast_safe_fork(int stop_reaper); 00573 00574 /*! 00575 * \brief Common routine to cleanup after fork'ed process is complete (if reaping was stopped) 00576 * \since 1.6.1 00577 */ 00578 void ast_safe_fork_cleanup(void); 00579 00580 #if defined(__cplusplus) || defined(c_plusplus) 00581 } 00582 #endif 00583 00584 #endif /* _ASTERISK_APP_H */