Wed Aug 7 17:15:33 2019

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 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  * \brief Run a macro on a channel, placing an optional second channel into autoservice.
00119  * \since 1.8.30.0
00120  * \since 11.0
00121  *
00122  * \details
00123  * This is a shorthand method that makes it very easy to run a
00124  * macro on any given channel.  It is perfectly reasonable to
00125  * supply a NULL autoservice_chan here in case there is no
00126  * channel to place into autoservice.
00127  *
00128  * \note Absolutely _NO_ channel locks should be held before calling this function.
00129  *
00130  * \param autoservice_chan A channel to place into autoservice while the macro is run
00131  * \param macro_chan Channel to execute macro on.
00132  * \param macro_args Macro application argument string.
00133  *
00134  * \retval 0 success
00135  * \retval -1 on error
00136  */
00137 int ast_app_exec_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const char *macro_args);
00138 
00139 /*!
00140  * \since 1.8
00141  * \brief Run a macro on a channel, placing an optional second channel into autoservice.
00142  *
00143  * \details
00144  * This is a shorthand method that makes it very easy to run a
00145  * macro on any given channel.  It is perfectly reasonable to
00146  * supply a NULL autoservice_chan here in case there is no
00147  * channel to place into autoservice.
00148  *
00149  * \note Absolutely _NO_ channel locks should be held before calling this function.
00150  *
00151  * \param autoservice_chan A channel to place into autoservice while the macro is run
00152  * \param macro_chan Channel to execute macro on.
00153  * \param macro_name The name of the macro to run.
00154  * \param macro_args The arguments to pass to the macro.
00155  *
00156  * \retval 0 success
00157  * \retval -1 on error
00158  */
00159 int ast_app_run_macro(struct ast_channel *autoservice_chan,
00160    struct ast_channel *macro_chan, const char *macro_name, const char *macro_args);
00161 
00162 /*!
00163  * \brief Stack applications callback functions.
00164  */
00165 struct ast_app_stack_funcs {
00166    /*!
00167     * Module reference pointer so the module will stick around
00168     * while a callback is active.
00169     */
00170    void *module;
00171 
00172    /*!
00173     * \brief Callback for the routine to run a subroutine on a channel.
00174     *
00175     * \note Absolutely _NO_ channel locks should be held before calling this function.
00176     *
00177     * \param chan Channel to execute subroutine on.
00178     * \param args Gosub application argument string.
00179     * \param ignore_hangup TRUE if a hangup does not stop execution of the routine.
00180     *
00181     * \retval 0 success
00182     * \retval -1 on error
00183     */
00184    int (*run_sub)(struct ast_channel *chan, const char *args, int ignore_hangup);
00185 
00186    /*!
00187     * \brief Add missing context/exten to Gosub application argument string.
00188     *
00189     * \param chan Channel to obtain context/exten.
00190     * \param args Gosub application argument string.
00191     *
00192     * \details
00193     * Fills in the optional context and exten from the given channel.
00194     *
00195     * \retval New-args Gosub argument string on success.  Must be freed.
00196     * \retval NULL on error.
00197     */
00198    const char *(*expand_sub_args)(struct ast_channel *chan, const char *args);
00199 
00200    /* Add new API calls to the end here. */
00201 };
00202 
00203 /*!
00204  * \since 1.8.30.0
00205  * \since 11
00206  * \brief Set stack application function callbacks
00207  * \param funcs Stack applications callback functions.
00208  */
00209 void ast_install_stack_functions(const struct ast_app_stack_funcs *funcs);
00210 
00211 /*!
00212  * \brief Add missing context/exten to subroutine argument string.
00213  * \since 1.8.30.0
00214  *
00215  * \param chan Channel to obtain context/exten.
00216  * \param args Gosub application argument string.
00217  *
00218  * \details
00219  * Fills in the optional context and exten from the given channel.
00220  *
00221  * \retval New-args Gosub argument string on success.  Must be freed.
00222  * \retval NULL on error.
00223  */
00224 const char *ast_app_expand_sub_args(struct ast_channel *chan, const char *args);
00225 
00226 /*!
00227  * \since 1.8.30.0
00228  * \since 11
00229  * \brief Run a subroutine on a channel, placing an optional second channel into autoservice.
00230  *
00231  * \details
00232  * This is a shorthand method that makes it very easy to run a
00233  * subroutine on any given channel.  It is perfectly reasonable
00234  * to supply a NULL autoservice_chan here in case there is no
00235  * channel to place into autoservice.
00236  *
00237  * \note Absolutely _NO_ channel locks should be held before calling this function.
00238  *
00239  * \param autoservice_chan A channel to place into autoservice while the subroutine is run
00240  * \param sub_chan Channel to execute subroutine on.
00241  * \param sub_args Gosub application argument string.
00242  * \param ignore_hangup TRUE if a hangup does not stop execution of the routine.
00243  *
00244  * \retval 0 success
00245  * \retval -1 on error
00246  */
00247 int ast_app_exec_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const char *sub_args, int ignore_hangup);
00248 
00249 /*!
00250  * \since 1.8.30.0
00251  * \since 11
00252  * \brief Run a subroutine on a channel, placing an optional second channel into autoservice.
00253  *
00254  * \details
00255  * This is a shorthand method that makes it very easy to run a
00256  * subroutine on any given channel.  It is perfectly reasonable
00257  * to supply a NULL autoservice_chan here in case there is no
00258  * channel to place into autoservice.
00259  *
00260  * \note Absolutely _NO_ channel locks should be held before calling this function.
00261  *
00262  * \param autoservice_chan A channel to place into autoservice while the subroutine is run
00263  * \param sub_chan Channel to execute subroutine on.
00264  * \param sub_location The location of the subroutine to run.
00265  * \param sub_args The arguments to pass to the subroutine.
00266  * \param ignore_hangup TRUE if a hangup does not stop execution of the routine.
00267  *
00268  * \retval 0 success
00269  * \retval -1 on error
00270  */
00271 int ast_app_run_sub(struct ast_channel *autoservice_chan,
00272    struct ast_channel *sub_chan, const char *sub_location, const char *sub_args, int ignore_hangup);
00273 
00274 /*!
00275  * \brief Set voicemail function callbacks
00276  * \param[in] has_voicemail_func set function pointer
00277  * \param[in] inboxcount2_func set function pointer
00278  * \param[in] sayname_func set function pointer
00279  * \param[in] inboxcount_func set function pointer
00280  * \param[in] messagecount_func set function pointer
00281  * \version 1.6.1 Added inboxcount2_func, sayname_func
00282  */
00283 void ast_install_vm_functions(int (*has_voicemail_func)(const char *mailbox, const char *folder),
00284                int (*inboxcount_func)(const char *mailbox, int *newmsgs, int *oldmsgs),
00285                int (*inboxcount2_func)(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs),
00286                int (*messagecount_func)(const char *context, const char *mailbox, const char *folder),
00287                int (*sayname_func)(struct ast_channel *chan, const char *mailbox, const char *context));
00288 
00289 void ast_uninstall_vm_functions(void);
00290 
00291 /*!
00292  * \brief Determine if a given mailbox has any voicemail
00293  * If folder is NULL, defaults to "INBOX".  If folder is "INBOX", includes the
00294  * number of messages in the "Urgent" folder.
00295  * \retval 1 Mailbox has voicemail
00296  * \retval 0 No new voicemail in specified mailbox
00297  * \retval -1 Failure
00298  * \since 1.0
00299  */
00300 int ast_app_has_voicemail(const char *mailbox, const char *folder);
00301 
00302 /*!
00303  * \brief Determine number of new/old messages in a mailbox
00304  * \since 1.0
00305  * \param[in] mailbox Mailbox specification in the format mbox[@context][&mbox2[@context2]][...]
00306  * \param[out] newmsgs Number of messages in the "INBOX" folder.  Includes number of messages in the "Urgent" folder, if any.
00307  * \param[out] oldmsgs Number of messages in the "Old" folder.
00308  * \retval 0 Success
00309  * \retval -1 Failure
00310  */
00311 int ast_app_inboxcount(const char *mailbox, int *newmsgs, int *oldmsgs);
00312 
00313 /*!
00314  * \brief Determine number of urgent/new/old messages in a mailbox
00315  * \param[in] mailbox the mailbox context to use
00316  * \param[out] urgentmsgs the urgent message count
00317  * \param[out] newmsgs the new message count
00318  * \param[out] oldmsgs the old message count
00319  * \return Returns 0 for success, negative upon error
00320  * \since 1.6.1
00321  */
00322 int ast_app_inboxcount2(const char *mailbox, int *urgentmsgs, int *newmsgs, int *oldmsgs);
00323 
00324 /*!
00325  * \brief Given a mailbox and context, play that mailbox owner's name to the channel specified
00326  * \param[in] chan Channel on which to play the name
00327  * \param[in] mailbox Mailbox number from which to retrieve the recording
00328  * \param[in] context Mailbox context from which to locate the mailbox number
00329  * \retval 0 Name played without interruption
00330  * \retval dtmf ASCII value of the DTMF which interrupted playback.
00331  * \retval -1 Unable to locate mailbox or hangup occurred.
00332  * \since 1.6.1
00333  */
00334 int ast_app_sayname(struct ast_channel *chan, const char *mailbox, const char *context);
00335 
00336 /*!
00337  * \brief Check number of messages in a given context, mailbox, and folder
00338  * \since 1.4
00339  * \param[in] context Mailbox context
00340  * \param[in] mailbox Mailbox number
00341  * \param[in] folder Mailbox folder
00342  * \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.
00343  */
00344 int ast_app_messagecount(const char *context, const char *mailbox, const char *folder);
00345 
00346 /*! \brief Safely spawn an external program while closing file descriptors
00347    \note This replaces the \b system call in all Asterisk modules
00348 */
00349 int ast_safe_system(const char *s);
00350 
00351 /*!
00352  * \brief Replace the SIGCHLD handler
00353  *
00354  * Normally, Asterisk has a SIGCHLD handler that is cleaning up all zombie
00355  * processes from forking elsewhere in Asterisk.  However, if you want to
00356  * wait*() on the process to retrieve information about it's exit status,
00357  * then this signal handler needs to be temporarily replaced.
00358  *
00359  * Code that executes this function *must* call ast_unreplace_sigchld()
00360  * after it is finished doing the wait*().
00361  */
00362 void ast_replace_sigchld(void);
00363 
00364 /*!
00365  * \brief Restore the SIGCHLD handler
00366  *
00367  * This function is called after a call to ast_replace_sigchld.  It restores
00368  * the SIGCHLD handler that cleans up any zombie processes.
00369  */
00370 void ast_unreplace_sigchld(void);
00371 
00372 /*!
00373   \brief Send DTMF to a channel
00374 
00375   \param chan    The channel that will receive the DTMF frames
00376   \param peer    (optional) Peer channel that will be autoserviced while the
00377                  primary channel is receiving DTMF
00378   \param digits  This is a string of characters representing the DTMF digits
00379                  to be sent to the channel.  Valid characters are
00380                  "0123456789*#abcdABCD".  Note: You can pass arguments 'f' or
00381                  'F', if you want to Flash the channel (if supported by the
00382                  channel), or 'w' to add a 500 millisecond pause to the DTMF
00383                  sequence.
00384   \param between This is the number of milliseconds to wait in between each
00385                  DTMF digit.  If zero milliseconds is specified, then the
00386                  default value of 100 will be used.
00387   \param duration This is the duration that each DTMF digit should have.
00388 */
00389 int ast_dtmf_stream(struct ast_channel *chan, struct ast_channel *peer, const char *digits, int between, unsigned int duration);
00390 
00391 /*! \brief Stream a filename (or file descriptor) as a generator. */
00392 int ast_linear_stream(struct ast_channel *chan, const char *filename, int fd, int allowoverride);
00393 
00394 /*!
00395  * \brief Stream a file with fast forward, pause, reverse, restart.
00396  * \param chan
00397  * \param file filename
00398  * \param fwd, rev, stop, pause, restart, skipms, offsetms
00399  *
00400  * Before calling this function, set this to be the number
00401  * of ms to start from the beginning of the file.  When the function
00402  * returns, it will be the number of ms from the beginning where the
00403  * playback stopped.  Pass NULL if you don't care.
00404  */
00405 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);
00406 
00407 /*! \brief Play a stream and wait for a digit, returning the digit that was pressed */
00408 int ast_play_and_wait(struct ast_channel *chan, const char *fn);
00409 
00410 /*!
00411  * \brief Record a file based on input from a channel
00412  *        This function will play "auth-thankyou" upon successful recording.
00413  *
00414  * \param chan the channel being recorded
00415  * \param playfile Filename of sound to play before recording begins
00416  * \param recordfile Filename to save the recording
00417  * \param maxtime_sec Longest possible message length in seconds
00418  * \param fmt string containing all formats to be recorded delimited by '|'
00419  * \param duration pointer to integer for storing length of the recording
00420  * \param sound_duration pointer to integer for storing length of the recording minus all silence
00421  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
00422  * \param maxsilence_ms Length of time in milliseconds which will trigger a timeout from silence, -1 for default
00423  * \param path Optional filesystem path to unlock
00424  * \param acceptdtmf Character of DTMF to end and accept the recording
00425  * \param canceldtmf Character of DTMF to end and cancel the recording
00426  *
00427  * \retval -1 failure or hangup
00428  * \retval 'S' Recording ended from silence timeout
00429  * \retval 't' Recording ended from the message exceeding the maximum duration
00430  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
00431  */
00432 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 *sound_duration, int silencethreshold, int maxsilence_ms, const char *path, const char *acceptdtmf, const char *canceldtmf);
00433 
00434 /*!
00435  * \brief Record a file based on input from a channel. Use default accept and cancel DTMF.
00436  *        This function will play "auth-thankyou" upon successful recording.
00437  *
00438  * \param chan the channel being recorded
00439  * \param playfile Filename of sound to play before recording begins
00440  * \param recordfile Filename to save the recording
00441  * \param maxtime_sec Longest possible message length in seconds
00442  * \param fmt string containing all formats to be recorded delimited by '|'
00443  * \param duration pointer to integer for storing length of the recording
00444  * \param sound_duration pointer to integer for storing length of the recording minus all silence
00445  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
00446  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default
00447  * \param path Optional filesystem path to unlock
00448  *
00449  * \retval -1 failure or hangup
00450  * \retval 'S' Recording ended from silence timeout
00451  * \retval 't' Recording ended from the message exceeding the maximum duration
00452  * \retval dtmfchar Recording ended via the return value's DTMF character for either cancel or accept.
00453  */
00454 int ast_play_and_record(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime_sec, const char *fmt, int *duration, int *sound_duration, int silencethreshold, int maxsilence_ms, const char *path);
00455 
00456 /*!
00457  * \brief Record a file based on input frm a channel. Recording is performed in 'prepend' mode which works a little differently from normal recordings
00458  *        This function will not play a success message due to post-recording control in the application this was added for.
00459  *
00460  * \param chan the channel being recorded
00461  * \param playfile Filename of sound to play before recording begins
00462  * \param recordfile Filename to save the recording
00463  * \param maxtime_sec Longest possible message length in seconds
00464  * \param fmt string containing all formats to be recorded delimited by '|'
00465  * \param duration pointer to integer for storing length of the recording
00466  * \param sound_duration pointer to integer for storing length of the recording minus all silence
00467  * \param beep whether to play a beep to prompt the recording
00468  * \param silencethreshold tolerance of noise levels that can be considered silence for the purpose of silence timeout, -1 for default
00469  * \param maxsilence_ms length of time in milliseconds which will trigger a timeout from silence, -1 for default.
00470  *
00471  * \retval -1 failure or hangup
00472  * \retval 'S' Recording ended from silence timeout
00473  * \retval 't' Recording either exceeded maximum duration or the call was ended via DTMF
00474  */
00475 int ast_play_and_prepend(struct ast_channel *chan, char *playfile, char *recordfile, int maxtime_sec, char *fmt, int *duration, int *sound_duration, int beep, int silencethreshold, int maxsilence_ms);
00476 
00477 enum ast_getdata_result {
00478    AST_GETDATA_FAILED = -1,
00479    AST_GETDATA_COMPLETE = 0,
00480    AST_GETDATA_TIMEOUT = 1,
00481    AST_GETDATA_INTERRUPTED = 2,
00482    /*! indicates a user terminated empty string rather than an empty string resulting 
00483     * from a timeout or other factors */
00484    AST_GETDATA_EMPTY_END_TERMINATED = 3,
00485 };
00486 
00487 enum AST_LOCK_RESULT {
00488    AST_LOCK_SUCCESS = 0,
00489    AST_LOCK_TIMEOUT = -1,
00490    AST_LOCK_PATH_NOT_FOUND = -2,
00491    AST_LOCK_FAILURE = -3,
00492 };
00493 
00494 /*! \brief Type of locking to use in ast_lock_path / ast_unlock_path */
00495 enum AST_LOCK_TYPE {
00496    AST_LOCK_TYPE_LOCKFILE = 0,
00497    AST_LOCK_TYPE_FLOCK = 1,
00498 };
00499 
00500 /*!
00501  * \brief Set the type of locks used by ast_lock_path()
00502  * \param type the locking type to use
00503  */
00504 void ast_set_lock_type(enum AST_LOCK_TYPE type);
00505 
00506 /*!
00507  * \brief Lock a filesystem path.
00508  * \param path the path to be locked
00509  * \return one of \ref AST_LOCK_RESULT values
00510  */
00511 enum AST_LOCK_RESULT ast_lock_path(const char *path);
00512 
00513 /*! \brief Unlock a path */
00514 int ast_unlock_path(const char *path);
00515 
00516 /*! \brief Read a file into asterisk*/
00517 char *ast_read_textfile(const char *file);
00518 
00519 struct ast_group_info;
00520 
00521 /*! \brief Split a group string into group and category, returning a default category if none is provided. */
00522 int ast_app_group_split_group(const char *data, char *group, int group_max, char *category, int category_max);
00523 
00524 /*! \brief Set the group for a channel, splitting the provided data into group and category, if specified. */
00525 int ast_app_group_set_channel(struct ast_channel *chan, const char *data);
00526 
00527 /*! \brief Get the current channel count of the specified group and category. */
00528 int ast_app_group_get_count(const char *group, const char *category);
00529 
00530 /*! \brief Get the current channel count of all groups that match the specified pattern and category. */
00531 int ast_app_group_match_get_count(const char *groupmatch, const char *category);
00532 
00533 /*! \brief Discard all group counting for a channel */
00534 int ast_app_group_discard(struct ast_channel *chan);
00535 
00536 /*! \brief Update all group counting for a channel to a new one */
00537 int ast_app_group_update(struct ast_channel *oldchan, struct ast_channel *newchan);
00538 
00539 /*! \brief Write Lock the group count list */
00540 int ast_app_group_list_wrlock(void);
00541 
00542 /*! \brief Read Lock the group count list */
00543 int ast_app_group_list_rdlock(void);
00544 
00545 /*! \brief Get the head of the group count list */
00546 struct ast_group_info *ast_app_group_list_head(void);
00547 
00548 /*! \brief Unlock the group count list */
00549 int ast_app_group_list_unlock(void);
00550 
00551 /*!
00552   \brief Define an application argument
00553   \param name The name of the argument
00554 */
00555 #define AST_APP_ARG(name) char *name
00556 
00557 /*!
00558   \brief Declare a structure to hold an application's arguments.
00559   \param name The name of the structure
00560   \param arglist The list of arguments, defined using AST_APP_ARG
00561 
00562   This macro declares a structure intended to be used in a call
00563   to ast_app_separate_args(). The structure includes all the
00564   arguments specified, plus an argv array that overlays them and an
00565   argc argument counter. The arguments must be declared using AST_APP_ARG,
00566   and they will all be character pointers (strings).
00567 
00568   \note The structure is <b>not</b> initialized, as the call to
00569   ast_app_separate_args() will perform that function before parsing
00570   the arguments.
00571  */
00572 #define AST_DECLARE_APP_ARGS(name, arglist) AST_DEFINE_APP_ARGS_TYPE(, arglist) name = { 0, }
00573 
00574 /*!
00575   \brief Define a structure type to hold an application's arguments.
00576   \param type The name of the structure type
00577   \param arglist The list of arguments, defined using AST_APP_ARG
00578 
00579   This macro defines a structure type intended to be used in a call
00580   to ast_app_separate_args(). The structure includes all the
00581   arguments specified, plus an argv array that overlays them and an
00582   argc argument counter. The arguments must be declared using AST_APP_ARG,
00583   and they will all be character pointers (strings).
00584 
00585   \note This defines a structure type, but does not declare an instance
00586   of the structure. That must be done separately.
00587  */
00588 #define AST_DEFINE_APP_ARGS_TYPE(type, arglist) \
00589    struct type { \
00590       unsigned int argc; \
00591       char *argv[0]; \
00592       arglist \
00593    }
00594 
00595 /*!
00596   \brief Performs the 'standard' argument separation process for an application.
00597   \param args An argument structure defined using AST_DECLARE_APP_ARGS
00598   \param parse A modifiable buffer containing the input to be parsed
00599 
00600   This function will separate the input string using the standard argument
00601   separator character ',' and fill in the provided structure, including
00602   the argc argument counter field.
00603  */
00604 #define AST_STANDARD_APP_ARGS(args, parse) \
00605    args.argc = __ast_app_separate_args(parse, ',', 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
00606 #define AST_STANDARD_RAW_ARGS(args, parse) \
00607    args.argc = __ast_app_separate_args(parse, ',', 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
00608 
00609 /*!
00610   \brief Performs the 'nonstandard' argument separation process for an application.
00611   \param args An argument structure defined using AST_DECLARE_APP_ARGS
00612   \param parse A modifiable buffer containing the input to be parsed
00613   \param sep A nonstandard separator character
00614 
00615   This function will separate the input string using the nonstandard argument
00616   separator character and fill in the provided structure, including
00617   the argc argument counter field.
00618  */
00619 #define AST_NONSTANDARD_APP_ARGS(args, parse, sep) \
00620    args.argc = __ast_app_separate_args(parse, sep, 1, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
00621 #define AST_NONSTANDARD_RAW_ARGS(args, parse, sep) \
00622    args.argc = __ast_app_separate_args(parse, sep, 0, args.argv, ((sizeof(args) - offsetof(typeof(args), argv)) / sizeof(args.argv[0])))
00623 
00624 /*!
00625   \brief Separate a string into arguments in an array
00626   \param buf The string to be parsed (this must be a writable copy, as it will be modified)
00627   \param delim The character to be used to delimit arguments
00628   \param remove_chars Remove backslashes and quote characters, while parsing
00629   \param array An array of 'char *' to be filled in with pointers to the found arguments
00630   \param arraylen The number of elements in the array (i.e. the number of arguments you will accept)
00631 
00632   Note: if there are more arguments in the string than the array will hold, the last element of
00633   the array will contain the remaining arguments, not separated.
00634 
00635   The array will be completely zeroed by this function before it populates any entries.
00636 
00637   \return The number of arguments found, or zero if the function arguments are not valid.
00638 */
00639 unsigned int __ast_app_separate_args(char *buf, char delim, int remove_chars, char **array, int arraylen);
00640 #define ast_app_separate_args(a,b,c,d) __ast_app_separate_args(a,b,1,c,d)
00641 
00642 /*!
00643   \brief A structure to hold the description of an application 'option'.
00644 
00645   Application 'options' are single-character flags that can be supplied
00646   to the application to affect its behavior; they can also optionally
00647   accept arguments enclosed in parenthesis.
00648 
00649   These structures are used by the ast_app_parse_options function, uses
00650   this data to fill in a flags structure (to indicate which options were
00651   supplied) and array of argument pointers (for those options that had
00652   arguments supplied).
00653  */
00654 struct ast_app_option {
00655    /*! \brief The flag bit that represents this option. */
00656    uint64_t flag;
00657    /*! \brief The index of the entry in the arguments array
00658      that should be used for this option's argument. */
00659    unsigned int arg_index;
00660 };
00661 
00662 #define BEGIN_OPTIONS {
00663 #define END_OPTIONS }
00664 
00665 /*!
00666   \brief Declares an array of options for an application.
00667   \param holder The name of the array to be created
00668   \param options The actual options to be placed into the array
00669   \sa ast_app_parse_options
00670 
00671   This macro declares a 'static const' array of \c struct \c ast_option
00672   elements to hold the list of available options for an application.
00673   Each option must be declared using either the AST_APP_OPTION()
00674   or AST_APP_OPTION_ARG() macros.
00675 
00676   Example usage:
00677   \code
00678   enum my_app_option_flags {
00679         OPT_JUMP = (1 << 0),
00680         OPT_BLAH = (1 << 1),
00681         OPT_BLORT = (1 << 2),
00682   };
00683 
00684   enum my_app_option_args {
00685         OPT_ARG_BLAH = 0,
00686         OPT_ARG_BLORT,
00687         !! this entry tells how many possible arguments there are,
00688            and must be the last entry in the list
00689         OPT_ARG_ARRAY_SIZE,
00690   };
00691 
00692   AST_APP_OPTIONS(my_app_options, {
00693         AST_APP_OPTION('j', OPT_JUMP),
00694         AST_APP_OPTION_ARG('b', OPT_BLAH, OPT_ARG_BLAH),
00695         AST_APP_OPTION_BLORT('B', OPT_BLORT, OPT_ARG_BLORT),
00696   });
00697 
00698   static int my_app_exec(struct ast_channel *chan, void *data)
00699   {
00700    char *options;
00701    struct ast_flags opts = { 0, };
00702    char *opt_args[OPT_ARG_ARRAY_SIZE];
00703 
00704    ... do any argument parsing here ...
00705 
00706    if (ast_app_parse_options(my_app_options, &opts, opt_args, options)) {
00707       return -1;
00708    }
00709   }
00710   \endcode
00711  */
00712 #define AST_APP_OPTIONS(holder, options...) \
00713    static const struct ast_app_option holder[128] = options
00714 
00715 /*!
00716   \brief Declares an application option that does not accept an argument.
00717   \param option The single character representing the option
00718   \param flagno The flag index to be set if this option is present
00719   \sa AST_APP_OPTIONS, ast_app_parse_options
00720  */
00721 #define AST_APP_OPTION(option, flagno) \
00722    [option] = { .flag = flagno }
00723 
00724 /*!
00725   \brief Declares an application option that accepts an argument.
00726   \param option The single character representing the option
00727   \param flagno The flag index to be set if this option is present
00728   \param argno The index into the argument array where the argument should
00729   be placed
00730   \sa AST_APP_OPTIONS, ast_app_parse_options
00731  */
00732 #define AST_APP_OPTION_ARG(option, flagno, argno) \
00733    [option] = { .flag = flagno, .arg_index = argno + 1 }
00734 
00735 /*!
00736   \brief Parses a string containing application options and sets flags/arguments.
00737   \param options The array of possible options declared with AST_APP_OPTIONS
00738   \param flags The flag structure to have option flags set
00739   \param args The array of argument pointers to hold arguments found
00740   \param optstr The string containing the options to be parsed
00741   \return zero for success, non-zero if an error occurs
00742   \sa AST_APP_OPTIONS
00743  */
00744 int ast_app_parse_options(const struct ast_app_option *options, struct ast_flags *flags, char **args, char *optstr);
00745 
00746    /*!
00747   \brief Parses a string containing application options and sets flags/arguments.
00748   \param options The array of possible options declared with AST_APP_OPTIONS
00749   \param flags The 64-bit flag structure to have option flags set
00750   \param args The array of argument pointers to hold arguments found
00751   \param optstr The string containing the options to be parsed
00752   \return zero for success, non-zero if an error occurs
00753   \sa AST_APP_OPTIONS
00754  */
00755 int ast_app_parse_options64(const struct ast_app_option *options, struct ast_flags64 *flags, char **args, char *optstr);
00756 
00757 /*! \brief Given a list of options array, return an option string based on passed flags
00758    \param options The array of possible options declared with AST_APP_OPTIONS
00759    \param flags The flags of the options that you wish to populate the buffer with
00760    \param buf The buffer to fill with the string of options
00761    \param len The maximum length of buf
00762 */
00763 void ast_app_options2str64(const struct ast_app_option *options, struct ast_flags64 *flags, char *buf, size_t len);
00764 
00765 /*! \brief Present a dialtone and collect a certain length extension.
00766     \return Returns 1 on valid extension entered, -1 on hangup, or 0 on invalid extension.
00767 \note Note that if 'collect' holds digits already, new digits will be appended, so be sure it's initialized properly */
00768 int ast_app_dtget(struct ast_channel *chan, const char *context, char *collect, size_t size, int maxlen, int timeout);
00769 
00770 /*! \brief Allow to record message and have a review option */
00771 int ast_record_review(struct ast_channel *chan, const char *playfile, const char *recordfile, int maxtime, const char *fmt, int *duration, const char *path);
00772 
00773 /*!\brief Decode an encoded control or extended ASCII character 
00774  * \param[in] stream String to decode
00775  * \param[out] result Decoded character
00776  * \param[out] consumed Number of characters used in stream to encode the character
00777  * \retval -1 Stream is of zero length
00778  * \retval 0 Success
00779  */
00780 int ast_get_encoded_char(const char *stream, char *result, size_t *consumed);
00781 
00782 /*!\brief Decode a stream of encoded control or extended ASCII characters
00783  * \param[in] stream Encoded string
00784  * \param[out] result Decoded string
00785  * \param[in] result_len Maximum size of the result buffer
00786  * \return A pointer to the result string
00787  */
00788 char *ast_get_encoded_str(const char *stream, char *result, size_t result_len);
00789 
00790 /*! \brief Decode a stream of encoded control or extended ASCII characters */
00791 int ast_str_get_encoded_str(struct ast_str **str, int maxlen, const char *stream);
00792 
00793 /*!
00794  * \brief Common routine for child processes, to close all fds prior to exec(2)
00795  * \param[in] n starting file descriptor number for closing all higher file descriptors
00796  * \since 1.6.1
00797  */
00798 void ast_close_fds_above_n(int n);
00799 
00800 /*!
00801  * \brief Common routine to safely fork without a chance of a signal handler firing badly in the child
00802  * \param[in] stop_reaper flag to determine if sigchld handler is replaced or not
00803  * \since 1.6.1
00804  */
00805 int ast_safe_fork(int stop_reaper);
00806 
00807 /*!
00808  * \brief Common routine to cleanup after fork'ed process is complete (if reaping was stopped)
00809  * \since 1.6.1
00810  */
00811 void ast_safe_fork_cleanup(void);
00812 
00813 /*!
00814  * \brief Common routine to parse time lengths, with optional time unit specifier
00815  * \param[in] timestr String to parse
00816  * \param[in] defunit Default unit type
00817  * \param[out] result Resulting value, specified in milliseconds
00818  * \retval 0 Success
00819  * \retval -1 Failure
00820  * \since 1.8
00821  */
00822 int ast_app_parse_timelen(const char *timestr, int *result, enum ast_timelen defunit);
00823 
00824 #if defined(__cplusplus) || defined(c_plusplus)
00825 }
00826 #endif
00827 
00828 #endif /* _ASTERISK_APP_H */

Generated on 7 Aug 2019 for Asterisk - The Open Source Telephony Project by  doxygen 1.6.1