Wed Aug 7 17:15:40 2019

Asterisk developer's documentation


channel.h

Go to the documentation of this file.
00001 /*
00002  * Asterisk -- An open source telephony toolkit.
00003  *
00004  * Copyright (C) 1999 - 2006, Digium, Inc.
00005  *
00006  * Mark Spencer <markster@digium.com>
00007  *
00008  * See http://www.asterisk.org for more information about
00009  * the Asterisk project. Please do not directly contact
00010  * any of the maintainers of this project for assistance;
00011  * the project provides a web site, mailing lists and IRC
00012  * channels for your use.
00013  *
00014  * This program is free software, distributed under the terms of
00015  * the GNU General Public License Version 2. See the LICENSE file
00016  * at the top of the source tree.
00017  */
00018 
00019 /*! \file
00020  * \brief General Asterisk PBX channel definitions.
00021  * \par See also:
00022  *  \arg \ref Def_Channel
00023  *  \arg \ref channel_drivers
00024  */
00025 
00026 /*! \page Def_Channel Asterisk Channels
00027    \par What is a Channel?
00028    A phone call through Asterisk consists of an incoming
00029    connection and an outbound connection. Each call comes
00030    in through a channel driver that supports one technology,
00031    like SIP, DAHDI, IAX2 etc.
00032    \par
00033    Each channel driver, technology, has it's own private
00034    channel or dialog structure, that is technology-dependent.
00035    Each private structure is "owned" by a generic Asterisk
00036    channel structure, defined in channel.h and handled by
00037    channel.c .
00038    \par Call scenario
00039    This happens when an incoming call arrives to Asterisk
00040    -# Call arrives on a channel driver interface
00041    -# Channel driver creates a PBX channel and starts a
00042       pbx thread on the channel
00043    -# The dial plan is executed
00044    -# At this point at least two things can happen:
00045       -# The call is answered by Asterisk and
00046          Asterisk plays a media stream or reads media
00047       -# The dial plan forces Asterisk to create an outbound
00048          call somewhere with the dial (see \ref app_dial.c)
00049          application
00050    .
00051 
00052    \par Bridging channels
00053    If Asterisk dials out this happens:
00054    -# Dial creates an outbound PBX channel and asks one of the
00055       channel drivers to create a call
00056    -# When the call is answered, Asterisk bridges the media streams
00057       so the caller on the first channel can speak with the callee
00058       on the second, outbound channel
00059    -# In some cases where we have the same technology on both
00060       channels and compatible codecs, a native bridge is used.
00061       In a native bridge, the channel driver handles forwarding
00062       of incoming audio to the outbound stream internally, without
00063       sending audio frames through the PBX.
00064    -# In SIP, theres an "external native bridge" where Asterisk
00065       redirects the endpoint, so audio flows directly between the
00066       caller's phone and the callee's phone. Signalling stays in
00067       Asterisk in order to be able to provide a proper CDR record
00068       for the call.
00069 
00070 
00071    \par Masquerading channels
00072    In some cases, a channel can masquerade itself into another
00073    channel. This happens frequently in call transfers, where
00074    a new channel takes over a channel that is already involved
00075    in a call. The new channel sneaks in and takes over the bridge
00076    and the old channel, now a zombie, is hung up.
00077 
00078    \par Reference
00079    \arg channel.c - generic functions
00080    \arg channel.h - declarations of functions, flags and structures
00081    \arg translate.h - Transcoding support functions
00082    \arg \ref channel_drivers - Implemented channel drivers
00083    \arg \ref Def_Frame Asterisk Multimedia Frames
00084    \arg \ref Def_Bridge
00085 
00086 */
00087 /*! \page Def_Bridge Asterisk Channel Bridges
00088 
00089    In Asterisk, there's several media bridges.
00090 
00091    The Core bridge handles two channels (a "phone call") and bridge
00092    them together.
00093 
00094    The conference bridge (meetme) handles several channels simultaneously
00095    with the support of an external timer (DAHDI timer). This is used
00096    not only by the Conference application (meetme) but also by the
00097    page application and the SLA system introduced in 1.4.
00098    The conference bridge does not handle video.
00099 
00100    When two channels of the same type connect, the channel driver
00101    or the media subsystem used by the channel driver (i.e. RTP)
00102    can create a native bridge without sending media through the
00103    core.
00104 
00105    Native bridging can be disabled by a number of reasons,
00106    like DTMF being needed by the core or codecs being incompatible
00107    so a transcoding module is needed.
00108 
00109 References:
00110    \li \see ast_channel_early_bridge()
00111    \li \see ast_channel_bridge()
00112    \li \see app_meetme.c
00113    \li \ref AstRTPbridge
00114    \li \see ast_rtp_bridge()
00115    \li \ref Def_Channel
00116 */
00117 
00118 /*! \page AstFileDesc File descriptors
00119    Asterisk File descriptors are connected to each channel (see \ref Def_Channel)
00120    in the \ref ast_channel structure.
00121 */
00122 
00123 #ifndef _ASTERISK_CHANNEL_H
00124 #define _ASTERISK_CHANNEL_H
00125 
00126 #include "asterisk/abstract_jb.h"
00127 #include "asterisk/astobj2.h"
00128 
00129 #include "asterisk/poll-compat.h"
00130 
00131 #if defined(__cplusplus) || defined(c_plusplus)
00132 extern "C" {
00133 #endif
00134 
00135 #define AST_MAX_EXTENSION  80 /*!< Max length of an extension */
00136 #define AST_MAX_CONTEXT    80 /*!< Max length of a context */
00137 #define AST_CHANNEL_NAME   80 /*!< Max length of an ast_channel name */
00138 #define MAX_LANGUAGE    40 /*!< Max length of the language setting */
00139 #define MAX_MUSICCLASS     80 /*!< Max length of the music class setting */
00140 
00141 #include "asterisk/frame.h"
00142 #include "asterisk/sched.h"
00143 #include "asterisk/chanvars.h"
00144 #include "asterisk/config.h"
00145 #include "asterisk/lock.h"
00146 #include "asterisk/cdr.h"
00147 #include "asterisk/utils.h"
00148 #include "asterisk/linkedlists.h"
00149 #include "asterisk/stringfields.h"
00150 #include "asterisk/datastore.h"
00151 #include "asterisk/data.h"
00152 #include "asterisk/channelstate.h"
00153 #include "asterisk/ccss.h"
00154 #include "asterisk/framehook.h"
00155 
00156 #define DATASTORE_INHERIT_FOREVER   INT_MAX
00157 
00158 #define AST_MAX_FDS     10
00159 /*
00160  * We have AST_MAX_FDS file descriptors in a channel.
00161  * Some of them have a fixed use:
00162  */
00163 #define AST_ALERT_FD (AST_MAX_FDS-1)      /*!< used for alertpipe */
00164 #define AST_TIMING_FD   (AST_MAX_FDS-2)      /*!< used for timingfd */
00165 #define AST_AGENT_FD (AST_MAX_FDS-3)      /*!< used by agents for pass through */
00166 #define AST_GENERATOR_FD   (AST_MAX_FDS-4)   /*!< used by generator */
00167 
00168 enum ast_bridge_result {
00169    AST_BRIDGE_COMPLETE = 0,
00170    AST_BRIDGE_FAILED = -1,
00171    AST_BRIDGE_FAILED_NOWARN = -2,
00172    AST_BRIDGE_RETRY = -3,
00173 };
00174 
00175 typedef unsigned long long ast_group_t;
00176 
00177 /*! \todo Add an explanation of an Asterisk generator
00178 */
00179 struct ast_generator {
00180    void *(*alloc)(struct ast_channel *chan, void *params);
00181    void (*release)(struct ast_channel *chan, void *data);
00182    /*! This function gets called with the channel unlocked, but is called in
00183     *  the context of the channel thread so we know the channel is not going
00184     *  to disappear.  This callback is responsible for locking the channel as
00185     *  necessary. */
00186    int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
00187    /*! This gets called when DTMF_END frames are read from the channel */
00188    void (*digit)(struct ast_channel *chan, char digit);
00189 };
00190 
00191 /*! Party name character set enumeration values (values from Q.SIG) */
00192 enum AST_PARTY_CHAR_SET {
00193    AST_PARTY_CHAR_SET_UNKNOWN = 0,
00194    AST_PARTY_CHAR_SET_ISO8859_1 = 1,
00195    AST_PARTY_CHAR_SET_WITHDRAWN = 2,/* ITU withdrew this enum value. */
00196    AST_PARTY_CHAR_SET_ISO8859_2 = 3,
00197    AST_PARTY_CHAR_SET_ISO8859_3 = 4,
00198    AST_PARTY_CHAR_SET_ISO8859_4 = 5,
00199    AST_PARTY_CHAR_SET_ISO8859_5 = 6,
00200    AST_PARTY_CHAR_SET_ISO8859_7 = 7,
00201    AST_PARTY_CHAR_SET_ISO10646_BMPSTRING = 8,
00202    AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING = 9,
00203 };
00204 
00205 /*!
00206  * \since 1.8
00207  * \brief Information needed to specify a name in a call.
00208  * \note All string fields here are malloc'ed, so they need to be
00209  * freed when the structure is deleted.
00210  * \note NULL and "" must be considered equivalent.
00211  */
00212 struct ast_party_name {
00213    /*! \brief Subscriber name (Malloced) */
00214    char *str;
00215    /*!
00216     * \brief Character set the name is using.
00217     * \see enum AST_PARTY_CHAR_SET
00218     * \note
00219     * Set to AST_PARTY_CHAR_SET_ISO8859_1 if unsure what to use.
00220     * \todo Start using the party name character set value.  Not currently used.
00221     */
00222    int char_set;
00223    /*!
00224     * \brief Q.931 encoded presentation-indicator encoded field
00225     * \note Must tolerate the Q.931 screening-indicator field values being present.
00226     */
00227    int presentation;
00228    /*! \brief TRUE if the name information is valid/present */
00229    unsigned char valid;
00230 };
00231 
00232 /*!
00233  * \since 1.8
00234  * \brief Information needed to specify a number in a call.
00235  * \note All string fields here are malloc'ed, so they need to be
00236  * freed when the structure is deleted.
00237  * \note NULL and "" must be considered equivalent.
00238  */
00239 struct ast_party_number {
00240    /*! \brief Subscriber phone number (Malloced) */
00241    char *str;
00242    /*! \brief Q.931 Type-Of-Number and Numbering-Plan encoded fields */
00243    int plan;
00244    /*! \brief Q.931 presentation-indicator and screening-indicator encoded fields */
00245    int presentation;
00246    /*! \brief TRUE if the number information is valid/present */
00247    unsigned char valid;
00248 };
00249 
00250 /*!
00251  * \since 1.8
00252  * \brief Information needed to specify a subaddress in a call.
00253  * \note All string fields here are malloc'ed, so they need to be
00254  * freed when the structure is deleted.
00255  * \note NULL and "" must be considered equivalent.
00256  */
00257 struct ast_party_subaddress {
00258    /*!
00259     * \brief Malloced subaddress string.
00260     * \note If the subaddress type is user specified then the subaddress is
00261     * a string of ASCII hex because the actual subaddress is likely BCD encoded.
00262     */
00263    char *str;
00264    /*!
00265     * \brief Q.931 subaddress type.
00266     * \details
00267     * nsap(0),
00268     * user_specified(2)
00269     */
00270    int type;
00271    /*!
00272     * \brief TRUE if odd number of address signals
00273     * \note The odd/even indicator is used when the type of subaddress is
00274     * user_specified and the coding is BCD.
00275     */
00276    unsigned char odd_even_indicator;
00277    /*! \brief TRUE if the subaddress information is valid/present */
00278    unsigned char valid;
00279 };
00280 
00281 /*!
00282  * \since 1.8
00283  * \brief Information needed to identify an endpoint in a call.
00284  * \note All string fields here are malloc'ed, so they need to be
00285  * freed when the structure is deleted.
00286  * \note NULL and "" must be considered equivalent.
00287  */
00288 struct ast_party_id {
00289    /*! \brief Subscriber name */
00290    struct ast_party_name name;
00291    /*! \brief Subscriber phone number */
00292    struct ast_party_number number;
00293    /*! \brief Subscriber subaddress. */
00294    struct ast_party_subaddress subaddress;
00295 
00296    /*!
00297     * \brief User-set "tag"
00298     * \details
00299     * A user-settable field used to help associate some extrinsic information
00300     * about the channel or user of the channel to the party ID.  This information
00301     * is normally not transmitted over the wire and so is only useful within an
00302     * Asterisk environment.
00303     */
00304    char *tag;
00305 };
00306 
00307 /*!
00308  * \since 1.8
00309  * \brief Indicate what information in ast_party_id should be set.
00310  */
00311 struct ast_set_party_id {
00312    /*! TRUE if the ast_party_name information should be set. */
00313    unsigned char name;
00314    /*! TRUE if the ast_party_number information should be set. */
00315    unsigned char number;
00316    /*! TRUE if the ast_party_subaddress information should be set. */
00317    unsigned char subaddress;
00318 };
00319 
00320 /*!
00321  * \since 1.8
00322  * \brief Dialed/Called Party information.
00323  * \note Dialed Number Identifier (DNID)
00324  * \note All string fields here are malloc'ed, so they need to be
00325  * freed when the structure is deleted.
00326  * \note NULL and "" must be considered equivalent.
00327  */
00328 struct ast_party_dialed {
00329    /*!
00330     * \brief Dialed/Called number
00331     * \note Done this way in case we ever really need to use ast_party_number.
00332     * We currently do not need all of the ast_party_number fields.
00333     */
00334    struct {
00335       /*! \brief Subscriber phone number (Malloced) */
00336       char *str;
00337       /*! \brief Q.931 Type-Of-Number and Numbering-Plan encoded fields */
00338       int plan;
00339    } number;
00340    /*! \brief Dialed/Called subaddress */
00341    struct ast_party_subaddress subaddress;
00342    /*!
00343     * \brief Transit Network Select
00344     * \note Currently this value is just passed around the system.
00345     * You can read it and set it but it is never used for anything.
00346     */
00347    int transit_network_select;
00348 };
00349 
00350 /*!
00351  * \since 1.8
00352  * \brief Caller Party information.
00353  * \note All string fields here are malloc'ed, so they need to be
00354  * freed when the structure is deleted.
00355  * \note NULL and "" must be considered equivalent.
00356  *
00357  * \note SIP and IAX2 has UTF8 encoded Unicode Caller ID names.
00358  * In some cases, we also have an alternative (RPID) E.164 number that can
00359  * be used as Caller ID on numeric E.164 phone networks (DAHDI or SIP/IAX2 to
00360  * PSTN gateway).
00361  *
00362  * \todo Implement settings for transliteration between UTF8 Caller ID names in
00363  *       to ASCII Caller ID's (DAHDI). Östen Åsklund might be transliterated into
00364  *       Osten Asklund or Oesten Aasklund depending upon language and person...
00365  *       We need automatic routines for incoming calls and static settings for
00366  *       our own accounts.
00367  */
00368 struct ast_party_caller {
00369    /*! \brief Caller party ID */
00370    struct ast_party_id id;
00371 
00372    /*!
00373     * \brief Automatic Number Identification (ANI)
00374     * \note The name subcomponent is only likely to be used by SIP.
00375     * \note The subaddress subcomponent is not likely to be used.
00376     */
00377    struct ast_party_id ani;
00378 
00379    /*! \brief Automatic Number Identification 2 (Info Digits) */
00380    int ani2;
00381 };
00382 
00383 /*!
00384  * \since 1.8
00385  * \brief Indicate what information in ast_party_caller should be set.
00386  */
00387 struct ast_set_party_caller {
00388    /*! What caller id information to set. */
00389    struct ast_set_party_id id;
00390    /*! What ANI id information to set. */
00391    struct ast_set_party_id ani;
00392 };
00393 
00394 /*!
00395  * \since 1.8
00396  * \brief Connected Line/Party information.
00397  * \note All string fields here are malloc'ed, so they need to be
00398  * freed when the structure is deleted.
00399  * \note NULL and "" must be considered equivalent.
00400  */
00401 struct ast_party_connected_line {
00402    /*! \brief Connected party ID */
00403    struct ast_party_id id;
00404 
00405    /*!
00406     * \brief Automatic Number Identification (ANI)
00407     * \note Not really part of connected line data but needed to
00408     * save the corresponding caller id value.
00409     */
00410    struct ast_party_id ani;
00411 
00412    /*!
00413     * \brief Automatic Number Identification 2 (Info Digits)
00414     * \note Not really part of connected line data but needed to
00415     * save the corresponding caller id value.
00416     */
00417    int ani2;
00418 
00419    /*!
00420     * \brief Information about the source of an update.
00421     * \note enum AST_CONNECTED_LINE_UPDATE_SOURCE values
00422     * for Normal-Answer and Call-transfer.
00423     */
00424    int source;
00425 };
00426 
00427 /*!
00428  * \since 1.8
00429  * \brief Indicate what information in ast_party_connected_line should be set.
00430  */
00431 struct ast_set_party_connected_line {
00432    /*! What connected line id information to set. */
00433    struct ast_set_party_id id;
00434    /*! What ANI id information to set. */
00435    struct ast_set_party_id ani;
00436 };
00437 
00438 /*!
00439  * \since 1.8
00440  * \brief Redirecting Line information.
00441  * RDNIS (Redirecting Directory Number Information Service)
00442  * Where a call diversion or transfer was invoked.
00443  * \note All string fields here are malloc'ed, so they need to be
00444  * freed when the structure is deleted.
00445  * \note NULL and "" must be considered equivalent.
00446  */
00447 struct ast_party_redirecting {
00448    /*! \brief Who is redirecting the call (Sent to the party the call is redirected toward) */
00449    struct ast_party_id from;
00450 
00451    /*! \brief Call is redirecting to a new party (Sent to the caller) */
00452    struct ast_party_id to;
00453 
00454    /*! \brief Number of times the call was redirected */
00455    int count;
00456 
00457    /*! \brief enum AST_REDIRECTING_REASON value for redirection */
00458    int reason;
00459 };
00460 
00461 /*!
00462  * \since 1.8
00463  * \brief Indicate what information in ast_party_redirecting should be set.
00464  */
00465 struct ast_set_party_redirecting {
00466    /*! What redirecting-from id information to set. */
00467    struct ast_set_party_id from;
00468    /*! What redirecting-to id information to set. */
00469    struct ast_set_party_id to;
00470 };
00471 
00472 /*! \brief Typedef for a custom read function */
00473 typedef int (*ast_acf_read_fn_t)(struct ast_channel *, const char *, char *, char *, size_t);
00474 
00475 /*! \brief Typedef for a custom read2 function */
00476 typedef int (*ast_acf_read2_fn_t)(struct ast_channel *, const char *, char *, struct ast_str **, ssize_t);
00477 
00478 /*! \brief Typedef for a custom write function */
00479 typedef int (*ast_acf_write_fn_t)(struct ast_channel *, const char *, char *, const char *);
00480 
00481 /*! \brief Structure to handle passing func_channel_write info to channels via setoption */
00482 typedef struct {
00483    /*! \brief ast_chan_write_info_t version. Must be incremented if structure is changed */
00484    #define AST_CHAN_WRITE_INFO_T_VERSION 1
00485    uint32_t version;
00486    ast_acf_write_fn_t write_fn;
00487    struct ast_channel *chan;
00488    const char *function;
00489    char *data;
00490    const char *value;
00491 } ast_chan_write_info_t;
00492 
00493 /*!
00494  * \brief
00495  * Structure to describe a channel "technology", ie a channel driver
00496  * See for examples:
00497  * \arg chan_iax2.c - The Inter-Asterisk exchange protocol
00498  * \arg chan_sip.c - The SIP channel driver
00499  * \arg chan_dahdi.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS)
00500  *
00501  * \details
00502  * If you develop your own channel driver, this is where you
00503  * tell the PBX at registration of your driver what properties
00504  * this driver supports and where different callbacks are
00505  * implemented.
00506  */
00507 struct ast_channel_tech {
00508    const char * const type;
00509    const char * const description;
00510 
00511    format_t capabilities;  /*!< Bitmap of formats this channel can handle */
00512 
00513    int properties;         /*!< Technology Properties */
00514 
00515    /*!
00516     * \brief Requester - to set up call data structures (pvt's)
00517     * \note data should be treated as const char *.
00518     */
00519    struct ast_channel *(* const requester)(const char *type, format_t format, const struct ast_channel *requestor, void *data, int *cause);
00520 
00521    int (* const devicestate)(void *data); /*!< Devicestate call back */
00522 
00523    /*!
00524     * \brief Start sending a literal DTMF digit
00525     *
00526     * \note The channel is not locked when this function gets called.
00527     */
00528    int (* const send_digit_begin)(struct ast_channel *chan, char digit);
00529 
00530    /*!
00531     * \brief Stop sending a literal DTMF digit
00532     *
00533     * \note The channel is not locked when this function gets called.
00534     */
00535    int (* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration);
00536 
00537    /*!
00538     * \brief Call a given phone number (address, etc), but don't
00539     * take longer than timeout seconds to do so.
00540     * \note addr should be treated as const char *.
00541     */
00542    int (* const call)(struct ast_channel *chan, char *addr, int timeout);
00543 
00544    /*! \brief Hangup (and possibly destroy) the channel */
00545    int (* const hangup)(struct ast_channel *chan);
00546 
00547    /*! \brief Answer the channel */
00548    int (* const answer)(struct ast_channel *chan);
00549 
00550    /*! \brief Read a frame, in standard format (see frame.h) */
00551    struct ast_frame * (* const read)(struct ast_channel *chan);
00552 
00553    /*! \brief Write a frame, in standard format (see frame.h) */
00554    int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
00555 
00556    /*! \brief Display or transmit text */
00557    int (* const send_text)(struct ast_channel *chan, const char *text);
00558 
00559    /*! \brief Display or send an image */
00560    int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
00561 
00562    /*! \brief Send HTML data */
00563    int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
00564 
00565    /*! \brief Handle an exception, reading a frame */
00566    struct ast_frame * (* const exception)(struct ast_channel *chan);
00567 
00568    /*! \brief Bridge two channels of the same type together */
00569    enum ast_bridge_result (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
00570                   struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
00571 
00572    /*! \brief Bridge two channels of the same type together (early) */
00573    enum ast_bridge_result (* const early_bridge)(struct ast_channel *c0, struct ast_channel *c1);
00574 
00575    /*! \brief Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
00576    int (* const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen);
00577 
00578    /*! \brief Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
00579    int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
00580 
00581    /*! \brief Set a given option. Called with chan locked */
00582    int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
00583 
00584    /*! \brief Query a given option. Called with chan locked */
00585    int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
00586 
00587    /*! \brief Blind transfer other side (see app_transfer.c and ast_transfer() */
00588    int (* const transfer)(struct ast_channel *chan, const char *newdest);
00589 
00590    /*! \brief Write a frame, in standard format */
00591    int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
00592 
00593    /*! \brief Write a text frame, in standard format */
00594    int (* const write_text)(struct ast_channel *chan, struct ast_frame *frame);
00595 
00596    /*! \brief Find bridged channel */
00597    struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
00598 
00599    /*! \brief Provide additional read items for CHANNEL() dialplan function */
00600    int (* func_channel_read)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
00601 
00602    /*! \brief Provide additional write items for CHANNEL() dialplan function */
00603    int (* func_channel_write)(struct ast_channel *chan, const char *function, char *data, const char *value);
00604 
00605    /*! \brief Retrieve base channel (agent and local) */
00606    struct ast_channel* (* get_base_channel)(struct ast_channel *chan);
00607 
00608    /*! \brief Set base channel (agent and local) */
00609    int (* set_base_channel)(struct ast_channel *chan, struct ast_channel *base);
00610 
00611    /*! \brief Get the unique identifier for the PVT, i.e. SIP call-ID for SIP */
00612    const char * (* get_pvt_uniqueid)(struct ast_channel *chan);
00613 
00614    /*! \brief Call a function with cc parameters as a function parameter
00615     *
00616     * \details
00617     * This is a highly specialized callback that is not likely to be needed in many
00618     * channel drivers. When dealing with a busy channel, for instance, most channel
00619     * drivers will successfully return a channel to the requester. Once called, the channel
00620     * can then queue a busy frame when it receives an appropriate message from the far end.
00621     * In such a case, the channel driver has the opportunity to also queue a CC frame.
00622     * The parameters for the CC channel can be retrieved from the channel structure.
00623     *
00624     * For other channel drivers, notably those that deal with "dumb" phones, the channel
00625     * driver will not return a channel when one is requested. In such a scenario, there is never
00626     * an opportunity for the channel driver to queue a CC frame since the channel is never
00627     * called. Furthermore, it is not possible to retrieve the CC configuration parameters
00628     * for the desired channel because no channel is ever allocated or returned to the
00629     * requester. In such a case, call completion may still be a viable option. What we do is
00630     * pass the same string that the requester used originally to request the channel to the
00631     * channel driver. The channel driver can then find any potential channels/devices that
00632     * match the input and return call the designated callback with the device's call completion
00633     * parameters as a parameter.
00634     */
00635    int (* cc_callback)(struct ast_channel *inbound, const char *dest, ast_cc_callback_fn callback);
00636 };
00637 
00638 /*! Kill the channel channel driver technology descriptor. */
00639 extern const struct ast_channel_tech ast_kill_tech;
00640 
00641 struct ast_epoll_data;
00642 
00643 /*!
00644  * The high bit of the frame count is used as a debug marker, so
00645  * increments of the counters must be done with care.
00646  * Please use c->fin = FRAMECOUNT_INC(c->fin) and the same for c->fout.
00647  */
00648 #define  DEBUGCHAN_FLAG  0x80000000
00649 
00650 /* XXX not ideal to evaluate x twice... */
00651 #define  FRAMECOUNT_INC(x) ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
00652 
00653 /*!
00654  * The current value of the debug flags is stored in the two
00655  * variables global_fin and global_fout (declared in main/channel.c)
00656  */
00657 extern unsigned long global_fin, global_fout;
00658 
00659 enum ast_channel_adsicpe {
00660    AST_ADSI_UNKNOWN,
00661    AST_ADSI_AVAILABLE,
00662    AST_ADSI_UNAVAILABLE,
00663    AST_ADSI_OFFHOOKONLY,
00664 };
00665 
00666 /*!
00667  * \brief Possible T38 states on channels
00668  */
00669 enum ast_t38_state {
00670    T38_STATE_UNAVAILABLE,  /*!< T38 is unavailable on this channel or disabled by configuration */
00671    T38_STATE_UNKNOWN,   /*!< The channel supports T38 but the current status is unknown */
00672    T38_STATE_NEGOTIATING,  /*!< T38 is being negotiated */
00673    T38_STATE_REJECTED,  /*!< Remote side has rejected our offer */
00674    T38_STATE_NEGOTIATED,   /*!< T38 established */
00675 };
00676 
00677 /*!
00678  * \page AstChannel ast_channel locking and reference tracking
00679  *
00680  * \par Creating Channels
00681  * A channel is allocated using the ast_channel_alloc() function.  When created, it is
00682  * automatically inserted into the main channels hash table that keeps track of all
00683  * active channels in the system.  The hash key is based on the channel name.  Because
00684  * of this, if you want to change the name, you _must_ use ast_change_name(), not change
00685  * the name field directly.  When ast_channel_alloc() returns a channel pointer, you now
00686  * hold a reference to that channel.  In most cases this reference is given to ast_pbx_run().
00687  *
00688  * \par Channel Locking
00689  * There is a lock associated with every ast_channel.  It is allocated internally via astobj2.
00690  * To lock or unlock a channel, you must use the ast_channel_lock() wrappers.
00691  *
00692  * Previously, before ast_channel was converted to astobj2, the channel lock was used in some
00693  * additional ways that are no longer necessary.  Before, the only way to ensure that a channel
00694  * did not disappear out from under you if you were working with a channel outside of the channel
00695  * thread that owns it, was to hold the channel lock.  Now, that is no longer necessary.
00696  * You simply must hold a reference to the channel to ensure it does not go away.
00697  *
00698  * The channel must be locked if you need to ensure that data that you reading from the channel
00699  * does not change while you access it.  Further, you must hold the channel lock if you are
00700  * making a non-atomic change to channel data.
00701  *
00702  * \par Channel References
00703  * There are multiple ways to get a reference to a channel.  The first is that you hold a reference
00704  * to a channel after creating it.  The other ways involve using the channel search or the channel
00705  * traversal APIs.  These functions are the ast_channel_get_*() functions or ast_channel_iterator_*()
00706  * functions.  Once a reference is retrieved by one of these methods, you know that the channel will
00707  * not go away.  So, the channel should only get locked as needed for data access or modification.
00708  * But, make sure that the reference gets released when you are done with it!
00709  *
00710  * There are different things you can do when you are done with a reference to a channel.  The first
00711  * is to simply release the reference using ast_channel_unref().  The other option is to call
00712  * ast_channel_release().  This function is generally used where ast_channel_free() was used in
00713  * the past.  The release function releases a reference as well as ensures that the channel is no
00714  * longer in the global channels container.  That way, the channel will get destroyed as soon as any
00715  * other pending references get released.
00716  *
00717  * \par Exceptions to the rules
00718  * Even though ast_channel is reference counted, there are some places where pointers to an ast_channel
00719  * get stored, but the reference count does not reflect it.  The reason is mostly historical.
00720  * The only places where this happens should be places where because of how the code works, we
00721  * _know_ that the pointer to the channel will get removed before the channel goes away.  The main
00722  * example of this is in channel drivers.  Channel drivers generally store a pointer to their owner
00723  * ast_channel in their technology specific pvt struct.  In this case, the channel drivers _know_
00724  * that this pointer to the channel will be removed in time, because the channel's hangup callback
00725  * gets called before the channel goes away.
00726  */
00727 
00728 /*!
00729  * \brief Main Channel structure associated with a channel.
00730  *
00731  * \note XXX It is important to remember to increment .cleancount each time
00732  *       this structure is changed. XXX
00733  *
00734  * \note When adding fields to this structure, it is important to add the field
00735  *       'in position' with like-aligned fields, so as to keep the compiler from
00736  *       having to add padding to align fields. The structure's fields are sorted
00737  *       in this order: pointers, structures, long, int/enum, short, char. This
00738  *       is especially important on 64-bit architectures, where mixing 4-byte
00739  *       and 8-byte fields causes 4 bytes of padding to be added before many
00740  *       8-byte fields.
00741  */
00742 struct ast_channel {
00743    const struct ast_channel_tech *tech;      /*!< Technology (point to channel driver) */
00744    void *tech_pvt;               /*!< Private data used by the technology driver */
00745    void *music_state;            /*!< Music State*/
00746    void *generatordata;          /*!< Current generator data if there is any */
00747    struct ast_generator *generator;    /*!< Current active data generator */
00748    struct ast_channel *_bridge;        /*!< Who are we bridged to, if we're bridged.
00749                       *   Who is proxying for us, if we are proxied (i.e. chan_agent).
00750                       *   Do not access directly, use ast_bridged_channel(chan) */
00751    struct ast_channel *masq;        /*!< Channel that will masquerade as us */
00752    struct ast_channel *masqr;       /*!< Who we are masquerading as */
00753    const char *blockproc;           /*!< Procedure causing blocking */
00754    const char *appl;          /*!< Current application */
00755    const char *data;          /*!< Data passed to current application */
00756    struct sched_context *sched;        /*!< Schedule context */
00757    struct ast_filestream *stream;         /*!< Stream itself. */
00758    struct ast_filestream *vstream;        /*!< Video Stream itself. */
00759    int (*timingfunc)(const void *data);
00760    void *timingdata;
00761    struct ast_pbx *pbx;          /*!< PBX private structure for this channel */
00762    struct ast_trans_pvt *writetrans;      /*!< Write translation path */
00763    struct ast_trans_pvt *readtrans;    /*!< Read translation path */
00764    struct ast_audiohook_list *audiohooks;
00765    struct ast_framehook_list *framehooks;
00766    struct ast_cdr *cdr;          /*!< Call Detail Record */
00767    struct ast_tone_zone *zone;         /*!< Tone zone as set in indications.conf or
00768                       *   in the CHANNEL dialplan function */
00769    struct ast_channel_monitor *monitor;      /*!< Channel monitoring */
00770 #ifdef HAVE_EPOLL
00771    struct ast_epoll_data *epfd_data[AST_MAX_FDS];
00772 #endif
00773 
00774    AST_DECLARE_STRING_FIELDS(
00775       AST_STRING_FIELD(name);       /*!< ASCII unique channel name */
00776       AST_STRING_FIELD(language);      /*!< Language requested for voice prompts */
00777       AST_STRING_FIELD(musicclass);    /*!< Default music class */
00778       AST_STRING_FIELD(accountcode);      /*!< Account code for billing */
00779       AST_STRING_FIELD(peeraccount);      /*!< Peer account code for billing */
00780       AST_STRING_FIELD(userfield);     /*!< Userfield for CEL billing */
00781       AST_STRING_FIELD(call_forward);     /*!< Where to forward to if asked to dial on this interface */
00782       AST_STRING_FIELD(uniqueid);      /*!< Unique Channel Identifier */
00783       AST_STRING_FIELD(linkedid);      /*!< Linked Channel Identifier -- gets propagated by linkage */
00784       AST_STRING_FIELD(parkinglot);    /*! Default parking lot, if empty, default parking lot  */
00785       AST_STRING_FIELD(hangupsource);     /*! Who is responsible for hanging up this channel */
00786       AST_STRING_FIELD(dialcontext);      /*!< Dial: Extension context that we were called from */
00787    );
00788 
00789    struct timeval whentohangup;              /*!< Non-zero, set to actual time when channel is to be hung up */
00790    pthread_t blocker;            /*!< If anyone is blocking, this is them */
00791 
00792    /*!
00793     * \brief Dialed/Called information.
00794     * \note Set on incoming channels to indicate the originally dialed party.
00795     * \note Dialed Number Identifier (DNID)
00796     */
00797    struct ast_party_dialed dialed;
00798 
00799    /*!
00800     * \brief Channel Caller ID information.
00801     * \note The caller id information is the caller id of this
00802     * channel when it is used to initiate a call.
00803     */
00804    struct ast_party_caller caller;
00805 
00806    /*!
00807     * \brief Channel Connected Line ID information.
00808     * \note The connected line information identifies the channel
00809     * connected/bridged to this channel.
00810     */
00811    struct ast_party_connected_line connected;
00812 
00813    /*! \brief Redirecting/Diversion information */
00814    struct ast_party_redirecting redirecting;
00815 
00816    struct ast_frame dtmff;          /*!< DTMF frame */
00817    struct varshead varshead;        /*!< A linked list for channel variables. See \ref AstChanVar */
00818    ast_group_t callgroup;           /*!< Call group for call pickups */
00819    ast_group_t pickupgroup;         /*!< Pickup group - which calls groups can be picked up? */
00820    AST_LIST_HEAD_NOLOCK(, ast_frame) readq;
00821    struct ast_jb jb;          /*!< The jitterbuffer state */
00822    struct timeval dtmf_tv;          /*!< The time that an in process digit began, or the last digit ended */
00823    AST_LIST_HEAD_NOLOCK(datastores, ast_datastore) datastores; /*!< Data stores on the channel */
00824    AST_LIST_HEAD_NOLOCK(autochans, ast_autochan) autochans; /*!< Autochans on the channel */
00825 
00826    unsigned long insmpl;            /*!< Track the read/written samples for monitor use */
00827    unsigned long outsmpl;           /*!< Track the read/written samples for monitor use */
00828 
00829    int fds[AST_MAX_FDS];            /*!< File descriptors for channel -- Drivers will poll on
00830                       *   these file descriptors, so at least one must be non -1.
00831                       *   See \arg \ref AstFileDesc */
00832    int _softhangup;           /*!< Whether or not we have been hung up...  Do not set this value
00833                       *   directly, use ast_softhangup() */
00834    int fdno;               /*!< Which fd had an event detected on */
00835    int streamid;              /*!< For streaming playback, the schedule ID */
00836    int vstreamid;             /*!< For streaming video playback, the schedule ID */
00837    format_t oldwriteformat;      /*!< Original writer format */
00838    int timingfd;              /*!< Timing fd */
00839    enum ast_channel_state _state;         /*!< State of line -- Don't write directly, use ast_setstate() */
00840    int rings;              /*!< Number of rings so far */
00841    int priority;              /*!< Dialplan: Current extension priority */
00842    int macropriority;            /*!< Macro: Current non-macro priority. See app_macro.c */
00843    int amaflags;              /*!< Set BEFORE PBX is started to determine AMA flags */
00844    enum ast_channel_adsicpe adsicpe;      /*!< Whether or not ADSI is detected on CPE */
00845    unsigned int fin;          /*!< Frames in counters. The high bit is a debug mask, so
00846                       *   the counter is only in the remaining bits */
00847    unsigned int fout;            /*!< Frames out counters. The high bit is a debug mask, so
00848                       *   the counter is only in the remaining bits */
00849    int hangupcause;           /*!< Why is the channel hanged up. See causes.h */
00850    unsigned int flags;           /*!< channel flags of AST_FLAG_ type */
00851    int alertpipe[2];
00852    format_t nativeformats;         /*!< Kinds of data this channel can natively handle */
00853    format_t readformat;            /*!< Requested read format (after translation) */
00854    format_t writeformat;           /*!< Requested write format (after translation) */
00855    format_t rawreadformat;         /*!< Raw read format (before translation) */
00856    format_t rawwriteformat;        /*!< Raw write format (before translation) */
00857    unsigned int emulate_dtmf_duration;    /*!< Number of ms left to emulate DTMF for */
00858 #ifdef HAVE_EPOLL
00859    int epfd;
00860 #endif
00861    int visible_indication;                         /*!< Indication currently playing on the channel */
00862 
00863    unsigned short transfercapability;     /*!< ISDN Transfer Capability - AST_FLAG_DIGITAL is not enough */
00864 
00865    struct ast_bridge *bridge;                      /*!< Bridge this channel is participating in */
00866    struct ast_timer *timer;         /*!< timer object that provided timingfd */
00867 
00868    char context[AST_MAX_CONTEXT];         /*!< Dialplan: Current extension context */
00869    char exten[AST_MAX_EXTENSION];         /*!< Dialplan: Current extension number */
00870    char macrocontext[AST_MAX_CONTEXT];    /*!< Macro: Current non-macro context. See app_macro.c */
00871    char macroexten[AST_MAX_EXTENSION];    /*!< Macro: Current non-macro extension. See app_macro.c */
00872    char emulate_dtmf_digit;         /*!< Digit being emulated */
00873    char sending_dtmf_digit;         /*!< Digit this channel is currently sending out. (zero if not sending) */
00874    struct timeval sending_dtmf_tv;     /*!< The time this channel started sending the current digit. (Invalid if sending_dtmf_digit is zero.) */
00875 };
00876 
00877 /*! \brief ast_channel_tech Properties */
00878 enum {
00879    /*!
00880      * \brief Channels have this property if they can accept input with jitter;
00881     * i.e. most VoIP channels
00882     */
00883    AST_CHAN_TP_WANTSJITTER = (1 << 0),
00884    /*!
00885      * \brief Channels have this property if they can create jitter;
00886     * i.e. most VoIP channels
00887     */
00888    AST_CHAN_TP_CREATESJITTER = (1 << 1),
00889 };
00890 
00891 /*! \brief ast_channel flags */
00892 enum {
00893    /*! Queue incoming DTMF, to be released when this flag is turned off */
00894    AST_FLAG_DEFER_DTMF =    (1 << 1),
00895    /*! write should be interrupt generator */
00896    AST_FLAG_WRITE_INT =     (1 << 2),
00897    /*! a thread is blocking on this channel */
00898    AST_FLAG_BLOCKING =      (1 << 3),
00899    /*! This is a zombie channel */
00900    AST_FLAG_ZOMBIE =        (1 << 4),
00901    /*! There is an exception pending */
00902    AST_FLAG_EXCEPTION =     (1 << 5),
00903    /*! Listening to moh XXX anthm promises me this will disappear XXX */
00904    AST_FLAG_MOH =           (1 << 6),
00905    /*! This channel is spying on another channel */
00906    AST_FLAG_SPYING =        (1 << 7),
00907    /*! This channel is in a native bridge */
00908    AST_FLAG_NBRIDGE =       (1 << 8),
00909    /*! the channel is in an auto-incrementing dialplan processor,
00910     *  so when ->priority is set, it will get incremented before
00911     *  finding the next priority to run */
00912    AST_FLAG_IN_AUTOLOOP =   (1 << 9),
00913    /*! This is an outgoing call */
00914    AST_FLAG_OUTGOING =      (1 << 10),
00915    /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
00916    AST_FLAG_IN_DTMF =       (1 << 12),
00917    /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is
00918     *  currently being emulated */
00919    AST_FLAG_EMULATE_DTMF =  (1 << 13),
00920    /*! This is set to tell the channel not to generate DTMF begin frames, and
00921     *  to instead only generate END frames. */
00922    AST_FLAG_END_DTMF_ONLY = (1 << 14),
00923    /*! Flag to show channels that this call is hangup due to the fact that the call
00924        was indeed answered, but in another channel */
00925    AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15),
00926    /*! This flag indicates that on a masquerade, an active stream should not
00927     *  be carried over */
00928    AST_FLAG_MASQ_NOSTREAM = (1 << 16),
00929    /*! This flag indicates that the hangup exten was run when the bridge terminated,
00930     *  a message aimed at preventing a subsequent hangup exten being run at the pbx_run
00931     *  level */
00932    AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
00933    /*! This flag indicates that the hangup exten should NOT be run when the
00934     *  bridge terminates, this will allow the hangup in the pbx loop to be run instead.
00935     *  */
00936    AST_FLAG_BRIDGE_HANGUP_DONT = (1 << 18),
00937    /*! Disable certain workarounds.  This reintroduces certain bugs, but allows
00938     *  some non-traditional dialplans (like AGI) to continue to function.
00939     */
00940    AST_FLAG_DISABLE_WORKAROUNDS = (1 << 20),
00941    /*!
00942     * Disable device state event caching.  This allows channel
00943     * drivers to selectively prevent device state events from being
00944     * cached by certain channels such as anonymous calls which have
00945     * no persistent represenatation that can be tracked.
00946     */
00947    AST_FLAG_DISABLE_DEVSTATE_CACHE = (1 << 21),
00948    /*!
00949     * This flag indicates that a dual channel redirect is in
00950     * progress.  The bridge needs to wait until the flag is cleared
00951     * to continue.
00952     */
00953    AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT = (1 << 22),
00954    /*!
00955     * The data on chan->timingdata is an astobj2 object.
00956     */
00957    AST_FLAG_TIMINGDATA_IS_AO2_OBJ = (1 << 23),
00958 };
00959 
00960 /*! \brief ast_bridge_config flags */
00961 enum {
00962    AST_FEATURE_PLAY_WARNING = (1 << 0),
00963    AST_FEATURE_REDIRECT =     (1 << 1),
00964    AST_FEATURE_DISCONNECT =   (1 << 2),
00965    AST_FEATURE_ATXFER =       (1 << 3),
00966    AST_FEATURE_AUTOMON =      (1 << 4),
00967    AST_FEATURE_PARKCALL =     (1 << 5),
00968    AST_FEATURE_AUTOMIXMON =   (1 << 6),
00969    AST_FEATURE_NO_H_EXTEN =   (1 << 7),
00970    AST_FEATURE_WARNING_ACTIVE = (1 << 8),
00971 };
00972 
00973 /*! \brief bridge configuration */
00974 struct ast_bridge_config {
00975    struct ast_flags features_caller;
00976    struct ast_flags features_callee;
00977    struct timeval start_time;
00978    struct timeval nexteventts;
00979    struct timeval feature_start_time;
00980    long feature_timer;
00981    long timelimit;
00982    long play_warning;
00983    long warning_freq;
00984    const char *warning_sound;
00985    const char *end_sound;
00986    const char *start_sound;
00987    unsigned int flags;
00988    void (* end_bridge_callback)(void *);   /*!< A callback that is called after a bridge attempt */
00989    void *end_bridge_callback_data;         /*!< Data passed to the callback */
00990    /*! If the end_bridge_callback_data refers to a channel which no longer is going to
00991     * exist when the end_bridge_callback is called, then it needs to be fixed up properly
00992     */
00993    void (*end_bridge_callback_data_fixup)(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator);
00994 };
00995 
00996 struct chanmon;
00997 
00998 struct outgoing_helper {
00999    const char *context;
01000    const char *exten;
01001    int priority;
01002    const char *cid_num;
01003    const char *cid_name;
01004    const char *account;
01005    struct ast_variable *vars;
01006    struct ast_channel *parent_channel;
01007 };
01008 
01009 enum {
01010    /*!
01011     * Soft hangup requested by device or other internal reason.
01012     * Actual hangup needed.
01013     */
01014    AST_SOFTHANGUP_DEV =       (1 << 0),
01015    /*!
01016     * Used to break the normal frame flow so an async goto can be
01017     * done instead of actually hanging up.
01018     */
01019    AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
01020    /*!
01021     * Soft hangup requested by system shutdown.  Actual hangup
01022     * needed.
01023     */
01024    AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
01025    /*!
01026     * Used to break the normal frame flow after a timeout so an
01027     * implicit async goto can be done to the 'T' exten if it exists
01028     * instead of actually hanging up.  If the exten does not exist
01029     * then actually hangup.
01030     */
01031    AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
01032    /*!
01033     * Soft hangup requested by application/channel-driver being
01034     * unloaded.  Actual hangup needed.
01035     */
01036    AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
01037    /*!
01038     * Soft hangup requested by non-associated party.  Actual hangup
01039     * needed.
01040     */
01041    AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
01042    /*!
01043     * Used to break a bridge so the channel can be spied upon
01044     * instead of actually hanging up.
01045     */
01046    AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
01047 
01048 
01049    /*!
01050     * \brief All softhangup flags.
01051     *
01052     * This can be used as an argument to ast_channel_softhangup_clear
01053     * to clear all softhangup flags from a channel.
01054     */
01055    AST_SOFTHANGUP_ALL =       (0xFFFFFFFF)
01056 };
01057 
01058 
01059 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
01060 enum channelreloadreason {
01061    CHANNEL_MODULE_LOAD,
01062    CHANNEL_MODULE_RELOAD,
01063    CHANNEL_CLI_RELOAD,
01064    CHANNEL_MANAGER_RELOAD,
01065 };
01066 
01067 /*!
01068  * \note None of the datastore API calls lock the ast_channel they are using.
01069  *       So, the channel should be locked before calling the functions that
01070  *       take a channel argument.
01071  */
01072 
01073 /*!
01074  * \brief Create a channel data store object
01075  * \deprecated You should use the ast_datastore_alloc() generic function instead.
01076  * \version 1.6.1 deprecated
01077  */
01078 struct ast_datastore * attribute_malloc ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
01079    __attribute__((deprecated));
01080 
01081 /*!
01082  * \brief Free a channel data store object
01083  * \deprecated You should use the ast_datastore_free() generic function instead.
01084  * \version 1.6.1 deprecated
01085  */
01086 int ast_channel_datastore_free(struct ast_datastore *datastore)
01087    __attribute__((deprecated));
01088 
01089 /*! \brief Inherit datastores from a parent to a child. */
01090 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to);
01091 
01092 /*!
01093  * \brief Add a datastore to a channel
01094  *
01095  * \note The channel should be locked before calling this function.
01096  *
01097  * \retval 0 success
01098  * \retval non-zero failure
01099  */
01100 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore);
01101 
01102 /*!
01103  * \brief Remove a datastore from a channel
01104  *
01105  * \note The channel should be locked before calling this function.
01106  *
01107  * \retval 0 success
01108  * \retval non-zero failure
01109  */
01110 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore);
01111 
01112 /*!
01113  * \brief Find a datastore on a channel
01114  *
01115  * \note The channel should be locked before calling this function.
01116  *
01117  * \note The datastore returned from this function must not be used if the
01118  *       reference to the channel is released.
01119  *
01120  * \retval pointer to the datastore if found
01121  * \retval NULL if not found
01122  */
01123 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid);
01124 
01125 /*!
01126  * \brief Create a channel structure
01127  * \since 1.8
01128  *
01129  * \retval NULL failure
01130  * \retval non-NULL successfully allocated channel
01131  *
01132  * \note Absolutely _NO_ channel locks should be held before calling this function.
01133  * \note By default, new channels are set to the "s" extension
01134  *       and "default" context.
01135  */
01136 struct ast_channel * attribute_malloc __attribute__((format(printf, 13, 14)))
01137    __ast_channel_alloc(int needqueue, int state, const char *cid_num,
01138              const char *cid_name, const char *acctcode,
01139              const char *exten, const char *context,
01140              const char *linkedid, const int amaflag,
01141              const char *file, int line, const char *function,
01142              const char *name_fmt, ...);
01143 
01144 /*!
01145  * \brief Create a channel structure
01146  *
01147  * \retval NULL failure
01148  * \retval non-NULL successfully allocated channel
01149  *
01150  * \note Absolutely _NO_ channel locks should be held before calling this function.
01151  * \note By default, new channels are set to the "s" extension
01152  *       and "default" context.
01153  */
01154 #define ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, ...) \
01155    __ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, \
01156              __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
01157 
01158 #if defined(REF_DEBUG) || defined(__AST_DEBUG_MALLOC)
01159 /*!
01160  * \brief Create a fake channel structure
01161  *
01162  * \retval NULL failure
01163  * \retval non-NULL successfully allocated channel
01164  *
01165  * \note This function should ONLY be used to create a fake channel
01166  *       that can then be populated with data for use in variable
01167  *       substitution when a real channel does not exist.
01168  *
01169  * \note The created dummy channel should be destroyed by
01170  * ast_channel_unref().  Using ast_channel_release() needlessly
01171  * grabs the channel container lock and can cause a deadlock as
01172  * a result.  Also grabbing the channel container lock reduces
01173  * system performance.
01174  */
01175 #define ast_dummy_channel_alloc()   __ast_dummy_channel_alloc(__FILE__, __LINE__, __PRETTY_FUNCTION__)
01176 struct ast_channel *__ast_dummy_channel_alloc(const char *file, int line, const char *function);
01177 #else
01178 /*!
01179  * \brief Create a fake channel structure
01180  *
01181  * \retval NULL failure
01182  * \retval non-NULL successfully allocated channel
01183  *
01184  * \note This function should ONLY be used to create a fake channel
01185  *       that can then be populated with data for use in variable
01186  *       substitution when a real channel does not exist.
01187  *
01188  * \note The created dummy channel should be destroyed by
01189  * ast_channel_unref().  Using ast_channel_release() needlessly
01190  * grabs the channel container lock and can cause a deadlock as
01191  * a result.  Also grabbing the channel container lock reduces
01192  * system performance.
01193  */
01194 struct ast_channel *ast_dummy_channel_alloc(void);
01195 #endif
01196 
01197 /*!
01198  * \brief Queue one or more frames to a channel's frame queue
01199  *
01200  * \param chan the channel to queue the frame(s) on
01201  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
01202  *        by this function.  It is the responsibility of the caller to handle
01203  *        freeing the memory associated with the frame(s) being passed if
01204  *        necessary.
01205  *
01206  * \retval 0 success
01207  * \retval non-zero failure
01208  */
01209 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
01210 
01211 /*!
01212  * \brief Queue one or more frames to the head of a channel's frame queue
01213  *
01214  * \param chan the channel to queue the frame(s) on
01215  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
01216  *        by this function.  It is the responsibility of the caller to handle
01217  *        freeing the memory associated with the frame(s) being passed if
01218  *        necessary.
01219  *
01220  * \retval 0 success
01221  * \retval non-zero failure
01222  */
01223 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *f);
01224 
01225 /*!
01226  * \brief Queue a hangup frame
01227  *
01228  * \note The channel does not need to be locked before calling this function.
01229  */
01230 int ast_queue_hangup(struct ast_channel *chan);
01231 
01232 /*!
01233  * \brief Queue a hangup frame with hangupcause set
01234  *
01235  * \note The channel does not need to be locked before calling this function.
01236  * \param[in] chan channel to queue frame onto
01237  * \param[in] cause the hangup cause
01238  * \return 0 on success, -1 on error
01239  * \since 1.6.1
01240  */
01241 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause);
01242 
01243 /*!
01244  * \brief Queue a control frame with payload
01245  *
01246  * \param chan channel to queue frame onto
01247  * \param control type of control frame
01248  *
01249  * \note The channel does not need to be locked before calling this function.
01250  *
01251  * \retval zero on success
01252  * \retval non-zero on failure
01253  */
01254 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control);
01255 
01256 /*!
01257  * \brief Queue a control frame with payload
01258  *
01259  * \param chan channel to queue frame onto
01260  * \param control type of control frame
01261  * \param data pointer to payload data to be included in frame
01262  * \param datalen number of bytes of payload data
01263  *
01264  * \retval 0 success
01265  * \retval non-zero failure
01266  *
01267  * \details
01268  * The supplied payload data is copied into the frame, so the caller's copy
01269  * is not modified nor freed, and the resulting frame will retain a copy of
01270  * the data even if the caller frees their local copy.
01271  *
01272  * \note This method should be treated as a 'network transport'; in other
01273  * words, your frames may be transferred across an IAX2 channel to another
01274  * system, which may be a different endianness than yours. Because of this,
01275  * you should ensure that either your frames will never be expected to work
01276  * across systems, or that you always put your payload data into 'network byte
01277  * order' before calling this function.
01278  *
01279  * \note The channel does not need to be locked before calling this function.
01280  */
01281 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
01282             const void *data, size_t datalen);
01283 
01284 /*!
01285  * \brief Change channel name
01286  *
01287  * \pre Absolutely all channels _MUST_ be unlocked before calling this function.
01288  *
01289  * \param chan the channel to change the name of
01290  * \param newname the name to change to
01291  *
01292  * \return nothing
01293  *
01294  * \note this function must _NEVER_ be used when any channels are locked
01295  * regardless if it is the channel who's name is being changed or not because
01296  * it invalidates our channel container locking order... lock container first,
01297  * then the individual channels, never the other way around.
01298  */
01299 void ast_change_name(struct ast_channel *chan, const char *newname);
01300 
01301 /*!
01302  * \brief Unlink and release reference to a channel
01303  *
01304  * This function will unlink the channel from the global channels container
01305  * if it is still there and also release the current reference to the channel.
01306  *
01307  * \return NULL, convenient for clearing invalid pointers
01308  * \note Absolutely _NO_ channel locks should be held before calling this function.
01309  *
01310  * \since 1.8
01311  */
01312 struct ast_channel *ast_channel_release(struct ast_channel *chan);
01313 
01314 /*!
01315  * \brief Requests a channel
01316  *
01317  * \param type type of channel to request
01318  * \param format requested channel format (codec)
01319  * \param requestor channel asking for data
01320  * \param data data to pass to the channel requester (Should be treated as const char *)
01321  * \param status status
01322  *
01323  * \details
01324  * Request a channel of a given type, with data as optional information used
01325  * by the low level module
01326  *
01327  * \retval NULL failure
01328  * \retval non-NULL channel on success
01329  */
01330 struct ast_channel *ast_request(const char *type, format_t format, const struct ast_channel *requestor, void *data, int *status);
01331 
01332 /*!
01333  * \brief Request a channel of a given type, with data as optional information used
01334  *        by the low level module and attempt to place a call on it
01335  *
01336  * \param type type of channel to request
01337  * \param format requested channel format
01338  * \param requestor channel asking for data
01339  * \param data data to pass to the channel requester
01340  * \param timeout maximum amount of time to wait for an answer
01341  * \param reason why unsuccessful (if unsuccessful)
01342  * \param cid_num Caller-ID Number
01343  * \param cid_name Caller-ID Name (ascii)
01344  *
01345  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
01346  * to know if the call was answered or not.
01347  */
01348 struct ast_channel *ast_request_and_dial(const char *type, format_t format, const struct ast_channel *requestor, void *data,
01349    int timeout, int *reason, const char *cid_num, const char *cid_name);
01350 
01351 /*!
01352  * \brief Request a channel of a given type, with data as optional information used
01353  * by the low level module and attempt to place a call on it
01354  * \param type type of channel to request
01355  * \param format requested channel format
01356  * \param requestor channel requesting data
01357  * \param data data to pass to the channel requester
01358  * \param timeout maximum amount of time to wait for an answer
01359  * \param reason why unsuccessful (if unsuccessful)
01360  * \param cid_num Caller-ID Number
01361  * \param cid_name Caller-ID Name (ascii)
01362  * \param oh Outgoing helper
01363  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
01364  * to know if the call was answered or not.
01365  */
01366 struct ast_channel *__ast_request_and_dial(const char *type, format_t format, const struct ast_channel *requestor, void *data,
01367    int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
01368 
01369 /*!
01370  * \brief Forwards a call to a new channel specified by the original channel's call_forward str.  If possible, the new forwarded channel is created and returned while the original one is terminated.
01371  * \param caller in channel that requested orig
01372  * \param orig channel being replaced by the call forward channel
01373  * \param timeout maximum amount of time to wait for setup of new forward channel
01374  * \param format requested channel format
01375  * \param oh outgoing helper used with original channel
01376  * \param outstate reason why unsuccessful (if uncuccessful)
01377  * \return Returns the forwarded call's ast_channel on success or NULL on failure
01378  */
01379 struct ast_channel *ast_call_forward(struct ast_channel *caller, struct ast_channel *orig, int *timeout, format_t format, struct outgoing_helper *oh, int *outstate);
01380 
01381 /*!
01382  * \brief Register a channel technology (a new channel driver)
01383  * Called by a channel module to register the kind of channels it supports.
01384  * \param tech Structure defining channel technology or "type"
01385  * \return Returns 0 on success, -1 on failure.
01386  */
01387 int ast_channel_register(const struct ast_channel_tech *tech);
01388 
01389 /*!
01390  * \brief Unregister a channel technology
01391  * \param tech Structure defining channel technology or "type" that was previously registered
01392  * \return No return value.
01393  */
01394 void ast_channel_unregister(const struct ast_channel_tech *tech);
01395 
01396 /*!
01397  * \brief Get a channel technology structure by name
01398  * \param name name of technology to find
01399  * \return a pointer to the structure, or NULL if no matching technology found
01400  */
01401 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
01402 
01403 #ifdef CHANNEL_TRACE
01404 /*!
01405  * \brief Update the context backtrace if tracing is enabled
01406  * \return Returns 0 on success, -1 on failure
01407  */
01408 int ast_channel_trace_update(struct ast_channel *chan);
01409 
01410 /*!
01411  * \brief Enable context tracing in the channel
01412  * \return Returns 0 on success, -1 on failure
01413  */
01414 int ast_channel_trace_enable(struct ast_channel *chan);
01415 
01416 /*!
01417  * \brief Disable context tracing in the channel.
01418  * \note Does not remove current trace entries
01419  * \return Returns 0 on success, -1 on failure
01420  */
01421 int ast_channel_trace_disable(struct ast_channel *chan);
01422 
01423 /*!
01424  * \brief Whether or not context tracing is enabled
01425  * \return Returns -1 when the trace is enabled. 0 if not.
01426  */
01427 int ast_channel_trace_is_enabled(struct ast_channel *chan);
01428 
01429 /*!
01430  * \brief Put the channel backtrace in a string
01431  * \return Returns the amount of lines in the backtrace. -1 on error.
01432  */
01433 int ast_channel_trace_serialize(struct ast_channel *chan, struct ast_str **out);
01434 #endif
01435 
01436 /*!
01437  * \brief Hang up a channel
01438  * \note Absolutely _NO_ channel locks should be held before calling this function.
01439  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
01440  * performs all stream stopping, etc, on the channel that needs to end.
01441  * chan is no longer valid after this call.
01442  * \param chan channel to hang up
01443  * \return Returns 0 on success, -1 on failure.
01444  */
01445 int ast_hangup(struct ast_channel *chan);
01446 
01447 /*!
01448  * \brief Softly hangup up a channel
01449  *
01450  * \param chan channel to be soft-hung-up
01451  * \param reason an AST_SOFTHANGUP_* reason code
01452  *
01453  * \details
01454  * Call the protocol layer, but don't destroy the channel structure
01455  * (use this if you are trying to
01456  * safely hangup a channel managed by another thread.
01457  *
01458  * \note The channel passed to this function does not need to be locked.
01459  *
01460  * \return Returns 0 regardless
01461  */
01462 int ast_softhangup(struct ast_channel *chan, int reason);
01463 
01464 /*!
01465  * \brief Softly hangup up a channel (no channel lock)
01466  * \param chan channel to be soft-hung-up
01467  * \param reason an AST_SOFTHANGUP_* reason code
01468  */
01469 int ast_softhangup_nolock(struct ast_channel *chan, int reason);
01470 
01471 /*!
01472  * \brief Clear a set of softhangup flags from a channel
01473  *
01474  * Never clear a softhangup flag from a channel directly.  Instead,
01475  * use this function.  This ensures that all aspects of the softhangup
01476  * process are aborted.
01477  *
01478  * \param chan the channel to clear the flag on
01479  * \param flag the flag or flags to clear
01480  *
01481  * \return Nothing.
01482  */
01483 void ast_channel_clear_softhangup(struct ast_channel *chan, int flag);
01484 
01485 /*!
01486  * \brief Set the source of the hangup in this channel and it's bridge
01487  *
01488  * \param chan channel to set the field on
01489  * \param source a string describing the source of the hangup for this channel
01490  * \param force
01491  *
01492  * \note Absolutely _NO_ channel locks should be held before calling this function.
01493  *
01494  * \since 1.8
01495  *
01496  * Hangupsource is generally the channel name that caused the bridge to be
01497  * hung up, but it can also be other things such as "dialplan/agi"
01498  * This can then be logged in the CDR or CEL
01499  */
01500 void ast_set_hangupsource(struct ast_channel *chan, const char *source, int force);
01501 
01502 /*! \brief Check to see if a channel is needing hang up
01503  * \param chan channel on which to check for hang up
01504  * This function determines if the channel is being requested to be hung up.
01505  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
01506  */
01507 int ast_check_hangup(struct ast_channel *chan);
01508 
01509 int ast_check_hangup_locked(struct ast_channel *chan);
01510 
01511 /*!
01512  * \brief Compare a offset with the settings of when to hang a channel up
01513  * \param chan channel on which to check for hang up
01514  * \param offset offset in seconds from current time
01515  * \return 1, 0, or -1
01516  * \details
01517  * This function compares a offset from current time with the absolute time
01518  * out on a channel (when to hang up). If the absolute time out on a channel
01519  * is earlier than current time plus the offset, it returns 1, if the two
01520  * time values are equal, it return 0, otherwise, it return -1.
01521  * \sa ast_channel_cmpwhentohangup_tv()
01522  * \version 1.6.1 deprecated function (only had seconds precision)
01523  */
01524 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
01525 
01526 /*!
01527  * \brief Compare a offset with the settings of when to hang a channel up
01528  * \param chan channel on which to check for hangup
01529  * \param offset offset in seconds and microseconds from current time
01530  * \return 1, 0, or -1
01531  * This function compares a offset from current time with the absolute time
01532  * out on a channel (when to hang up). If the absolute time out on a channel
01533  * is earlier than current time plus the offset, it returns 1, if the two
01534  * time values are equal, it return 0, otherwise, it return -1.
01535  * \since 1.6.1
01536  */
01537 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
01538 
01539 /*!
01540  * \brief Set when to hang a channel up
01541  *
01542  * \param chan channel on which to check for hang up
01543  * \param offset offset in seconds relative to the current time of when to hang up
01544  *
01545  * \details
01546  * This function sets the absolute time out on a channel (when to hang up).
01547  *
01548  * \note This function does not require that the channel is locked before
01549  *       calling it.
01550  *
01551  * \return Nothing
01552  * \sa ast_channel_setwhentohangup_tv()
01553  * \version 1.6.1 deprecated function (only had seconds precision)
01554  */
01555 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
01556 
01557 /*!
01558  * \brief Set when to hang a channel up
01559  *
01560  * \param chan channel on which to check for hang up
01561  * \param offset offset in seconds and useconds relative to the current time of when to hang up
01562  *
01563  * This function sets the absolute time out on a channel (when to hang up).
01564  *
01565  * \note This function does not require that the channel is locked before
01566  * calling it.
01567  *
01568  * \return Nothing
01569  * \since 1.6.1
01570  */
01571 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
01572 
01573 /*!
01574  * \brief Answer a channel
01575  *
01576  * \param chan channel to answer
01577  *
01578  * \details
01579  * This function answers a channel and handles all necessary call
01580  * setup functions.
01581  *
01582  * \note The channel passed does not need to be locked, but is locked
01583  * by the function when needed.
01584  *
01585  * \note This function will wait up to 500 milliseconds for media to
01586  * arrive on the channel before returning to the caller, so that the
01587  * caller can properly assume the channel is 'ready' for media flow.
01588  *
01589  * \retval 0 on success
01590  * \retval non-zero on failure
01591  */
01592 int ast_answer(struct ast_channel *chan);
01593 
01594 /*!
01595  * \brief Answer a channel
01596  *
01597  * \param chan channel to answer
01598  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
01599  *
01600  * This function answers a channel and handles all necessary call
01601  * setup functions.
01602  *
01603  * \note The channel passed does not need to be locked, but is locked
01604  * by the function when needed.
01605  *
01606  * \note Unlike ast_answer(), this function will not wait for media
01607  * flow to begin. The caller should be careful before sending media
01608  * to the channel before incoming media arrives, as the outgoing
01609  * media may be lost.
01610  *
01611  * \retval 0 on success
01612  * \retval non-zero on failure
01613  */
01614 int ast_raw_answer(struct ast_channel *chan, int cdr_answer);
01615 
01616 /*!
01617  * \brief Answer a channel, with a selectable delay before returning
01618  *
01619  * \param chan channel to answer
01620  * \param delay maximum amount of time to wait for incoming media
01621  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
01622  *
01623  * This function answers a channel and handles all necessary call
01624  * setup functions.
01625  *
01626  * \note The channel passed does not need to be locked, but is locked
01627  * by the function when needed.
01628  *
01629  * \note This function will wait up to 'delay' milliseconds for media to
01630  * arrive on the channel before returning to the caller, so that the
01631  * caller can properly assume the channel is 'ready' for media flow. If
01632  * 'delay' is less than 500, the function will wait up to 500 milliseconds.
01633  *
01634  * \retval 0 on success
01635  * \retval non-zero on failure
01636  */
01637 int __ast_answer(struct ast_channel *chan, unsigned int delay, int cdr_answer);
01638 
01639 /*!
01640  * \brief Make a call
01641  * \note Absolutely _NO_ channel locks should be held before calling this function.
01642  * \param chan which channel to make the call on
01643  * \param addr destination of the call (Should be treated as const char *)
01644  * \param timeout time to wait on for connect
01645  * \details
01646  * Place a call, take no longer than timeout ms.
01647  * \return -1 on failure, 0 on not enough time
01648  * (does not automatically stop ringing), and
01649  * the number of seconds the connect took otherwise.
01650  */
01651 int ast_call(struct ast_channel *chan, char *addr, int timeout);
01652 
01653 /*!
01654  * \brief Indicates condition of channel
01655  * \note Absolutely _NO_ channel locks should be held before calling this function.
01656  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
01657  * \param chan channel to change the indication
01658  * \param condition which condition to indicate on the channel
01659  * \return Returns 0 on success, -1 on failure
01660  */
01661 int ast_indicate(struct ast_channel *chan, int condition);
01662 
01663 /*!
01664  * \brief Indicates condition of channel, with payload
01665  * \note Absolutely _NO_ channel locks should be held before calling this function.
01666  * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
01667  * \param chan channel to change the indication
01668  * \param condition which condition to indicate on the channel
01669  * \param data pointer to payload data
01670  * \param datalen size of payload data
01671  * \return Returns 0 on success, -1 on failure
01672  */
01673 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
01674 
01675 /* Misc stuff ------------------------------------------------ */
01676 
01677 /*!
01678  * \brief Wait for input on a channel
01679  * \param chan channel to wait on
01680  * \param ms length of time to wait on the channel
01681  * \details
01682  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
01683  * \retval < 0 on failure
01684  * \retval 0 if nothing ever arrived
01685  * \retval the # of ms remaining otherwise
01686  */
01687 int ast_waitfor(struct ast_channel *chan, int ms);
01688 
01689 /*!
01690  * \brief Should we keep this frame for later?
01691  *
01692  * There are functions such as ast_safe_sleep which will
01693  * service a channel to ensure that it does not have a
01694  * large backlog of queued frames. When this happens,
01695  * we want to hold on to specific frame types and just drop
01696  * others. This function will tell if the frame we just
01697  * read should be held onto.
01698  *
01699  * \param frame The frame we just read
01700  * \retval 1 frame should be kept
01701  * \retval 0 frame should be dropped
01702  */
01703 int ast_is_deferrable_frame(const struct ast_frame *frame);
01704 
01705 /*!
01706  * \brief Wait for a specified amount of time, looking for hangups
01707  * \param chan channel to wait for
01708  * \param ms length of time in milliseconds to sleep. This should never be less than zero.
01709  * \details
01710  * Waits for a specified amount of time, servicing the channel as required.
01711  * \return returns -1 on hangup, otherwise 0.
01712  */
01713 int ast_safe_sleep(struct ast_channel *chan, int ms);
01714 
01715 /*!
01716  * \brief Wait for a specified amount of time, looking for hangups and a condition argument
01717  * \param chan channel to wait for
01718  * \param ms length of time in milliseconds to sleep.
01719  * \param cond a function pointer for testing continue condition
01720  * \param data argument to be passed to the condition test function
01721  * \return returns -1 on hangup, otherwise 0.
01722  * \details
01723  * Waits for a specified amount of time, servicing the channel as required. If cond
01724  * returns 0, this function returns.
01725  */
01726 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
01727 
01728 /*!
01729  * \brief Waits for activity on a group of channels
01730  * \param chan an array of pointers to channels
01731  * \param n number of channels that are to be waited upon
01732  * \param fds an array of fds to wait upon
01733  * \param nfds the number of fds to wait upon
01734  * \param exception exception flag
01735  * \param outfd fd that had activity on it
01736  * \param ms how long the wait was
01737  * \details
01738  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
01739  * file descriptors.
01740  * \return Returns the channel with activity, or NULL on error or if an FD
01741  * came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
01742  * will be -1
01743  */
01744 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n,
01745    int *fds, int nfds, int *exception, int *outfd, int *ms);
01746 
01747 /*!
01748  * \brief Waits for input on a group of channels
01749  * Wait for input on an array of channels for a given # of milliseconds.
01750  * \return Return channel with activity, or NULL if none has activity.
01751  * \param chan an array of pointers to channels
01752  * \param n number of channels that are to be waited upon
01753  * \param ms time "ms" is modified in-place, if applicable
01754  */
01755 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
01756 
01757 /*!
01758  * \brief Waits for input on an fd
01759  * \note This version works on fd's only.  Be careful with it.
01760  */
01761 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
01762 
01763 
01764 /*!
01765  * \brief Reads a frame
01766  * \param chan channel to read a frame from
01767  * \return Returns a frame, or NULL on error.  If it returns NULL, you
01768  * best just stop reading frames and assume the channel has been
01769  * disconnected.
01770  */
01771 struct ast_frame *ast_read(struct ast_channel *chan);
01772 
01773 /*!
01774  * \brief Reads a frame, returning AST_FRAME_NULL frame if audio.
01775  * \param chan channel to read a frame from
01776  * \return  Returns a frame, or NULL on error.  If it returns NULL, you
01777  * best just stop reading frames and assume the channel has been
01778  * disconnected.
01779  * \note Audio is replaced with AST_FRAME_NULL to avoid
01780  * transcode when the resulting audio is not necessary.
01781  */
01782 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
01783 
01784 /*!
01785  * \brief Write a frame to a channel
01786  * This function writes the given frame to the indicated channel.
01787  * \param chan destination channel of the frame
01788  * \param frame frame that will be written
01789  * \return It returns 0 on success, -1 on failure.
01790  */
01791 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
01792 
01793 /*!
01794  * \brief Write video frame to a channel
01795  * This function writes the given frame to the indicated channel.
01796  * \param chan destination channel of the frame
01797  * \param frame frame that will be written
01798  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
01799  */
01800 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
01801 
01802 /*!
01803  * \brief Write text frame to a channel
01804  * This function writes the given frame to the indicated channel.
01805  * \param chan destination channel of the frame
01806  * \param frame frame that will be written
01807  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
01808  */
01809 int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
01810 
01811 /*! \brief Send empty audio to prime a channel driver */
01812 int ast_prod(struct ast_channel *chan);
01813 
01814 /*!
01815  * \brief Sets read format on channel chan
01816  * Set read format for channel to whichever component of "format" is best.
01817  * \param chan channel to change
01818  * \param format format to change to
01819  * \return Returns 0 on success, -1 on failure
01820  */
01821 int ast_set_read_format(struct ast_channel *chan, format_t format);
01822 
01823 /*!
01824  * \brief Sets write format on channel chan
01825  * Set write format for channel to whichever component of "format" is best.
01826  * \param chan channel to change
01827  * \param format new format for writing
01828  * \return Returns 0 on success, -1 on failure
01829  */
01830 int ast_set_write_format(struct ast_channel *chan, format_t format);
01831 
01832 /*!
01833  * \brief Sends text to a channel
01834  *
01835  * \param chan channel to act upon
01836  * \param text string of text to send on the channel
01837  *
01838  * \details
01839  * Write text to a display on a channel
01840  *
01841  * \note The channel does not need to be locked before calling this function.
01842  *
01843  * \retval 0 on success
01844  * \retval -1 on failure
01845  */
01846 int ast_sendtext(struct ast_channel *chan, const char *text);
01847 
01848 /*!
01849  * \brief Receives a text character from a channel
01850  * \param chan channel to act upon
01851  * \param timeout timeout in milliseconds (0 for infinite wait)
01852  * \details
01853  * Read a char of text from a channel
01854  * \return 0 on success, -1 on failure
01855  */
01856 int ast_recvchar(struct ast_channel *chan, int timeout);
01857 
01858 /*!
01859  * \brief Send a DTMF digit to a channel.
01860  * \param chan channel to act upon
01861  * \param digit the DTMF digit to send, encoded in ASCII
01862  * \param duration the duration of the digit ending in ms
01863  * \return 0 on success, -1 on failure
01864  */
01865 int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
01866 
01867 /*!
01868  * \brief Send a DTMF digit to a channel.
01869  * \param chan channel to act upon
01870  * \param digit the DTMF digit to send, encoded in ASCII
01871  * \return 0 on success, -1 on failure
01872  */
01873 int ast_senddigit_begin(struct ast_channel *chan, char digit);
01874 
01875 /*!
01876  * \brief Send a DTMF digit to a channel.
01877  * \param chan channel to act upon
01878  * \param digit the DTMF digit to send, encoded in ASCII
01879  * \param duration the duration of the digit ending in ms
01880  * \return Returns 0 on success, -1 on failure
01881  */
01882 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
01883 
01884 /*!
01885  * \brief Receives a text string from a channel
01886  * Read a string of text from a channel
01887  * \param chan channel to act upon
01888  * \param timeout timeout in milliseconds (0 for infinite wait)
01889  * \return the received text, or NULL to signify failure.
01890  */
01891 char *ast_recvtext(struct ast_channel *chan, int timeout);
01892 
01893 /*!
01894  * \brief Waits for a digit
01895  * \param c channel to wait for a digit on
01896  * \param ms how many milliseconds to wait (<0 for indefinite).
01897  * \return Returns <0 on error, 0 on no entry, and the digit on success.
01898  */
01899 int ast_waitfordigit(struct ast_channel *c, int ms);
01900 
01901 /*!
01902  * \brief Wait for a digit
01903  * Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
01904  * \param c channel to wait for a digit on
01905  * \param ms how many milliseconds to wait (<0 for indefinite).
01906  * \param audiofd audio file descriptor to write to if audio frames are received
01907  * \param ctrlfd control file descriptor to monitor for reading
01908  * \return Returns 1 if ctrlfd becomes available
01909  */
01910 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
01911 
01912 /*!
01913  * \brief Reads multiple digits
01914  * \param c channel to read from
01915  * \param s string to read in to.  Must be at least the size of your length
01916  * \param len how many digits to read (maximum)
01917  * \param timeout how long to timeout between digits
01918  * \param rtimeout timeout to wait on the first digit
01919  * \param enders digits to end the string
01920  * \details
01921  * Read in a digit string "s", max length "len", maximum timeout between
01922  * digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
01923  * for the first digit.
01924  * \return Returns 0 on normal return, or 1 on a timeout.  In the case of
01925  * a timeout, any digits that were read before the timeout will still be available in s.
01926  * RETURNS 2 in full version when ctrlfd is available, NOT 1
01927  */
01928 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
01929 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
01930 
01931 /*! \brief Report DTMF on channel 0 */
01932 #define AST_BRIDGE_DTMF_CHANNEL_0      (1 << 0)
01933 /*! \brief Report DTMF on channel 1 */
01934 #define AST_BRIDGE_DTMF_CHANNEL_1      (1 << 1)
01935 /*! \brief Return all voice frames on channel 0 */
01936 #define AST_BRIDGE_REC_CHANNEL_0    (1 << 2)
01937 /*! \brief Return all voice frames on channel 1 */
01938 #define AST_BRIDGE_REC_CHANNEL_1    (1 << 3)
01939 /*! \brief Ignore all signal frames except NULL */
01940 #define AST_BRIDGE_IGNORE_SIGS         (1 << 4)
01941 
01942 
01943 /*!
01944  * \brief Makes two channel formats compatible
01945  * \param c0 first channel to make compatible
01946  * \param c1 other channel to make compatible
01947  * \details
01948  * Set two channels to compatible formats -- call before ast_channel_bridge in general.
01949  * \return Returns 0 on success and -1 if it could not be done
01950  */
01951 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
01952 
01953 /*!
01954  * \brief Bridge two channels together (early)
01955  * \param c0 first channel to bridge
01956  * \param c1 second channel to bridge
01957  * \details
01958  * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
01959  * \return Returns 0 on success and -1 if it could not be done
01960  */
01961 int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
01962 
01963 /*!
01964  * \brief Bridge two channels together
01965  * \param c0 first channel to bridge
01966  * \param c1 second channel to bridge
01967  * \param config config for the channels
01968  * \param fo destination frame(?)
01969  * \param rc destination channel(?)
01970  * \details
01971  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
01972  * *rf (remember, it could be NULL) and which channel (0 or 1) in rc
01973  */
01974 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
01975 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,
01976    struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc);
01977 
01978 /*!
01979  * \brief Weird function made for call transfers
01980  *
01981  * \param original channel to make a copy of
01982  * \param clone copy of the original channel
01983  *
01984  * \details
01985  * This is a very strange and freaky function used primarily for transfer.  Suppose that
01986  * "original" and "clone" are two channels in random situations.  This function takes
01987  * the guts out of "clone" and puts them into the "original" channel, then alerts the
01988  * channel driver of the change, asking it to fixup any private information (like the
01989  * p->owner pointer) that is affected by the change.  The physical layer of the original
01990  * channel is hung up.
01991  *
01992  * \note Neither channel passed here should be locked before
01993  * calling this function.  This function performs deadlock
01994  * avoidance involving these two channels.
01995  */
01996 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
01997 
01998 /*!
01999  * \brief Setup a masquerade to transfer a call.
02000  * \since 1.8
02001  *
02002  * \param target_chan Target of the call transfer.  (Masquerade original channel)
02003  * \param target_id New connected line information for the target channel.
02004  * \param target_held TRUE if the target call is on hold.
02005  * \param transferee_chan Transferee of the call transfer. (Masquerade clone channel)
02006  * \param transferee_id New connected line information for the transferee channel.
02007  * \param transferee_held TRUE if the transferee call is on hold.
02008  *
02009  * \details
02010  * Party A - Transferee
02011  * Party B - Transferer
02012  * Party C - Target of transfer
02013  *
02014  * Party B transfers A to C.
02015  *
02016  * Party A is connected to bridged channel B1.
02017  * Party B is connected to channels C1 and C2.
02018  * Party C is connected to bridged channel B2.
02019  *
02020  * Party B -- C1 == B1 -- Party A
02021  *               __/
02022  *              /
02023  * Party B -- C2 == B2 -- Party C
02024  *
02025  * Bridged channel B1 is masqueraded into channel C2.  Where B1
02026  * is the masquerade clone channel and C2 is the masquerade
02027  * original channel.
02028  *
02029  * \see ast_channel_masquerade()
02030  *
02031  * \note Has the same locking requirements as ast_channel_masquerade().
02032  *
02033  * \retval 0 on success.
02034  * \retval -1 on error.
02035  */
02036 int ast_channel_transfer_masquerade(
02037    struct ast_channel *target_chan,
02038    const struct ast_party_connected_line *target_id,
02039    int target_held,
02040    struct ast_channel *transferee_chan,
02041    const struct ast_party_connected_line *transferee_id,
02042    int transferee_held);
02043 
02044 /*!
02045  * \brief Gives the string form of a given cause code.
02046  *
02047  * \param state cause to get the description of
02048  * \return the text form of the binary cause code given
02049  */
02050 const char *ast_cause2str(int state) attribute_pure;
02051 
02052 /*!
02053  * \brief Convert the string form of a cause code to a number
02054  *
02055  * \param name string form of the cause
02056  * \return the cause code
02057  */
02058 int ast_str2cause(const char *name) attribute_pure;
02059 
02060 /*!
02061  * \brief Gives the string form of a given channel state
02062  *
02063  * \param ast_channel_state state to get the name of
02064  * \return the text form of the binary state given
02065  */
02066 const char *ast_state2str(enum ast_channel_state);
02067 
02068 /*!
02069  * \brief Gives the string form of a given transfer capability
02070  *
02071  * \param transfercapability transfer capability to get the name of
02072  * \return the text form of the binary transfer capability
02073  */
02074 char *ast_transfercapability2str(int transfercapability) attribute_const;
02075 
02076 /*
02077  * Options: Some low-level drivers may implement "options" allowing fine tuning of the
02078  * low level channel.  See frame.h for options.  Note that many channel drivers may support
02079  * none or a subset of those features, and you should not count on this if you want your
02080  * asterisk application to be portable.  They're mainly useful for tweaking performance
02081  */
02082 
02083 /*!
02084  * \brief Sets an option on a channel
02085  *
02086  * \param channel channel to set options on
02087  * \param option option to change
02088  * \param data data specific to option
02089  * \param datalen length of the data
02090  * \param block blocking or not
02091  * \details
02092  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply
02093  * \return 0 on success and -1 on failure
02094  */
02095 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
02096 
02097 /*! Pick the best codec
02098  * Choose the best codec...  Uhhh...   Yah. */
02099 format_t ast_best_codec(format_t fmts);
02100 
02101 
02102 /*!
02103  * \brief Checks the value of an option
02104  *
02105  * Query the value of an option
02106  * Works similarly to setoption except only reads the options.
02107  */
02108 int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
02109 
02110 /*!
02111  * \brief Checks for HTML support on a channel
02112  * \return 0 if channel does not support HTML or non-zero if it does
02113  */
02114 int ast_channel_supports_html(struct ast_channel *channel);
02115 
02116 /*!
02117  * \brief Sends HTML on given channel
02118  * Send HTML or URL on link.
02119  * \return 0 on success or -1 on failure
02120  */
02121 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
02122 
02123 /*!
02124  * \brief Sends a URL on a given link
02125  * Send URL on link.
02126  * \return 0 on success or -1 on failure
02127  */
02128 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
02129 
02130 /*!
02131  * \brief Defers DTMF so that you only read things like hangups and audio.
02132  * \return non-zero if channel was already DTMF-deferred or
02133  * 0 if channel is just now being DTMF-deferred
02134  */
02135 int ast_channel_defer_dtmf(struct ast_channel *chan);
02136 
02137 /*! Undo defer.  ast_read will return any DTMF characters that were queued */
02138 void ast_channel_undefer_dtmf(struct ast_channel *chan);
02139 
02140 /*! Initiate system shutdown -- prevents new channels from being allocated.
02141  * \param hangup  If "hangup" is non-zero, all existing channels will receive soft
02142  *  hangups */
02143 void ast_begin_shutdown(int hangup);
02144 
02145 /*! Cancels an existing shutdown and returns to normal operation */
02146 void ast_cancel_shutdown(void);
02147 
02148 /*! \return number of channels available for lookup */
02149 int ast_active_channels(void);
02150 
02151 /*! \return the number of channels not yet destroyed */
02152 int ast_undestroyed_channels(void);
02153 
02154 /*! \return non-zero if Asterisk is being shut down */
02155 int ast_shutting_down(void);
02156 
02157 /*! Activate a given generator */
02158 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
02159 
02160 /*! Deactivate an active generator */
02161 void ast_deactivate_generator(struct ast_channel *chan);
02162 
02163 /*!
02164  * \brief Set caller ID number, name and ANI and generate AMI event.
02165  *
02166  * \note Use ast_channel_set_caller() and ast_channel_set_caller_event() instead.
02167  * \note The channel does not need to be locked before calling this function.
02168  */
02169 void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
02170 
02171 /*!
02172  * \brief Set the caller id information in the Asterisk channel
02173  * \since 1.8
02174  *
02175  * \param chan Asterisk channel to set caller id information
02176  * \param caller Caller id information
02177  * \param update What caller information to update.  NULL if all.
02178  *
02179  * \return Nothing
02180  *
02181  * \note The channel does not need to be locked before calling this function.
02182  */
02183 void ast_channel_set_caller(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
02184 
02185 /*!
02186  * \brief Set the caller id information in the Asterisk channel and generate an AMI event
02187  * if the caller id name or number changed.
02188  * \since 1.8
02189  *
02190  * \param chan Asterisk channel to set caller id information
02191  * \param caller Caller id information
02192  * \param update What caller information to update.  NULL if all.
02193  *
02194  * \return Nothing
02195  *
02196  * \note The channel does not need to be locked before calling this function.
02197  */
02198 void ast_channel_set_caller_event(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
02199 
02200 /*! Set the file descriptor on the channel */
02201 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
02202 
02203 /*! Add a channel to an optimized waitfor */
02204 void ast_poll_channel_add(struct ast_channel *chan0, struct ast_channel *chan1);
02205 
02206 /*! Delete a channel from an optimized waitfor */
02207 void ast_poll_channel_del(struct ast_channel *chan0, struct ast_channel *chan1);
02208 
02209 /*! Start a tone going */
02210 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
02211 /*! Stop a tone from playing */
02212 void ast_tonepair_stop(struct ast_channel *chan);
02213 /*! Play a tone pair for a given amount of time */
02214 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
02215 
02216 /*!
02217  * \brief Automatically service a channel for us...
02218  *
02219  * \retval 0 success
02220  * \retval -1 failure, or the channel is already being autoserviced
02221  */
02222 int ast_autoservice_start(struct ast_channel *chan);
02223 
02224 /*!
02225  * \brief Stop servicing a channel for us...
02226  *
02227  * \note if chan is locked prior to calling ast_autoservice_stop, it
02228  * is likely that there will be a deadlock between the thread that calls
02229  * ast_autoservice_stop and the autoservice thread. It is important
02230  * that chan is not locked prior to this call
02231  *
02232  * \param chan
02233  * \retval 0 success
02234  * \retval -1 error, or the channel has been hungup
02235  */
02236 int ast_autoservice_stop(struct ast_channel *chan);
02237 
02238 /*!
02239  * \brief Ignore certain frame types
02240  * \note Normally, we cache DTMF, IMAGE, HTML, TEXT, and CONTROL frames
02241  * while a channel is in autoservice and queue them up when taken out of
02242  * autoservice.  When this is not desireable, this API may be used to
02243  * cause the channel to ignore those frametypes after the channel is put
02244  * into autoservice, but before autoservice is stopped.
02245  * \retval 0 success
02246  * \retval -1 channel is not in autoservice
02247  */
02248 int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype);
02249 
02250 /*!
02251  * \brief Enable or disable timer ticks for a channel
02252  *
02253  * \param c channel
02254  * \param rate number of timer ticks per second
02255  * \param func callback function
02256  * \param data
02257  *
02258  * \details
02259  * If timers are supported, force a scheduled expiration on the
02260  * timer fd, at which point we call the callback function / data
02261  *
02262  * \note Call this function with a rate of 0 to turn off the timer ticks
02263  *
02264  * \version 1.6.1 changed samples parameter to rate, accomodates new timing methods
02265  */
02266 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
02267 int ast_settimeout_full(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data, unsigned int is_ao2_obj);
02268 
02269 /*!
02270  * \brief Transfer a channel (if supported).
02271  * \retval -1 on error
02272  * \retval 0 if not supported
02273  * \retval 1 if supported and requested
02274  * \param chan current channel
02275  * \param dest destination extension for transfer
02276  */
02277 int ast_transfer(struct ast_channel *chan, char *dest);
02278 
02279 /*!
02280  * \brief Start masquerading a channel
02281  * \note absolutely _NO_ channel locks should be held before calling this function.
02282  * \details
02283  * XXX This is a seriously whacked out operation.  We're essentially putting the guts of
02284  *     the clone channel into the original channel.  Start by killing off the original
02285  *     channel's backend.   I'm not sure we're going to keep this function, because
02286  *     while the features are nice, the cost is very high in terms of pure nastiness. XXX
02287  * \param chan Channel to masquerade
02288  */
02289 int ast_do_masquerade(struct ast_channel *chan);
02290 
02291 /*!
02292  * \brief Find bridged channel
02293  *
02294  * \note This function does _not_ return a reference to the bridged channel.
02295  * The reason for this is mostly historical.  It _should_ return a reference,
02296  * but it will take a lot of work to make the code base account for that.
02297  * So, for now, the old rules still apply for how to handle this function.
02298  * If this function is being used from the channel thread that owns the channel,
02299  * then a reference is already held, and channel locking is not required to
02300  * guarantee that the channel will stay around.  If this function is used
02301  * outside of the associated channel thread, the channel parameter 'chan'
02302  * MUST be locked before calling this function.  Also, 'chan' must remain locked
02303  * for the entire time that the result of this function is being used.
02304  *
02305  * \param chan Current channel
02306  *
02307  * \return A pointer to the bridged channel
02308 */
02309 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
02310 
02311 /*!
02312  * \brief Inherits channel variable from parent to child channel
02313  * \param parent Parent channel
02314  * \param child Child channel
02315  *
02316  * \details
02317  * Scans all channel variables in the parent channel, looking for those
02318  * that should be copied into the child channel.
02319  * Variables whose names begin with a single '_' are copied into the
02320  * child channel with the prefix removed.
02321  * Variables whose names begin with '__' are copied into the child
02322  * channel with their names unchanged.
02323  */
02324 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
02325 
02326 /*!
02327  * \brief adds a list of channel variables to a channel
02328  * \param chan the channel
02329  * \param vars a linked list of variables
02330  *
02331  * \details
02332  * Variable names can be for a regular channel variable or a dialplan function
02333  * that has the ability to be written to.
02334  */
02335 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
02336 
02337 /*!
02338  * \brief An opaque 'object' structure use by silence generators on channels.
02339  */
02340 struct ast_silence_generator;
02341 
02342 /*!
02343  * \brief Starts a silence generator on the given channel.
02344  * \param chan The channel to generate silence on
02345  * \return An ast_silence_generator pointer, or NULL if an error occurs
02346  *
02347  * \details
02348  * This function will cause SLINEAR silence to be generated on the supplied
02349  * channel until it is disabled; if the channel cannot be put into SLINEAR
02350  * mode then the function will fail.
02351  *
02352  * \note
02353  * The pointer returned by this function must be preserved and passed to
02354  * ast_channel_stop_silence_generator when you wish to stop the silence
02355  * generation.
02356  */
02357 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
02358 
02359 /*!
02360  * \brief Stops a previously-started silence generator on the given channel.
02361  * \param chan The channel to operate on
02362  * \param state The ast_silence_generator pointer return by a previous call to
02363  * ast_channel_start_silence_generator.
02364  * \return nothing
02365  *
02366  * \details
02367  * This function will stop the operating silence generator and return the channel
02368  * to its previous write format.
02369  */
02370 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
02371 
02372 /*!
02373  * \brief Check if the channel can run in internal timing mode.
02374  * \param chan The channel to check
02375  * \return boolean
02376  *
02377  * \details
02378  * This function will return 1 if internal timing is enabled and the timing
02379  * device is available.
02380  */
02381 int ast_internal_timing_enabled(struct ast_channel *chan);
02382 
02383 /* Misc. functions below */
02384 
02385 /*!
02386  * \brief if fd is a valid descriptor, set *pfd with the descriptor
02387  * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
02388  * return value to the index into the array)
02389  */
02390 static inline int ast_add_fd(struct pollfd *pfd, int fd)
02391 {
02392    pfd->fd = fd;
02393    pfd->events = POLLIN | POLLPRI;
02394    return fd >= 0;
02395 }
02396 
02397 /*! \brief Helper function for migrating select to poll */
02398 static inline int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
02399 {
02400    int x;
02401    int dummy = 0;
02402 
02403    if (fd < 0)
02404       return 0;
02405    if (!start)
02406       start = &dummy;
02407    for (x = *start; x < maximum; x++)
02408       if (pfds[x].fd == fd) {
02409          if (x == *start)
02410             (*start)++;
02411          return pfds[x].revents;
02412       }
02413    return 0;
02414 }
02415 
02416 /*! \brief Retrieves the current T38 state of a channel */
02417 static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
02418 {
02419    enum ast_t38_state state = T38_STATE_UNAVAILABLE;
02420    int datalen = sizeof(state);
02421 
02422    ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
02423 
02424    return state;
02425 }
02426 
02427 #define CHECK_BLOCKING(c) do {    \
02428    if (ast_test_flag(c, AST_FLAG_BLOCKING)) {\
02429       ast_debug(1, "Thread %p is blocking '%s', already blocked by thread %p in procedure %s\n", \
02430          (void *) pthread_self(), (c)->name, (void *) (c)->blocker, (c)->blockproc); \
02431    } else { \
02432       (c)->blocker = pthread_self(); \
02433       (c)->blockproc = __PRETTY_FUNCTION__; \
02434       ast_set_flag(c, AST_FLAG_BLOCKING); \
02435    } } while (0)
02436 
02437 ast_group_t ast_get_group(const char *s);
02438 
02439 /*! \brief print call- and pickup groups into buffer */
02440 char *ast_print_group(char *buf, int buflen, ast_group_t group);
02441 
02442 /*!
02443  * \brief Convert enum channelreloadreason to text string for manager event
02444  * \param reason The reason for reload (manager, cli, start etc)
02445  */
02446 const char *channelreloadreason2txt(enum channelreloadreason reason);
02447 
02448 /*! \brief return an ast_variable list of channeltypes */
02449 struct ast_variable *ast_channeltype_list(void);
02450 
02451 /*!
02452  * \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
02453  * \param reason  The integer argument, usually taken from AST_CONTROL_ macros
02454  * \return char pointer explaining the code
02455  */
02456 const char *ast_channel_reason2str(int reason);
02457 
02458 /*! \brief channel group info */
02459 struct ast_group_info {
02460    struct ast_channel *chan;
02461    char *category;
02462    char *group;
02463    AST_LIST_ENTRY(ast_group_info) group_list;
02464 };
02465 
02466 #define ast_channel_lock(chan) ao2_lock(chan)
02467 #define ast_channel_unlock(chan) ao2_unlock(chan)
02468 #define ast_channel_trylock(chan) ao2_trylock(chan)
02469 
02470 /*!
02471  * \brief Lock two channels.
02472  */
02473 #define ast_channel_lock_both(chan1, chan2) do { \
02474       ast_channel_lock(chan1); \
02475       while (ast_channel_trylock(chan2)) { \
02476          ast_channel_unlock(chan1); \
02477          sched_yield(); \
02478          ast_channel_lock(chan1); \
02479       } \
02480    } while (0)
02481 
02482 /*!
02483  * \brief Increase channel reference count
02484  *
02485  * \param c the channel
02486  *
02487  * \retval c always
02488  *
02489  * \since 1.8
02490  */
02491 #define ast_channel_ref(c) ({ ao2_ref(c, +1); (c); })
02492 
02493 /*!
02494  * \brief Decrease channel reference count
02495  *
02496  * \param c the channel
02497  *
02498  * \retval NULL always
02499  *
02500  * \since 1.8
02501  */
02502 #define ast_channel_unref(c) ({ ao2_ref(c, -1); (struct ast_channel *) (NULL); })
02503 
02504 /*! Channel Iterating @{ */
02505 
02506 /*!
02507  * \brief A channel iterator
02508  *
02509  * This is an opaque type.
02510  */
02511 struct ast_channel_iterator;
02512 
02513 /*!
02514  * \brief Destroy a channel iterator
02515  *
02516  * \arg i the itereator to destroy
02517  *
02518  * This function is used to destroy a channel iterator that was retrieved by
02519  * using one of the channel_iterator_new() functions.
02520  *
02521  * \return NULL, for convenience to clear out the pointer to the iterator that
02522  * was just destroyed.
02523  *
02524  * \since 1.8
02525  */
02526 struct ast_channel_iterator *ast_channel_iterator_destroy(struct ast_channel_iterator *i);
02527 
02528 /*!
02529  * \brief Create a new channel iterator based on extension
02530  *
02531  * \arg exten The extension that channels must be in
02532  * \arg context The context that channels must be in (optional)
02533  *
02534  * After creating an iterator using this function, the ast_channel_iterator_next()
02535  * function can be used to iterate through all channels that are currently
02536  * in the specified context and extension.
02537  *
02538  * \retval NULL on failure
02539  * \retval a new channel iterator based on the specified parameters
02540  *
02541  * \since 1.8
02542  */
02543 struct ast_channel_iterator *ast_channel_iterator_by_exten_new(const char *exten, const char *context);
02544 
02545 /*!
02546  * \brief Create a new channel iterator based on name
02547  *
02548  * \arg name channel name or channel uniqueid to match
02549  * \arg name_len number of characters in the channel name to match on.  This
02550  *      would be used to match based on name prefix.  If matching on the full
02551  *      channel name is desired, then this parameter should be 0.
02552  *
02553  * After creating an iterator using this function, the ast_channel_iterator_next()
02554  * function can be used to iterate through all channels that exist that have
02555  * the specified name or name prefix.
02556  *
02557  * \retval NULL on failure
02558  * \retval a new channel iterator based on the specified parameters
02559  *
02560  * \since 1.8
02561  */
02562 struct ast_channel_iterator *ast_channel_iterator_by_name_new(const char *name,  size_t name_len);
02563 
02564 /*!
02565  * \brief Create a new channel iterator
02566  *
02567  * After creating an iterator using this function, the ast_channel_iterator_next()
02568  * function can be used to iterate through all channels that exist.
02569  *
02570  * \retval NULL on failure
02571  * \retval a new channel iterator
02572  *
02573  * \since 1.8
02574  */
02575 struct ast_channel_iterator *ast_channel_iterator_all_new(void);
02576 
02577 /*!
02578  * \brief Get the next channel for a channel iterator
02579  *
02580  * \arg i the channel iterator that was created using one of the
02581  *  channel_iterator_new() functions.
02582  *
02583  * This function should be used to iterate through all channels that match a
02584  * specified set of parameters that were provided when the iterator was created.
02585  *
02586  * \retval the next channel that matches the parameters used when the iterator
02587  *         was created.
02588  * \retval NULL, if no more channels match the iterator parameters.
02589  *
02590  * \since 1.8
02591  */
02592 struct ast_channel *ast_channel_iterator_next(struct ast_channel_iterator *i);
02593 
02594 /*! @} End channel iterator definitions. */
02595 
02596 /*!
02597  * \brief Call a function with every active channel
02598  *
02599  * This function executes a callback one time for each active channel on the
02600  * system.  The channel is provided as an argument to the function.
02601  *
02602  * \note Absolutely _NO_ channel locks should be held before calling this function.
02603  * \since 1.8
02604  */
02605 struct ast_channel *ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg,
02606       void *data, int ao2_flags);
02607 
02608 /*! @{ Channel search functions */
02609 
02610 /*!
02611  * \brief Find a channel by name
02612  *
02613  * \arg name the name or uniqueid of the channel to search for
02614  *
02615  * Find a channel that has the same name as the provided argument.
02616  *
02617  * \retval a channel with the name specified by the argument
02618  * \retval NULL if no channel was found
02619  *
02620  * \since 1.8
02621  */
02622 struct ast_channel *ast_channel_get_by_name(const char *name);
02623 
02624 /*!
02625  * \brief Find a channel by a name prefix
02626  *
02627  * \arg name The channel name or uniqueid prefix to search for
02628  * \arg name_len Only search for up to this many characters from the name
02629  *
02630  * Find a channel that has the same name prefix as specified by the arguments.
02631  *
02632  * \retval a channel with the name prefix specified by the arguments
02633  * \retval NULL if no channel was found
02634  *
02635  * \since 1.8
02636  */
02637 struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len);
02638 
02639 /*!
02640  * \brief Find a channel by extension and context
02641  *
02642  * \arg exten the extension to search for
02643  * \arg context the context to search for (optional)
02644  *
02645  * Return a channel that is currently at the specified extension and context.
02646  *
02647  * \retval a channel that is at the specified extension and context
02648  * \retval NULL if no channel was found
02649  *
02650  * \since 1.8
02651  */
02652 struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context);
02653 
02654 /*! @} End channel search functions. */
02655 
02656 /*!
02657   \brief propagate the linked id between chan and peer
02658  */
02659 void ast_channel_set_linkgroup(struct ast_channel *chan, struct ast_channel *peer);
02660 
02661 
02662 /*!
02663  * \brief Initialize the given name structure.
02664  * \since 1.8
02665  *
02666  * \param init Name structure to initialize.
02667  *
02668  * \return Nothing
02669  */
02670 void ast_party_name_init(struct ast_party_name *init);
02671 
02672 /*!
02673  * \brief Copy the source party name information to the destination party name.
02674  * \since 1.8
02675  *
02676  * \param dest Destination party name
02677  * \param src Source party name
02678  *
02679  * \return Nothing
02680  */
02681 void ast_party_name_copy(struct ast_party_name *dest, const struct ast_party_name *src);
02682 
02683 /*!
02684  * \brief Initialize the given party name structure using the given guide
02685  * for a set update operation.
02686  * \since 1.8
02687  *
02688  * \details
02689  * The initialization is needed to allow a set operation to know if a
02690  * value needs to be updated.  Simple integers need the guide's original
02691  * value in case the set operation is not trying to set a new value.
02692  * String values are simply set to NULL pointers if they are not going
02693  * to be updated.
02694  *
02695  * \param init Party name structure to initialize.
02696  * \param guide Source party name to use as a guide in initializing.
02697  *
02698  * \return Nothing
02699  */
02700 void ast_party_name_set_init(struct ast_party_name *init, const struct ast_party_name *guide);
02701 
02702 /*!
02703  * \brief Set the source party name information into the destination party name.
02704  * \since 1.8
02705  *
02706  * \param dest The name one wishes to update
02707  * \param src The new name values to update the dest
02708  *
02709  * \return Nothing
02710  */
02711 void ast_party_name_set(struct ast_party_name *dest, const struct ast_party_name *src);
02712 
02713 /*!
02714  * \brief Destroy the party name contents
02715  * \since 1.8
02716  *
02717  * \param doomed The party name to destroy.
02718  *
02719  * \return Nothing
02720  */
02721 void ast_party_name_free(struct ast_party_name *doomed);
02722 
02723 /*!
02724  * \brief Initialize the given number structure.
02725  * \since 1.8
02726  *
02727  * \param init Number structure to initialize.
02728  *
02729  * \return Nothing
02730  */
02731 void ast_party_number_init(struct ast_party_number *init);
02732 
02733 /*!
02734  * \brief Copy the source party number information to the destination party number.
02735  * \since 1.8
02736  *
02737  * \param dest Destination party number
02738  * \param src Source party number
02739  *
02740  * \return Nothing
02741  */
02742 void ast_party_number_copy(struct ast_party_number *dest, const struct ast_party_number *src);
02743 
02744 /*!
02745  * \brief Initialize the given party number structure using the given guide
02746  * for a set update operation.
02747  * \since 1.8
02748  *
02749  * \details
02750  * The initialization is needed to allow a set operation to know if a
02751  * value needs to be updated.  Simple integers need the guide's original
02752  * value in case the set operation is not trying to set a new value.
02753  * String values are simply set to NULL pointers if they are not going
02754  * to be updated.
02755  *
02756  * \param init Party number structure to initialize.
02757  * \param guide Source party number to use as a guide in initializing.
02758  *
02759  * \return Nothing
02760  */
02761 void ast_party_number_set_init(struct ast_party_number *init, const struct ast_party_number *guide);
02762 
02763 /*!
02764  * \brief Set the source party number information into the destination party number.
02765  * \since 1.8
02766  *
02767  * \param dest The number one wishes to update
02768  * \param src The new number values to update the dest
02769  *
02770  * \return Nothing
02771  */
02772 void ast_party_number_set(struct ast_party_number *dest, const struct ast_party_number *src);
02773 
02774 /*!
02775  * \brief Destroy the party number contents
02776  * \since 1.8
02777  *
02778  * \param doomed The party number to destroy.
02779  *
02780  * \return Nothing
02781  */
02782 void ast_party_number_free(struct ast_party_number *doomed);
02783 
02784 /*!
02785  * \since 1.8
02786  * \brief Initialize the given subaddress structure.
02787  *
02788  * \param init Subaddress structure to initialize.
02789  *
02790  * \return Nothing
02791  */
02792 void ast_party_subaddress_init(struct ast_party_subaddress *init);
02793 
02794 /*!
02795  * \since 1.8
02796  * \brief Copy the source party subaddress information to the destination party subaddress.
02797  *
02798  * \param dest Destination party subaddress
02799  * \param src Source party subaddress
02800  *
02801  * \return Nothing
02802  */
02803 void ast_party_subaddress_copy(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
02804 
02805 /*!
02806  * \since 1.8
02807  * \brief Initialize the given party subaddress structure using the given guide
02808  * for a set update operation.
02809  *
02810  * \details
02811  * The initialization is needed to allow a set operation to know if a
02812  * value needs to be updated.  Simple integers need the guide's original
02813  * value in case the set operation is not trying to set a new value.
02814  * String values are simply set to NULL pointers if they are not going
02815  * to be updated.
02816  *
02817  * \param init Party subaddress structure to initialize.
02818  * \param guide Source party subaddress to use as a guide in initializing.
02819  *
02820  * \return Nothing
02821  */
02822 void ast_party_subaddress_set_init(struct ast_party_subaddress *init, const struct ast_party_subaddress *guide);
02823 
02824 /*!
02825  * \since 1.8
02826  * \brief Set the source party subaddress information into the destination party subaddress.
02827  *
02828  * \param dest The subaddress one wishes to update
02829  * \param src The new subaddress values to update the dest
02830  *
02831  * \return Nothing
02832  */
02833 void ast_party_subaddress_set(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
02834 
02835 /*!
02836  * \since 1.8
02837  * \brief Destroy the party subaddress contents
02838  *
02839  * \param doomed The party subaddress to destroy.
02840  *
02841  * \return Nothing
02842  */
02843 void ast_party_subaddress_free(struct ast_party_subaddress *doomed);
02844 
02845 /*!
02846  * \brief Initialize the given party id structure.
02847  * \since 1.8
02848  *
02849  * \param init Party id structure to initialize.
02850  *
02851  * \return Nothing
02852  */
02853 void ast_party_id_init(struct ast_party_id *init);
02854 
02855 /*!
02856  * \brief Copy the source party id information to the destination party id.
02857  * \since 1.8
02858  *
02859  * \param dest Destination party id
02860  * \param src Source party id
02861  *
02862  * \return Nothing
02863  */
02864 void ast_party_id_copy(struct ast_party_id *dest, const struct ast_party_id *src);
02865 
02866 /*!
02867  * \brief Initialize the given party id structure using the given guide
02868  * for a set update operation.
02869  * \since 1.8
02870  *
02871  * \details
02872  * The initialization is needed to allow a set operation to know if a
02873  * value needs to be updated.  Simple integers need the guide's original
02874  * value in case the set operation is not trying to set a new value.
02875  * String values are simply set to NULL pointers if they are not going
02876  * to be updated.
02877  *
02878  * \param init Party id structure to initialize.
02879  * \param guide Source party id to use as a guide in initializing.
02880  *
02881  * \return Nothing
02882  */
02883 void ast_party_id_set_init(struct ast_party_id *init, const struct ast_party_id *guide);
02884 
02885 /*!
02886  * \brief Set the source party id information into the destination party id.
02887  * \since 1.8
02888  *
02889  * \param dest The id one wishes to update
02890  * \param src The new id values to update the dest
02891  * \param update What id information to update.  NULL if all.
02892  *
02893  * \return Nothing
02894  */
02895 void ast_party_id_set(struct ast_party_id *dest, const struct ast_party_id *src, const struct ast_set_party_id *update);
02896 
02897 /*!
02898  * \brief Destroy the party id contents
02899  * \since 1.8
02900  *
02901  * \param doomed The party id to destroy.
02902  *
02903  * \return Nothing
02904  */
02905 void ast_party_id_free(struct ast_party_id *doomed);
02906 
02907 /*!
02908  * \brief Determine the overall presentation value for the given party.
02909  * \since 1.8
02910  *
02911  * \param id Party to determine the overall presentation value.
02912  *
02913  * \return Overall presentation value for the given party.
02914  */
02915 int ast_party_id_presentation(const struct ast_party_id *id);
02916 
02917 /*!
02918  * \brief Initialize the given dialed structure.
02919  * \since 1.8
02920  *
02921  * \param init Dialed structure to initialize.
02922  *
02923  * \return Nothing
02924  */
02925 void ast_party_dialed_init(struct ast_party_dialed *init);
02926 
02927 /*!
02928  * \brief Copy the source dialed party information to the destination dialed party.
02929  * \since 1.8
02930  *
02931  * \param dest Destination dialed party
02932  * \param src Source dialed party
02933  *
02934  * \return Nothing
02935  */
02936 void ast_party_dialed_copy(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
02937 
02938 /*!
02939  * \brief Initialize the given dialed structure using the given
02940  * guide for a set update operation.
02941  * \since 1.8
02942  *
02943  * \details
02944  * The initialization is needed to allow a set operation to know if a
02945  * value needs to be updated.  Simple integers need the guide's original
02946  * value in case the set operation is not trying to set a new value.
02947  * String values are simply set to NULL pointers if they are not going
02948  * to be updated.
02949  *
02950  * \param init Caller structure to initialize.
02951  * \param guide Source dialed to use as a guide in initializing.
02952  *
02953  * \return Nothing
02954  */
02955 void ast_party_dialed_set_init(struct ast_party_dialed *init, const struct ast_party_dialed *guide);
02956 
02957 /*!
02958  * \brief Set the dialed information based on another dialed source
02959  * \since 1.8
02960  *
02961  * This is similar to ast_party_dialed_copy, except that NULL values for
02962  * strings in the src parameter indicate not to update the corresponding dest values.
02963  *
02964  * \param dest The dialed one wishes to update
02965  * \param src The new dialed values to update the dest
02966  *
02967  * \return Nada
02968  */
02969 void ast_party_dialed_set(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
02970 
02971 /*!
02972  * \brief Destroy the dialed party contents
02973  * \since 1.8
02974  *
02975  * \param doomed The dialed party to destroy.
02976  *
02977  * \return Nothing
02978  */
02979 void ast_party_dialed_free(struct ast_party_dialed *doomed);
02980 
02981 /*!
02982  * \since 1.8
02983  * \brief Initialize the given caller structure.
02984  *
02985  * \param init Caller structure to initialize.
02986  *
02987  * \return Nothing
02988  */
02989 void ast_party_caller_init(struct ast_party_caller *init);
02990 
02991 /*!
02992  * \since 1.8
02993  * \brief Copy the source caller information to the destination caller.
02994  *
02995  * \param dest Destination caller
02996  * \param src Source caller
02997  *
02998  * \return Nothing
02999  */
03000 void ast_party_caller_copy(struct ast_party_caller *dest, const struct ast_party_caller *src);
03001 
03002 /*!
03003  * \brief Initialize the given caller structure using the given
03004  * guide for a set update operation.
03005  * \since 1.8
03006  *
03007  * \details
03008  * The initialization is needed to allow a set operation to know if a
03009  * value needs to be updated.  Simple integers need the guide's original
03010  * value in case the set operation is not trying to set a new value.
03011  * String values are simply set to NULL pointers if they are not going
03012  * to be updated.
03013  *
03014  * \param init Caller structure to initialize.
03015  * \param guide Source caller to use as a guide in initializing.
03016  *
03017  * \return Nothing
03018  */
03019 void ast_party_caller_set_init(struct ast_party_caller *init, const struct ast_party_caller *guide);
03020 
03021 /*!
03022  * \brief Set the caller information based on another caller source
03023  * \since 1.8
03024  *
03025  * This is similar to ast_party_caller_copy, except that NULL values for
03026  * strings in the src parameter indicate not to update the corresponding dest values.
03027  *
03028  * \param dest The caller one wishes to update
03029  * \param src The new caller values to update the dest
03030  * \param update What caller information to update.  NULL if all.
03031  *
03032  * \return Nada
03033  */
03034 void ast_party_caller_set(struct ast_party_caller *dest, const struct ast_party_caller *src, const struct ast_set_party_caller *update);
03035 
03036 /*!
03037  * \brief Destroy the caller party contents
03038  * \since 1.8
03039  *
03040  * \param doomed The caller party to destroy.
03041  *
03042  * \return Nothing
03043  */
03044 void ast_party_caller_free(struct ast_party_caller *doomed);
03045 
03046 /*!
03047  * \since 1.8
03048  * \brief Initialize the given connected line structure.
03049  *
03050  * \param init Connected line structure to initialize.
03051  *
03052  * \return Nothing
03053  */
03054 void ast_party_connected_line_init(struct ast_party_connected_line *init);
03055 
03056 /*!
03057  * \since 1.8
03058  * \brief Copy the source connected line information to the destination connected line.
03059  *
03060  * \param dest Destination connected line
03061  * \param src Source connected line
03062  *
03063  * \return Nothing
03064  */
03065 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
03066 
03067 /*!
03068  * \since 1.8
03069  * \brief Initialize the given connected line structure using the given
03070  * guide for a set update operation.
03071  *
03072  * \details
03073  * The initialization is needed to allow a set operation to know if a
03074  * value needs to be updated.  Simple integers need the guide's original
03075  * value in case the set operation is not trying to set a new value.
03076  * String values are simply set to NULL pointers if they are not going
03077  * to be updated.
03078  *
03079  * \param init Connected line structure to initialize.
03080  * \param guide Source connected line to use as a guide in initializing.
03081  *
03082  * \return Nothing
03083  */
03084 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
03085 
03086 /*!
03087  * \since 1.8
03088  * \brief Set the connected line information based on another connected line source
03089  *
03090  * This is similar to ast_party_connected_line_copy, except that NULL values for
03091  * strings in the src parameter indicate not to update the corresponding dest values.
03092  *
03093  * \param dest The connected line one wishes to update
03094  * \param src The new connected line values to update the dest
03095  * \param update What connected line information to update.  NULL if all.
03096  *
03097  * \return Nothing
03098  */
03099 void ast_party_connected_line_set(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src, const struct ast_set_party_connected_line *update);
03100 
03101 /*!
03102  * \since 1.8
03103  * \brief Collect the caller party information into a connected line structure.
03104  *
03105  * \param connected Collected caller information for the connected line
03106  * \param caller Caller information.
03107  *
03108  * \return Nothing
03109  *
03110  * \warning This is a shallow copy.
03111  * \warning DO NOT call ast_party_connected_line_free() on the filled in
03112  * connected line structure!
03113  */
03114 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_party_caller *caller);
03115 
03116 /*!
03117  * \since 1.8
03118  * \brief Destroy the connected line information contents
03119  *
03120  * \param doomed The connected line information to destroy.
03121  *
03122  * \return Nothing
03123  */
03124 void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
03125 
03126 /*!
03127  * \brief Initialize the given redirecting structure.
03128  * \since 1.8
03129  *
03130  * \param init Redirecting structure to initialize.
03131  *
03132  * \return Nothing
03133  */
03134 void ast_party_redirecting_init(struct ast_party_redirecting *init);
03135 
03136 /*!
03137  * \since 1.8
03138  * \brief Copy the source redirecting information to the destination redirecting.
03139  *
03140  * \param dest Destination redirecting
03141  * \param src Source redirecting
03142  *
03143  * \return Nothing
03144  */
03145 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
03146 
03147 /*!
03148  * \since 1.8
03149  * \brief Initialize the given redirecting id structure using the given guide
03150  * for a set update operation.
03151  *
03152  * \details
03153  * The initialization is needed to allow a set operation to know if a
03154  * value needs to be updated.  Simple integers need the guide's original
03155  * value in case the set operation is not trying to set a new value.
03156  * String values are simply set to NULL pointers if they are not going
03157  * to be updated.
03158  *
03159  * \param init Redirecting id structure to initialize.
03160  * \param guide Source redirecting id to use as a guide in initializing.
03161  *
03162  * \return Nothing
03163  */
03164 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
03165 
03166 /*!
03167  * \brief Set the redirecting information based on another redirecting source
03168  * \since 1.8
03169  *
03170  * This is similar to ast_party_redirecting_copy, except that NULL values for
03171  * strings in the src parameter indicate not to update the corresponding dest values.
03172  *
03173  * \param dest The redirecting one wishes to update
03174  * \param src The new redirecting values to update the dest
03175  * \param update What redirecting information to update.  NULL if all.
03176  *
03177  * \return Nothing
03178  */
03179 void ast_party_redirecting_set(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src, const struct ast_set_party_redirecting *update);
03180 
03181 /*!
03182  * \since 1.8
03183  * \brief Destroy the redirecting information contents
03184  *
03185  * \param doomed The redirecting information to destroy.
03186  *
03187  * \return Nothing
03188  */
03189 void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
03190 
03191 /*!
03192  * \since 1.8
03193  * \brief Copy the caller information to the connected line information.
03194  *
03195  * \param dest Destination connected line information
03196  * \param src Source caller information
03197  *
03198  * \return Nothing
03199  *
03200  * \note Assumes locks are already acquired
03201  */
03202 void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_party_caller *src);
03203 
03204 /*!
03205  * \since 1.8
03206  * \brief Copy the connected line information to the caller information.
03207  *
03208  * \param dest Destination caller information
03209  * \param src Source connected line information
03210  *
03211  * \return Nothing
03212  *
03213  * \note Assumes locks are already acquired
03214  */
03215 void ast_connected_line_copy_to_caller(struct ast_party_caller *dest, const struct ast_party_connected_line *src);
03216 
03217 /*!
03218  * \since 1.8
03219  * \brief Set the connected line information in the Asterisk channel
03220  *
03221  * \param chan Asterisk channel to set connected line information
03222  * \param connected Connected line information
03223  * \param update What connected line information to update.  NULL if all.
03224  *
03225  * \return Nothing
03226  *
03227  * \note The channel does not need to be locked before calling this function.
03228  */
03229 void ast_channel_set_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
03230 
03231 /*!
03232  * \since 1.8
03233  * \brief Build the connected line information data frame.
03234  *
03235  * \param data Buffer to fill with the frame data
03236  * \param datalen Size of the buffer to fill
03237  * \param connected Connected line information
03238  * \param update What connected line information to build.  NULL if all.
03239  *
03240  * \retval -1 if error
03241  * \retval Amount of data buffer used
03242  */
03243 int ast_connected_line_build_data(unsigned char *data, size_t datalen, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
03244 
03245 /*!
03246  * \since 1.8
03247  * \brief Parse connected line indication frame data
03248  *
03249  * \param data Buffer with the frame data to parse
03250  * \param datalen Size of the buffer
03251  * \param connected Extracted connected line information
03252  *
03253  * \retval 0 on success.
03254  * \retval -1 on error.
03255  *
03256  * \note The filled in connected line structure needs to be initialized by
03257  * ast_party_connected_line_set_init() before calling.  If defaults are not
03258  * required use ast_party_connected_line_init().
03259  * \note The filled in connected line structure needs to be destroyed by
03260  * ast_party_connected_line_free() when it is no longer needed.
03261  */
03262 int ast_connected_line_parse_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
03263 
03264 /*!
03265  * \since 1.8
03266  * \brief Indicate that the connected line information has changed
03267  *
03268  * \param chan Asterisk channel to indicate connected line information
03269  * \param connected Connected line information
03270  * \param update What connected line information to update.  NULL if all.
03271  *
03272  * \return Nothing
03273  */
03274 void ast_channel_update_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
03275 
03276 /*!
03277  * \since 1.8
03278  * \brief Queue a connected line update frame on a channel
03279  *
03280  * \param chan Asterisk channel to indicate connected line information
03281  * \param connected Connected line information
03282  * \param update What connected line information to update.  NULL if all.
03283  *
03284  * \return Nothing
03285  */
03286 void ast_channel_queue_connected_line_update(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
03287 
03288 /*!
03289  * \since 1.8
03290  * \brief Set the redirecting id information in the Asterisk channel
03291  *
03292  * \param chan Asterisk channel to set redirecting id information
03293  * \param redirecting Redirecting id information
03294  * \param update What redirecting information to update.  NULL if all.
03295  *
03296  * \return Nothing
03297  *
03298  * \note The channel does not need to be locked before calling this function.
03299  */
03300 void ast_channel_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
03301 
03302 /*!
03303  * \since 1.8
03304  * \brief Build the redirecting id data frame.
03305  *
03306  * \param data Buffer to fill with the frame data
03307  * \param datalen Size of the buffer to fill
03308  * \param redirecting Redirecting id information
03309  * \param update What redirecting information to build.  NULL if all.
03310  *
03311  * \retval -1 if error
03312  * \retval Amount of data buffer used
03313  */
03314 int ast_redirecting_build_data(unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
03315 
03316 /*!
03317  * \since 1.8
03318  * \brief Parse redirecting indication frame data
03319  *
03320  * \param data Buffer with the frame data to parse
03321  * \param datalen Size of the buffer
03322  * \param redirecting Extracted redirecting id information
03323  *
03324  * \retval 0 on success.
03325  * \retval -1 on error.
03326  *
03327  * \note The filled in id structure needs to be initialized by
03328  * ast_party_redirecting_set_init() before calling.
03329  * \note The filled in id structure needs to be destroyed by
03330  * ast_party_redirecting_free() when it is no longer needed.
03331  */
03332 int ast_redirecting_parse_data(const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting);
03333 
03334 /*!
03335  * \since 1.8
03336  * \brief Indicate that the redirecting id has changed
03337  *
03338  * \param chan Asterisk channel to indicate redirecting id information
03339  * \param redirecting Redirecting id information
03340  * \param update What redirecting information to update.  NULL if all.
03341  *
03342  * \return Nothing
03343  */
03344 void ast_channel_update_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
03345 
03346 /*!
03347  * \since 1.8
03348  * \brief Queue a redirecting update frame on a channel
03349  *
03350  * \param chan Asterisk channel to indicate redirecting id information
03351  * \param redirecting Redirecting id information
03352  * \param update What redirecting information to update.  NULL if all.
03353  *
03354  * \return Nothing
03355  */
03356 void ast_channel_queue_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
03357 
03358 /*!
03359  * \since 1.8
03360  * \brief Run a connected line interception macro and update a channel's connected line
03361  * information
03362  *
03363  * Whenever we want to update a channel's connected line information, we may need to run
03364  * a macro so that an administrator can manipulate the information before sending it
03365  * out. This function both runs the macro and sends the update to the channel.
03366  *
03367  * \param autoservice_chan Channel to place into autoservice while the macro is running.
03368  *    It is perfectly safe for this to be NULL
03369  * \param macro_chan The channel to run the macro on. Also the channel from which we
03370  *    determine which macro we need to run.
03371  * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type
03372  *    AST_CONTROL_CONNECTED_LINE
03373  * \param caller If true, then run CONNECTED_LINE_CALLER_SEND_MACRO, otherwise run
03374  *    CONNECTED_LINE_CALLEE_SEND_MACRO
03375  * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an
03376  *    ast_party_connected_line pointer.
03377  * \retval 0 Success
03378  * \retval -1 Either the macro does not exist, or there was an error while attempting to
03379  *    run the macro
03380  *
03381  * \todo Have multiple return codes based on the MACRO_RESULT
03382  * \todo Make constants so that caller and frame can be more expressive than just '1' and
03383  *    '0'
03384  */
03385 int ast_channel_connected_line_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const void *connected_info, int caller, int frame);
03386 
03387 /*!
03388  * \brief Insert into an astdata tree, the channel structure.
03389  * \param[in] tree The ast data tree.
03390  * \param[in] chan The channel structure to add to tree.
03391  * \param[in] add_bridged Add the bridged channel to the structure.
03392  * \retval <0 on error.
03393  * \retval 0 on success.
03394  */
03395 int ast_channel_data_add_structure(struct ast_data *tree, struct ast_channel *chan, int add_bridged);
03396 
03397 /*!
03398  * \brief Compare to channel structures using the data api.
03399  * \param[in] tree The search tree generated by the data api.
03400  * \param[in] chan The channel to compare.
03401  * \param[in] structure_name The name of the node of the channel structure.
03402  * \retval 0 The structure matches.
03403  * \retval 1 The structure doesn't matches.
03404  */
03405 int ast_channel_data_cmp_structure(const struct ast_data_search *tree, struct ast_channel *chan,
03406    const char *structure_name);
03407 
03408 /*!
03409  * \since 1.8
03410  * \brief Run a redirecting interception macro and update a channel's redirecting information
03411  *
03412  * \details
03413  * Whenever we want to update a channel's redirecting information, we may need to run
03414  * a macro so that an administrator can manipulate the information before sending it
03415  * out. This function both runs the macro and sends the update to the channel.
03416  *
03417  * \param autoservice_chan Channel to place into autoservice while the macro is running.
03418  * It is perfectly safe for this to be NULL
03419  * \param macro_chan The channel to run the macro on. Also the channel from which we
03420  * determine which macro we need to run.
03421  * \param redirecting_info Either an ast_party_redirecting or ast_frame pointer of type
03422  * AST_CONTROL_REDIRECTING
03423  * \param is_caller If true, then run REDIRECTING_CALLER_SEND_MACRO, otherwise run
03424  * REDIRECTING_CALLEE_SEND_MACRO
03425  * \param is_frame If true, then redirecting_info is an ast_frame pointer, otherwise it is an
03426  * ast_party_redirecting pointer.
03427  *
03428  * \retval 0 Success
03429  * \retval -1 Either the macro does not exist, or there was an error while attempting to
03430  * run the macro
03431  *
03432  * \todo Have multiple return codes based on the MACRO_RESULT
03433  * \todo Make constants so that caller and frame can be more expressive than just '1' and
03434  * '0'
03435  */
03436 int ast_channel_redirecting_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const void *redirecting_info, int is_caller, int is_frame);
03437 
03438 #include "asterisk/ccss.h"
03439 
03440 /*!
03441  * \since 1.8
03442  * \brief Set up datastore with CCSS parameters for a channel
03443  *
03444  * \note
03445  * If base_params is NULL, the channel will get the default
03446  * values for all CCSS parameters.
03447  *
03448  * \details
03449  * This function makes use of datastore operations on the channel, so
03450  * it is important to lock the channel before calling this function.
03451  *
03452  * \param chan The channel to create the datastore on
03453  * \param base_params CCSS parameters we wish to copy into the channel
03454  * \retval 0 Success
03455  * \retval -1 Failure
03456  */
03457 int ast_channel_cc_params_init(struct ast_channel *chan,
03458       const struct ast_cc_config_params *base_params);
03459 
03460 /*!
03461  * \since 1.8
03462  * \brief Get the CCSS parameters from a channel
03463  *
03464  * \details
03465  * This function makes use of datastore operations on the channel, so
03466  * it is important to lock the channel before calling this function.
03467  *
03468  * \param chan Channel to retrieve parameters from
03469  * \retval NULL Failure
03470  * \retval non-NULL The parameters desired
03471  */
03472 struct ast_cc_config_params *ast_channel_get_cc_config_params(struct ast_channel *chan);
03473 
03474 
03475 /*!
03476  * \since 1.8
03477  * \brief Get a device name given its channel structure
03478  *
03479  * \details
03480  * A common practice in Asterisk is to determine the device being talked
03481  * to by dissecting the channel name. For certain channel types, this is not
03482  * accurate. For instance, an ISDN channel is named based on what B channel is
03483  * used, not the device being communicated with.
03484  *
03485  * This function interfaces with a channel tech's queryoption callback to
03486  * retrieve the name of the device being communicated with. If the channel does not
03487  * implement this specific option, then the traditional method of using the channel
03488  * name is used instead.
03489  *
03490  * \param chan The channel to retrieve the information from
03491  * \param[out] device_name The buffer to place the device's name into
03492  * \param name_buffer_length The allocated space for the device_name
03493  * \return 0 always
03494  */
03495 int ast_channel_get_device_name(struct ast_channel *chan, char *device_name, size_t name_buffer_length);
03496 
03497 /*!
03498  * \since 1.8
03499  * \brief Find the appropriate CC agent type to use given a channel
03500  *
03501  * \details
03502  * During call completion, we will need to create a call completion agent structure. To
03503  * figure out the type of agent to construct, we need to ask the channel driver for the
03504  * appropriate type.
03505  *
03506  * Prior to adding this function, the call completion core attempted to figure this
03507  * out for itself by stripping the technology off the channel's name. However, in the
03508  * case of chan_dahdi, there are multiple agent types registered, and so simply searching
03509  * for an agent type called "DAHDI" is not possible. In a case where multiple agent types
03510  * are defined, the channel driver must have a queryoption callback defined in its
03511  * channel_tech, and the queryoption callback must handle AST_OPTION_CC_AGENT_TYPE
03512  *
03513  * If a channel driver does not have a queryoption callback or if the queryoption callback
03514  * does not handle AST_OPTION_CC_AGENT_TYPE, then the old behavior of using the technology
03515  * portion of the channel name is used instead. This is perfectly suitable for channel drivers
03516  * whose channel technologies are a one-to-one match with the agent types defined within.
03517  *
03518  * Note that this function is only called when the agent policy on a given channel is set
03519  * to "native." Generic agents' type can be determined automatically by the core.
03520  *
03521  * \param chan The channel for which we wish to retrieve the agent type
03522  * \param[out] agent_type The type of agent the channel driver wants us to use
03523  * \param size The size of the buffer to write to
03524  */
03525 int ast_channel_get_cc_agent_type(struct ast_channel *chan, char *agent_type, size_t size);
03526 #if defined(__cplusplus) || defined(c_plusplus)
03527 }
03528 #endif
03529 
03530 #endif /* _ASTERISK_CHANNEL_H */

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