Sat Mar 10 01:54:14 2012

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

Generated on Sat Mar 10 01:54:14 2012 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7