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