Thu Apr 28 2011 17:15:13

Asterisk developer's documentation


app.h

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