Fri Jun 19 12:09:24 2009

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

Generated on Fri Jun 19 12:09:24 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7