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