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