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