Named ACLs: Introduces a system for creating and sharing ACLs
[asterisk/asterisk.git] / include / asterisk / channel.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 1999 - 2006, Digium, Inc.
5  *
6  * Mark Spencer <markster@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 /*! \file
20  * \brief General Asterisk PBX channel definitions.
21  * \par See also:
22  *  \arg \ref Def_Channel
23  *  \arg \ref channel_drivers
24  */
25
26 /*! \page Def_Channel Asterisk Channels
27         \par What is a Channel?
28         A phone call through Asterisk consists of an incoming
29         connection and an outbound connection. Each call comes
30         in through a channel driver that supports one technology,
31         like SIP, DAHDI, IAX2 etc.
32         \par
33         Each channel driver, technology, has it's own private
34         channel or dialog structure, that is technology-dependent.
35         Each private structure is "owned" by a generic Asterisk
36         channel structure, defined in channel.h and handled by
37         channel.c .
38         \par Call scenario
39         This happens when an incoming call arrives to Asterisk
40         -# Call arrives on a channel driver interface
41         -# Channel driver creates a PBX channel and starts a
42            pbx thread on the channel
43         -# The dial plan is executed
44         -# At this point at least two things can happen:
45                 -# The call is answered by Asterisk and
46                    Asterisk plays a media stream or reads media
47                 -# The dial plan forces Asterisk to create an outbound
48                    call somewhere with the dial (see \ref app_dial.c)
49                    application
50         .
51
52         \par Bridging channels
53         If Asterisk dials out this happens:
54         -# Dial creates an outbound PBX channel and asks one of the
55            channel drivers to create a call
56         -# When the call is answered, Asterisk bridges the media streams
57            so the caller on the first channel can speak with the callee
58            on the second, outbound channel
59         -# In some cases where we have the same technology on both
60            channels and compatible codecs, a native bridge is used.
61            In a native bridge, the channel driver handles forwarding
62            of incoming audio to the outbound stream internally, without
63            sending audio frames through the PBX.
64         -# In SIP, theres an "external native bridge" where Asterisk
65            redirects the endpoint, so audio flows directly between the
66            caller's phone and the callee's phone. Signalling stays in
67            Asterisk in order to be able to provide a proper CDR record
68            for the call.
69
70
71         \par Masquerading channels
72         In some cases, a channel can masquerade itself into another
73         channel. This happens frequently in call transfers, where
74         a new channel takes over a channel that is already involved
75         in a call. The new channel sneaks in and takes over the bridge
76         and the old channel, now a zombie, is hung up.
77
78         \par Reference
79         \arg channel.c - generic functions
80         \arg channel.h - declarations of functions, flags and structures
81         \arg translate.h - Transcoding support functions
82         \arg \ref channel_drivers - Implemented channel drivers
83         \arg \ref Def_Frame Asterisk Multimedia Frames
84         \arg \ref Def_Bridge
85
86 */
87 /*! \page Def_Bridge Asterisk Channel Bridges
88
89         In Asterisk, there's several media bridges.
90
91         The Core bridge handles two channels (a "phone call") and bridge
92         them together.
93
94         The conference bridge (meetme) handles several channels simultaneously
95         with the support of an external timer (DAHDI timer). This is used
96         not only by the Conference application (meetme) but also by the
97         page application and the SLA system introduced in 1.4.
98         The conference bridge does not handle video.
99
100         When two channels of the same type connect, the channel driver
101         or the media subsystem used by the channel driver (i.e. RTP)
102         can create a native bridge without sending media through the
103         core.
104
105         Native bridging can be disabled by a number of reasons,
106         like DTMF being needed by the core or codecs being incompatible
107         so a transcoding module is needed.
108
109 References:
110         \li \see ast_channel_early_bridge()
111         \li \see ast_channel_bridge()
112         \li \see app_meetme.c
113         \li \ref AstRTPbridge
114         \li \see ast_rtp_bridge()
115         \li \ref Def_Channel
116 */
117
118 /*! \page AstFileDesc File descriptors
119         Asterisk File descriptors are connected to each channel (see \ref Def_Channel)
120         in the \ref ast_channel structure.
121 */
122
123 #ifndef _ASTERISK_CHANNEL_H
124 #define _ASTERISK_CHANNEL_H
125
126 #include "asterisk/abstract_jb.h"
127 #include "asterisk/astobj2.h"
128
129 #include "asterisk/poll-compat.h"
130
131 #if defined(__cplusplus) || defined(c_plusplus)
132 extern "C" {
133 #endif
134
135 #define AST_MAX_EXTENSION       80      /*!< Max length of an extension */
136 #define AST_MAX_CONTEXT         80      /*!< Max length of a context */
137 #define AST_CHANNEL_NAME        80      /*!< Max length of an ast_channel name */
138 #define MAX_LANGUAGE            40      /*!< Max length of the language setting */
139 #define MAX_MUSICCLASS          80      /*!< Max length of the music class setting */
140
141 #include "asterisk/frame.h"
142 #include "asterisk/chanvars.h"
143 #include "asterisk/config.h"
144 #include "asterisk/lock.h"
145 #include "asterisk/cdr.h"
146 #include "asterisk/utils.h"
147 #include "asterisk/linkedlists.h"
148 #include "asterisk/stringfields.h"
149 #include "asterisk/datastore.h"
150 #include "asterisk/data.h"
151 #include "asterisk/channelstate.h"
152 #include "asterisk/ccss.h"
153 #include "asterisk/framehook.h"
154
155 #define DATASTORE_INHERIT_FOREVER       INT_MAX
156
157 #define AST_MAX_FDS             11
158 /*
159  * We have AST_MAX_FDS file descriptors in a channel.
160  * Some of them have a fixed use:
161  */
162 #define AST_ALERT_FD    (AST_MAX_FDS-1)         /*!< used for alertpipe */
163 #define AST_TIMING_FD   (AST_MAX_FDS-2)         /*!< used for timingfd */
164 #define AST_AGENT_FD    (AST_MAX_FDS-3)         /*!< used by agents for pass through */
165 #define AST_GENERATOR_FD        (AST_MAX_FDS-4) /*!< used by generator */
166 #define AST_JITTERBUFFER_FD     (AST_MAX_FDS-5) /*!< used by generator */
167
168 enum ast_bridge_result {
169         AST_BRIDGE_COMPLETE = 0,
170         AST_BRIDGE_FAILED = -1,
171         AST_BRIDGE_FAILED_NOWARN = -2,
172         AST_BRIDGE_RETRY = -3,
173 };
174
175 typedef unsigned long long ast_group_t;
176
177 /*! \todo Add an explanation of an Asterisk generator
178 */
179 struct ast_generator {
180         void *(*alloc)(struct ast_channel *chan, void *params);
181         /*! Channel is locked during this function callback. */
182         void (*release)(struct ast_channel *chan, void *data);
183         /*! This function gets called with the channel unlocked, but is called in
184          *  the context of the channel thread so we know the channel is not going
185          *  to disappear.  This callback is responsible for locking the channel as
186          *  necessary. */
187         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
188         /*! This gets called when DTMF_END frames are read from the channel */
189         void (*digit)(struct ast_channel *chan, char digit);
190         /*! This gets called when the write format on a channel is changed while
191          * generating. The channel is locked during this callback. */
192         void (*write_format_change)(struct ast_channel *chan, void *data);
193 };
194
195 /*! Party name character set enumeration values (values from Q.SIG) */
196 enum AST_PARTY_CHAR_SET {
197         AST_PARTY_CHAR_SET_UNKNOWN = 0,
198         AST_PARTY_CHAR_SET_ISO8859_1 = 1,
199         AST_PARTY_CHAR_SET_WITHDRAWN = 2,/* ITU withdrew this enum value. */
200         AST_PARTY_CHAR_SET_ISO8859_2 = 3,
201         AST_PARTY_CHAR_SET_ISO8859_3 = 4,
202         AST_PARTY_CHAR_SET_ISO8859_4 = 5,
203         AST_PARTY_CHAR_SET_ISO8859_5 = 6,
204         AST_PARTY_CHAR_SET_ISO8859_7 = 7,
205         AST_PARTY_CHAR_SET_ISO10646_BMPSTRING = 8,
206         AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING = 9,
207 };
208
209 /*!
210  * \since 1.8
211  * \brief Information needed to specify a name in a call.
212  * \note All string fields here are malloc'ed, so they need to be
213  * freed when the structure is deleted.
214  * \note NULL and "" must be considered equivalent.
215  */
216 struct ast_party_name {
217         /*! \brief Subscriber name (Malloced) */
218         char *str;
219         /*!
220          * \brief Character set the name is using.
221          * \see enum AST_PARTY_CHAR_SET
222          * \note
223          * Set to AST_PARTY_CHAR_SET_ISO8859_1 if unsure what to use.
224          * \todo Start using the party name character set value.  Not currently used.
225          */
226         int char_set;
227         /*!
228          * \brief Q.931 encoded presentation-indicator encoded field
229          * \note Must tolerate the Q.931 screening-indicator field values being present.
230          */
231         int presentation;
232         /*! \brief TRUE if the name information is valid/present */
233         unsigned char valid;
234 };
235
236 /*!
237  * \since 1.8
238  * \brief Information needed to specify a number in a call.
239  * \note All string fields here are malloc'ed, so they need to be
240  * freed when the structure is deleted.
241  * \note NULL and "" must be considered equivalent.
242  */
243 struct ast_party_number {
244         /*! \brief Subscriber phone number (Malloced) */
245         char *str;
246         /*! \brief Q.931 Type-Of-Number and Numbering-Plan encoded fields */
247         int plan;
248         /*! \brief Q.931 presentation-indicator and screening-indicator encoded fields */
249         int presentation;
250         /*! \brief TRUE if the number information is valid/present */
251         unsigned char valid;
252 };
253
254 /*!
255  * \since 1.8
256  * \brief Information needed to specify a subaddress in a call.
257  * \note All string fields here are malloc'ed, so they need to be
258  * freed when the structure is deleted.
259  * \note NULL and "" must be considered equivalent.
260  */
261 struct ast_party_subaddress {
262         /*!
263          * \brief Malloced subaddress string.
264          * \note If the subaddress type is user specified then the subaddress is
265          * a string of ASCII hex because the actual subaddress is likely BCD encoded.
266          */
267         char *str;
268         /*!
269          * \brief Q.931 subaddress type.
270          * \details
271          * nsap(0),
272          * user_specified(2)
273          */
274         int type;
275         /*!
276          * \brief TRUE if odd number of address signals
277          * \note The odd/even indicator is used when the type of subaddress is
278          * user_specified and the coding is BCD.
279          */
280         unsigned char odd_even_indicator;
281         /*! \brief TRUE if the subaddress information is valid/present */
282         unsigned char valid;
283 };
284
285 /*!
286  * \since 1.8
287  * \brief Information needed to identify an endpoint in a call.
288  * \note All string fields here are malloc'ed, so they need to be
289  * freed when the structure is deleted.
290  * \note NULL and "" must be considered equivalent.
291  */
292 struct ast_party_id {
293         /*! \brief Subscriber name */
294         struct ast_party_name name;
295         /*! \brief Subscriber phone number */
296         struct ast_party_number number;
297         /*! \brief Subscriber subaddress. */
298         struct ast_party_subaddress subaddress;
299
300         /*!
301          * \brief User-set "tag"
302          * \details
303          * A user-settable field used to help associate some extrinsic information
304          * about the channel or user of the channel to the party ID.  This information
305          * is normally not transmitted over the wire and so is only useful within an
306          * Asterisk environment.
307          */
308         char *tag;
309 };
310
311 /*!
312  * \since 1.8
313  * \brief Indicate what information in ast_party_id should be set.
314  */
315 struct ast_set_party_id {
316         /*! TRUE if the ast_party_name information should be set. */
317         unsigned char name;
318         /*! TRUE if the ast_party_number information should be set. */
319         unsigned char number;
320         /*! TRUE if the ast_party_subaddress information should be set. */
321         unsigned char subaddress;
322 };
323
324 /*!
325  * \since 1.8
326  * \brief Dialed/Called Party information.
327  * \note Dialed Number Identifier (DNID)
328  * \note All string fields here are malloc'ed, so they need to be
329  * freed when the structure is deleted.
330  * \note NULL and "" must be considered equivalent.
331  */
332 struct ast_party_dialed {
333         /*!
334          * \brief Dialed/Called number
335          * \note Done this way in case we ever really need to use ast_party_number.
336          * We currently do not need all of the ast_party_number fields.
337          */
338         struct {
339                 /*! \brief Subscriber phone number (Malloced) */
340                 char *str;
341                 /*! \brief Q.931 Type-Of-Number and Numbering-Plan encoded fields */
342                 int plan;
343         } number;
344         /*! \brief Dialed/Called subaddress */
345         struct ast_party_subaddress subaddress;
346         /*!
347          * \brief Transit Network Select
348          * \note Currently this value is just passed around the system.
349          * You can read it and set it but it is never used for anything.
350          */
351         int transit_network_select;
352 };
353
354 /*!
355  * \since 1.8
356  * \brief Caller Party information.
357  * \note All string fields here are malloc'ed, so they need to be
358  * freed when the structure is deleted.
359  * \note NULL and "" must be considered equivalent.
360  *
361  * \note SIP and IAX2 has UTF8 encoded Unicode Caller ID names.
362  * In some cases, we also have an alternative (RPID) E.164 number that can
363  * be used as Caller ID on numeric E.164 phone networks (DAHDI or SIP/IAX2 to
364  * PSTN gateway).
365  *
366  * \todo Implement settings for transliteration between UTF8 Caller ID names in
367  *       to ASCII Caller ID's (DAHDI). Östen Åsklund might be transliterated into
368  *       Osten Asklund or Oesten Aasklund depending upon language and person...
369  *       We need automatic routines for incoming calls and static settings for
370  *       our own accounts.
371  */
372 struct ast_party_caller {
373         /*! \brief Caller party ID */
374         struct ast_party_id id;
375
376         /*!
377          * \brief Automatic Number Identification (ANI)
378          * \note The name subcomponent is only likely to be used by SIP.
379          * \note The subaddress subcomponent is not likely to be used.
380          */
381         struct ast_party_id ani;
382
383         /*! \brief Automatic Number Identification 2 (Info Digits) */
384         int ani2;
385 };
386
387 /*!
388  * \since 1.8
389  * \brief Indicate what information in ast_party_caller should be set.
390  */
391 struct ast_set_party_caller {
392         /*! What caller id information to set. */
393         struct ast_set_party_id id;
394         /*! What ANI id information to set. */
395         struct ast_set_party_id ani;
396 };
397
398 /*!
399  * \since 1.8
400  * \brief Connected Line/Party information.
401  * \note All string fields here are malloc'ed, so they need to be
402  * freed when the structure is deleted.
403  * \note NULL and "" must be considered equivalent.
404  */
405 struct ast_party_connected_line {
406         /*! \brief Connected party ID */
407         struct ast_party_id id;
408
409         /*!
410          * \brief Automatic Number Identification (ANI)
411          * \note Not really part of connected line data but needed to
412          * save the corresponding caller id value.
413          */
414         struct ast_party_id ani;
415
416         /*!
417          * \brief Automatic Number Identification 2 (Info Digits)
418          * \note Not really part of connected line data but needed to
419          * save the corresponding caller id value.
420          */
421         int ani2;
422
423         /*!
424          * \brief Information about the source of an update.
425          * \note enum AST_CONNECTED_LINE_UPDATE_SOURCE values
426          * for Normal-Answer and Call-transfer.
427          */
428         int source;
429 };
430
431 /*!
432  * \since 1.8
433  * \brief Indicate what information in ast_party_connected_line should be set.
434  */
435 struct ast_set_party_connected_line {
436         /*! What connected line id information to set. */
437         struct ast_set_party_id id;
438         /*! What ANI id information to set. */
439         struct ast_set_party_id ani;
440 };
441
442 /*!
443  * \since 1.8
444  * \brief Redirecting Line information.
445  * RDNIS (Redirecting Directory Number Information Service)
446  * Where a call diversion or transfer was invoked.
447  * \note All string fields here are malloc'ed, so they need to be
448  * freed when the structure is deleted.
449  * \note NULL and "" must be considered equivalent.
450  */
451 struct ast_party_redirecting {
452         /*! \brief Who originally redirected the call (Sent to the party the call is redirected toward) */
453         struct ast_party_id orig;
454
455         /*! \brief Who is redirecting the call (Sent to the party the call is redirected toward) */
456         struct ast_party_id from;
457
458         /*! \brief Call is redirecting to a new party (Sent to the caller) */
459         struct ast_party_id to;
460
461         /*! \brief Number of times the call was redirected */
462         int count;
463
464         /*! \brief enum AST_REDIRECTING_REASON value for redirection */
465         int reason;
466
467         /*! \brief enum AST_REDIRECTING_REASON value for redirection by original party */
468         int orig_reason;
469 };
470
471 /*!
472  * \since 1.8
473  * \brief Indicate what information in ast_party_redirecting should be set.
474  */
475 struct ast_set_party_redirecting {
476         /*! What redirecting-orig id information to set. */
477         struct ast_set_party_id orig;
478         /*! What redirecting-from id information to set. */
479         struct ast_set_party_id from;
480         /*! What redirecting-to id information to set. */
481         struct ast_set_party_id to;
482 };
483
484 /*!
485  * \brief Typedef for a custom read function
486  * \note data should be treated as const char *.
487  */
488 typedef int (*ast_acf_read_fn_t)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
489
490 /*!
491  * \brief Typedef for a custom read2 function
492  * \note data should be treated as const char *.
493  */
494 typedef int (*ast_acf_read2_fn_t)(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **str, ssize_t len);
495
496 /*!
497  * \brief Typedef for a custom write function
498  * \note data should be treated as const char *.
499  */
500 typedef int (*ast_acf_write_fn_t)(struct ast_channel *chan, const char *function, char *data, const char *value);
501
502 /*! \brief Structure to handle passing func_channel_write info to channels via setoption */
503 typedef struct {
504         /*! \brief ast_chan_write_info_t version. Must be incremented if structure is changed */
505         #define AST_CHAN_WRITE_INFO_T_VERSION 1
506         uint32_t version;
507         ast_acf_write_fn_t write_fn;
508         struct ast_channel *chan;
509         const char *function;
510         char *data;
511         const char *value;
512 } ast_chan_write_info_t;
513
514 /*!
515  * \brief
516  * Structure to describe a channel "technology", ie a channel driver
517  * See for examples:
518  * \arg chan_iax2.c - The Inter-Asterisk exchange protocol
519  * \arg chan_sip.c - The SIP channel driver
520  * \arg chan_dahdi.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS)
521  *
522  * \details
523  * If you develop your own channel driver, this is where you
524  * tell the PBX at registration of your driver what properties
525  * this driver supports and where different callbacks are
526  * implemented.
527  */
528 struct ast_channel_tech {
529         const char * const type;
530         const char * const description;
531
532         struct ast_format_cap *capabilities;  /*!< format capabilities this channel can handle */
533
534         int properties;         /*!< Technology Properties */
535
536         /*!
537          * \brief Requester - to set up call data structures (pvt's)
538          *
539          * \param type type of channel to request
540          * \param cap Format capabilities for requested channel
541          * \param requestor channel asking for data
542          * \param addr destination of the call
543          * \param cause Cause of failure
544          *
545          * \details
546          * Request a channel of a given type, with addr as optional information used
547          * by the low level module
548          *
549          * \retval NULL failure
550          * \retval non-NULL channel on success
551          */
552         struct ast_channel *(* const requester)(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *addr, int *cause);
553
554         int (* const devicestate)(const char *device_number);   /*!< Devicestate call back */
555
556         /*!
557          * \brief Start sending a literal DTMF digit
558          *
559          * \note The channel is not locked when this function gets called.
560          */
561         int (* const send_digit_begin)(struct ast_channel *chan, char digit);
562
563         /*!
564          * \brief Stop sending a literal DTMF digit
565          *
566          * \note The channel is not locked when this function gets called.
567          */
568         int (* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration);
569
570         /*!
571          * \brief Make a call
572          * \note The channel is locked when called.
573          * \param chan which channel to make the call on
574          * \param addr destination of the call
575          * \param timeout time to wait on for connect (Doesn't seem to be used.)
576          * \retval 0 on success
577          * \retval -1 on failure
578          */
579         int (* const call)(struct ast_channel *chan, const char *addr, int timeout);
580
581         /*! \brief Hangup (and possibly destroy) the channel */
582         int (* const hangup)(struct ast_channel *chan);
583
584         /*! \brief Answer the channel */
585         int (* const answer)(struct ast_channel *chan);
586
587         /*! \brief Read a frame, in standard format (see frame.h) */
588         struct ast_frame * (* const read)(struct ast_channel *chan);
589
590         /*! \brief Write a frame, in standard format (see frame.h) */
591         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
592
593         /*! \brief Display or transmit text */
594         int (* const send_text)(struct ast_channel *chan, const char *text);
595
596         /*! \brief Display or send an image */
597         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
598
599         /*! \brief Send HTML data */
600         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
601
602         /*! \brief Handle an exception, reading a frame */
603         struct ast_frame * (* const exception)(struct ast_channel *chan);
604
605         /*! \brief Bridge two channels of the same type together */
606         enum ast_bridge_result (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
607                                                 struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
608
609         /*! \brief Bridge two channels of the same type together (early) */
610         enum ast_bridge_result (* const early_bridge)(struct ast_channel *c0, struct ast_channel *c1);
611
612         /*! \brief Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
613         int (* const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen);
614
615         /*! \brief Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
616         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
617
618         /*! \brief Set a given option. Called with chan locked */
619         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
620
621         /*! \brief Query a given option. Called with chan locked */
622         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
623
624         /*! \brief Blind transfer other side (see app_transfer.c and ast_transfer() */
625         int (* const transfer)(struct ast_channel *chan, const char *newdest);
626
627         /*! \brief Write a frame, in standard format */
628         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
629
630         /*! \brief Write a text frame, in standard format */
631         int (* const write_text)(struct ast_channel *chan, struct ast_frame *frame);
632
633         /*! \brief Find bridged channel */
634         struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
635
636         /*!
637          * \brief Provide additional read items for CHANNEL() dialplan function
638          * \note data should be treated as a const char *.
639          */
640         int (* func_channel_read)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
641
642         /*!
643          * \brief Provide additional write items for CHANNEL() dialplan function
644          * \note data should be treated as a const char *.
645          */
646         int (* func_channel_write)(struct ast_channel *chan, const char *function, char *data, const char *value);
647
648         /*! \brief Retrieve base channel (agent and local) */
649         struct ast_channel* (* get_base_channel)(struct ast_channel *chan);
650
651         /*! \brief Set base channel (agent and local) */
652         int (* set_base_channel)(struct ast_channel *chan, struct ast_channel *base);
653
654         /*! \brief Get the unique identifier for the PVT, i.e. SIP call-ID for SIP */
655         const char * (* get_pvt_uniqueid)(struct ast_channel *chan);
656
657         /*! \brief Call a function with cc parameters as a function parameter
658          *
659          * \details
660          * This is a highly specialized callback that is not likely to be needed in many
661          * channel drivers. When dealing with a busy channel, for instance, most channel
662          * drivers will successfully return a channel to the requester. Once called, the channel
663          * can then queue a busy frame when it receives an appropriate message from the far end.
664          * In such a case, the channel driver has the opportunity to also queue a CC frame.
665          * The parameters for the CC channel can be retrieved from the channel structure.
666          *
667          * For other channel drivers, notably those that deal with "dumb" phones, the channel
668          * driver will not return a channel when one is requested. In such a scenario, there is never
669          * an opportunity for the channel driver to queue a CC frame since the channel is never
670          * called. Furthermore, it is not possible to retrieve the CC configuration parameters
671          * for the desired channel because no channel is ever allocated or returned to the
672          * requester. In such a case, call completion may still be a viable option. What we do is
673          * pass the same string that the requester used originally to request the channel to the
674          * channel driver. The channel driver can then find any potential channels/devices that
675          * match the input and return call the designated callback with the device's call completion
676          * parameters as a parameter.
677          */
678         int (* cc_callback)(struct ast_channel *inbound, const char *dest, ast_cc_callback_fn callback);
679
680         /*!
681          * \brief Execute a Gosub call on the channel in a technology specific way before a call is placed.
682          * \since 11.0
683          *
684          * \param chan Channel to execute Gosub in a tech specific way.
685          * \param sub_args Gosub application parameter string.
686          *
687          * \note The chan is locked before calling.
688          *
689          * \retval 0 on success.
690          * \retval -1 on error.
691          */
692         int (*pre_call)(struct ast_channel *chan, const char *sub_args);
693 };
694
695 /*! Kill the channel channel driver technology descriptor. */
696 extern const struct ast_channel_tech ast_kill_tech;
697
698 struct ast_epoll_data;
699
700 /*!
701  * The high bit of the frame count is used as a debug marker, so
702  * increments of the counters must be done with care.
703  * Please use c->fin = FRAMECOUNT_INC(c->fin) and the same for c->fout.
704  */
705 #define DEBUGCHAN_FLAG  0x80000000
706
707 /* XXX not ideal to evaluate x twice... */
708 #define FRAMECOUNT_INC(x)       ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
709
710 /*!
711  * The current value of the debug flags is stored in the two
712  * variables global_fin and global_fout (declared in main/channel.c)
713  */
714 extern unsigned long global_fin, global_fout;
715
716 enum ast_channel_adsicpe {
717         AST_ADSI_UNKNOWN,
718         AST_ADSI_AVAILABLE,
719         AST_ADSI_UNAVAILABLE,
720         AST_ADSI_OFFHOOKONLY,
721 };
722
723 /*!
724  * \brief Possible T38 states on channels
725  */
726 enum ast_t38_state {
727         T38_STATE_UNAVAILABLE,  /*!< T38 is unavailable on this channel or disabled by configuration */
728         T38_STATE_UNKNOWN,      /*!< The channel supports T38 but the current status is unknown */
729         T38_STATE_NEGOTIATING,  /*!< T38 is being negotiated */
730         T38_STATE_REJECTED,     /*!< Remote side has rejected our offer */
731         T38_STATE_NEGOTIATED,   /*!< T38 established */
732 };
733
734 /*! Hangup handler instance node. */
735 struct ast_hangup_handler {
736         /*! Next hangup handler node. */
737         AST_LIST_ENTRY(ast_hangup_handler) node;
738         /*! Hangup handler arg string passed to the Gosub application */
739         char args[0];
740 };
741
742 AST_LIST_HEAD_NOLOCK(ast_hangup_handler_list, ast_hangup_handler);
743 AST_LIST_HEAD_NOLOCK(ast_datastore_list, ast_datastore);
744 AST_LIST_HEAD_NOLOCK(ast_autochan_list, ast_autochan);
745 AST_LIST_HEAD_NOLOCK(ast_readq_list, ast_frame);
746
747 typedef int(*ast_timing_func_t)(const void *data);
748 /*!
749  * \page AstChannel ast_channel locking and reference tracking
750  *
751  * \par Creating Channels
752  * A channel is allocated using the ast_channel_alloc() function.  When created, it is
753  * automatically inserted into the main channels hash table that keeps track of all
754  * active channels in the system.  The hash key is based on the channel name.  Because
755  * of this, if you want to change the name, you _must_ use ast_change_name(), not change
756  * the name field directly.  When ast_channel_alloc() returns a channel pointer, you now
757  * hold a reference to that channel.  In most cases this reference is given to ast_pbx_run().
758  *
759  * \par Channel Locking
760  * There is a lock associated with every ast_channel.  It is allocated internally via astobj2.
761  * To lock or unlock a channel, you must use the ast_channel_lock() wrappers.
762  *
763  * Previously, before ast_channel was converted to astobj2, the channel lock was used in some
764  * additional ways that are no longer necessary.  Before, the only way to ensure that a channel
765  * did not disappear out from under you if you were working with a channel outside of the channel
766  * thread that owns it, was to hold the channel lock.  Now, that is no longer necessary.
767  * You simply must hold a reference to the channel to ensure it does not go away.
768  *
769  * The channel must be locked if you need to ensure that data that you reading from the channel
770  * does not change while you access it.  Further, you must hold the channel lock if you are
771  * making a non-atomic change to channel data.
772  *
773  * \par Channel References
774  * There are multiple ways to get a reference to a channel.  The first is that you hold a reference
775  * to a channel after creating it.  The other ways involve using the channel search or the channel
776  * traversal APIs.  These functions are the ast_channel_get_*() functions or ast_channel_iterator_*()
777  * functions.  Once a reference is retrieved by one of these methods, you know that the channel will
778  * not go away.  So, the channel should only get locked as needed for data access or modification.
779  * But, make sure that the reference gets released when you are done with it!
780  *
781  * There are different things you can do when you are done with a reference to a channel.  The first
782  * is to simply release the reference using ast_channel_unref().  The other option is to call
783  * ast_channel_release().  This function is generally used where ast_channel_free() was used in
784  * the past.  The release function releases a reference as well as ensures that the channel is no
785  * longer in the global channels container.  That way, the channel will get destroyed as soon as any
786  * other pending references get released.
787  *
788  * \par Exceptions to the rules
789  * Even though ast_channel is reference counted, there are some places where pointers to an ast_channel
790  * get stored, but the reference count does not reflect it.  The reason is mostly historical.
791  * The only places where this happens should be places where because of how the code works, we
792  * _know_ that the pointer to the channel will get removed before the channel goes away.  The main
793  * example of this is in channel drivers.  Channel drivers generally store a pointer to their owner
794  * ast_channel in their technology specific pvt struct.  In this case, the channel drivers _know_
795  * that this pointer to the channel will be removed in time, because the channel's hangup callback
796  * gets called before the channel goes away.
797  */
798
799 struct ast_channel;
800
801 /*! \brief ast_channel_tech Properties */
802 enum {
803         /*!
804      * \brief Channels have this property if they can accept input with jitter;
805          * i.e. most VoIP channels
806          */
807         AST_CHAN_TP_WANTSJITTER = (1 << 0),
808         /*!
809      * \brief Channels have this property if they can create jitter;
810          * i.e. most VoIP channels
811          */
812         AST_CHAN_TP_CREATESJITTER = (1 << 1),
813 };
814
815 /*! \brief ast_channel flags */
816 enum {
817         /*! Queue incoming DTMF, to be released when this flag is turned off */
818         AST_FLAG_DEFER_DTMF =    (1 << 1),
819         /*! write should be interrupt generator */
820         AST_FLAG_WRITE_INT =     (1 << 2),
821         /*! a thread is blocking on this channel */
822         AST_FLAG_BLOCKING =      (1 << 3),
823         /*! This is a zombie channel */
824         AST_FLAG_ZOMBIE =        (1 << 4),
825         /*! There is an exception pending */
826         AST_FLAG_EXCEPTION =     (1 << 5),
827         /*! Listening to moh XXX anthm promises me this will disappear XXX */
828         AST_FLAG_MOH =           (1 << 6),
829         /*! This channel is spying on another channel */
830         AST_FLAG_SPYING =        (1 << 7),
831         /*! This channel is in a native bridge */
832         AST_FLAG_NBRIDGE =       (1 << 8),
833         /*! the channel is in an auto-incrementing dialplan processor,
834          *  so when ->priority is set, it will get incremented before
835          *  finding the next priority to run */
836         AST_FLAG_IN_AUTOLOOP =   (1 << 9),
837         /*! This is an outgoing call */
838         AST_FLAG_OUTGOING =      (1 << 10),
839         /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
840         AST_FLAG_IN_DTMF =       (1 << 12),
841         /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is
842          *  currently being emulated */
843         AST_FLAG_EMULATE_DTMF =  (1 << 13),
844         /*! This is set to tell the channel not to generate DTMF begin frames, and
845          *  to instead only generate END frames. */
846         AST_FLAG_END_DTMF_ONLY = (1 << 14),
847         /* OBSOLETED in favor of AST_CAUSE_ANSWERED_ELSEWHERE
848         Flag to show channels that this call is hangup due to the fact that the call
849             was indeed answered, but in another channel */
850         /* AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15), */
851         /*! This flag indicates that on a masquerade, an active stream should not
852          *  be carried over */
853         AST_FLAG_MASQ_NOSTREAM = (1 << 16),
854         /*! This flag indicates that the hangup exten was run when the bridge terminated,
855          *  a message aimed at preventing a subsequent hangup exten being run at the pbx_run
856          *  level */
857         AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
858         /*! This flag indicates that the hangup exten should NOT be run when the
859          *  bridge terminates, this will allow the hangup in the pbx loop to be run instead.
860          *  */
861         AST_FLAG_BRIDGE_HANGUP_DONT = (1 << 18),
862         /*! Disable certain workarounds.  This reintroduces certain bugs, but allows
863          *  some non-traditional dialplans (like AGI) to continue to function.
864          */
865         AST_FLAG_DISABLE_WORKAROUNDS = (1 << 20),
866 };
867
868 /*! \brief ast_bridge_config flags */
869 enum {
870         AST_FEATURE_PLAY_WARNING = (1 << 0),
871         AST_FEATURE_REDIRECT =     (1 << 1),
872         AST_FEATURE_DISCONNECT =   (1 << 2),
873         AST_FEATURE_ATXFER =       (1 << 3),
874         AST_FEATURE_AUTOMON =      (1 << 4),
875         AST_FEATURE_PARKCALL =     (1 << 5),
876         AST_FEATURE_AUTOMIXMON =   (1 << 6),
877         AST_FEATURE_NO_H_EXTEN =   (1 << 7),
878         AST_FEATURE_WARNING_ACTIVE = (1 << 8),
879 };
880
881 /*! \brief bridge configuration */
882 struct ast_bridge_config {
883         struct ast_flags features_caller;
884         struct ast_flags features_callee;
885         struct timeval start_time;
886         struct timeval nexteventts;
887         struct timeval feature_start_time;
888         long feature_timer;
889         long timelimit;
890         long play_warning;
891         long warning_freq;
892         const char *warning_sound;
893         const char *end_sound;
894         const char *start_sound;
895         unsigned int flags;
896         void (* end_bridge_callback)(void *);   /*!< A callback that is called after a bridge attempt */
897         void *end_bridge_callback_data;         /*!< Data passed to the callback */
898         /*! If the end_bridge_callback_data refers to a channel which no longer is going to
899          * exist when the end_bridge_callback is called, then it needs to be fixed up properly
900          */
901         void (*end_bridge_callback_data_fixup)(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator);
902 };
903
904 struct chanmon;
905
906 struct outgoing_helper {
907         const char *context;
908         const char *exten;
909         int priority;
910         const char *cid_num;
911         const char *cid_name;
912         const char *account;
913         struct ast_variable *vars;
914         struct ast_channel *parent_channel;
915 };
916
917 enum {
918         /*!
919          * Soft hangup requested by device or other internal reason.
920          * Actual hangup needed.
921          */
922         AST_SOFTHANGUP_DEV =       (1 << 0),
923         /*!
924          * Used to break the normal frame flow so an async goto can be
925          * done instead of actually hanging up.
926          */
927         AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
928         /*!
929          * Soft hangup requested by system shutdown.  Actual hangup
930          * needed.
931          */
932         AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
933         /*!
934          * Used to break the normal frame flow after a timeout so an
935          * implicit async goto can be done to the 'T' exten if it exists
936          * instead of actually hanging up.  If the exten does not exist
937          * then actually hangup.
938          */
939         AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
940         /*!
941          * Soft hangup requested by application/channel-driver being
942          * unloaded.  Actual hangup needed.
943          */
944         AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
945         /*!
946          * Soft hangup requested by non-associated party.  Actual hangup
947          * needed.
948          */
949         AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
950         /*!
951          * Used to break a bridge so the channel can be spied upon
952          * instead of actually hanging up.
953          */
954         AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
955
956
957         /*!
958          * \brief All softhangup flags.
959          *
960          * This can be used as an argument to ast_channel_clear_softhangup()
961          * to clear all softhangup flags from a channel.
962          */
963         AST_SOFTHANGUP_ALL =       (0xFFFFFFFF)
964 };
965
966
967 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
968 enum channelreloadreason {
969         CHANNEL_MODULE_LOAD,
970         CHANNEL_MODULE_RELOAD,
971         CHANNEL_CLI_RELOAD,
972         CHANNEL_MANAGER_RELOAD,
973         CHANNEL_ACL_RELOAD,
974 };
975
976 /*!
977  * \note None of the datastore API calls lock the ast_channel they are using.
978  *       So, the channel should be locked before calling the functions that
979  *       take a channel argument.
980  */
981
982 /*!
983  * \brief Create a channel data store object
984  * \deprecated You should use the ast_datastore_alloc() generic function instead.
985  * \version 1.6.1 deprecated
986  */
987 struct ast_datastore * attribute_malloc ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
988         __attribute__((deprecated));
989
990 /*!
991  * \brief Free a channel data store object
992  * \deprecated You should use the ast_datastore_free() generic function instead.
993  * \version 1.6.1 deprecated
994  */
995 int ast_channel_datastore_free(struct ast_datastore *datastore)
996         __attribute__((deprecated));
997
998 /*! \brief Inherit datastores from a parent to a child. */
999 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to);
1000
1001 /*!
1002  * \brief Add a datastore to a channel
1003  *
1004  * \note The channel should be locked before calling this function.
1005  *
1006  * \retval 0 success
1007  * \retval non-zero failure
1008  */
1009 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore);
1010
1011 /*!
1012  * \brief Remove a datastore from a channel
1013  *
1014  * \note The channel should be locked before calling this function.
1015  *
1016  * \retval 0 success
1017  * \retval non-zero failure
1018  */
1019 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore);
1020
1021 /*!
1022  * \brief Find a datastore on a channel
1023  *
1024  * \note The channel should be locked before calling this function.
1025  *
1026  * \note The datastore returned from this function must not be used if the
1027  *       reference to the channel is released.
1028  *
1029  * \retval pointer to the datastore if found
1030  * \retval NULL if not found
1031  */
1032 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid);
1033
1034 /*!
1035  * \brief Create a channel structure
1036  * \since 1.8
1037  *
1038  * \retval NULL failure
1039  * \retval non-NULL successfully allocated channel
1040  *
1041  * \note Absolutely _NO_ channel locks should be held before calling this function.
1042  * \note By default, new channels are set to the "s" extension
1043  *       and "default" context.
1044  */
1045 struct ast_channel * attribute_malloc __attribute__((format(printf, 13, 14)))
1046         __ast_channel_alloc(int needqueue, int state, const char *cid_num,
1047                             const char *cid_name, const char *acctcode,
1048                             const char *exten, const char *context,
1049                             const char *linkedid, const int amaflag,
1050                             const char *file, int line, const char *function,
1051                             const char *name_fmt, ...);
1052
1053 /*!
1054  * \brief Create a channel structure
1055  *
1056  * \retval NULL failure
1057  * \retval non-NULL successfully allocated channel
1058  *
1059  * \note Absolutely _NO_ channel locks should be held before calling this function.
1060  * \note By default, new channels are set to the "s" extension
1061  *       and "default" context.
1062  */
1063 #define ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, ...) \
1064         __ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, \
1065                             __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
1066
1067 #if defined(REF_DEBUG) || defined(__AST_DEBUG_MALLOC)
1068 /*!
1069  * \brief Create a fake channel structure
1070  *
1071  * \retval NULL failure
1072  * \retval non-NULL successfully allocated channel
1073  *
1074  * \note This function should ONLY be used to create a fake channel
1075  *       that can then be populated with data for use in variable
1076  *       substitution when a real channel does not exist.
1077  *
1078  * \note The created dummy channel should be destroyed by
1079  * ast_channel_unref().  Using ast_channel_release() needlessly
1080  * grabs the channel container lock and can cause a deadlock as
1081  * a result.  Also grabbing the channel container lock reduces
1082  * system performance.
1083  */
1084 #define ast_dummy_channel_alloc()       __ast_dummy_channel_alloc(__FILE__, __LINE__, __PRETTY_FUNCTION__)
1085 struct ast_channel *__ast_dummy_channel_alloc(const char *file, int line, const char *function);
1086 #else
1087 /*!
1088  * \brief Create a fake channel structure
1089  *
1090  * \retval NULL failure
1091  * \retval non-NULL successfully allocated channel
1092  *
1093  * \note This function should ONLY be used to create a fake channel
1094  *       that can then be populated with data for use in variable
1095  *       substitution when a real channel does not exist.
1096  *
1097  * \note The created dummy channel should be destroyed by
1098  * ast_channel_unref().  Using ast_channel_release() needlessly
1099  * grabs the channel container lock and can cause a deadlock as
1100  * a result.  Also grabbing the channel container lock reduces
1101  * system performance.
1102  */
1103 struct ast_channel *ast_dummy_channel_alloc(void);
1104 #endif
1105
1106 /*!
1107  * \brief Queue one or more frames to a channel's frame queue
1108  *
1109  * \param chan the channel to queue the frame(s) on
1110  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1111  *        by this function.  It is the responsibility of the caller to handle
1112  *        freeing the memory associated with the frame(s) being passed if
1113  *        necessary.
1114  *
1115  * \retval 0 success
1116  * \retval non-zero failure
1117  */
1118 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
1119
1120 /*!
1121  * \brief Queue one or more frames to the head of a channel's frame queue
1122  *
1123  * \param chan the channel to queue the frame(s) on
1124  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1125  *        by this function.  It is the responsibility of the caller to handle
1126  *        freeing the memory associated with the frame(s) being passed if
1127  *        necessary.
1128  *
1129  * \retval 0 success
1130  * \retval non-zero failure
1131  */
1132 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *f);
1133
1134 /*!
1135  * \brief Queue a hangup frame
1136  *
1137  * \note The channel does not need to be locked before calling this function.
1138  */
1139 int ast_queue_hangup(struct ast_channel *chan);
1140
1141 /*!
1142  * \brief Queue a hangup frame with hangupcause set
1143  *
1144  * \note The channel does not need to be locked before calling this function.
1145  * \param[in] chan channel to queue frame onto
1146  * \param[in] cause the hangup cause
1147  * \return 0 on success, -1 on error
1148  * \since 1.6.1
1149  */
1150 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause);
1151
1152 /*!
1153  * \brief Queue a control frame with payload
1154  *
1155  * \param chan channel to queue frame onto
1156  * \param control type of control frame
1157  *
1158  * \note The channel does not need to be locked before calling this function.
1159  *
1160  * \retval zero on success
1161  * \retval non-zero on failure
1162  */
1163 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control);
1164
1165 /*!
1166  * \brief Queue a control frame with payload
1167  *
1168  * \param chan channel to queue frame onto
1169  * \param control type of control frame
1170  * \param data pointer to payload data to be included in frame
1171  * \param datalen number of bytes of payload data
1172  *
1173  * \retval 0 success
1174  * \retval non-zero failure
1175  *
1176  * \details
1177  * The supplied payload data is copied into the frame, so the caller's copy
1178  * is not modified nor freed, and the resulting frame will retain a copy of
1179  * the data even if the caller frees their local copy.
1180  *
1181  * \note This method should be treated as a 'network transport'; in other
1182  * words, your frames may be transferred across an IAX2 channel to another
1183  * system, which may be a different endianness than yours. Because of this,
1184  * you should ensure that either your frames will never be expected to work
1185  * across systems, or that you always put your payload data into 'network byte
1186  * order' before calling this function.
1187  *
1188  * \note The channel does not need to be locked before calling this function.
1189  */
1190 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
1191                            const void *data, size_t datalen);
1192
1193 /*!
1194  * \brief Change channel name
1195  *
1196  * \pre Absolutely all channels _MUST_ be unlocked before calling this function.
1197  *
1198  * \param chan the channel to change the name of
1199  * \param newname the name to change to
1200  *
1201  * \return nothing
1202  *
1203  * \note this function must _NEVER_ be used when any channels are locked
1204  * regardless if it is the channel who's name is being changed or not because
1205  * it invalidates our channel container locking order... lock container first,
1206  * then the individual channels, never the other way around.
1207  */
1208 void ast_change_name(struct ast_channel *chan, const char *newname);
1209
1210 /*!
1211  * \brief Unlink and release reference to a channel
1212  *
1213  * This function will unlink the channel from the global channels container
1214  * if it is still there and also release the current reference to the channel.
1215  *
1216  * \return NULL, convenient for clearing invalid pointers
1217  * \note Absolutely _NO_ channel locks should be held before calling this function.
1218  *
1219  * \since 1.8
1220  */
1221 struct ast_channel *ast_channel_release(struct ast_channel *chan);
1222
1223 /*!
1224  * \brief Requests a channel
1225  *
1226  * \param type type of channel to request
1227  * \param request_cap Format capabilities for requested channel
1228  * \param requestor channel asking for data
1229  * \param addr destination of the call
1230  * \param cause Cause of failure
1231  *
1232  * \details
1233  * Request a channel of a given type, with addr as optional information used
1234  * by the low level module
1235  *
1236  * \retval NULL failure
1237  * \retval non-NULL channel on success
1238  */
1239 struct ast_channel *ast_request(const char *type, struct ast_format_cap *request_cap, const struct ast_channel *requestor, const char *addr, int *cause);
1240
1241 /*!
1242  * \brief Request a channel of a given type, with data as optional information used
1243  *        by the low level module and attempt to place a call on it
1244  *
1245  * \param type type of channel to request
1246  * \param format capabilities for requested channel
1247  * \param requestor channel asking for data
1248  * \param addr destination of the call
1249  * \param timeout maximum amount of time to wait for an answer
1250  * \param reason why unsuccessful (if unsuccessful)
1251  * \param cid_num Caller-ID Number
1252  * \param cid_name Caller-ID Name (ascii)
1253  *
1254  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1255  * to know if the call was answered or not.
1256  */
1257 struct ast_channel *ast_request_and_dial(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *addr,
1258         int timeout, int *reason, const char *cid_num, const char *cid_name);
1259
1260 /*!
1261  * \brief Request a channel of a given type, with data as optional information used
1262  * by the low level module and attempt to place a call on it
1263  * \param type type of channel to request
1264  * \param format capabilities for requested channel
1265  * \param requestor channel requesting data
1266  * \param addr destination of the call
1267  * \param timeout maximum amount of time to wait for an answer
1268  * \param reason why unsuccessful (if unsuccessful)
1269  * \param cid_num Caller-ID Number
1270  * \param cid_name Caller-ID Name (ascii)
1271  * \param oh Outgoing helper
1272  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1273  * to know if the call was answered or not.
1274  */
1275 struct ast_channel *__ast_request_and_dial(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *addr,
1276         int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
1277
1278 /*!
1279  * \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.
1280  * \param caller in channel that requested orig
1281  * \param orig channel being replaced by the call forward channel
1282  * \param timeout maximum amount of time to wait for setup of new forward channel
1283  * \param format capabilities for requested channel
1284  * \param oh outgoing helper used with original channel
1285  * \param outstate reason why unsuccessful (if uncuccessful)
1286  * \return Returns the forwarded call's ast_channel on success or NULL on failure
1287  */
1288 struct ast_channel *ast_call_forward(struct ast_channel *caller, struct ast_channel *orig, int *timeout, struct ast_format_cap *cap, struct outgoing_helper *oh, int *outstate);
1289
1290 /*!
1291  * \brief Register a channel technology (a new channel driver)
1292  * Called by a channel module to register the kind of channels it supports.
1293  * \param tech Structure defining channel technology or "type"
1294  * \return Returns 0 on success, -1 on failure.
1295  */
1296 int ast_channel_register(const struct ast_channel_tech *tech);
1297
1298 /*!
1299  * \brief Unregister a channel technology
1300  * \param tech Structure defining channel technology or "type" that was previously registered
1301  * \return No return value.
1302  */
1303 void ast_channel_unregister(const struct ast_channel_tech *tech);
1304
1305 /*!
1306  * \brief Get a channel technology structure by name
1307  * \param name name of technology to find
1308  * \return a pointer to the structure, or NULL if no matching technology found
1309  */
1310 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
1311
1312 #ifdef CHANNEL_TRACE
1313 /*!
1314  * \brief Update the context backtrace if tracing is enabled
1315  * \return Returns 0 on success, -1 on failure
1316  */
1317 int ast_channel_trace_update(struct ast_channel *chan);
1318
1319 /*!
1320  * \brief Enable context tracing in the channel
1321  * \return Returns 0 on success, -1 on failure
1322  */
1323 int ast_channel_trace_enable(struct ast_channel *chan);
1324
1325 /*!
1326  * \brief Disable context tracing in the channel.
1327  * \note Does not remove current trace entries
1328  * \return Returns 0 on success, -1 on failure
1329  */
1330 int ast_channel_trace_disable(struct ast_channel *chan);
1331
1332 /*!
1333  * \brief Whether or not context tracing is enabled
1334  * \return Returns -1 when the trace is enabled. 0 if not.
1335  */
1336 int ast_channel_trace_is_enabled(struct ast_channel *chan);
1337
1338 /*!
1339  * \brief Put the channel backtrace in a string
1340  * \return Returns the amount of lines in the backtrace. -1 on error.
1341  */
1342 int ast_channel_trace_serialize(struct ast_channel *chan, struct ast_str **out);
1343 #endif
1344
1345 /*!
1346  * \brief Hang up a channel
1347  * \note Absolutely _NO_ channel locks should be held before calling this function.
1348  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
1349  * performs all stream stopping, etc, on the channel that needs to end.
1350  * chan is no longer valid after this call.
1351  * \param chan channel to hang up
1352  * \return Returns 0 on success, -1 on failure.
1353  */
1354 int ast_hangup(struct ast_channel *chan);
1355
1356 /*!
1357  * \brief Softly hangup up a channel
1358  *
1359  * \param chan channel to be soft-hung-up
1360  * \param reason an AST_SOFTHANGUP_* reason code
1361  *
1362  * \details
1363  * Call the protocol layer, but don't destroy the channel structure
1364  * (use this if you are trying to
1365  * safely hangup a channel managed by another thread.
1366  *
1367  * \note The channel passed to this function does not need to be locked.
1368  *
1369  * \return Returns 0 regardless
1370  */
1371 int ast_softhangup(struct ast_channel *chan, int reason);
1372
1373 /*!
1374  * \brief Softly hangup up a channel (no channel lock)
1375  * \param chan channel to be soft-hung-up
1376  * \param reason an AST_SOFTHANGUP_* reason code
1377  */
1378 int ast_softhangup_nolock(struct ast_channel *chan, int reason);
1379
1380 /*!
1381  * \brief Clear a set of softhangup flags from a channel
1382  *
1383  * Never clear a softhangup flag from a channel directly.  Instead,
1384  * use this function.  This ensures that all aspects of the softhangup
1385  * process are aborted.
1386  *
1387  * \param chan the channel to clear the flag on
1388  * \param flag the flag or flags to clear
1389  *
1390  * \return Nothing.
1391  */
1392 void ast_channel_clear_softhangup(struct ast_channel *chan, int flag);
1393
1394 /*!
1395  * \brief Set the source of the hangup in this channel and it's bridge
1396  *
1397  * \param chan channel to set the field on
1398  * \param source a string describing the source of the hangup for this channel
1399  * \param force
1400  *
1401  * \note Absolutely _NO_ channel locks should be held before calling this function.
1402  *
1403  * \since 1.8
1404  *
1405  * Hangupsource is generally the channel name that caused the bridge to be
1406  * hung up, but it can also be other things such as "dialplan/agi"
1407  * This can then be logged in the CDR or CEL
1408  */
1409 void ast_set_hangupsource(struct ast_channel *chan, const char *source, int force);
1410
1411 /*! \brief Check to see if a channel is needing hang up
1412  * \param chan channel on which to check for hang up
1413  * This function determines if the channel is being requested to be hung up.
1414  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
1415  */
1416 int ast_check_hangup(struct ast_channel *chan);
1417
1418 int ast_check_hangup_locked(struct ast_channel *chan);
1419
1420 /*!
1421  * \brief Lock the given channel, then request softhangup on the channel with the given causecode
1422  * \param chan channel on which to hang up
1423  * \param causecode cause code to use (Zero if don't use cause code)
1424  * \return Nothing
1425  */
1426 void ast_channel_softhangup_withcause_locked(struct ast_channel *chan, int causecode);
1427
1428 /*!
1429  * \brief Compare a offset with the settings of when to hang a channel up
1430  * \param chan channel on which to check for hang up
1431  * \param offset offset in seconds from current time
1432  * \return 1, 0, or -1
1433  * \details
1434  * This function compares a offset from current time with the absolute time
1435  * out on a channel (when to hang up). If the absolute time out on a channel
1436  * is earlier than current time plus the offset, it returns 1, if the two
1437  * time values are equal, it return 0, otherwise, it return -1.
1438  * \sa ast_channel_cmpwhentohangup_tv()
1439  * \version 1.6.1 deprecated function (only had seconds precision)
1440  */
1441 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1442
1443 /*!
1444  * \brief Compare a offset with the settings of when to hang a channel up
1445  * \param chan channel on which to check for hangup
1446  * \param offset offset in seconds and microseconds from current time
1447  * \return 1, 0, or -1
1448  * This function compares a offset from current time with the absolute time
1449  * out on a channel (when to hang up). If the absolute time out on a channel
1450  * is earlier than current time plus the offset, it returns 1, if the two
1451  * time values are equal, it return 0, otherwise, it return -1.
1452  * \since 1.6.1
1453  */
1454 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1455
1456 /*!
1457  * \brief Set when to hang a channel up
1458  *
1459  * \param chan channel on which to check for hang up
1460  * \param offset offset in seconds relative to the current time of when to hang up
1461  *
1462  * \details
1463  * This function sets the absolute time out on a channel (when to hang up).
1464  *
1465  * \note This function does not require that the channel is locked before
1466  *       calling it.
1467  *
1468  * \return Nothing
1469  * \sa ast_channel_setwhentohangup_tv()
1470  * \version 1.6.1 deprecated function (only had seconds precision)
1471  */
1472 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1473
1474 /*!
1475  * \brief Set when to hang a channel up
1476  *
1477  * \param chan channel on which to check for hang up
1478  * \param offset offset in seconds and useconds relative to the current time of when to hang up
1479  *
1480  * This function sets the absolute time out on a channel (when to hang up).
1481  *
1482  * \note This function does not require that the channel is locked before
1483  * calling it.
1484  *
1485  * \return Nothing
1486  * \since 1.6.1
1487  */
1488 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1489
1490 /*!
1491  * \brief Answer a channel
1492  *
1493  * \param chan channel to answer
1494  *
1495  * \details
1496  * This function answers a channel and handles all necessary call
1497  * setup functions.
1498  *
1499  * \note The channel passed does not need to be locked, but is locked
1500  * by the function when needed.
1501  *
1502  * \note This function will wait up to 500 milliseconds for media to
1503  * arrive on the channel before returning to the caller, so that the
1504  * caller can properly assume the channel is 'ready' for media flow.
1505  *
1506  * \retval 0 on success
1507  * \retval non-zero on failure
1508  */
1509 int ast_answer(struct ast_channel *chan);
1510
1511 /*!
1512  * \brief Answer a channel
1513  *
1514  * \param chan channel to answer
1515  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
1516  *
1517  * This function answers a channel and handles all necessary call
1518  * setup functions.
1519  *
1520  * \note The channel passed does not need to be locked, but is locked
1521  * by the function when needed.
1522  *
1523  * \note Unlike ast_answer(), this function will not wait for media
1524  * flow to begin. The caller should be careful before sending media
1525  * to the channel before incoming media arrives, as the outgoing
1526  * media may be lost.
1527  *
1528  * \retval 0 on success
1529  * \retval non-zero on failure
1530  */
1531 int ast_raw_answer(struct ast_channel *chan, int cdr_answer);
1532
1533 /*!
1534  * \brief Answer a channel, with a selectable delay before returning
1535  *
1536  * \param chan channel to answer
1537  * \param delay maximum amount of time to wait for incoming media
1538  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
1539  *
1540  * This function answers a channel and handles all necessary call
1541  * setup functions.
1542  *
1543  * \note The channel passed does not need to be locked, but is locked
1544  * by the function when needed.
1545  *
1546  * \note This function will wait up to 'delay' milliseconds for media to
1547  * arrive on the channel before returning to the caller, so that the
1548  * caller can properly assume the channel is 'ready' for media flow. If
1549  * 'delay' is less than 500, the function will wait up to 500 milliseconds.
1550  *
1551  * \retval 0 on success
1552  * \retval non-zero on failure
1553  */
1554 int __ast_answer(struct ast_channel *chan, unsigned int delay, int cdr_answer);
1555
1556 /*!
1557  * \brief Execute a Gosub call on the channel before a call is placed.
1558  * \since 11.0
1559  *
1560  * \details
1561  * This is called between ast_request() and ast_call() to
1562  * execute a predial routine on the newly created channel.
1563  *
1564  * \param chan Channel to execute Gosub.
1565  * \param sub_args Gosub application parameter string.
1566  *
1567  * \note Absolutely _NO_ channel locks should be held before calling this function.
1568  *
1569  * \retval 0 on success.
1570  * \retval -1 on error.
1571  */
1572 int ast_pre_call(struct ast_channel *chan, const char *sub_args);
1573
1574 /*!
1575  * \brief Make a call
1576  * \note Absolutely _NO_ channel locks should be held before calling this function.
1577  * \param chan which channel to make the call on
1578  * \param addr destination of the call
1579  * \param timeout time to wait on for connect (Doesn't seem to be used.)
1580  * \details
1581  * Place a call, take no longer than timeout ms.
1582  * \retval 0 on success
1583  * \retval -1 on failure
1584  */
1585 int ast_call(struct ast_channel *chan, const char *addr, int timeout);
1586
1587 /*!
1588  * \brief Indicates condition of channel
1589  * \note Absolutely _NO_ channel locks should be held before calling this function.
1590  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
1591  * \param chan channel to change the indication
1592  * \param condition which condition to indicate on the channel
1593  * \return Returns 0 on success, -1 on failure
1594  */
1595 int ast_indicate(struct ast_channel *chan, int condition);
1596
1597 /*!
1598  * \brief Indicates condition of channel, with payload
1599  * \note Absolutely _NO_ channel locks should be held before calling this function.
1600  * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
1601  * \param chan channel to change the indication
1602  * \param condition which condition to indicate on the channel
1603  * \param data pointer to payload data
1604  * \param datalen size of payload data
1605  * \return Returns 0 on success, -1 on failure
1606  */
1607 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
1608
1609 /* Misc stuff ------------------------------------------------ */
1610
1611 /*!
1612  * \brief Wait for input on a channel
1613  * \param chan channel to wait on
1614  * \param ms length of time to wait on the channel
1615  * \details
1616  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
1617  * \retval < 0 on failure
1618  * \retval 0 if nothing ever arrived
1619  * \retval the # of ms remaining otherwise
1620  */
1621 int ast_waitfor(struct ast_channel *chan, int ms);
1622
1623 /*!
1624  * \brief Should we keep this frame for later?
1625  *
1626  * There are functions such as ast_safe_sleep which will
1627  * service a channel to ensure that it does not have a
1628  * large backlog of queued frames. When this happens,
1629  * we want to hold on to specific frame types and just drop
1630  * others. This function will tell if the frame we just
1631  * read should be held onto.
1632  *
1633  * \param frame The frame we just read
1634  * \retval 1 frame should be kept
1635  * \retval 0 frame should be dropped
1636  */
1637 int ast_is_deferrable_frame(const struct ast_frame *frame);
1638
1639 /*!
1640  * \brief Wait for a specified amount of time, looking for hangups
1641  * \param chan channel to wait for
1642  * \param ms length of time in milliseconds to sleep
1643  * \details
1644  * Waits for a specified amount of time, servicing the channel as required.
1645  * \return returns -1 on hangup, otherwise 0.
1646  */
1647 int ast_safe_sleep(struct ast_channel *chan, int ms);
1648
1649 /*!
1650  * \brief Wait for a specified amount of time, looking for hangups and a condition argument
1651  * \param chan channel to wait for
1652  * \param ms length of time in milliseconds to sleep
1653  * \param cond a function pointer for testing continue condition
1654  * \param data argument to be passed to the condition test function
1655  * \return returns -1 on hangup, otherwise 0.
1656  * \details
1657  * Waits for a specified amount of time, servicing the channel as required. If cond
1658  * returns 0, this function returns.
1659  */
1660 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
1661
1662 /*!
1663  * \brief Waits for activity on a group of channels
1664  * \param chan an array of pointers to channels
1665  * \param n number of channels that are to be waited upon
1666  * \param fds an array of fds to wait upon
1667  * \param nfds the number of fds to wait upon
1668  * \param exception exception flag
1669  * \param outfd fd that had activity on it
1670  * \param ms how long the wait was
1671  * \details
1672  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
1673  * file descriptors.
1674  * \return Returns the channel with activity, or NULL on error or if an FD
1675  * came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
1676  * will be -1
1677  */
1678 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n,
1679         int *fds, int nfds, int *exception, int *outfd, int *ms);
1680
1681 /*!
1682  * \brief Waits for input on a group of channels
1683  * Wait for input on an array of channels for a given # of milliseconds.
1684  * \return Return channel with activity, or NULL if none has activity.
1685  * \param chan an array of pointers to channels
1686  * \param n number of channels that are to be waited upon
1687  * \param ms time "ms" is modified in-place, if applicable
1688  */
1689 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
1690
1691 /*!
1692  * \brief Waits for input on an fd
1693  * \note This version works on fd's only.  Be careful with it.
1694  */
1695 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
1696
1697
1698 /*!
1699  * \brief Reads a frame
1700  * \param chan channel to read a frame from
1701  * \return Returns a frame, or NULL on error.  If it returns NULL, you
1702  * best just stop reading frames and assume the channel has been
1703  * disconnected.
1704  */
1705 struct ast_frame *ast_read(struct ast_channel *chan);
1706
1707 /*!
1708  * \brief Reads a frame, returning AST_FRAME_NULL frame if audio.
1709  * \param chan channel to read a frame from
1710  * \return  Returns a frame, or NULL on error.  If it returns NULL, you
1711  * best just stop reading frames and assume the channel has been
1712  * disconnected.
1713  * \note Audio is replaced with AST_FRAME_NULL to avoid
1714  * transcode when the resulting audio is not necessary.
1715  */
1716 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
1717
1718 /*!
1719  * \brief Write a frame to a channel
1720  * This function writes the given frame to the indicated channel.
1721  * \param chan destination channel of the frame
1722  * \param frame frame that will be written
1723  * \return It returns 0 on success, -1 on failure.
1724  */
1725 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
1726
1727 /*!
1728  * \brief Write video frame to a channel
1729  * This function writes the given frame to the indicated channel.
1730  * \param chan destination channel of the frame
1731  * \param frame frame that will be written
1732  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1733  */
1734 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
1735
1736 /*!
1737  * \brief Write text frame to a channel
1738  * This function writes the given frame to the indicated channel.
1739  * \param chan destination channel of the frame
1740  * \param frame frame that will be written
1741  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1742  */
1743 int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
1744
1745 /*! \brief Send empty audio to prime a channel driver */
1746 int ast_prod(struct ast_channel *chan);
1747
1748 /*!
1749  * \brief Sets read format on channel chan from capabilities
1750  * Set read format for channel to whichever component of "format" is best.
1751  * \param chan channel to change
1752  * \param formats new formats to pick from for reading
1753  * \return Returns 0 on success, -1 on failure
1754  */
1755 int ast_set_read_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
1756
1757 /*!
1758  * \brief Sets read format on channel chan
1759  * \param chan channel to change
1760  * \param formats, format to set for reading
1761  * \return Returns 0 on success, -1 on failure
1762  */
1763 int ast_set_read_format(struct ast_channel *chan, struct ast_format *format);
1764
1765 /*!
1766  * \brief Sets read format on channel chan by id
1767  * \param chan channel to change
1768  * \param format id to set for reading, only used for formats without attributes
1769  * \return Returns 0 on success, -1 on failure
1770  */
1771 int ast_set_read_format_by_id(struct ast_channel *chan, enum ast_format_id id);
1772
1773 /*!
1774  * \brief Sets write format on channel chan
1775  * Set write format for channel to whichever component of "format" is best.
1776  * \param chan channel to change
1777  * \param formats new formats to pick from for writing
1778  * \return Returns 0 on success, -1 on failure
1779  */
1780 int ast_set_write_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
1781
1782 /*!
1783  * \brief Sets write format on channel chan
1784  * \param chan channel to change
1785  * \param formats, format to set for writing
1786  * \return Returns 0 on success, -1 on failure
1787  */
1788 int ast_set_write_format(struct ast_channel *chan, struct ast_format *format);
1789
1790 /*!
1791  * \brief Sets write format on channel chan
1792  * \param chan channel to change
1793  * \param format id to set for writing, only used for formats without attributes
1794  * \return Returns 0 on success, -1 on failure
1795  */
1796 int ast_set_write_format_by_id(struct ast_channel *chan, enum ast_format_id id);
1797
1798 /*!
1799  * \brief Sends text to a channel
1800  *
1801  * \param chan channel to act upon
1802  * \param text string of text to send on the channel
1803  *
1804  * \details
1805  * Write text to a display on a channel
1806  *
1807  * \note The channel does not need to be locked before calling this function.
1808  *
1809  * \retval 0 on success
1810  * \retval -1 on failure
1811  */
1812 int ast_sendtext(struct ast_channel *chan, const char *text);
1813
1814 /*!
1815  * \brief Receives a text character from a channel
1816  * \param chan channel to act upon
1817  * \param timeout timeout in milliseconds (0 for infinite wait)
1818  * \details
1819  * Read a char of text from a channel
1820  * \return 0 on success, -1 on failure
1821  */
1822 int ast_recvchar(struct ast_channel *chan, int timeout);
1823
1824 /*!
1825  * \brief Send a DTMF digit to a channel.
1826  * \param chan channel to act upon
1827  * \param digit the DTMF digit to send, encoded in ASCII
1828  * \param duration the duration of the digit ending in ms
1829  * \return 0 on success, -1 on failure
1830  */
1831 int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
1832
1833 /*!
1834  * \brief Send a DTMF digit to a channel.
1835  * \param chan channel to act upon
1836  * \param digit the DTMF digit to send, encoded in ASCII
1837  * \return 0 on success, -1 on failure
1838  */
1839 int ast_senddigit_begin(struct ast_channel *chan, char digit);
1840
1841 /*!
1842  * \brief Send a DTMF digit to a channel.
1843  * \param chan channel to act upon
1844  * \param digit the DTMF digit to send, encoded in ASCII
1845  * \param duration the duration of the digit ending in ms
1846  * \return Returns 0 on success, -1 on failure
1847  */
1848 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
1849
1850 /*!
1851  * \brief Receives a text string from a channel
1852  * Read a string of text from a channel
1853  * \param chan channel to act upon
1854  * \param timeout timeout in milliseconds (0 for infinite wait)
1855  * \return the received text, or NULL to signify failure.
1856  */
1857 char *ast_recvtext(struct ast_channel *chan, int timeout);
1858
1859 /*!
1860  * \brief Waits for a digit
1861  * \param c channel to wait for a digit on
1862  * \param ms how many milliseconds to wait
1863  * \return Returns <0 on error, 0 on no entry, and the digit on success.
1864  */
1865 int ast_waitfordigit(struct ast_channel *c, int ms);
1866
1867 /*!
1868  * \brief Wait for a digit
1869  * Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
1870  * \param c channel to wait for a digit on
1871  * \param ms how many milliseconds to wait
1872  * \param audiofd audio file descriptor to write to if audio frames are received
1873  * \param ctrlfd control file descriptor to monitor for reading
1874  * \return Returns 1 if ctrlfd becomes available
1875  */
1876 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
1877
1878 /*!
1879  * \brief Reads multiple digits
1880  * \param c channel to read from
1881  * \param s string to read in to.  Must be at least the size of your length
1882  * \param len how many digits to read (maximum)
1883  * \param timeout how long to timeout between digits
1884  * \param rtimeout timeout to wait on the first digit
1885  * \param enders digits to end the string
1886  * \details
1887  * Read in a digit string "s", max length "len", maximum timeout between
1888  * digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
1889  * for the first digit.
1890  * \return Returns 0 on normal return, or 1 on a timeout.  In the case of
1891  * a timeout, any digits that were read before the timeout will still be available in s.
1892  * RETURNS 2 in full version when ctrlfd is available, NOT 1
1893  */
1894 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
1895 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
1896
1897 /*! \brief Report DTMF on channel 0 */
1898 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)
1899 /*! \brief Report DTMF on channel 1 */
1900 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)
1901 /*! \brief Return all voice frames on channel 0 */
1902 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)
1903 /*! \brief Return all voice frames on channel 1 */
1904 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)
1905 /*! \brief Ignore all signal frames except NULL */
1906 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)
1907
1908
1909 /*!
1910  * \brief Makes two channel formats compatible
1911  * \param c0 first channel to make compatible
1912  * \param c1 other channel to make compatible
1913  * \details
1914  * Set two channels to compatible formats -- call before ast_channel_bridge in general.
1915  * \return Returns 0 on success and -1 if it could not be done
1916  */
1917 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
1918
1919 /*!
1920  * \brief Bridge two channels together (early)
1921  * \param c0 first channel to bridge
1922  * \param c1 second channel to bridge
1923  * \details
1924  * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
1925  * \return Returns 0 on success and -1 if it could not be done
1926  */
1927 int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
1928
1929 /*!
1930  * \brief Bridge two channels together
1931  * \param c0 first channel to bridge
1932  * \param c1 second channel to bridge
1933  * \param config config for the channels
1934  * \param fo destination frame(?)
1935  * \param rc destination channel(?)
1936  * \details
1937  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
1938  * *rf (remember, it could be NULL) and which channel (0 or 1) in rc
1939  */
1940 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
1941 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,
1942         struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc);
1943
1944 /*!
1945  * \brief Weird function made for call transfers
1946  *
1947  * \param original channel to make a copy of
1948  * \param clone copy of the original channel
1949  *
1950  * \details
1951  * This is a very strange and freaky function used primarily for transfer.  Suppose that
1952  * "original" and "clone" are two channels in random situations.  This function takes
1953  * the guts out of "clone" and puts them into the "original" channel, then alerts the
1954  * channel driver of the change, asking it to fixup any private information (like the
1955  * p->owner pointer) that is affected by the change.  The physical layer of the original
1956  * channel is hung up.
1957  *
1958  * \note Neither channel passed here should be locked before
1959  * calling this function.  This function performs deadlock
1960  * avoidance involving these two channels.
1961  */
1962 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
1963
1964 /*!
1965  * \brief Setup a masquerade to transfer a call.
1966  * \since 1.8
1967  *
1968  * \param target_chan Target of the call transfer.  (Masquerade original channel)
1969  * \param target_id New connected line information for the target channel.
1970  * \param target_held TRUE if the target call is on hold.
1971  * \param transferee_chan Transferee of the call transfer. (Masquerade clone channel)
1972  * \param transferee_id New connected line information for the transferee channel.
1973  * \param transferee_held TRUE if the transferee call is on hold.
1974  *
1975  * \details
1976  * Party A - Transferee
1977  * Party B - Transferer
1978  * Party C - Target of transfer
1979  *
1980  * Party B transfers A to C.
1981  *
1982  * Party A is connected to bridged channel B1.
1983  * Party B is connected to channels C1 and C2.
1984  * Party C is connected to bridged channel B2.
1985  *
1986  * Party B -- C1 == B1 -- Party A
1987  *               __/
1988  *              /
1989  * Party B -- C2 == B2 -- Party C
1990  *
1991  * Bridged channel B1 is masqueraded into channel C2.  Where B1
1992  * is the masquerade clone channel and C2 is the masquerade
1993  * original channel.
1994  *
1995  * \see ast_channel_masquerade()
1996  *
1997  * \note Has the same locking requirements as ast_channel_masquerade().
1998  *
1999  * \retval 0 on success.
2000  * \retval -1 on error.
2001  */
2002 int ast_channel_transfer_masquerade(
2003         struct ast_channel *target_chan,
2004         const struct ast_party_connected_line *target_id,
2005         int target_held,
2006         struct ast_channel *transferee_chan,
2007         const struct ast_party_connected_line *transferee_id,
2008         int transferee_held);
2009
2010 /*!
2011  * \brief Gives the string form of a given cause code.
2012  *
2013  * \param state cause to get the description of
2014  * \return the text form of the binary cause code given
2015  */
2016 const char *ast_cause2str(int state) attribute_pure;
2017
2018 /*!
2019  * \brief Convert the string form of a cause code to a number
2020  *
2021  * \param name string form of the cause
2022  * \return the cause code
2023  */
2024 int ast_str2cause(const char *name) attribute_pure;
2025
2026 /*!
2027  * \brief Gives the string form of a given channel state
2028  *
2029  * \param ast_channel_state state to get the name of
2030  * \return the text form of the binary state given
2031  */
2032 const char *ast_state2str(enum ast_channel_state);
2033
2034 /*!
2035  * \brief Gives the string form of a given transfer capability
2036  *
2037  * \param transfercapability transfer capability to get the name of
2038  * \return the text form of the binary transfer capability
2039  */
2040 char *ast_transfercapability2str(int transfercapability) attribute_const;
2041
2042 /*
2043  * Options: Some low-level drivers may implement "options" allowing fine tuning of the
2044  * low level channel.  See frame.h for options.  Note that many channel drivers may support
2045  * none or a subset of those features, and you should not count on this if you want your
2046  * asterisk application to be portable.  They're mainly useful for tweaking performance
2047  */
2048
2049 /*!
2050  * \brief Sets an option on a channel
2051  *
2052  * \param channel channel to set options on
2053  * \param option option to change
2054  * \param data data specific to option
2055  * \param datalen length of the data
2056  * \param block blocking or not
2057  * \details
2058  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply
2059  * \return 0 on success and -1 on failure
2060  */
2061 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
2062
2063 /*!
2064  * \brief Pick the best codec
2065  *
2066  * \param capabilities to pick best codec out of
2067  * \param result stucture to store the best codec in.
2068  * \retval on success, pointer to result structure
2069  * \retval on failure, NULL
2070  */
2071 struct ast_format *ast_best_codec(struct ast_format_cap *cap, struct ast_format *result);
2072
2073
2074 /*!
2075  * \brief Checks the value of an option
2076  *
2077  * Query the value of an option
2078  * Works similarly to setoption except only reads the options.
2079  */
2080 int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
2081
2082 /*!
2083  * \brief Checks for HTML support on a channel
2084  * \return 0 if channel does not support HTML or non-zero if it does
2085  */
2086 int ast_channel_supports_html(struct ast_channel *channel);
2087
2088 /*!
2089  * \brief Sends HTML on given channel
2090  * Send HTML or URL on link.
2091  * \return 0 on success or -1 on failure
2092  */
2093 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
2094
2095 /*!
2096  * \brief Sends a URL on a given link
2097  * Send URL on link.
2098  * \return 0 on success or -1 on failure
2099  */
2100 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
2101
2102 /*!
2103  * \brief Defers DTMF so that you only read things like hangups and audio.
2104  * \return non-zero if channel was already DTMF-deferred or
2105  * 0 if channel is just now being DTMF-deferred
2106  */
2107 int ast_channel_defer_dtmf(struct ast_channel *chan);
2108
2109 /*! Undo defer.  ast_read will return any DTMF characters that were queued */
2110 void ast_channel_undefer_dtmf(struct ast_channel *chan);
2111
2112 /*! Initiate system shutdown -- prevents new channels from being allocated.
2113  * \param hangup  If "hangup" is non-zero, all existing channels will receive soft
2114  *  hangups */
2115 void ast_begin_shutdown(int hangup);
2116
2117 /*! Cancels an existing shutdown and returns to normal operation */
2118 void ast_cancel_shutdown(void);
2119
2120 /*! \return number of channels available for lookup */
2121 int ast_active_channels(void);
2122
2123 /*! \return the number of channels not yet destroyed */
2124 int ast_undestroyed_channels(void);
2125
2126 /*! \return non-zero if Asterisk is being shut down */
2127 int ast_shutting_down(void);
2128
2129 /*! Activate a given generator */
2130 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
2131
2132 /*! Deactivate an active generator */
2133 void ast_deactivate_generator(struct ast_channel *chan);
2134
2135 /*!
2136  * \brief Set caller ID number, name and ANI and generate AMI event.
2137  *
2138  * \note Use ast_channel_set_caller() and ast_channel_set_caller_event() instead.
2139  * \note The channel does not need to be locked before calling this function.
2140  */
2141 void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
2142
2143 /*!
2144  * \brief Set the caller id information in the Asterisk channel
2145  * \since 1.8
2146  *
2147  * \param chan Asterisk channel to set caller id information
2148  * \param caller Caller id information
2149  * \param update What caller information to update.  NULL if all.
2150  *
2151  * \return Nothing
2152  *
2153  * \note The channel does not need to be locked before calling this function.
2154  */
2155 void ast_channel_set_caller(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2156
2157 /*!
2158  * \brief Set the caller id information in the Asterisk channel and generate an AMI event
2159  * if the caller id name or number changed.
2160  * \since 1.8
2161  *
2162  * \param chan Asterisk channel to set caller id information
2163  * \param caller Caller id information
2164  * \param update What caller information to update.  NULL if all.
2165  *
2166  * \return Nothing
2167  *
2168  * \note The channel does not need to be locked before calling this function.
2169  */
2170 void ast_channel_set_caller_event(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2171
2172 /*! Set the file descriptor on the channel */
2173 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
2174
2175 /*! Add a channel to an optimized waitfor */
2176 void ast_poll_channel_add(struct ast_channel *chan0, struct ast_channel *chan1);
2177
2178 /*! Delete a channel from an optimized waitfor */
2179 void ast_poll_channel_del(struct ast_channel *chan0, struct ast_channel *chan1);
2180
2181 /*! Start a tone going */
2182 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2183 /*! Stop a tone from playing */
2184 void ast_tonepair_stop(struct ast_channel *chan);
2185 /*! Play a tone pair for a given amount of time */
2186 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2187
2188 /*!
2189  * \brief Automatically service a channel for us...
2190  *
2191  * \retval 0 success
2192  * \retval -1 failure, or the channel is already being autoserviced
2193  */
2194 int ast_autoservice_start(struct ast_channel *chan);
2195
2196 /*!
2197  * \brief Stop servicing a channel for us...
2198  *
2199  * \note if chan is locked prior to calling ast_autoservice_stop, it
2200  * is likely that there will be a deadlock between the thread that calls
2201  * ast_autoservice_stop and the autoservice thread. It is important
2202  * that chan is not locked prior to this call
2203  *
2204  * \param chan
2205  * \retval 0 success
2206  * \retval -1 error, or the channel has been hungup
2207  */
2208 int ast_autoservice_stop(struct ast_channel *chan);
2209
2210 /*!
2211  * \brief Put chan into autoservice while hanging up peer.
2212  * \since 11.0
2213  *
2214  * \param chan Chan to put into autoservice.
2215  * \param peer Chan to run hangup handlers and hangup.
2216  *
2217  * \return Nothing
2218  */
2219 void ast_autoservice_chan_hangup_peer(struct ast_channel *chan, struct ast_channel *peer);
2220
2221 /*!
2222  * \brief Ignore certain frame types
2223  * \note Normally, we cache DTMF, IMAGE, HTML, TEXT, and CONTROL frames
2224  * while a channel is in autoservice and queue them up when taken out of
2225  * autoservice.  When this is not desireable, this API may be used to
2226  * cause the channel to ignore those frametypes after the channel is put
2227  * into autoservice, but before autoservice is stopped.
2228  * \retval 0 success
2229  * \retval -1 channel is not in autoservice
2230  */
2231 int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype);
2232
2233 /*!
2234  * \brief Enable or disable timer ticks for a channel
2235  *
2236  * \param c channel
2237  * \param rate number of timer ticks per second
2238  * \param func callback function
2239  * \param data
2240  *
2241  * \details
2242  * If timers are supported, force a scheduled expiration on the
2243  * timer fd, at which point we call the callback function / data
2244  *
2245  * \note Call this function with a rate of 0 to turn off the timer ticks
2246  *
2247  * \version 1.6.1 changed samples parameter to rate, accomodates new timing methods
2248  */
2249 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
2250
2251 /*!
2252  * \brief Transfer a channel (if supported).
2253  * \retval -1 on error
2254  * \retval 0 if not supported
2255  * \retval 1 if supported and requested
2256  * \param chan current channel
2257  * \param dest destination extension for transfer
2258  */
2259 int ast_transfer(struct ast_channel *chan, char *dest);
2260
2261 /*!
2262  * \brief Start masquerading a channel
2263  * \note absolutely _NO_ channel locks should be held before calling this function.
2264  * \details
2265  * XXX This is a seriously whacked out operation.  We're essentially putting the guts of
2266  *     the clone channel into the original channel.  Start by killing off the original
2267  *     channel's backend.   I'm not sure we're going to keep this function, because
2268  *     while the features are nice, the cost is very high in terms of pure nastiness. XXX
2269  * \param chan Channel to masquerade
2270  */
2271 int ast_do_masquerade(struct ast_channel *chan);
2272
2273 /*!
2274  * \brief Find bridged channel
2275  *
2276  * \note This function does _not_ return a reference to the bridged channel.
2277  * The reason for this is mostly historical.  It _should_ return a reference,
2278  * but it will take a lot of work to make the code base account for that.
2279  * So, for now, the old rules still apply for how to handle this function.
2280  * If this function is being used from the channel thread that owns the channel,
2281  * then a reference is already held, and channel locking is not required to
2282  * guarantee that the channel will stay around.  If this function is used
2283  * outside of the associated channel thread, the channel parameter 'chan'
2284  * MUST be locked before calling this function.  Also, 'chan' must remain locked
2285  * for the entire time that the result of this function is being used.
2286  *
2287  * \param chan Current channel
2288  *
2289  * \return A pointer to the bridged channel
2290 */
2291 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
2292
2293 /*!
2294  * \brief Inherits channel variable from parent to child channel
2295  * \param parent Parent channel
2296  * \param child Child channel
2297  *
2298  * \details
2299  * Scans all channel variables in the parent channel, looking for those
2300  * that should be copied into the child channel.
2301  * Variables whose names begin with a single '_' are copied into the
2302  * child channel with the prefix removed.
2303  * Variables whose names begin with '__' are copied into the child
2304  * channel with their names unchanged.
2305  */
2306 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
2307
2308 /*!
2309  * \brief adds a list of channel variables to a channel
2310  * \param chan the channel
2311  * \param vars a linked list of variables
2312  *
2313  * \details
2314  * Variable names can be for a regular channel variable or a dialplan function
2315  * that has the ability to be written to.
2316  */
2317 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
2318
2319 /*!
2320  * \brief An opaque 'object' structure use by silence generators on channels.
2321  */
2322 struct ast_silence_generator;
2323
2324 /*!
2325  * \brief Starts a silence generator on the given channel.
2326  * \param chan The channel to generate silence on
2327  * \return An ast_silence_generator pointer, or NULL if an error occurs
2328  *
2329  * \details
2330  * This function will cause SLINEAR silence to be generated on the supplied
2331  * channel until it is disabled; if the channel cannot be put into SLINEAR
2332  * mode then the function will fail.
2333  *
2334  * \note
2335  * The pointer returned by this function must be preserved and passed to
2336  * ast_channel_stop_silence_generator when you wish to stop the silence
2337  * generation.
2338  */
2339 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
2340
2341 /*!
2342  * \brief Stops a previously-started silence generator on the given channel.
2343  * \param chan The channel to operate on
2344  * \param state The ast_silence_generator pointer return by a previous call to
2345  * ast_channel_start_silence_generator.
2346  * \return nothing
2347  *
2348  * \details
2349  * This function will stop the operating silence generator and return the channel
2350  * to its previous write format.
2351  */
2352 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
2353
2354 /*!
2355  * \brief Check if the channel can run in internal timing mode.
2356  * \param chan The channel to check
2357  * \return boolean
2358  *
2359  * \details
2360  * This function will return 1 if internal timing is enabled and the timing
2361  * device is available.
2362  */
2363 int ast_internal_timing_enabled(struct ast_channel *chan);
2364
2365 /* Misc. functions below */
2366
2367 /*!
2368  * \brief if fd is a valid descriptor, set *pfd with the descriptor
2369  * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
2370  * return value to the index into the array)
2371  */
2372 static inline int ast_add_fd(struct pollfd *pfd, int fd)
2373 {
2374         pfd->fd = fd;
2375         pfd->events = POLLIN | POLLPRI;
2376         return fd >= 0;
2377 }
2378
2379 /*! \brief Helper function for migrating select to poll */
2380 static inline int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
2381 {
2382         int x;
2383         int dummy = 0;
2384
2385         if (fd < 0)
2386                 return 0;
2387         if (!start)
2388                 start = &dummy;
2389         for (x = *start; x < maximum; x++)
2390                 if (pfds[x].fd == fd) {
2391                         if (x == *start)
2392                                 (*start)++;
2393                         return pfds[x].revents;
2394                 }
2395         return 0;
2396 }
2397
2398 /*! \brief Retrieves the current T38 state of a channel */
2399 static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
2400 {
2401         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
2402         int datalen = sizeof(state);
2403
2404         ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
2405
2406         return state;
2407 }
2408
2409 #define CHECK_BLOCKING(c) do {   \
2410         if (ast_test_flag(ast_channel_flags(c), AST_FLAG_BLOCKING)) {\
2411                 ast_debug(1, "Thread %ld Blocking '%s', already blocked by thread %ld in procedure %s\n", (long) pthread_self(), ast_channel_name(c), (long) ast_channel_blocker(c), ast_channel_blockproc(c)); \
2412         } else { \
2413                 ast_channel_blocker_set((c), pthread_self()); \
2414                 ast_channel_blockproc_set((c), __PRETTY_FUNCTION__); \
2415                 ast_set_flag(ast_channel_flags(c), AST_FLAG_BLOCKING); \
2416         } } while (0)
2417
2418 ast_group_t ast_get_group(const char *s);
2419
2420 /*! \brief print call- and pickup groups into buffer */
2421 char *ast_print_group(char *buf, int buflen, ast_group_t group);
2422
2423 /*!
2424  * \brief Convert enum channelreloadreason to text string for manager event
2425  * \param reason The reason for reload (manager, cli, start etc)
2426  */
2427 const char *channelreloadreason2txt(enum channelreloadreason reason);
2428
2429 /*! \brief return an ast_variable list of channeltypes */
2430 struct ast_variable *ast_channeltype_list(void);
2431
2432 /*!
2433  * \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
2434  * \param reason  The integer argument, usually taken from AST_CONTROL_ macros
2435  * \return char pointer explaining the code
2436  */
2437 const char *ast_channel_reason2str(int reason);
2438
2439 /*! \brief channel group info */
2440 struct ast_group_info {
2441         struct ast_channel *chan;
2442         char *category;
2443         char *group;
2444         AST_LIST_ENTRY(ast_group_info) group_list;
2445 };
2446
2447 #define ast_channel_lock(chan) ao2_lock(chan)
2448 #define ast_channel_unlock(chan) ao2_unlock(chan)
2449 #define ast_channel_trylock(chan) ao2_trylock(chan)
2450
2451 /*!
2452  * \brief Lock two channels.
2453  */
2454 #define ast_channel_lock_both(chan1, chan2) do { \
2455                 ast_channel_lock(chan1); \
2456                 while (ast_channel_trylock(chan2)) { \
2457                         ast_channel_unlock(chan1); \
2458                         sched_yield(); \
2459                         ast_channel_lock(chan1); \
2460                 } \
2461         } while (0)
2462
2463 /*!
2464  * \brief Increase channel reference count
2465  *
2466  * \param c the channel
2467  *
2468  * \retval c always
2469  *
2470  * \since 1.8
2471  */
2472 #define ast_channel_ref(c) ({ ao2_ref(c, +1); (c); })
2473
2474 /*!
2475  * \brief Decrease channel reference count
2476  *
2477  * \param c the channel
2478  *
2479  * \retval NULL always
2480  *
2481  * \since 1.8
2482  */
2483 #define ast_channel_unref(c) ({ ao2_ref(c, -1); (struct ast_channel *) (NULL); })
2484
2485 /*! Channel Iterating @{ */
2486
2487 /*!
2488  * \brief A channel iterator
2489  *
2490  * This is an opaque type.
2491  */
2492 struct ast_channel_iterator;
2493
2494 /*!
2495  * \brief Destroy a channel iterator
2496  *
2497  * \param i the itereator to destroy
2498  *
2499  * \details
2500  * This function is used to destroy a channel iterator that was retrieved by
2501  * using one of the channel_iterator_xxx_new() functions.
2502  *
2503  * \return NULL, for convenience to clear out the pointer to the iterator that
2504  * was just destroyed.
2505  *
2506  * \since 1.8
2507  */
2508 struct ast_channel_iterator *ast_channel_iterator_destroy(struct ast_channel_iterator *i);
2509
2510 /*!
2511  * \brief Create a new channel iterator based on extension
2512  *
2513  * \param exten The extension that channels must be in
2514  * \param context The context that channels must be in
2515  *
2516  * \details
2517  * After creating an iterator using this function, the ast_channel_iterator_next()
2518  * function can be used to iterate through all channels that are currently
2519  * in the specified context and extension.
2520  *
2521  * \note You must call ast_channel_iterator_destroy() when done.
2522  *
2523  * \retval NULL on failure
2524  * \retval a new channel iterator based on the specified parameters
2525  *
2526  * \since 1.8
2527  */
2528 struct ast_channel_iterator *ast_channel_iterator_by_exten_new(const char *exten, const char *context);
2529
2530 /*!
2531  * \brief Create a new channel iterator based on name
2532  *
2533  * \param name channel name or channel uniqueid to match
2534  * \param name_len number of characters in the channel name to match on.  This
2535  *      would be used to match based on name prefix.  If matching on the full
2536  *      channel name is desired, then this parameter should be 0.
2537  *
2538  * \details
2539  * After creating an iterator using this function, the ast_channel_iterator_next()
2540  * function can be used to iterate through all channels that exist that have
2541  * the specified name or name prefix.
2542  *
2543  * \note You must call ast_channel_iterator_destroy() when done.
2544  *
2545  * \retval NULL on failure
2546  * \retval a new channel iterator based on the specified parameters
2547  *
2548  * \since 1.8
2549  */
2550 struct ast_channel_iterator *ast_channel_iterator_by_name_new(const char *name, size_t name_len);
2551
2552 /*!
2553  * \brief Create a new channel iterator
2554  *
2555  * \details
2556  * After creating an iterator using this function, the ast_channel_iterator_next()
2557  * function can be used to iterate through all channels that exist.
2558  *
2559  * \note You must call ast_channel_iterator_destroy() when done.
2560  *
2561  * \retval NULL on failure
2562  * \retval a new channel iterator
2563  *
2564  * \since 1.8
2565  */
2566 struct ast_channel_iterator *ast_channel_iterator_all_new(void);
2567
2568 /*!
2569  * \brief Get the next channel for a channel iterator
2570  *
2571  * \param i the channel iterator that was created using one of the
2572  *  channel_iterator_xxx_new() functions.
2573  *
2574  * \details
2575  * This function should be used to iterate through all channels that match a
2576  * specified set of parameters that were provided when the iterator was created.
2577  *
2578  * \retval the next channel that matches the parameters used when the iterator
2579  *         was created.
2580  * \retval NULL, if no more channels match the iterator parameters.
2581  *
2582  * \since 1.8
2583  */
2584 struct ast_channel *ast_channel_iterator_next(struct ast_channel_iterator *i);
2585
2586 /*! @} End channel iterator definitions. */
2587
2588 /*!
2589  * \brief Call a function with every active channel
2590  *
2591  * \details
2592  * This function executes a callback one time for each active channel on the
2593  * system.  The channel is provided as an argument to the function.
2594  *
2595  * \note Absolutely _NO_ channel locks should be held before calling this function.
2596  * \since 1.8
2597  */
2598 struct ast_channel *ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg,
2599                 void *data, int ao2_flags);
2600
2601 /*! @{ Channel search functions */
2602
2603 /*!
2604  * \brief Find a channel by name
2605  *
2606  * \param name the name or uniqueid of the channel to search for
2607  *
2608  * \details
2609  * Find a channel that has the same name as the provided argument.
2610  *
2611  * \retval a channel with the name specified by the argument
2612  * \retval NULL if no channel was found
2613  *
2614  * \since 1.8
2615  */
2616 struct ast_channel *ast_channel_get_by_name(const char *name);
2617
2618 /*!
2619  * \brief Find a channel by a name prefix
2620  *
2621  * \param name The channel name or uniqueid prefix to search for
2622  * \param name_len Only search for up to this many characters from the name
2623  *
2624  * \details
2625  * Find a channel that has the same name prefix as specified by the arguments.
2626  *
2627  * \retval a channel with the name prefix specified by the arguments
2628  * \retval NULL if no channel was found
2629  *
2630  * \since 1.8
2631  */
2632 struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len);
2633
2634 /*!
2635  * \brief Find a channel by extension and context
2636  *
2637  * \param exten the extension to search for
2638  * \param context the context to search for
2639  *
2640  * \details
2641  * Return a channel that is currently at the specified extension and context.
2642  *
2643  * \retval a channel that is at the specified extension and context
2644  * \retval NULL if no channel was found
2645  *
2646  * \since 1.8
2647  */
2648 struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context);
2649
2650 /*! @} End channel search functions. */
2651
2652 /*!
2653   \brief propagate the linked id between chan and peer
2654  */
2655 void ast_channel_set_linkgroup(struct ast_channel *chan, struct ast_channel *peer);
2656
2657
2658 /*!
2659  * \brief Initialize the given name structure.
2660  * \since 1.8
2661  *
2662  * \param init Name structure to initialize.
2663  *
2664  * \return Nothing
2665  */
2666 void ast_party_name_init(struct ast_party_name *init);
2667
2668 /*!
2669  * \brief Copy the source party name information to the destination party name.
2670  * \since 1.8
2671  *
2672  * \param dest Destination party name
2673  * \param src Source party name
2674  *
2675  * \return Nothing
2676  */
2677 void ast_party_name_copy(struct ast_party_name *dest, const struct ast_party_name *src);
2678
2679 /*!
2680  * \brief Initialize the given party name structure using the given guide
2681  * for a set update operation.
2682  * \since 1.8
2683  *
2684  * \details
2685  * The initialization is needed to allow a set operation to know if a
2686  * value needs to be updated.  Simple integers need the guide's original
2687  * value in case the set operation is not trying to set a new value.
2688  * String values are simply set to NULL pointers if they are not going
2689  * to be updated.
2690  *
2691  * \param init Party name structure to initialize.
2692  * \param guide Source party name to use as a guide in initializing.
2693  *
2694  * \return Nothing
2695  */
2696 void ast_party_name_set_init(struct ast_party_name *init, const struct ast_party_name *guide);
2697
2698 /*!
2699  * \brief Set the source party name information into the destination party name.
2700  * \since 1.8
2701  *
2702  * \param dest The name one wishes to update
2703  * \param src The new name values to update the dest
2704  *
2705  * \return Nothing
2706  */
2707 void ast_party_name_set(struct ast_party_name *dest, const struct ast_party_name *src);
2708
2709 /*!
2710  * \brief Destroy the party name contents
2711  * \since 1.8
2712  *
2713  * \param doomed The party name to destroy.
2714  *
2715  * \return Nothing
2716  */
2717 void ast_party_name_free(struct ast_party_name *doomed);
2718
2719 /*!
2720  * \brief Initialize the given number structure.
2721  * \since 1.8
2722  *
2723  * \param init Number structure to initialize.
2724  *
2725  * \return Nothing
2726  */
2727 void ast_party_number_init(struct ast_party_number *init);
2728
2729 /*!
2730  * \brief Copy the source party number information to the destination party number.
2731  * \since 1.8
2732  *
2733  * \param dest Destination party number
2734  * \param src Source party number
2735  *
2736  * \return Nothing
2737  */
2738 void ast_party_number_copy(struct ast_party_number *dest, const struct ast_party_number *src);
2739
2740 /*!
2741  * \brief Initialize the given party number structure using the given guide
2742  * for a set update operation.
2743  * \since 1.8
2744  *
2745  * \details
2746  * The initialization is needed to allow a set operation to know if a
2747  * value needs to be updated.  Simple integers need the guide's original
2748  * value in case the set operation is not trying to set a new value.
2749  * String values are simply set to NULL pointers if they are not going
2750  * to be updated.
2751  *
2752  * \param init Party number structure to initialize.
2753  * \param guide Source party number to use as a guide in initializing.
2754  *
2755  * \return Nothing
2756  */
2757 void ast_party_number_set_init(struct ast_party_number *init, const struct ast_party_number *guide);
2758
2759 /*!
2760  * \brief Set the source party number information into the destination party number.
2761  * \since 1.8
2762  *
2763  * \param dest The number one wishes to update
2764  * \param src The new number values to update the dest
2765  *
2766  * \return Nothing
2767  */
2768 void ast_party_number_set(struct ast_party_number *dest, const struct ast_party_number *src);
2769
2770 /*!
2771  * \brief Destroy the party number contents
2772  * \since 1.8
2773  *
2774  * \param doomed The party number to destroy.
2775  *
2776  * \return Nothing
2777  */
2778 void ast_party_number_free(struct ast_party_number *doomed);
2779
2780 /*!
2781  * \since 1.8
2782  * \brief Initialize the given subaddress structure.
2783  *
2784  * \param init Subaddress structure to initialize.
2785  *
2786  * \return Nothing
2787  */
2788 void ast_party_subaddress_init(struct ast_party_subaddress *init);
2789
2790 /*!
2791  * \since 1.8
2792  * \brief Copy the source party subaddress information to the destination party subaddress.
2793  *
2794  * \param dest Destination party subaddress
2795  * \param src Source party subaddress
2796  *
2797  * \return Nothing
2798  */
2799 void ast_party_subaddress_copy(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
2800
2801 /*!
2802  * \since 1.8
2803  * \brief Initialize the given party subaddress structure using the given guide
2804  * for a set update operation.
2805  *
2806  * \details
2807  * The initialization is needed to allow a set operation to know if a
2808  * value needs to be updated.  Simple integers need the guide's original
2809  * value in case the set operation is not trying to set a new value.
2810  * String values are simply set to NULL pointers if they are not going
2811  * to be updated.
2812  *
2813  * \param init Party subaddress structure to initialize.
2814  * \param guide Source party subaddress to use as a guide in initializing.
2815  *
2816  * \return Nothing
2817  */
2818 void ast_party_subaddress_set_init(struct ast_party_subaddress *init, const struct ast_party_subaddress *guide);
2819
2820 /*!
2821  * \since 1.8
2822  * \brief Set the source party subaddress information into the destination party subaddress.
2823  *
2824  * \param dest The subaddress one wishes to update
2825  * \param src The new subaddress values to update the dest
2826  *
2827  * \return Nothing
2828  */
2829 void ast_party_subaddress_set(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
2830
2831 /*!
2832  * \since 1.8
2833  * \brief Destroy the party subaddress contents
2834  *
2835  * \param doomed The party subaddress to destroy.
2836  *
2837  * \return Nothing
2838  */
2839 void ast_party_subaddress_free(struct ast_party_subaddress *doomed);
2840
2841 /*!
2842  * \brief Initialize the given party id structure.
2843  * \since 1.8
2844  *
2845  * \param init Party id structure to initialize.
2846  *
2847  * \return Nothing
2848  */
2849 void ast_party_id_init(struct ast_party_id *init);
2850
2851 /*!
2852  * \brief Copy the source party id information to the destination party id.
2853  * \since 1.8
2854  *
2855  * \param dest Destination party id
2856  * \param src Source party id
2857  *
2858  * \return Nothing
2859  */
2860 void ast_party_id_copy(struct ast_party_id *dest, const struct ast_party_id *src);
2861
2862 /*!
2863  * \brief Initialize the given party id structure using the given guide
2864  * for a set update operation.
2865  * \since 1.8
2866  *
2867  * \details
2868  * The initialization is needed to allow a set operation to know if a
2869  * value needs to be updated.  Simple integers need the guide's original
2870  * value in case the set operation is not trying to set a new value.
2871  * String values are simply set to NULL pointers if they are not going
2872  * to be updated.
2873  *
2874  * \param init Party id structure to initialize.
2875  * \param guide Source party id to use as a guide in initializing.
2876  *
2877  * \return Nothing
2878  */
2879 void ast_party_id_set_init(struct ast_party_id *init, const struct ast_party_id *guide);
2880
2881 /*!
2882  * \brief Set the source party id information into the destination party id.
2883  * \since 1.8
2884  *
2885  * \param dest The id one wishes to update
2886  * \param src The new id values to update the dest
2887  * \param update What id information to update.  NULL if all.
2888  *
2889  * \return Nothing
2890  */
2891 void ast_party_id_set(struct ast_party_id *dest, const struct ast_party_id *src, const struct ast_set_party_id *update);
2892
2893 /*!
2894  * \brief Destroy the party id contents
2895  * \since 1.8
2896  *
2897  * \param doomed The party id to destroy.
2898  *
2899  * \return Nothing
2900  */
2901 void ast_party_id_free(struct ast_party_id *doomed);
2902
2903 /*!
2904  * \brief Determine the overall presentation value for the given party.
2905  * \since 1.8
2906  *
2907  * \param id Party to determine the overall presentation value.
2908  *
2909  * \return Overall presentation value for the given party.
2910  */
2911 int ast_party_id_presentation(const struct ast_party_id *id);
2912
2913 /*!
2914  * \brief Initialize the given dialed structure.
2915  * \since 1.8
2916  *
2917  * \param init Dialed structure to initialize.
2918  *
2919  * \return Nothing
2920  */
2921 void ast_party_dialed_init(struct ast_party_dialed *init);
2922
2923 /*!
2924  * \brief Copy the source dialed party information to the destination dialed party.
2925  * \since 1.8
2926  *
2927  * \param dest Destination dialed party
2928  * \param src Source dialed party
2929  *
2930  * \return Nothing
2931  */
2932 void ast_party_dialed_copy(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
2933
2934 /*!
2935  * \brief Initialize the given dialed structure using the given
2936  * guide for a set update operation.
2937  * \since 1.8
2938  *
2939  * \details
2940  * The initialization is needed to allow a set operation to know if a
2941  * value needs to be updated.  Simple integers need the guide's original
2942  * value in case the set operation is not trying to set a new value.
2943  * String values are simply set to NULL pointers if they are not going
2944  * to be updated.
2945  *
2946  * \param init Caller structure to initialize.
2947  * \param guide Source dialed to use as a guide in initializing.
2948  *
2949  * \return Nothing
2950  */
2951 void ast_party_dialed_set_init(struct ast_party_dialed *init, const struct ast_party_dialed *guide);
2952
2953 /*!
2954  * \brief Set the dialed information based on another dialed source
2955  * \since 1.8
2956  *
2957  * This is similar to ast_party_dialed_copy, except that NULL values for
2958  * strings in the src parameter indicate not to update the corresponding dest values.
2959  *
2960  * \param dest The dialed one wishes to update
2961  * \param src The new dialed values to update the dest
2962  *
2963  * \return Nada
2964  */
2965 void ast_party_dialed_set(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
2966
2967 /*!
2968  * \brief Destroy the dialed party contents
2969  * \since 1.8
2970  *
2971  * \param doomed The dialed party to destroy.
2972  *
2973  * \return Nothing
2974  */
2975 void ast_party_dialed_free(struct ast_party_dialed *doomed);
2976
2977 /*!
2978  * \since 1.8
2979  * \brief Initialize the given caller structure.
2980  *
2981  * \param init Caller structure to initialize.
2982  *
2983  * \return Nothing
2984  */
2985 void ast_party_caller_init(struct ast_party_caller *init);
2986
2987 /*!
2988  * \since 1.8
2989  * \brief Copy the source caller information to the destination caller.
2990  *
2991  * \param dest Destination caller
2992  * \param src Source caller
2993  *
2994  * \return Nothing
2995  */
2996 void ast_party_caller_copy(struct ast_party_caller *dest, const struct ast_party_caller *src);
2997
2998 /*!
2999  * \brief Initialize the given caller structure using the given
3000  * guide for a set update operation.
3001  * \since 1.8
3002  *
3003  * \details
3004  * The initialization is needed to allow a set operation to know if a
3005  * value needs to be updated.  Simple integers need the guide's original
3006  * value in case the set operation is not trying to set a new value.
3007  * String values are simply set to NULL pointers if they are not going
3008  * to be updated.
3009  *
3010  * \param init Caller structure to initialize.
3011  * \param guide Source caller to use as a guide in initializing.
3012  *
3013  * \return Nothing
3014  */
3015 void ast_party_caller_set_init(struct ast_party_caller *init, const struct ast_party_caller *guide);
3016
3017 /*!
3018  * \brief Set the caller information based on another caller source
3019  * \since 1.8
3020  *
3021  * This is similar to ast_party_caller_copy, except that NULL values for
3022  * strings in the src parameter indicate not to update the corresponding dest values.
3023  *
3024  * \param dest The caller one wishes to update
3025  * \param src The new caller values to update the dest
3026  * \param update What caller information to update.  NULL if all.
3027  *
3028  * \return Nada
3029  */
3030 void ast_party_caller_set(struct ast_party_caller *dest, const struct ast_party_caller *src, const struct ast_set_party_caller *update);
3031
3032 /*!
3033  * \brief Destroy the caller party contents
3034  * \since 1.8
3035  *
3036  * \param doomed The caller party to destroy.
3037  *
3038  * \return Nothing
3039  */
3040 void ast_party_caller_free(struct ast_party_caller *doomed);
3041
3042 /*!
3043  * \since 1.8
3044  * \brief Initialize the given connected line structure.
3045  *
3046  * \param init Connected line structure to initialize.
3047  *
3048  * \return Nothing
3049  */
3050 void ast_party_connected_line_init(struct ast_party_connected_line *init);
3051
3052 /*!
3053  * \since 1.8
3054  * \brief Copy the source connected line information to the destination connected line.
3055  *
3056  * \param dest Destination connected line
3057  * \param src Source connected line
3058  *
3059  * \return Nothing
3060  */
3061 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
3062
3063 /*!
3064  * \since 1.8
3065  * \brief Initialize the given connected line structure using the given
3066  * guide for a set update operation.
3067  *
3068  * \details
3069  * The initialization is needed to allow a set operation to know if a
3070  * value needs to be updated.  Simple integers need the guide's original
3071  * value in case the set operation is not trying to set a new value.
3072  * String values are simply set to NULL pointers if they are not going
3073  * to be updated.
3074  *
3075  * \param init Connected line structure to initialize.
3076  * \param guide Source connected line to use as a guide in initializing.
3077  *
3078  * \return Nothing
3079  */
3080 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
3081
3082 /*!
3083  * \since 1.8
3084  * \brief Set the connected line information based on another connected line source
3085  *
3086  * This is similar to ast_party_connected_line_copy, except that NULL values for
3087  * strings in the src parameter indicate not to update the corresponding dest values.
3088  *
3089  * \param dest The connected line one wishes to update
3090  * \param src The new connected line values to update the dest
3091  * \param update What connected line information to update.  NULL if all.
3092  *
3093  * \return Nothing
3094  */
3095 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);
3096
3097 /*!
3098  * \since 1.8
3099  * \brief Collect the caller party information into a connected line structure.
3100  *
3101  * \param connected Collected caller information for the connected line
3102  * \param caller Caller information.
3103  *
3104  * \return Nothing
3105  *
3106  * \warning This is a shallow copy.
3107  * \warning DO NOT call ast_party_connected_line_free() on the filled in
3108  * connected line structure!
3109  */
3110 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_party_caller *caller);
3111
3112 /*!
3113  * \since 1.8
3114  * \brief Destroy the connected line information contents
3115  *
3116  * \param doomed The connected line information to destroy.
3117  *
3118  * \return Nothing
3119  */
3120 void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
3121
3122 /*!
3123  * \brief Initialize the given redirecting structure.
3124  * \since 1.8
3125  *
3126  * \param init Redirecting structure to initialize.
3127  *
3128  * \return Nothing
3129  */
3130 void ast_party_redirecting_init(struct ast_party_redirecting *init);
3131
3132 /*!
3133  * \since 1.8
3134  * \brief Copy the source redirecting information to the destination redirecting.
3135  *
3136  * \param dest Destination redirecting
3137  * \param src Source redirecting
3138  *
3139  * \return Nothing
3140  */
3141 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
3142
3143 /*!
3144  * \since 1.8
3145  * \brief Initialize the given redirecting id structure using the given guide
3146  * for a set update operation.
3147  *
3148  * \details
3149  * The initialization is needed to allow a set operation to know if a
3150  * value needs to be updated.  Simple integers need the guide's original
3151  * value in case the set operation is not trying to set a new value.
3152  * String values are simply set to NULL pointers if they are not going
3153  * to be updated.
3154  *
3155  * \param init Redirecting id structure to initialize.
3156  * \param guide Source redirecting id to use as a guide in initializing.
3157  *
3158  * \return Nothing
3159  */
3160 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
3161
3162 /*!
3163  * \brief Set the redirecting information based on another redirecting source
3164  * \since 1.8
3165  *
3166  * This is similar to ast_party_redirecting_copy, except that NULL values for
3167  * strings in the src parameter indicate not to update the corresponding dest values.
3168  *
3169  * \param dest The redirecting one wishes to update
3170  * \param src The new redirecting values to update the dest
3171  * \param update What redirecting information to update.  NULL if all.
3172  *
3173  * \return Nothing
3174  */
3175 void ast_party_redirecting_set(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src, const struct ast_set_party_redirecting *update);
3176
3177 /*!
3178  * \since 1.8
3179  * \brief Destroy the redirecting information contents
3180  *
3181  * \param doomed The redirecting information to destroy.
3182  *
3183  * \return Nothing
3184  */
3185 void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
3186
3187 /*!
3188  * \since 1.8
3189  * \brief Copy the caller information to the connected line information.
3190  *
3191  * \param dest Destination connected line information
3192  * \param src Source caller information
3193  *
3194  * \return Nothing
3195  *
3196  * \note Assumes locks are already acquired
3197  */
3198 void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_party_caller *src);
3199
3200 /*!
3201  * \since 1.8
3202  * \brief Copy the connected line information to the caller information.
3203  *
3204  * \param dest Destination caller information
3205  * \param src Source connected line information
3206  *
3207  * \return Nothing
3208  *
3209  * \note Assumes locks are already acquired
3210  */
3211 void ast_connected_line_copy_to_caller(struct ast_party_caller *dest, const struct ast_party_connected_line *src);
3212
3213 /*!
3214  * \since 1.8
3215  * \brief Set the connected line information in the Asterisk channel
3216  *
3217  * \param chan Asterisk channel to set connected line information
3218  * \param connected Connected line information
3219  * \param update What connected line information to update.  NULL if all.
3220  *
3221  * \return Nothing
3222  *
3223  * \note The channel does not need to be locked before calling this function.
3224  */
3225 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);
3226
3227 /*!
3228  * \since 1.8
3229  * \brief Build the connected line information data frame.
3230  *
3231  * \param data Buffer to fill with the frame data
3232  * \param datalen Size of the buffer to fill
3233  * \param connected Connected line information
3234  * \param update What connected line information to build.  NULL if all.
3235  *
3236  * \retval -1 if error
3237  * \retval Amount of data buffer used
3238  */
3239 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);
3240
3241 /*!
3242  * \since 1.8
3243  * \brief Parse connected line indication frame data
3244  *
3245  * \param data Buffer with the frame data to parse
3246  * \param datalen Size of the buffer
3247  * \param connected Extracted connected line information
3248  *
3249  * \retval 0 on success.
3250  * \retval -1 on error.
3251  *
3252  * \note The filled in connected line structure needs to be initialized by
3253  * ast_party_connected_line_set_init() before calling.  If defaults are not
3254  * required use ast_party_connected_line_init().
3255  * \note The filled in connected line structure needs to be destroyed by
3256  * ast_party_connected_line_free() when it is no longer needed.
3257  */
3258 int ast_connected_line_parse_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
3259
3260 /*!
3261  * \since 1.8
3262  * \brief Indicate that the connected line information has changed
3263  *
3264  * \param chan Asterisk channel to indicate connected line information
3265  * \param connected Connected line information
3266  * \param update What connected line information to update.  NULL if all.
3267  *
3268  * \return Nothing
3269  */
3270 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);
3271
3272 /*!
3273  * \since 1.8
3274  * \brief Queue a connected line update frame on a channel
3275  *
3276  * \param chan Asterisk channel to indicate connected line information
3277  * \param connected Connected line information
3278  * \param update What connected line information to update.  NULL if all.
3279  *
3280  * \return Nothing
3281  */
3282 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);
3283
3284 /*!
3285  * \since 1.8
3286  * \brief Set the redirecting id information in the Asterisk channel
3287  *
3288  * \param chan Asterisk channel to set redirecting id information
3289  * \param redirecting Redirecting id information
3290  * \param update What redirecting information to update.  NULL if all.
3291  *
3292  * \return Nothing
3293  *
3294  * \note The channel does not need to be locked before calling this function.
3295  */
3296 void ast_channel_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3297
3298 /*!
3299  * \since 1.8
3300  * \brief Build the redirecting id data frame.
3301  *
3302  * \param data Buffer to fill with the frame data
3303  * \param datalen Size of the buffer to fill
3304  * \param redirecting Redirecting id information
3305  * \param update What redirecting information to build.  NULL if all.
3306  *
3307  * \retval -1 if error
3308  * \retval Amount of data buffer used
3309  */
3310 int ast_redirecting_build_data(unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3311
3312 /*!
3313  * \since 1.8
3314  * \brief Parse redirecting indication frame data
3315  *
3316  * \param data Buffer with the frame data to parse
3317  * \param datalen Size of the buffer
3318  * \param redirecting Extracted redirecting id information
3319  *
3320  * \retval 0 on success.
3321  * \retval -1 on error.
3322  *
3323  * \note The filled in id structure needs to be initialized by
3324  * ast_party_redirecting_set_init() before calling.
3325  * \note The filled in id structure needs to be destroyed by
3326  * ast_party_redirecting_free() when it is no longer needed.
3327  */
3328 int ast_redirecting_parse_data(const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting);
3329
3330 /*!
3331  * \since 1.8
3332  * \brief Indicate that the redirecting id has changed
3333  *
3334  * \param chan Asterisk channel to indicate redirecting id information
3335  * \param redirecting Redirecting id information
3336  * \param update What redirecting information to update.  NULL if all.
3337  *
3338  * \return Nothing
3339  */
3340 void ast_channel_update_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3341
3342 /*!
3343  * \since 1.8
3344  * \brief Queue a redirecting update frame on a channel
3345  *
3346  * \param chan Asterisk channel to indicate redirecting id information
3347  * \param redirecting Redirecting id information
3348  * \param update What redirecting information to update.  NULL if all.
3349  *
3350  * \return Nothing
3351  */
3352 void ast_channel_queue_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3353
3354 /*!
3355  * \since 1.8
3356  * \brief Run a connected line interception macro and update a channel's connected line
3357  * information
3358  * \deprecated You should use the ast_channel_connected_line_sub() function instead.
3359  *
3360  * Whenever we want to update a channel's connected line information, we may need to run
3361  * a macro so that an administrator can manipulate the information before sending it
3362  * out. This function both runs the macro and sends the update to the channel.
3363  *
3364  * \param autoservice_chan Channel to place into autoservice while the macro is running.
3365  * It is perfectly safe for this to be NULL
3366  * \param macro_chan The channel to run the macro on. Also the channel from which we
3367  * determine which macro we need to run.
3368  * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type
3369  * AST_CONTROL_CONNECTED_LINE
3370  * \param is_caller If true, then run CONNECTED_LINE_CALLER_SEND_MACRO with arguments from
3371  * CONNECTED_LINE_CALLER_SEND_MACRO_ARGS, otherwise run CONNECTED_LINE_CALLEE_SEND_MACRO
3372  * with arguments from CONNECTED_LINE_CALLEE_SEND_MACRO_ARGS
3373  * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an
3374  * ast_party_connected_line pointer.
3375  * \retval 0 Success
3376  * \retval -1 Either the macro does not exist, or there was an error while attempting to
3377  * run the macro
3378  *
3379  * \todo Have multiple return codes based on the MACRO_RESULT
3380  * \todo Make constants so that caller and frame can be more expressive than just '1' and
3381  * '0'
3382  */
3383 int ast_channel_connected_line_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const void *connected_info, int is_caller, int frame);
3384
3385 /*!
3386  * \since 11
3387  * \brief Run a connected line interception subroutine and update a channel's connected line
3388  * information
3389  *
3390  * Whenever we want to update a channel's connected line information, we may need to run
3391  * a subroutine so that an administrator can manipulate the information before sending it
3392  * out. This function both runs the subroutine specified by CONNECTED_LINE_SEND_SUB and
3393  * sends the update to the channel.
3394  *
3395  * \param autoservice_chan Channel to place into autoservice while the sub is running.
3396  * It is perfectly safe for this to be NULL
3397  * \param sub_chan The channel to run the subroutine on. Also the channel from which we
3398  * determine which subroutine we need to run.
3399  * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type
3400  * AST_CONTROL_CONNECTED_LINE
3401  * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an
3402  * ast_party_connected_line pointer.
3403  * \retval 0 Success
3404  * \retval -1 Either the subroutine does not exist, or there was an error while attempting to
3405  * run the subroutine
3406  */
3407 int ast_channel_connected_line_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *connected_info, int frame);
3408
3409 /*!
3410  * \brief Insert into an astdata tree, the channel structure.
3411  * \param[in] tree The ast data tree.
3412  * \param[in] chan The channel structure to add to tree.
3413  * \param[in] add_bridged Add the bridged channel to the structure.
3414  * \retval <0 on error.
3415  * \retval 0 on success.
3416  */
3417 int ast_channel_data_add_structure(struct ast_data *tree, struct ast_channel *chan, int add_bridged);
3418
3419 /*!
3420  * \brief Compare to channel structures using the data api.
3421  * \param[in] tree The search tree generated by the data api.
3422  * \param[in] chan The channel to compare.
3423  * \param[in] structure_name The name of the node of the channel structure.
3424  * \retval 0 The structure matches.
3425  * \retval 1 The structure doesn't matches.
3426  */
3427 int ast_channel_data_cmp_structure(const struct ast_data_search *tree, struct ast_channel *chan,
3428         const char *structure_name);
3429
3430 /*!
3431  * \since 1.8
3432  * \brief Run a redirecting interception macro and update a channel's redirecting information
3433  * \deprecated You should use the ast_channel_redirecting_sub() function instead.
3434  *
3435  * \details
3436  * Whenever we want to update a channel's redirecting information, we may need to run
3437  * a macro so that an administrator can manipulate the information before sending it
3438  * out. This function both runs the macro and sends the update to the channel.
3439  *
3440  * \param autoservice_chan Channel to place into autoservice while the macro is running.
3441  * It is perfectly safe for this to be NULL
3442  * \param macro_chan The channel to run the macro on. Also the channel from which we
3443  * determine which macro we need to run.
3444  * \param redirecting_info Either an ast_party_redirecting or ast_frame pointer of type
3445  * AST_CONTROL_REDIRECTING
3446  * \param is_caller If true, then run REDIRECTING_CALLER_SEND_MACRO with arguments from
3447  * REDIRECTING_CALLER_SEND_MACRO_ARGS, otherwise run REDIRECTING_CALLEE_SEND_MACRO with
3448  * arguments from REDIRECTING_CALLEE_SEND_MACRO_ARGS
3449  * \param is_frame If true, then redirecting_info is an ast_frame pointer, otherwise it is an
3450  * ast_party_redirecting pointer.
3451  *
3452  * \retval 0 Success
3453  * \retval -1 Either the macro does not exist, or there was an error while attempting to
3454  * run the macro
3455  *
3456  * \todo Have multiple return codes based on the MACRO_RESULT
3457  * \todo Make constants so that caller and frame can be more expressive than just '1' and
3458  * '0'
3459  */
3460 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);
3461
3462 /*!
3463  * \since 11
3464  * \brief Run a redirecting interception subroutine and update a channel's redirecting information
3465  *
3466  * \details
3467  * Whenever we want to update a channel's redirecting information, we may need to run
3468  * a subroutine so that an administrator can manipulate the&nbs