aec7f75296c57e9fe89f1c61f2ba16351e9a61ed
[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         int (* const presencestate)(const char *presence_provider, char **subtype, char **message); /*!< Presencestate callback */
635
636         /*!
637          * \brief Start sending a literal DTMF digit
638          *
639          * \note The channel is not locked when this function gets called.
640          */
641         int (* const send_digit_begin)(struct ast_channel *chan, char digit);
642
643         /*!
644          * \brief Stop sending a literal DTMF digit
645          *
646          * \note The channel is not locked when this function gets called.
647          */
648         int (* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration);
649
650         /*!
651          * \brief Make a call
652          * \note The channel is locked when called.
653          * \param chan which channel to make the call on
654          * \param addr destination of the call
655          * \param timeout time to wait on for connect (Doesn't seem to be used.)
656          * \retval 0 on success
657          * \retval -1 on failure
658          */
659         int (* const call)(struct ast_channel *chan, const char *addr, int timeout);
660
661         /*! \brief Hangup (and possibly destroy) the channel */
662         int (* const hangup)(struct ast_channel *chan);
663
664         /*! \brief Answer the channel */
665         int (* const answer)(struct ast_channel *chan);
666
667         /*! \brief Read a frame, in standard format (see frame.h) */
668         struct ast_frame * (* const read)(struct ast_channel *chan);
669
670         /*! \brief Write a frame, in standard format (see frame.h) */
671         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
672
673         /*! \brief Display or transmit text */
674         int (* const send_text)(struct ast_channel *chan, const char *text);
675
676         /*! \brief Display or send an image */
677         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
678
679         /*! \brief Send HTML data */
680         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
681
682         /*! \brief Handle an exception, reading a frame */
683         struct ast_frame * (* const exception)(struct ast_channel *chan);
684
685         /*! \brief Bridge two channels of the same type together (early) */
686         enum ast_bridge_result (* const early_bridge)(struct ast_channel *c0, struct ast_channel *c1);
687
688         /*! \brief Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
689         int (* const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen);
690
691         /*! \brief Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
692         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
693
694         /*! \brief Set a given option. Called with chan locked */
695         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
696
697         /*! \brief Query a given option. Called with chan locked */
698         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
699
700         /*! \brief Blind transfer other side (see app_transfer.c and ast_transfer() */
701         int (* const transfer)(struct ast_channel *chan, const char *newdest);
702
703         /*! \brief Write a frame, in standard format */
704         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
705
706         /*! \brief Write a text frame, in standard format */
707         int (* const write_text)(struct ast_channel *chan, struct ast_frame *frame);
708
709         /*!
710          * \brief Provide additional read items for CHANNEL() dialplan function
711          * \note data should be treated as a const char *.
712          */
713         int (* func_channel_read)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
714
715         /*!
716          * \brief Provide additional write items for CHANNEL() dialplan function
717          * \note data should be treated as a const char *.
718          */
719         int (* func_channel_write)(struct ast_channel *chan, const char *function, char *data, const char *value);
720
721         /*! \brief Get the unique identifier for the PVT, i.e. SIP call-ID for SIP */
722         const char * (* get_pvt_uniqueid)(struct ast_channel *chan);
723
724         /*! \brief Call a function with cc parameters as a function parameter
725          *
726          * \details
727          * This is a highly specialized callback that is not likely to be needed in many
728          * channel drivers. When dealing with a busy channel, for instance, most channel
729          * drivers will successfully return a channel to the requester. Once called, the channel
730          * can then queue a busy frame when it receives an appropriate message from the far end.
731          * In such a case, the channel driver has the opportunity to also queue a CC frame.
732          * The parameters for the CC channel can be retrieved from the channel structure.
733          *
734          * For other channel drivers, notably those that deal with "dumb" phones, the channel
735          * driver will not return a channel when one is requested. In such a scenario, there is never
736          * an opportunity for the channel driver to queue a CC frame since the channel is never
737          * called. Furthermore, it is not possible to retrieve the CC configuration parameters
738          * for the desired channel because no channel is ever allocated or returned to the
739          * requester. In such a case, call completion may still be a viable option. What we do is
740          * pass the same string that the requester used originally to request the channel to the
741          * channel driver. The channel driver can then find any potential channels/devices that
742          * match the input and return call the designated callback with the device's call completion
743          * parameters as a parameter.
744          */
745         int (* cc_callback)(struct ast_channel *inbound, const char *dest, ast_cc_callback_fn callback);
746
747         /*!
748          * \brief Execute a Gosub call on the channel in a technology specific way before a call is placed.
749          * \since 11.0
750          *
751          * \param chan Channel to execute Gosub in a tech specific way.
752          * \param sub_args Gosub application parameter string.
753          *
754          * \note The chan is locked before calling.
755          *
756          * \retval 0 on success.
757          * \retval -1 on error.
758          */
759         int (*pre_call)(struct ast_channel *chan, const char *sub_args);
760 };
761
762 /*! Kill the channel channel driver technology descriptor. */
763 extern const struct ast_channel_tech ast_kill_tech;
764
765 struct ast_epoll_data;
766
767 /*!
768  * The high bit of the frame count is used as a debug marker, so
769  * increments of the counters must be done with care.
770  * Please use c->fin = FRAMECOUNT_INC(c->fin) and the same for c->fout.
771  */
772 #define DEBUGCHAN_FLAG  0x80000000
773
774 /* XXX not ideal to evaluate x twice... */
775 #define FRAMECOUNT_INC(x)       ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
776
777 /*!
778  * The current value of the debug flags is stored in the two
779  * variables global_fin and global_fout (declared in main/channel.c)
780  */
781 extern unsigned long global_fin, global_fout;
782
783 enum ast_channel_adsicpe {
784         AST_ADSI_UNKNOWN,
785         AST_ADSI_AVAILABLE,
786         AST_ADSI_UNAVAILABLE,
787         AST_ADSI_OFFHOOKONLY,
788 };
789
790 /*!
791  * \brief Possible T38 states on channels
792  */
793 enum ast_t38_state {
794         T38_STATE_UNAVAILABLE,  /*!< T38 is unavailable on this channel or disabled by configuration */
795         T38_STATE_UNKNOWN,      /*!< The channel supports T38 but the current status is unknown */
796         T38_STATE_NEGOTIATING,  /*!< T38 is being negotiated */
797         T38_STATE_REJECTED,     /*!< Remote side has rejected our offer */
798         T38_STATE_NEGOTIATED,   /*!< T38 established */
799 };
800
801 /*! Hangup handler instance node. */
802 struct ast_hangup_handler {
803         /*! Next hangup handler node. */
804         AST_LIST_ENTRY(ast_hangup_handler) node;
805         /*! Hangup handler arg string passed to the Gosub application */
806         char args[0];
807 };
808
809 AST_LIST_HEAD_NOLOCK(ast_hangup_handler_list, ast_hangup_handler);
810 AST_LIST_HEAD_NOLOCK(ast_datastore_list, ast_datastore);
811 AST_LIST_HEAD_NOLOCK(ast_autochan_list, ast_autochan);
812 AST_LIST_HEAD_NOLOCK(ast_readq_list, ast_frame);
813
814 typedef int(*ast_timing_func_t)(const void *data);
815 /*!
816  * \page AstChannel ast_channel locking and reference tracking
817  *
818  * \par Creating Channels
819  * A channel is allocated using the ast_channel_alloc() function.  When created, it is
820  * automatically inserted into the main channels hash table that keeps track of all
821  * active channels in the system.  The hash key is based on the channel name.  Because
822  * of this, if you want to change the name, you _must_ use ast_change_name(), not change
823  * the name field directly.  When ast_channel_alloc() returns a channel pointer, you now
824  * hold both a reference to that channel and a lock on the channel. Once the channel has
825  * been set up the lock can be released. In most cases the reference is given to ast_pbx_run().
826  *
827  * \par Channel Locking
828  * There is a lock associated with every ast_channel.  It is allocated internally via astobj2.
829  * To lock or unlock a channel, you must use the ast_channel_lock() wrappers.
830  *
831  * Previously, before ast_channel was converted to astobj2, the channel lock was used in some
832  * additional ways that are no longer necessary.  Before, the only way to ensure that a channel
833  * did not disappear out from under you if you were working with a channel outside of the channel
834  * thread that owns it, was to hold the channel lock.  Now, that is no longer necessary.
835  * You simply must hold a reference to the channel to ensure it does not go away.
836  *
837  * The channel must be locked if you need to ensure that data that you reading from the channel
838  * does not change while you access it.  Further, you must hold the channel lock if you are
839  * making a non-atomic change to channel data.
840  *
841  * \par Channel References
842  * There are multiple ways to get a reference to a channel.  The first is that you hold a reference
843  * to a channel after creating it.  The other ways involve using the channel search or the channel
844  * traversal APIs.  These functions are the ast_channel_get_*() functions or ast_channel_iterator_*()
845  * functions.  Once a reference is retrieved by one of these methods, you know that the channel will
846  * not go away.  So, the channel should only get locked as needed for data access or modification.
847  * But, make sure that the reference gets released when you are done with it!
848  *
849  * There are different things you can do when you are done with a reference to a channel.  The first
850  * is to simply release the reference using ast_channel_unref().  The other option is to call
851  * ast_channel_release().  This function is generally used where ast_channel_free() was used in
852  * the past.  The release function releases a reference as well as ensures that the channel is no
853  * longer in the global channels container.  That way, the channel will get destroyed as soon as any
854  * other pending references get released.
855  *
856  * \par Exceptions to the rules
857  * Even though ast_channel is reference counted, there are some places where pointers to an ast_channel
858  * get stored, but the reference count does not reflect it.  The reason is mostly historical.
859  * The only places where this happens should be places where because of how the code works, we
860  * _know_ that the pointer to the channel will get removed before the channel goes away.  The main
861  * example of this is in channel drivers.  Channel drivers generally store a pointer to their owner
862  * ast_channel in their technology specific pvt struct.  In this case, the channel drivers _know_
863  * that this pointer to the channel will be removed in time, because the channel's hangup callback
864  * gets called before the channel goes away.
865  */
866
867 struct ast_channel;
868
869 /*! \brief ast_channel_tech Properties */
870 enum {
871         /*!
872          * \brief Channels have this property if they can accept input with jitter;
873          * i.e. most VoIP channels
874          */
875         AST_CHAN_TP_WANTSJITTER = (1 << 0),
876         /*!
877          * \brief Channels have this property if they can create jitter;
878          * i.e. most VoIP channels
879          */
880         AST_CHAN_TP_CREATESJITTER = (1 << 1),
881         /*!
882          * \brief Channels with this particular technology are an implementation detail of
883          * Asterisk and should generally not be exposed or manipulated by the outside
884          * world
885          */
886         AST_CHAN_TP_INTERNAL = (1 << 2),
887 };
888
889 /*! \brief ast_channel flags */
890 enum {
891         /*! Queue incoming DTMF, to be released when this flag is turned off */
892         AST_FLAG_DEFER_DTMF =    (1 << 1),
893         /*! write should be interrupt generator */
894         AST_FLAG_WRITE_INT =     (1 << 2),
895         /*! a thread is blocking on this channel */
896         AST_FLAG_BLOCKING =      (1 << 3),
897         /*! This is a zombie channel */
898         AST_FLAG_ZOMBIE =        (1 << 4),
899         /*! There is an exception pending */
900         AST_FLAG_EXCEPTION =     (1 << 5),
901         /*! Listening to moh XXX anthm promises me this will disappear XXX */
902         AST_FLAG_MOH =           (1 << 6),
903         /*! This channel is spying on another channel */
904         AST_FLAG_SPYING =        (1 << 7),
905         /*! the channel is in an auto-incrementing dialplan processor,
906          *  so when ->priority is set, it will get incremented before
907          *  finding the next priority to run */
908         AST_FLAG_IN_AUTOLOOP =   (1 << 9),
909         /*! This is an outgoing call */
910         AST_FLAG_OUTGOING =      (1 << 10),
911         /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
912         AST_FLAG_IN_DTMF =       (1 << 12),
913         /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is
914          *  currently being emulated */
915         AST_FLAG_EMULATE_DTMF =  (1 << 13),
916         /*! This is set to tell the channel not to generate DTMF begin frames, and
917          *  to instead only generate END frames. */
918         AST_FLAG_END_DTMF_ONLY = (1 << 14),
919         /* OBSOLETED in favor of AST_CAUSE_ANSWERED_ELSEWHERE
920          * Flag to show channels that this call is hangup due to the fact that the call
921          * was indeed answered, but in another channel */
922         /* AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15), */
923         /*! This flag indicates that on a masquerade, an active stream should not
924          *  be carried over */
925         AST_FLAG_MASQ_NOSTREAM = (1 << 16),
926         /*! This flag indicates that the hangup exten was run when the bridge terminated,
927          *  a message aimed at preventing a subsequent hangup exten being run at the pbx_run
928          *  level */
929         AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
930         /*! Disable certain workarounds.  This reintroduces certain bugs, but allows
931          *  some non-traditional dialplans (like AGI) to continue to function.
932          */
933         AST_FLAG_DISABLE_WORKAROUNDS = (1 << 20),
934         /*!
935          * Disable device state event caching.  This allows channel
936          * drivers to selectively prevent device state events from being
937          * cached by certain channels such as anonymous calls which have
938          * no persistent represenatation that can be tracked.
939          */
940         AST_FLAG_DISABLE_DEVSTATE_CACHE = (1 << 21),
941         /*!
942          * This flag indicates that a dual channel redirect is in
943          * progress.  The bridge needs to wait until the flag is cleared
944          * to continue.
945          */
946         AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT = (1 << 22),
947         /*!
948          * This flag indicates that the channel was originated.
949          */
950         AST_FLAG_ORIGINATED = (1 << 23),
951         /*!
952          * The channel is well and truly dead. Once this is set and published, no further
953          * actions should be taken upon the channel, and no further publications should
954          * occur.
955          */
956         AST_FLAG_DEAD = (1 << 24),
957         /*!
958          * Channel snapshot should not be published, it is being staged for an explicit
959          * publish.
960          */
961         AST_FLAG_SNAPSHOT_STAGE = (1 << 25),
962         /*!
963          * The data on chan->timingdata is an astobj2 object.
964          */
965         AST_FLAG_TIMINGDATA_IS_AO2_OBJ = (1 << 26),
966         /*!
967          * The channel is executing a subroutine or macro
968          */
969         AST_FLAG_SUBROUTINE_EXEC = (1 << 27),
970 };
971
972 /*! \brief ast_bridge_config flags */
973 enum {
974         AST_FEATURE_PLAY_WARNING = (1 << 0),
975         AST_FEATURE_REDIRECT =     (1 << 1),
976         AST_FEATURE_DISCONNECT =   (1 << 2),
977         AST_FEATURE_ATXFER =       (1 << 3),
978         AST_FEATURE_AUTOMON =      (1 << 4),
979         AST_FEATURE_PARKCALL =     (1 << 5),
980         AST_FEATURE_AUTOMIXMON =   (1 << 6),
981 };
982
983 #define AST_FEATURE_DTMF_MASK (AST_FEATURE_REDIRECT | AST_FEATURE_DISCONNECT |\
984         AST_FEATURE_ATXFER | AST_FEATURE_AUTOMON | AST_FEATURE_PARKCALL | AST_FEATURE_AUTOMIXMON)
985
986 /*! \brief bridge configuration */
987 struct ast_bridge_config {
988         struct ast_flags features_caller;
989         struct ast_flags features_callee;
990         struct timeval start_time;
991         struct timeval nexteventts;
992         struct timeval feature_start_time;
993         long feature_timer;
994         long timelimit;
995         long play_warning;
996         long warning_freq;
997         const char *warning_sound;
998         const char *end_sound;
999         const char *start_sound;
1000         unsigned int flags;
1001         void (* end_bridge_callback)(void *);   /*!< A callback that is called after a bridge attempt */
1002         void *end_bridge_callback_data;         /*!< Data passed to the callback */
1003         /*! If the end_bridge_callback_data refers to a channel which no longer is going to
1004          * exist when the end_bridge_callback is called, then it needs to be fixed up properly
1005          */
1006         void (*end_bridge_callback_data_fixup)(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator);
1007 };
1008
1009 struct chanmon;
1010
1011 struct outgoing_helper {
1012         const char *context;
1013         const char *exten;
1014         int priority;
1015         int connect_on_early_media;     /* If set, treat session progress as answer */
1016         const char *cid_num;
1017         const char *cid_name;
1018         const char *account;
1019         struct ast_variable *vars;
1020         struct ast_channel *parent_channel;
1021 };
1022
1023 enum {
1024         /*!
1025          * Soft hangup requested by device or other internal reason.
1026          * Actual hangup needed.
1027          */
1028         AST_SOFTHANGUP_DEV =       (1 << 0),
1029         /*!
1030          * Used to break the normal frame flow so an async goto can be
1031          * done instead of actually hanging up.
1032          */
1033         AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
1034         /*!
1035          * Soft hangup requested by system shutdown.  Actual hangup
1036          * needed.
1037          */
1038         AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
1039         /*!
1040          * Used to break the normal frame flow after a timeout so an
1041          * implicit async goto can be done to the 'T' exten if it exists
1042          * instead of actually hanging up.  If the exten does not exist
1043          * then actually hangup.
1044          */
1045         AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
1046         /*!
1047          * Soft hangup requested by application/channel-driver being
1048          * unloaded.  Actual hangup needed.
1049          */
1050         AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
1051         /*!
1052          * Soft hangup requested by non-associated party.  Actual hangup
1053          * needed.
1054          */
1055         AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
1056         /*!
1057          * Used to indicate that the channel is currently executing hangup
1058          * logic in the dialplan. The channel has been hungup when this is
1059          * set.
1060          */
1061         AST_SOFTHANGUP_HANGUP_EXEC = (1 << 7),
1062         /*!
1063          * \brief All softhangup flags.
1064          *
1065          * This can be used as an argument to ast_channel_clear_softhangup()
1066          * to clear all softhangup flags from a channel.
1067          */
1068         AST_SOFTHANGUP_ALL =       (0xFFFFFFFF)
1069 };
1070
1071
1072 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
1073 enum channelreloadreason {
1074         CHANNEL_MODULE_LOAD,
1075         CHANNEL_MODULE_RELOAD,
1076         CHANNEL_CLI_RELOAD,
1077         CHANNEL_MANAGER_RELOAD,
1078         CHANNEL_ACL_RELOAD,
1079 };
1080
1081 /*!
1082  * \brief Channel AMA Flags
1083  */
1084 enum ama_flags {
1085         AST_AMA_NONE = 0,
1086         AST_AMA_OMIT,
1087         AST_AMA_BILLING,
1088         AST_AMA_DOCUMENTATION,
1089 };
1090
1091 /*!
1092  * \note None of the datastore API calls lock the ast_channel they are using.
1093  *       So, the channel should be locked before calling the functions that
1094  *       take a channel argument.
1095  */
1096
1097 /*!
1098  * \brief Create a channel data store object
1099  * \deprecated You should use the ast_datastore_alloc() generic function instead.
1100  * \version 1.6.1 deprecated
1101  */
1102 struct ast_datastore * attribute_malloc ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
1103         __attribute__((deprecated));
1104
1105 /*!
1106  * \brief Free a channel data store object
1107  * \deprecated You should use the ast_datastore_free() generic function instead.
1108  * \version 1.6.1 deprecated
1109  */
1110 int ast_channel_datastore_free(struct ast_datastore *datastore)
1111         __attribute__((deprecated));
1112
1113 /*! \brief Inherit datastores from a parent to a child. */
1114 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to);
1115
1116 /*!
1117  * \brief Add a datastore to a channel
1118  *
1119  * \note The channel should be locked before calling this function.
1120  *
1121  * \retval 0 success
1122  * \retval non-zero failure
1123  */
1124 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore);
1125
1126 /*!
1127  * \brief Remove a datastore from a channel
1128  *
1129  * \note The channel should be locked before calling this function.
1130  *
1131  * \retval 0 success
1132  * \retval non-zero failure
1133  */
1134 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore);
1135
1136 /*!
1137  * \brief Find a datastore on a channel
1138  *
1139  * \note The channel should be locked before calling this function.
1140  *
1141  * \note The datastore returned from this function must not be used if the
1142  *       reference to the channel is released.
1143  *
1144  * \retval pointer to the datastore if found
1145  * \retval NULL if not found
1146  */
1147 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid);
1148
1149 /*!
1150  * \brief Create a channel structure
1151  * \since 1.8
1152  *
1153  * \retval NULL failure
1154  * \retval non-NULL successfully allocated channel
1155  *
1156  * \note Absolutely _NO_ channel locks should be held before calling this function.
1157  * \note By default, new channels are set to the "s" extension
1158  *       and "default" context.
1159  * \note Since 12.0.0 this function returns with the newly created channel locked.
1160  */
1161 struct ast_channel * attribute_malloc __attribute__((format(printf, 15, 16)))
1162         __ast_channel_alloc(int needqueue, int state, const char *cid_num,
1163                 const char *cid_name, const char *acctcode,
1164                 const char *exten, const char *context, const struct ast_assigned_ids *assignedids,
1165                 const struct ast_channel *requestor, enum ama_flags amaflag,
1166                 struct ast_endpoint *endpoint,
1167                 const char *file, int line, const char *function,
1168                 const char *name_fmt, ...);
1169
1170 /*!
1171  * \brief Create a channel structure
1172  *
1173  * \retval NULL failure
1174  * \retval non-NULL successfully allocated channel
1175  *
1176  * \note Absolutely _NO_ channel locks should be held before calling this function.
1177  * \note By default, new channels are set to the "s" extension
1178  *       and "default" context.
1179  * \note Since 12.0.0 this function returns with the newly created channel locked.
1180  */
1181 #define ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, assignedids, requestor, amaflag, ...) \
1182         __ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, assignedids, requestor, amaflag, NULL, \
1183                 __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
1184
1185 #define ast_channel_alloc_with_endpoint(needqueue, state, cid_num, cid_name, acctcode, exten, context, assignedids, requestor, amaflag, endpoint, ...) \
1186         __ast_channel_alloc((needqueue), (state), (cid_num), (cid_name), (acctcode), (exten), (context), (assignedids), (requestor), (amaflag), (endpoint), \
1187                 __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
1188
1189 /*!
1190  * \brief Create a fake channel structure
1191  *
1192  * \retval NULL failure
1193  * \retval non-NULL successfully allocated channel
1194  *
1195  * \note This function should ONLY be used to create a fake channel
1196  *       that can then be populated with data for use in variable
1197  *       substitution when a real channel does not exist.
1198  *
1199  * \note The created dummy channel should be destroyed by
1200  * ast_channel_unref().  Using ast_channel_release() needlessly
1201  * grabs the channel container lock and can cause a deadlock as
1202  * a result.  Also grabbing the channel container lock reduces
1203  * system performance.
1204  */
1205 #define ast_dummy_channel_alloc()       __ast_dummy_channel_alloc(__FILE__, __LINE__, __PRETTY_FUNCTION__)
1206 struct ast_channel *__ast_dummy_channel_alloc(const char *file, int line, const char *function);
1207
1208 /*!
1209  * \brief Queue one or more frames to a channel's frame queue
1210  *
1211  * \param chan the channel to queue the frame(s) on
1212  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1213  *        by this function.  It is the responsibility of the caller to handle
1214  *        freeing the memory associated with the frame(s) being passed if
1215  *        necessary.
1216  *
1217  * \retval 0 success
1218  * \retval non-zero failure
1219  */
1220 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
1221
1222 /*!
1223  * \brief Queue one or more frames to the head of a channel's frame queue
1224  *
1225  * \param chan the channel to queue the frame(s) on
1226  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1227  *        by this function.  It is the responsibility of the caller to handle
1228  *        freeing the memory associated with the frame(s) being passed if
1229  *        necessary.
1230  *
1231  * \retval 0 success
1232  * \retval non-zero failure
1233  */
1234 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *f);
1235
1236 /*!
1237  * \brief Queue a hangup frame
1238  *
1239  * \note The channel does not need to be locked before calling this function.
1240  */
1241 int ast_queue_hangup(struct ast_channel *chan);
1242
1243 /*!
1244  * \brief Queue a hangup frame with hangupcause set
1245  *
1246  * \note The channel does not need to be locked before calling this function.
1247  * \param[in] chan channel to queue frame onto
1248  * \param[in] cause the hangup cause
1249  * \return 0 on success, -1 on error
1250  * \since 1.6.1
1251  */
1252 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause);
1253
1254 /*!
1255  * \brief Queue a hold frame
1256  *
1257  * \param chan channel to queue frame onto
1258  * \param musicclass The suggested musicclass for the other end to use
1259  *
1260  * \note The channel does not need to be locked before calling this function.
1261  *
1262  * \retval zero on success
1263  * \retval non-zero on failure
1264  */
1265 int ast_queue_hold(struct ast_channel *chan, const char *musicclass);
1266
1267 /*!
1268  * \brief Queue an unhold frame
1269  *
1270  * \param chan channel to queue frame onto
1271  *
1272  * \note The channel does not need to be locked before calling this function.
1273  *
1274  * \retval zero on success
1275  * \retval non-zero on failure
1276  */
1277 int ast_queue_unhold(struct ast_channel *chan);
1278
1279 /*!
1280  * \brief Queue a control frame without payload
1281  *
1282  * \param chan channel to queue frame onto
1283  * \param control type of control frame
1284  *
1285  * \note The channel does not need to be locked before calling this function.
1286  *
1287  * \retval zero on success
1288  * \retval non-zero on failure
1289  */
1290 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control);
1291
1292 /*!
1293  * \brief Queue a control frame with payload
1294  *
1295  * \param chan channel to queue frame onto
1296  * \param control type of control frame
1297  * \param data pointer to payload data to be included in frame
1298  * \param datalen number of bytes of payload data
1299  *
1300  * \retval 0 success
1301  * \retval non-zero failure
1302  *
1303  * \details
1304  * The supplied payload data is copied into the frame, so the caller's copy
1305  * is not modified nor freed, and the resulting frame will retain a copy of
1306  * the data even if the caller frees their local copy.
1307  *
1308  * \note This method should be treated as a 'network transport'; in other
1309  * words, your frames may be transferred across an IAX2 channel to another
1310  * system, which may be a different endianness than yours. Because of this,
1311  * you should ensure that either your frames will never be expected to work
1312  * across systems, or that you always put your payload data into 'network byte
1313  * order' before calling this function.
1314  *
1315  * \note The channel does not need to be locked before calling this function.
1316  */
1317 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
1318                            const void *data, size_t datalen);
1319
1320 /*!
1321  * \brief Change channel name
1322  *
1323  * \pre Absolutely all channels _MUST_ be unlocked before calling this function.
1324  *
1325  * \param chan the channel to change the name of
1326  * \param newname the name to change to
1327  *
1328  * \return nothing
1329  *
1330  * \note this function must _NEVER_ be used when any channels are locked
1331  * regardless if it is the channel who's name is being changed or not because
1332  * it invalidates our channel container locking order... lock container first,
1333  * then the individual channels, never the other way around.
1334  */
1335 void ast_change_name(struct ast_channel *chan, const char *newname);
1336
1337 /*!
1338  * \brief Unlink and release reference to a channel
1339  *
1340  * This function will unlink the channel from the global channels container
1341  * if it is still there and also release the current reference to the channel.
1342  *
1343  * \return NULL, convenient for clearing invalid pointers
1344  * \note Absolutely _NO_ channel locks should be held before calling this function.
1345  *
1346  * \since 1.8
1347  */
1348 struct ast_channel *ast_channel_release(struct ast_channel *chan);
1349
1350 /*!
1351  * \brief Requests a channel
1352  *
1353  * \param type type of channel to request
1354  * \param request_cap Format capabilities for requested channel
1355  * \param assignedids Unique ID to create channel with
1356  * \param requestor channel asking for data
1357  * \param addr destination of the call
1358  * \param cause Cause of failure
1359  *
1360  * \details
1361  * Request a channel of a given type, with addr as optional information used
1362  * by the low level module
1363  *
1364  * \retval NULL failure
1365  * \retval non-NULL channel on success
1366  */
1367 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);
1368
1369 enum ast_channel_requestor_relationship {
1370         /*! The requestor is the future bridge peer of the channel. */
1371         AST_CHANNEL_REQUESTOR_BRIDGE_PEER,
1372         /*! The requestor is to be replaced by the channel. */
1373         AST_CHANNEL_REQUESTOR_REPLACEMENT,
1374 };
1375
1376 /*!
1377  * \brief Setup new channel accountcodes from the requestor channel after ast_request().
1378  * \since 13.0.0
1379  *
1380  * \param chan New channel to get accountcodes setup.
1381  * \param requestor Requesting channel to get accountcodes from.
1382  * \param relationship What the new channel was created for.
1383  *
1384  * \pre The chan and requestor channels are already locked.
1385  *
1386  * \note Pre-existing accountcodes on chan will be overwritten.
1387  *
1388  * \return Nothing
1389  */
1390 void ast_channel_req_accountcodes(struct ast_channel *chan, const struct ast_channel *requestor, enum ast_channel_requestor_relationship relationship);
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 not be overwritten.
1403  *
1404  * \return Nothing
1405  */
1406 void ast_channel_req_accountcodes_precious(struct ast_channel *chan, const struct ast_channel *requestor, enum ast_channel_requestor_relationship relationship);
1407
1408 /*!
1409  * \brief Request a channel of a given type, with data as optional information used
1410  *        by the low level module and attempt to place a call on it
1411  *
1412  * \param type type of channel to request
1413  * \param cap format capabilities for requested channel
1414  * \param assignedids Unique Id to assign to channel
1415  * \param requestor channel asking for data
1416  * \param addr destination of the call
1417  * \param timeout maximum amount of time to wait for an answer
1418  * \param reason why unsuccessful (if unsuccessful)
1419  * \param cid_num Caller-ID Number
1420  * \param cid_name Caller-ID Name (ascii)
1421  *
1422  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1423  * to know if the call was answered or not.
1424  */
1425 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,
1426         int timeout, int *reason, const char *cid_num, const char *cid_name);
1427
1428 /*!
1429  * \brief Request a channel of a given type, with data as optional information used
1430  * by the low level module and attempt to place a call on it
1431  * \param type type of channel to request
1432  * \param cap format capabilities for requested channel
1433  * \param assignedids Unique Id to assign to channel
1434  * \param requestor channel requesting data
1435  * \param addr destination of the call
1436  * \param timeout maximum amount of time to wait for an answer
1437  * \param reason why unsuccessful (if unsuccessful)
1438  * \param cid_num Caller-ID Number
1439  * \param cid_name Caller-ID Name (ascii)
1440  * \param oh Outgoing helper
1441  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1442  * to know if the call was answered or not.
1443  */
1444 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,
1445         int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
1446
1447 /*!
1448  * \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.
1449  * \param caller in channel that requested orig
1450  * \param orig channel being replaced by the call forward channel
1451  * \param timeout maximum amount of time to wait for setup of new forward channel
1452  * \param cap format capabilities for requested channel
1453  * \param oh outgoing helper used with original channel
1454  * \param outstate reason why unsuccessful (if uncuccessful)
1455  * \return Returns the forwarded call's ast_channel on success or NULL on failure
1456  */
1457 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);
1458
1459 /*!
1460  * \brief Register a channel technology (a new channel driver)
1461  * Called by a channel module to register the kind of channels it supports.
1462  * \param tech Structure defining channel technology or "type"
1463  * \return Returns 0 on success, -1 on failure.
1464  */
1465 int ast_channel_register(const struct ast_channel_tech *tech);
1466
1467 /*!
1468  * \brief Unregister a channel technology
1469  * \param tech Structure defining channel technology or "type" that was previously registered
1470  * \return No return value.
1471  */
1472 void ast_channel_unregister(const struct ast_channel_tech *tech);
1473
1474 /*!
1475  * \brief Get a channel technology structure by name
1476  * \param name name of technology to find
1477  * \return a pointer to the structure, or NULL if no matching technology found
1478  */
1479 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
1480
1481 /*!
1482  * \brief Hang up a channel
1483  * \note Absolutely _NO_ channel locks should be held before calling this function.
1484  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
1485  * performs all stream stopping, etc, on the channel that needs to end.
1486  * chan is no longer valid after this call.
1487  * \param chan channel to hang up (NULL tolerant)
1488  * \return Nothing
1489  */
1490 void ast_hangup(struct ast_channel *chan);
1491
1492 /*!
1493  * \brief Soft hangup all active channels.
1494  * \since 13.3.0
1495  *
1496  * \return Nothing
1497  */
1498 void ast_softhangup_all(void);
1499
1500 /*!
1501  * \brief Softly hangup up a channel
1502  *
1503  * \param chan channel to be soft-hung-up
1504  * \param reason an AST_SOFTHANGUP_* reason code
1505  *
1506  * \details
1507  * Call the protocol layer, but don't destroy the channel structure
1508  * (use this if you are trying to
1509  * safely hangup a channel managed by another thread.
1510  *
1511  * \note The channel passed to this function does not need to be locked.
1512  *
1513  * \return Returns 0 regardless
1514  */
1515 int ast_softhangup(struct ast_channel *chan, int reason);
1516
1517 /*!
1518  * \brief Softly hangup up a channel (no channel lock)
1519  * \param chan channel to be soft-hung-up
1520  * \param reason an AST_SOFTHANGUP_* reason code
1521  */
1522 int ast_softhangup_nolock(struct ast_channel *chan, int reason);
1523
1524 /*!
1525  * \brief Clear a set of softhangup flags from a channel
1526  *
1527  * Never clear a softhangup flag from a channel directly.  Instead,
1528  * use this function.  This ensures that all aspects of the softhangup
1529  * process are aborted.
1530  *
1531  * \param chan the channel to clear the flag on
1532  * \param flag the flag or flags to clear
1533  *
1534  * \return Nothing.
1535  */
1536 void ast_channel_clear_softhangup(struct ast_channel *chan, int flag);
1537
1538 /*!
1539  * \brief Set the source of the hangup in this channel and it's bridge
1540  *
1541  * \param chan channel to set the field on
1542  * \param source a string describing the source of the hangup for this channel
1543  * \param force
1544  *
1545  * \note Absolutely _NO_ channel locks should be held before calling this function.
1546  *
1547  * \since 1.8
1548  *
1549  * Hangupsource is generally the channel name that caused the bridge to be
1550  * hung up, but it can also be other things such as "dialplan/agi"
1551  * This can then be logged in the CDR or CEL
1552  */
1553 void ast_set_hangupsource(struct ast_channel *chan, const char *source, int force);
1554
1555 /*! \brief Check to see if a channel is needing hang up
1556  * \param chan channel on which to check for hang up
1557  * This function determines if the channel is being requested to be hung up.
1558  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
1559  */
1560 int ast_check_hangup(struct ast_channel *chan);
1561
1562 int ast_check_hangup_locked(struct ast_channel *chan);
1563
1564 /*! \brief This function will check if the bridge needs to be re-evaluated due to
1565  *         external changes.
1566  *
1567  *  \param chan Channel on which to check the unbridge_eval flag
1568  *
1569  *  \return Returns 0 if the flag is down or 1 if the flag is up.
1570  */
1571 int ast_channel_unbridged(struct ast_channel *chan);
1572
1573 /*! \brief ast_channel_unbridged variant. Use this if the channel
1574  *         is already locked prior to calling.
1575  *
1576  *  \param chan Channel on which to check the unbridge flag
1577  *
1578  *  \return Returns 0 if the flag is down or 1 if the flag is up.
1579  */
1580 int ast_channel_unbridged_nolock(struct ast_channel *chan);
1581
1582 /*! \brief Sets the unbridged flag and queues a NULL frame on the channel to trigger
1583  *         a check by bridge_channel_wait
1584  *
1585  *  \param chan Which channel is having its unbridged value set
1586  *  \param value What the unbridge value is being set to
1587  */
1588 void ast_channel_set_unbridged(struct ast_channel *chan, int value);
1589
1590 /*! \brief Variant of ast_channel_set_unbridged. Use this if the channel
1591  *         is already locked prior to calling.
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_nolock(struct ast_channel *chan, int value);
1597
1598 /*!
1599  * \brief Lock the given channel, then request softhangup on the channel with the given causecode
1600  * \param chan channel on which to hang up
1601  * \param causecode cause code to use (Zero if don't use cause code)
1602  * \return Nothing
1603  */
1604 void ast_channel_softhangup_withcause_locked(struct ast_channel *chan, int causecode);
1605
1606 /*!
1607  * \brief Compare a offset with the settings of when to hang a channel up
1608  * \param chan channel on which to check for hang up
1609  * \param offset offset in seconds from current time
1610  * \return 1, 0, or -1
1611  * \details
1612  * This function compares a offset from current time with the absolute time
1613  * out on a channel (when to hang up). If the absolute time out on a channel
1614  * is earlier than current time plus the offset, it returns 1, if the two
1615  * time values are equal, it return 0, otherwise, it return -1.
1616  * \sa ast_channel_cmpwhentohangup_tv()
1617  * \version 1.6.1 deprecated function (only had seconds precision)
1618  */
1619 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1620
1621 /*!
1622  * \brief Compare a offset with the settings of when to hang a channel up
1623  * \param chan channel on which to check for hangup
1624  * \param offset offset in seconds and microseconds from current time
1625  * \return 1, 0, or -1
1626  * This function compares a offset from current time with the absolute time
1627  * out on a channel (when to hang up). If the absolute time out on a channel
1628  * is earlier than current time plus the offset, it returns 1, if the two
1629  * time values are equal, it return 0, otherwise, it return -1.
1630  * \since 1.6.1
1631  */
1632 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1633
1634 /*!
1635  * \brief Set when to hang a channel up
1636  *
1637  * \param chan channel on which to check for hang up
1638  * \param offset offset in seconds relative to the current time of when to hang up
1639  *
1640  * \details
1641  * This function sets the absolute time out on a channel (when to hang up).
1642  *
1643  * \pre chan is locked
1644  *
1645  * \return Nothing
1646  * \sa ast_channel_setwhentohangup_tv()
1647  * \version 1.6.1 deprecated function (only had seconds precision)
1648  */
1649 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1650
1651 /*!
1652  * \brief Set when to hang a channel up
1653  *
1654  * \param chan channel on which to check for hang up
1655  * \param offset offset in seconds and useconds relative to the current time of when to hang up
1656  *
1657  * This function sets the absolute time out on a channel (when to hang up).
1658  *
1659  * \pre chan is locked
1660  *
1661  * \return Nothing
1662  * \since 1.6.1
1663  */
1664 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1665
1666 /*!
1667  * \brief Answer a channel
1668  *
1669  * \param chan channel to answer
1670  *
1671  * \details
1672  * This function answers a channel and handles all necessary call
1673  * setup functions.
1674  *
1675  * \note The channel passed does not need to be locked, but is locked
1676  * by the function when needed.
1677  *
1678  * \note This function will wait up to 500 milliseconds for media to
1679  * arrive on the channel before returning to the caller, so that the
1680  * caller can properly assume the channel is 'ready' for media flow.
1681  *
1682  * \retval 0 on success
1683  * \retval non-zero on failure
1684  */
1685 int ast_answer(struct ast_channel *chan);
1686
1687 /*!
1688  * \brief Answer a channel, if it's not already answered.
1689  *
1690  * \param chan channel to answer
1691  *
1692  * \details See ast_answer()
1693  *
1694  * \retval 0 on success
1695  * \retval non-zero on failure
1696  */
1697 int ast_auto_answer(struct ast_channel *chan);
1698
1699 /*!
1700  * \brief Answer a channel
1701  *
1702  * \param chan channel to answer
1703  *
1704  * This function answers a channel and handles all necessary call
1705  * setup functions.
1706  *
1707  * \note The channel passed does not need to be locked, but is locked
1708  * by the function when needed.
1709  *
1710  * \note Unlike ast_answer(), this function will not wait for media
1711  * flow to begin. The caller should be careful before sending media
1712  * to the channel before incoming media arrives, as the outgoing
1713  * media may be lost.
1714  *
1715  * \retval 0 on success
1716  * \retval non-zero on failure
1717  */
1718 int ast_raw_answer(struct ast_channel *chan);
1719
1720 /*!
1721  * \brief Answer a channel, with a selectable delay before returning
1722  *
1723  * \param chan channel to answer
1724  * \param delay maximum amount of time to wait for incoming media
1725  *
1726  * This function answers a channel and handles all necessary call
1727  * setup functions.
1728  *
1729  * \note The channel passed does not need to be locked, but is locked
1730  * by the function when needed.
1731  *
1732  * \note This function will wait up to 'delay' milliseconds for media to
1733  * arrive on the channel before returning to the caller, so that the
1734  * caller can properly assume the channel is 'ready' for media flow. If
1735  * 'delay' is less than 500, the function will wait up to 500 milliseconds.
1736  *
1737  * \retval 0 on success
1738  * \retval non-zero on failure
1739  */
1740 int __ast_answer(struct ast_channel *chan, unsigned int delay);
1741
1742 /*!
1743  * \brief Execute a Gosub call on the channel before a call is placed.
1744  * \since 11.0
1745  *
1746  * \details
1747  * This is called between ast_request() and ast_call() to
1748  * execute a predial routine on the newly created channel.
1749  *
1750  * \param chan Channel to execute Gosub.
1751  * \param sub_args Gosub application parameter string.
1752  *
1753  * \note Absolutely _NO_ channel locks should be held before calling this function.
1754  *
1755  * \retval 0 on success.
1756  * \retval -1 on error.
1757  */
1758 int ast_pre_call(struct ast_channel *chan, const char *sub_args);
1759
1760 /*!
1761  * \brief Make a call
1762  * \note Absolutely _NO_ channel locks should be held before calling this function.
1763  * \param chan which channel to make the call on
1764  * \param addr destination of the call
1765  * \param timeout time to wait on for connect (Doesn't seem to be used.)
1766  * \details
1767  * Place a call, take no longer than timeout ms.
1768  * \retval 0 on success
1769  * \retval -1 on failure
1770  */
1771 int ast_call(struct ast_channel *chan, const char *addr, int timeout);
1772
1773 /*!
1774  * \brief Indicates condition of channel
1775  * \note Absolutely _NO_ channel locks should be held before calling this function.
1776  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
1777  * \param chan channel to change the indication
1778  * \param condition which condition to indicate on the channel
1779  * \return Returns 0 on success, -1 on failure
1780  */
1781 int ast_indicate(struct ast_channel *chan, int condition);
1782
1783 /*!
1784  * \brief Indicates condition of channel, with payload
1785  * \note Absolutely _NO_ channel locks should be held before calling this function.
1786  * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
1787  * \param chan channel to change the indication
1788  * \param condition which condition to indicate on the channel
1789  * \param data pointer to payload data
1790  * \param datalen size of payload data
1791  * \return Returns 0 on success, -1 on failure
1792  */
1793 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
1794
1795 /* Misc stuff ------------------------------------------------ */
1796
1797 /*!
1798  * \brief Wait for input on a channel
1799  * \param chan channel to wait on
1800  * \param ms length of time to wait on the channel
1801  * \details
1802  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
1803  * \retval < 0 on failure
1804  * \retval 0 if nothing ever arrived
1805  * \retval the # of ms remaining otherwise
1806  */
1807 int ast_waitfor(struct ast_channel *chan, int ms);
1808
1809 /*!
1810  * \brief Should we keep this frame for later?
1811  *
1812  * There are functions such as ast_safe_sleep which will
1813  * service a channel to ensure that it does not have a
1814  * large backlog of queued frames. When this happens,
1815  * we want to hold on to specific frame types and just drop
1816  * others. This function will tell if the frame we just
1817  * read should be held onto.
1818  *
1819  * \param frame The frame we just read
1820  * \retval 1 frame should be kept
1821  * \retval 0 frame should be dropped
1822  */
1823 int ast_is_deferrable_frame(const struct ast_frame *frame);
1824
1825 /*!
1826  * \brief Wait for a specified amount of time, looking for hangups
1827  * \param chan channel to wait for
1828  * \param ms length of time in milliseconds to sleep. This should never be less than zero.
1829  * \details
1830  * Waits for a specified amount of time, servicing the channel as required.
1831  * \return returns -1 on hangup, otherwise 0.
1832  */
1833 int ast_safe_sleep(struct ast_channel *chan, int ms);
1834
1835 /*!
1836  * \brief Wait for a specified amount of time, looking for hangups and a condition argument
1837  * \param chan channel to wait for
1838  * \param ms length of time in milliseconds to sleep.
1839  * \param cond a function pointer for testing continue condition
1840  * \param data argument to be passed to the condition test function
1841  * \return returns -1 on hangup, otherwise 0.
1842  * \details
1843  * Waits for a specified amount of time, servicing the channel as required. If cond
1844  * returns 0, this function returns.
1845  */
1846 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
1847
1848 /*!
1849  * \brief Waits for activity on a group of channels
1850  * \param chan an array of pointers to channels
1851  * \param n number of channels that are to be waited upon
1852  * \param fds an array of fds to wait upon
1853  * \param nfds the number of fds to wait upon
1854  * \param exception exception flag
1855  * \param outfd fd that had activity on it
1856  * \param ms how long the wait was
1857  * \details
1858  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
1859  * file descriptors.
1860  * \return Returns the channel with activity, or NULL on error or if an FD
1861  * came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
1862  * will be -1
1863  */
1864 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n,
1865         int *fds, int nfds, int *exception, int *outfd, int *ms);
1866
1867 /*!
1868  * \brief Waits for input on a group of channels
1869  * Wait for input on an array of channels for a given # of milliseconds.
1870  * \return Return channel with activity, or NULL if none has activity.
1871  * \param chan an array of pointers to channels
1872  * \param n number of channels that are to be waited upon
1873  * \param ms time "ms" is modified in-place, if applicable
1874  */
1875 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
1876
1877 /*!
1878  * \brief Waits for input on an fd
1879  * \note This version works on fd's only.  Be careful with it.
1880  */
1881 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
1882
1883
1884 /*!
1885  * \brief Reads a frame
1886  * \param chan channel to read a frame from
1887  * \return Returns a frame, or NULL on error.  If it returns NULL, you
1888  * best just stop reading frames and assume the channel has been
1889  * disconnected.
1890  */
1891 struct ast_frame *ast_read(struct ast_channel *chan);
1892
1893 /*!
1894  * \brief Reads a frame, returning AST_FRAME_NULL frame if audio.
1895  * \param chan channel to read a frame from
1896  * \return  Returns a frame, or NULL on error.  If it returns NULL, you
1897  * best just stop reading frames and assume the channel has been
1898  * disconnected.
1899  * \note Audio is replaced with AST_FRAME_NULL to avoid
1900  * transcode when the resulting audio is not necessary.
1901  */
1902 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
1903
1904 /*!
1905  * \brief Write a frame to a channel
1906  * This function writes the given frame to the indicated channel.
1907  * \param chan destination channel of the frame
1908  * \param frame frame that will be written
1909  * \return It returns 0 on success, -1 on failure.
1910  */
1911 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
1912
1913 /*!
1914  * \brief Write video frame to a channel
1915  * This function writes the given frame to the indicated channel.
1916  * \param chan destination channel of the frame
1917  * \param frame frame that will be written
1918  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1919  */
1920 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
1921
1922 /*!
1923  * \brief Write text frame to a channel
1924  * This function writes the given frame to the indicated channel.
1925  * \param chan destination channel of the frame
1926  * \param frame frame that will be written
1927  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1928  */
1929 int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
1930
1931 /*! \brief Send empty audio to prime a channel driver */
1932 int ast_prod(struct ast_channel *chan);
1933
1934 /*!
1935  * \brief Set specific read path on channel.
1936  * \since 13.4.0
1937  *
1938  * \param chan Channel to setup read path.
1939  * \param raw_format Format to expect from the channel driver.
1940  * \param core_format What the core wants to read.
1941  *
1942  * \pre chan is locked
1943  *
1944  * \retval 0 on success.
1945  * \retval -1 on error.
1946  */
1947 int ast_set_read_format_path(struct ast_channel *chan, struct ast_format *raw_format, struct ast_format *core_format);
1948
1949 /*!
1950  * \brief Sets read format on channel chan from capabilities
1951  * Set read format for channel to whichever component of "format" is best.
1952  * \param chan channel to change
1953  * \param formats new formats to pick from for reading
1954  * \return Returns 0 on success, -1 on failure
1955  */
1956 int ast_set_read_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
1957
1958 /*!
1959  * \brief Sets read format on channel chan
1960  * \param chan channel to change
1961  * \param format format to set for reading
1962  * \return Returns 0 on success, -1 on failure
1963  */
1964 int ast_set_read_format(struct ast_channel *chan, struct ast_format *format);
1965
1966 /*!
1967  * \brief Sets write format on channel chan
1968  * Set write format for channel to whichever component of "format" is best.
1969  * \param chan channel to change
1970  * \param formats new formats to pick from for writing
1971  * \return Returns 0 on success, -1 on failure
1972  */
1973 int ast_set_write_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
1974
1975 /*!
1976  * \brief Sets write format on channel chan
1977  * \param chan channel to change
1978  * \param format format to set for writing
1979  * \return Returns 0 on success, -1 on failure
1980  */
1981 int ast_set_write_format(struct ast_channel *chan, struct ast_format *format);
1982
1983 /*!
1984  * \brief Sends text to a channel
1985  *
1986  * \param chan channel to act upon
1987  * \param text string of text to send on the channel
1988  *
1989  * \details
1990  * Write text to a display on a channel
1991  *
1992  * \note The channel does not need to be locked before calling this function.
1993  *
1994  * \retval 0 on success
1995  * \retval -1 on failure
1996  */
1997 int ast_sendtext(struct ast_channel *chan, const char *text);
1998
1999 /*!
2000  * \brief Receives a text character from a channel
2001  * \param chan channel to act upon
2002  * \param timeout timeout in milliseconds (0 for infinite wait)
2003  * \details
2004  * Read a char of text from a channel
2005  * \return 0 on success, -1 on failure
2006  */
2007 int ast_recvchar(struct ast_channel *chan, int timeout);
2008
2009 /*!
2010  * \brief Send a DTMF digit to a channel.
2011  * \param chan channel to act upon
2012  * \param digit the DTMF digit to send, encoded in ASCII
2013  * \param duration the duration of the digit ending in ms
2014  * \return 0 on success, -1 on failure
2015  */
2016 int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
2017
2018 /*!
2019  * \brief Send a DTMF digit to a channel.
2020  * \param chan channel to act upon
2021  * \param digit the DTMF digit to send, encoded in ASCII
2022  * \return 0 on success, -1 on failure
2023  */
2024 int ast_senddigit_begin(struct ast_channel *chan, char digit);
2025
2026 /*!
2027  * \brief Send a DTMF digit to a channel.
2028  * \param chan channel to act upon
2029  * \param digit the DTMF digit to send, encoded in ASCII
2030  * \param duration the duration of the digit ending in ms
2031  * \return Returns 0 on success, -1 on failure
2032  */
2033 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
2034
2035 /*!
2036  * \brief Receives a text string from a channel
2037  * Read a string of text from a channel
2038  * \param chan channel to act upon
2039  * \param timeout timeout in milliseconds (0 for infinite wait)
2040  * \return the received text, or NULL to signify failure.
2041  */
2042 char *ast_recvtext(struct ast_channel *chan, int timeout);
2043
2044 /*!
2045  * \brief Waits for a digit
2046  * \param c channel to wait for a digit on
2047  * \param ms how many milliseconds to wait (<0 for indefinite).
2048  * \return Returns <0 on error, 0 on no entry, and the digit on success.
2049  */
2050 int ast_waitfordigit(struct ast_channel *c, int ms);
2051
2052 /*!
2053  * \brief Wait for a digit
2054  * Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
2055  * \param c channel to wait for a digit on
2056  * \param ms how many milliseconds to wait (<0 for indefinite).
2057  * \param audiofd audio file descriptor to write to if audio frames are received
2058  * \param ctrlfd control file descriptor to monitor for reading
2059  * \return Returns 1 if ctrlfd becomes available
2060  */
2061 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
2062
2063 /*!
2064  * \brief Reads multiple digits
2065  * \param c channel to read from
2066  * \param s string to read in to.  Must be at least the size of your length
2067  * \param len how many digits to read (maximum)
2068  * \param timeout how long to timeout between digits
2069  * \param rtimeout timeout to wait on the first digit
2070  * \param enders digits to end the string
2071  * \details
2072  * Read in a digit string "s", max length "len", maximum timeout between
2073  * digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
2074  * for the first digit.
2075  * \return Returns 0 on normal return, or 1 on a timeout.  In the case of
2076  * a timeout, any digits that were read before the timeout will still be available in s.
2077  * RETURNS 2 in full version when ctrlfd is available, NOT 1
2078  */
2079 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
2080 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
2081
2082 /*! \brief Report DTMF on channel 0 */
2083 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)
2084 /*! \brief Report DTMF on channel 1 */
2085 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)
2086
2087
2088 /*!
2089  * \brief Make the frame formats of two channels compatible.
2090  *
2091  * \param chan First channel to make compatible.  Should be the calling party.
2092  * \param peer Other channel to make compatible.  Should be the called party.
2093  *
2094  * \note Absolutely _NO_ channel locks should be held before calling this function.
2095  *
2096  * \details
2097  * Set two channels to compatible frame formats in both
2098  * directions.  The path from peer to chan is made compatible
2099  * first to allow for in-band audio in case the other direction
2100  * cannot be made compatible.
2101  *
2102  * \retval 0 on success.
2103  * \retval -1 on error.
2104  */
2105 int ast_channel_make_compatible(struct ast_channel *chan, struct ast_channel *peer);
2106
2107 /*!
2108  * \brief Bridge two channels together (early)
2109  * \param c0 first channel to bridge
2110  * \param c1 second channel to bridge
2111  * \details
2112  * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
2113  * \return Returns 0 on success and -1 if it could not be done
2114  */
2115 int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
2116
2117 /*!
2118  * \brief Gives the string form of a given cause code.
2119  *
2120  * \param state cause to get the description of
2121  * \return the text form of the binary cause code given
2122  */
2123 const char *ast_cause2str(int state) attribute_pure;
2124
2125 /*!
2126  * \brief Convert the string form of a cause code to a number
2127  *
2128  * \param name string form of the cause
2129  * \return the cause code
2130  */
2131 int ast_str2cause(const char *name) attribute_pure;
2132
2133 /*!
2134  * \brief Gives the string form of a given channel state
2135  *
2136  * \param ast_channel_state state to get the name of
2137  * \return the text form of the binary state given
2138  */
2139 const char *ast_state2str(enum ast_channel_state);
2140
2141 /*!
2142  * \brief Gives the string form of a given transfer capability
2143  *
2144  * \param transfercapability transfer capability to get the name of
2145  * \return the text form of the binary transfer capability
2146  */
2147 char *ast_transfercapability2str(int transfercapability) attribute_const;
2148
2149 /*
2150  * Options: Some low-level drivers may implement "options" allowing fine tuning of the
2151  * low level channel.  See frame.h for options.  Note that many channel drivers may support
2152  * none or a subset of those features, and you should not count on this if you want your
2153  * asterisk application to be portable.  They're mainly useful for tweaking performance
2154  */
2155
2156 /*!
2157  * \brief Sets an option on a channel
2158  *
2159  * \param channel channel to set options on
2160  * \param option option to change
2161  * \param data data specific to option
2162  * \param datalen length of the data
2163  * \param block blocking or not
2164  * \details
2165  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply
2166  * \return 0 on success and -1 on failure
2167  */
2168 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
2169
2170 /*!
2171  * \brief Checks the value of an option
2172  *
2173  * Query the value of an option
2174  * Works similarly to setoption except only reads the options.
2175  */
2176 int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
2177
2178 /*!
2179  * \brief Checks for HTML support on a channel
2180  * \return 0 if channel does not support HTML or non-zero if it does
2181  */
2182 int ast_channel_supports_html(struct ast_channel *channel);
2183
2184 /*!
2185  * \brief Sends HTML on given channel
2186  * Send HTML or URL on link.
2187  * \return 0 on success or -1 on failure
2188  */
2189 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
2190
2191 /*!
2192  * \brief Sends a URL on a given link
2193  * Send URL on link.
2194  * \return 0 on success or -1 on failure
2195  */
2196 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
2197
2198 /*!
2199  * \brief Defers DTMF so that you only read things like hangups and audio.
2200  * \return non-zero if channel was already DTMF-deferred or
2201  * 0 if channel is just now being DTMF-deferred
2202  */
2203 int ast_channel_defer_dtmf(struct ast_channel *chan);
2204
2205 /*! Undo defer.  ast_read will return any DTMF characters that were queued */
2206 void ast_channel_undefer_dtmf(struct ast_channel *chan);
2207
2208 /*! \return number of channels available for lookup */
2209 int ast_active_channels(void);
2210
2211 /*! \return the number of channels not yet destroyed */
2212 int ast_undestroyed_channels(void);
2213
2214 /*! Activate a given generator */
2215 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
2216
2217 /*! Deactivate an active generator */
2218 void ast_deactivate_generator(struct ast_channel *chan);
2219
2220 /*!
2221  * \since 12
2222  * \brief Obtain how long the channel since the channel was created
2223  *
2224  * \param chan The channel object
2225  *
2226  * \retval 0 if the time value cannot be computed (or you called this really fast)
2227  * \retval The number of seconds the channel has been up
2228  */
2229 int ast_channel_get_duration(struct ast_channel *chan);
2230
2231 /*!
2232  * \since 12
2233  * \brief Obtain how long it has been since the channel was answered
2234  *
2235  * \param chan The channel object
2236  *
2237  * \retval 0 if the channel isn't answered (or you called this really fast)
2238  * \retval The number of seconds the channel has been up
2239  */
2240 int ast_channel_get_up_time(struct ast_channel *chan);
2241
2242 /*!
2243  * \brief Set caller ID number, name and ANI and generate AMI event.
2244  *
2245  * \note Use ast_channel_set_caller() and ast_channel_set_caller_event() instead.
2246  * \note The channel does not need to be locked before calling this function.
2247  */
2248 void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
2249
2250 /*!
2251  * \brief Set the caller id information in the Asterisk channel
2252  * \since 1.8
2253  *
2254  * \param chan Asterisk channel to set caller id information
2255  * \param caller Caller id information
2256  * \param update What caller information to update.  NULL if all.
2257  *
2258  * \return Nothing
2259  *
2260  * \note The channel does not need to be locked before calling this function.
2261  */
2262 void ast_channel_set_caller(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2263
2264 /*!
2265  * \brief Set the caller id information in the Asterisk channel and generate an AMI event
2266  * if the caller id name or number changed.
2267  * \since 1.8
2268  *
2269  * \param chan Asterisk channel to set caller id information
2270  * \param caller Caller id information
2271  * \param update What caller information to update.  NULL if all.
2272  *
2273  * \return Nothing
2274  *
2275  * \note The channel does not need to be locked before calling this function.
2276  */
2277 void ast_channel_set_caller_event(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2278
2279 /*! Set the file descriptor on the channel */
2280 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
2281
2282 /*! Add a channel to an optimized waitfor */
2283 void ast_poll_channel_add(struct ast_channel *chan0, struct ast_channel *chan1);
2284
2285 /*! Delete a channel from an optimized waitfor */
2286 void ast_poll_channel_del(struct ast_channel *chan0, struct ast_channel *chan1);
2287
2288 /*! Start a tone going */
2289 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2290 /*! Stop a tone from playing */
2291 void ast_tonepair_stop(struct ast_channel *chan);
2292 /*! Play a tone pair for a given amount of time */
2293 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2294
2295 /*!
2296  * \brief Automatically service a channel for us...
2297  *
2298  * \retval 0 success
2299  * \retval -1 failure, or the channel is already being autoserviced
2300  */
2301 int ast_autoservice_start(struct ast_channel *chan);
2302
2303 /*!
2304  * \brief Stop servicing a channel for us...
2305  *
2306  * \note if chan is locked prior to calling ast_autoservice_stop, it
2307  * is likely that there will be a deadlock between the thread that calls
2308  * ast_autoservice_stop and the autoservice thread. It is important
2309  * that chan is not locked prior to this call
2310  *
2311  * \param chan
2312  * \retval 0 success
2313  * \retval -1 error, or the channel has been hungup
2314  */
2315 int ast_autoservice_stop(struct ast_channel *chan);
2316
2317 /*!
2318  * \brief Put chan into autoservice while hanging up peer.
2319  * \since 11.0
2320  *
2321  * \param chan Chan to put into autoservice.
2322  * \param peer Chan to run hangup handlers and hangup.
2323  *
2324  * \return Nothing
2325  */
2326 void ast_autoservice_chan_hangup_peer(struct ast_channel *chan, struct ast_channel *peer);
2327
2328 /*!
2329  * \brief Ignore certain frame types
2330  * \note Normally, we cache DTMF, IMAGE, HTML, TEXT, and CONTROL frames
2331  * while a channel is in autoservice and queue them up when taken out of
2332  * autoservice.  When this is not desireable, this API may be used to
2333  * cause the channel to ignore those frametypes after the channel is put
2334  * into autoservice, but before autoservice is stopped.
2335  * \retval 0 success
2336  * \retval -1 channel is not in autoservice
2337  */
2338 int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype);
2339
2340 /*!
2341  * \brief Enable or disable timer ticks for a channel
2342  *
2343  * \param c channel
2344  * \param rate number of timer ticks per second
2345  * \param func callback function
2346  * \param data
2347  *
2348  * \details
2349  * If timers are supported, force a scheduled expiration on the
2350  * timer fd, at which point we call the callback function / data
2351  *
2352  * \note Call this function with a rate of 0 to turn off the timer ticks
2353  *
2354  * \version 1.6.1 changed samples parameter to rate, accomodates new timing methods
2355  */
2356 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
2357 int ast_settimeout_full(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data, unsigned int is_ao2_obj);
2358
2359 /*!
2360  * \brief Transfer a channel (if supported).
2361  * \retval -1 on error
2362  * \retval 0 if not supported
2363  * \retval 1 if supported and requested
2364  * \param chan current channel
2365  * \param dest destination extension for transfer
2366  */
2367 int ast_transfer(struct ast_channel *chan, char *dest);
2368
2369 /*!
2370  * \brief Inherits channel variable from parent to child channel
2371  * \param parent Parent channel
2372  * \param child Child channel
2373  *
2374  * \details
2375  * Scans all channel variables in the parent channel, looking for those
2376  * that should be copied into the child channel.
2377  * Variables whose names begin with a single '_' are copied into the
2378  * child channel with the prefix removed.
2379  * Variables whose names begin with '__' are copied into the child
2380  * channel with their names unchanged.
2381  */
2382 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
2383
2384 /*!
2385  * \brief adds a list of channel variables to a channel
2386  * \param chan the channel
2387  * \param vars a linked list of variables
2388  *
2389  * \pre chan is locked
2390  *
2391  * \details
2392  * Variable names can be for a regular channel variable or a dialplan function
2393  * that has the ability to be written to.
2394  */
2395 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
2396
2397 /*!
2398  * \brief An opaque 'object' structure use by silence generators on channels.
2399  */
2400 struct ast_silence_generator;
2401
2402 /*!
2403  * \brief Starts a silence generator on the given channel.
2404  * \param chan The channel to generate silence on
2405  * \return An ast_silence_generator pointer, or NULL if an error occurs
2406  *
2407  * \details
2408  * This function will cause SLINEAR silence to be generated on the supplied
2409  * channel until it is disabled; if the channel cannot be put into SLINEAR
2410  * mode then the function will fail.
2411  *
2412  * \note
2413  * The pointer returned by this function must be preserved and passed to
2414  * ast_channel_stop_silence_generator when you wish to stop the silence
2415  * generation.
2416  */
2417 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
2418
2419 /*!
2420  * \brief Stops a previously-started silence generator on the given channel.
2421  * \param chan The channel to operate on
2422  * \param state The ast_silence_generator pointer return by a previous call to
2423  * ast_channel_start_silence_generator.
2424  * \return nothing
2425  *
2426  * \details
2427  * This function will stop the operating silence generator and return the channel
2428  * to its previous write format.
2429  */
2430 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
2431
2432 /*!
2433  * \brief Determine which channel has an older linkedid
2434  * \param a First channel
2435  * \param b Second channel
2436  * \return Returns an ast_channel structure that has oldest linkedid
2437  */
2438 struct ast_channel *ast_channel_internal_oldest_linkedid(struct ast_channel *a, struct ast_channel *b);
2439
2440 /*!
2441  * \brief Copy the full linkedid channel id structure from one channel to another
2442  * \param dest Destination to copy linkedid to
2443  * \param source Source channel to copy linkedid from
2444  * \return void
2445  */
2446 void ast_channel_internal_copy_linkedid(struct ast_channel *dest, struct ast_channel *source);
2447
2448 /*!
2449  * \brief Swap uniqueid and linkedid beteween two channels
2450  * \param a First channel
2451  * \param b Second channel
2452  * \return void
2453  *
2454  * \note
2455  * This is used in masquerade to exchange identities
2456  */
2457 void ast_channel_internal_swap_uniqueid_and_linkedid(struct ast_channel *a, struct ast_channel *b);
2458
2459 /*!
2460  * \brief Swap topics beteween two channels
2461  * \param a First channel
2462  * \param b Second channel
2463  * \return void
2464  *
2465  * \note
2466  * This is used in masquerade to exchange topics for message routing
2467  */
2468 void ast_channel_internal_swap_topics(struct ast_channel *a, struct ast_channel *b);
2469
2470 /*!
2471  * \brief Set uniqueid and linkedid string value only (not time)
2472  * \param chan The channel to set the uniqueid to
2473  * \param uniqueid The uniqueid to set
2474  * \param linkedid The linkedid to set
2475  * \return void
2476  *
2477  * \note
2478  * This is used only by ast_cel_fabricate_channel_from_event()
2479  * to create a temporary fake channel - time values are invalid
2480  */
2481 void ast_channel_internal_set_fake_ids(struct ast_channel *chan, const char *uniqueid, const char *linkedid);
2482
2483 /* Misc. functions below */
2484
2485 /*!
2486  * \brief if fd is a valid descriptor, set *pfd with the descriptor
2487  * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
2488  * return value to the index into the array)
2489  */
2490 static inline int ast_add_fd(struct pollfd *pfd, int fd)
2491 {
2492         pfd->fd = fd;
2493         pfd->events = POLLIN | POLLPRI;
2494         return fd >= 0;
2495 }
2496
2497 /*! \brief Helper function for migrating select to poll */
2498 static inline int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
2499 {
2500         int x;
2501         int dummy = 0;
2502
2503         if (fd < 0)
2504                 return 0;
2505         if (!start)
2506                 start = &dummy;
2507         for (x = *start; x < maximum; x++)
2508                 if (pfds[x].fd == fd) {
2509                         if (x == *start)
2510                                 (*start)++;
2511                         return pfds[x].revents;
2512                 }
2513         return 0;
2514 }
2515
2516 /*! \brief Retrieves the current T38 state of a channel */
2517 static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
2518 {
2519         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
2520         int datalen = sizeof(state);
2521
2522         ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
2523
2524         return state;
2525 }
2526
2527 #define CHECK_BLOCKING(c) do {   \
2528         if (ast_test_flag(ast_channel_flags(c), AST_FLAG_BLOCKING)) {\
2529                 ast_debug(1, "Thread %p is blocking '%s', already blocked by thread %p in procedure %s\n", \
2530                         (void *) pthread_self(), ast_channel_name(c), (void *) ast_channel_blocker(c), ast_channel_blockproc(c)); \
2531         } else { \
2532                 ast_channel_blocker_set((c), pthread_self()); \
2533                 ast_channel_blockproc_set((c), __PRETTY_FUNCTION__); \
2534                 ast_set_flag(ast_channel_flags(c), AST_FLAG_BLOCKING); \
2535         } } while (0)
2536
2537 ast_group_t ast_get_group(const char *s);
2538
2539 /*! \brief Print call and pickup groups into buffer */
2540 char *ast_print_group(char *buf, int buflen, ast_group_t group);
2541
2542 /*! \brief Opaque struct holding a namedgroups set, i.e. a set of group names */
2543 struct ast_namedgroups;
2544
2545 /*! \brief Create an ast_namedgroups set with group names from comma separated string */
2546 struct ast_namedgroups *ast_get_namedgroups(const char *s);
2547 struct ast_namedgroups *ast_unref_namedgroups(struct ast_namedgroups *groups);
2548 struct ast_namedgroups *ast_ref_namedgroups(struct ast_namedgroups *groups);
2549 /*! \brief Return TRUE if group a and b contain at least one common groupname */
2550 int ast_namedgroups_intersect(struct ast_namedgroups *a, struct ast_namedgroups *b);
2551
2552 /*! \brief Print named call groups and named pickup groups */
2553 char *ast_print_namedgroups(struct ast_str **buf, struct ast_namedgroups *groups);
2554
2555 /*!
2556  * \brief Convert enum channelreloadreason to text string for manager event
2557  * \param reason The reason for reload (manager, cli, start etc)
2558  */
2559 const char *channelreloadreason2txt(enum channelreloadreason reason);
2560
2561 /*! \brief return an ast_variable list of channeltypes */
2562 struct ast_variable *ast_channeltype_list(void);
2563
2564 /*!
2565  * \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
2566  * \param reason  The integer argument, usually taken from AST_CONTROL_ macros
2567  * \return char pointer explaining the code
2568  */
2569 const char *ast_channel_reason2str(int reason);
2570
2571 /*! \brief channel group info */
2572 struct ast_group_info {
2573         struct ast_channel *chan;
2574         char *category;
2575         char *group;
2576         AST_LIST_ENTRY(ast_group_info) group_list;
2577 };
2578
2579 #define ast_channel_lock(chan) ao2_lock(chan)
2580 #define ast_channel_unlock(chan) ao2_unlock(chan)
2581 #define ast_channel_trylock(chan) ao2_trylock(chan)
2582
2583 /*!
2584  * \brief Lock two channels.
2585  */
2586 #define ast_channel_lock_both(chan1, chan2) do { \
2587                 ast_channel_lock(chan1); \
2588                 while (ast_channel_trylock(chan2)) { \
2589                         ast_channel_unlock(chan1); \
2590                         sched_yield(); \
2591                         ast_channel_lock(chan1); \
2592                 } \
2593         } while (0)
2594
2595 /*!
2596  * \brief Increase channel reference count
2597  *
2598  * \param c the channel
2599  *
2600  * \retval c always
2601  *
2602  * \since 1.8
2603  */
2604 #define ast_channel_ref(c) ({ ao2_ref(c, +1); (c); })
2605
2606 /*!
2607  * \brief Decrease channel reference count
2608  *
2609  * \param c the channel
2610  *
2611  * \retval NULL always
2612  *
2613  * \since 1.8
2614  */
2615 #define ast_channel_unref(c) ({ ao2_ref(c, -1); (struct ast_channel *) (NULL); })
2616
2617 /*!
2618  * \brief Cleanup a channel reference
2619  *
2620  * \param c the channel (NULL tolerant)
2621  *
2622  * \retval NULL always
2623  *
2624  * \since 12.0.0
2625  */
2626 #define ast_channel_cleanup(c) ({ ao2_cleanup(c); (struct ast_channel *) (NULL); })
2627
2628 /*! Channel Iterating @{ */
2629
2630 /*!
2631  * \brief A channel iterator
2632  *
2633  * This is an opaque type.
2634  */
2635 struct ast_channel_iterator;
2636
2637 /*!
2638  * \brief Destroy a channel iterator
2639  *
2640  * \param i the itereator to destroy
2641  *
2642  * \details
2643  * This function is used to destroy a channel iterator that was retrieved by
2644  * using one of the channel_iterator_xxx_new() functions.
2645  *
2646  * \return NULL, for convenience to clear out the pointer to the iterator that
2647  * was just destroyed.
2648  *
2649  * \since 1.8
2650  */
2651 struct ast_channel_iterator *ast_channel_iterator_destroy(struct ast_channel_iterator *i);
2652
2653 /*!
2654  * \brief Create a new channel iterator based on extension
2655  *
2656  * \param exten The extension that channels must be in
2657  * \param context The context that channels must be in
2658  *
2659  * \details
2660  * After creating an iterator using this function, the ast_channel_iterator_next()
2661  * function can be used to iterate through all channels that are currently
2662  * in the specified context and extension.
2663  *
2664  * \note You must call ast_channel_iterator_destroy() when done.
2665  *
2666  * \retval NULL on failure
2667  * \retval a new channel iterator based on the specified parameters
2668  *
2669  * \since 1.8
2670  */
2671 struct ast_channel_iterator *ast_channel_iterator_by_exten_new(const char *exten, const char *context);
2672
2673 /*!
2674  * \brief Create a new channel iterator based on name
2675  *
2676  * \param name channel name or channel uniqueid to match
2677  * \param name_len number of characters in the channel name to match on.  This
2678  *      would be used to match based on name prefix.  If matching on the full
2679  *      channel name is desired, then this parameter should be 0.
2680  *
2681  * \details
2682  * After creating an iterator using this function, the ast_channel_iterator_next()
2683  * function can be used to iterate through all channels that exist that have
2684  * the specified name or name prefix.
2685  *
2686  * \note You must call ast_channel_iterator_destroy() when done.
2687  *
2688  * \retval NULL on failure
2689  * \retval a new channel iterator based on the specified parameters
2690  *
2691  * \since 1.8
2692  */
2693 struct ast_channel_iterator *ast_channel_iterator_by_name_new(const char *name, size_t name_len);
2694
2695 /*!
2696  * \brief Create a new channel iterator
2697  *
2698  * \details
2699  * After creating an iterator using this function, the ast_channel_iterator_next()
2700  * function can be used to iterate through all channels that exist.
2701  *
2702  * \note You must call ast_channel_iterator_destroy() when done.
2703  *
2704  * \retval NULL on failure
2705  * \retval a new channel iterator
2706  *
2707  * \since 1.8
2708  */
2709 struct ast_channel_iterator *ast_channel_iterator_all_new(void);
2710
2711 /*!
2712  * \brief Get the next channel for a channel iterator
2713  *
2714  * \param i the channel iterator that was created using one of the
2715  *  channel_iterator_xxx_new() functions.
2716  *
2717  * \details
2718  * This function should be used to iterate through all channels that match a
2719  * specified set of parameters that were provided when the iterator was created.
2720  *
2721  * \retval the next channel that matches the parameters used when the iterator
2722  *         was created.
2723  * \retval NULL, if no more channels match the iterator parameters.
2724  *
2725  * \since 1.8
2726  */
2727 struct ast_channel *ast_channel_iterator_next(struct ast_channel_iterator *i);
2728
2729 /*! @} End channel iterator definitions. */
2730
2731 /*!
2732  * \brief Call a function with every active channel
2733  *
2734  * \details
2735  * This function executes a callback one time for each active channel on the
2736  * system.  The channel is provided as an argument to the function.
2737  *
2738  * \note Absolutely _NO_ channel locks should be held before calling this function.
2739  * \since 1.8
2740  */
2741 struct ast_channel *ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg,
2742                 void *data, int ao2_flags);
2743
2744 /*! @{ Channel search functions */
2745
2746 /*!
2747  * \brief Find a channel by name
2748  *
2749  * \param name the name or uniqueid of the channel to search for
2750  *
2751  * \details
2752  * Find a channel that has the same name as the provided argument.
2753  *
2754  * \retval a channel with the name specified by the argument
2755  * \retval NULL if no channel was found
2756  *
2757  * \since 1.8
2758  */
2759 struct ast_channel *ast_channel_get_by_name(const char *name);
2760
2761 /*!
2762  * \brief Find a channel by a name prefix
2763  *
2764  * \param name The channel name or uniqueid prefix to search for
2765  * \param name_len Only search for up to this many characters from the name
2766  *
2767  * \details
2768  * Find a channel that has the same name prefix as specified by the arguments.
2769  *
2770  * \retval a channel with the name prefix specified by the arguments
2771  * \retval NULL if no channel was found
2772  *
2773  * \since 1.8
2774  */
2775 struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len);
2776
2777 /*!
2778  * \brief Find a channel by extension and context
2779  *
2780  * \param exten the extension to search for
2781  * \param context the context to search for
2782  *
2783  * \details
2784  * Return a channel that is currently at the specified extension and context.
2785  *
2786  * \retval a channel that is at the specified extension and context
2787  * \retval NULL if no channel was found
2788  *
2789  * \since 1.8
2790  */
2791 struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context);
2792
2793 /*! @} End channel search functions. */
2794
2795 /*!
2796  * \brief Initialize the given name structure.
2797  * \since 1.8
2798  *
2799  * \param init Name structure to initialize.
2800  *
2801  * \return Nothing
2802  */
2803 void ast_party_name_init(struct ast_party_name *init);
2804
2805 /*!
2806  * \brief Copy the source party name information to the destination party name.
2807  * \since 1.8
2808  *
2809  * \param dest Destination party name
2810  * \param src Source party name
2811  *
2812  * \return Nothing
2813  */
2814 void ast_party_name_copy(struct ast_party_name *dest, const struct ast_party_name *src);
2815
2816 /*!
2817  * \brief Initialize the given party name structure using the given guide
2818  * for a set update operation.
2819  * \since 1.8
2820  *
2821  * \details
2822  * The initialization is needed to allow a set operation to know if a
2823  * value needs to be updated.  Simple integers need the guide's original
2824  * value in case the set operation is not trying to set a new value.
2825  * String values are simply set to NULL pointers if they are not going
2826  * to be updated.
2827  *
2828  * \param init Party name structure to initialize.
2829  * \param guide Source party name to use as a guide in initializing.
2830  *
2831  * \return Nothing
2832  */
2833 void ast_party_name_set_init(struct ast_party_name *init, const struct ast_party_name *guide);
2834
2835 /*!
2836  * \brief Set the source party name information into the destination party name.
2837  * \since 1.8
2838  *
2839  * \param dest The name one wishes to update
2840  * \param src The new name values to update the dest
2841  *
2842  * \return Nothing
2843  */
2844 void ast_party_name_set(struct ast_party_name *dest, const struct ast_party_name *src);
2845
2846 /*!
2847  * \brief Destroy the party name contents
2848  * \since 1.8
2849  *
2850  * \param doomed The party name to destroy.
2851  *
2852  * \return Nothing
2853  */
2854 void ast_party_name_free(struct ast_party_name *doomed);
2855
2856 /*!
2857  * \brief Initialize the given number structure.
2858  * \since 1.8
2859  *
2860  * \param init Number structure to initialize.
2861  *
2862  * \return Nothing
2863  */
2864 void ast_party_number_init(struct ast_party_number *init);
2865
2866 /*!
2867  * \brief Copy the source party number information to the destination party number.
2868  * \since 1.8
2869  *
2870  * \param dest Destination party number
2871  * \param src Source party number
2872  *
2873  * \return Nothing
2874  */
2875 void ast_party_number_copy(struct ast_party_number *dest, const struct ast_party_number *src);
2876
2877 /*!
2878  * \brief Initialize the given party number structure using the given guide
2879  * for a set update operation.
2880  * \since 1.8
2881  *
2882  * \details
2883  * The initialization is needed to allow a set operation to know if a
2884  * value needs to be updated.  Simple integers need the guide's original
2885  * value in case the set operation is not trying to set a new value.
2886  * String values are simply set to NULL pointers if they are not going
2887  * to be updated.
2888  *
2889  * \param init Party number structure to initialize.
2890  * \param guide Source party number to use as a guide in initializing.
2891  *
2892  * \return Nothing
2893  */
2894 void ast_party_number_set_init(struct ast_party_number *init, const struct ast_party_number *guide);
2895
2896 /*!
2897  * \brief Set the source party number information into the destination party number.
2898  * \since 1.8
2899  *
2900  * \param dest The number one wishes to update
2901  * \param src The new number values to update the dest
2902  *
2903  * \return Nothing
2904  */
2905 void ast_party_number_set(struct ast_party_number *dest, const struct ast_party_number *src);
2906
2907 /*!
2908  * \brief Destroy the party number contents
2909  * \since 1.8
2910  *
2911  * \param doomed The party number to destroy.
2912  *
2913  * \return Nothing
2914  */
2915 void ast_party_number_free(struct ast_party_number *doomed);
2916
2917 /*!
2918  * \since 1.8
2919  * \brief Initialize the given subaddress structure.
2920  *
2921  * \param init Subaddress structure to initialize.
2922  *
2923  * \return Nothing
2924  */
2925 void ast_party_subaddress_init(struct ast_party_subaddress *init);
2926
2927 /*!
2928  * \since 1.8
2929  * \brief Copy the source party subaddress information to the destination party subaddress.
2930  *
2931  * \param dest Destination party subaddress
2932  * \param src Source party subaddress
2933  *
2934  * \return Nothing
2935  */
2936 void ast_party_subaddress_copy(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
2937
2938 /*!
2939  * \since 1.8
2940  * \brief Initialize the given party subaddress structure using the given guide
2941  * for a set update operation.
2942  *
2943  * \details
2944  * The initialization is needed to allow a set operation to know if a
2945  * value needs to be updated.  Simple integers need the guide's original
2946  * value in case the set operation is not trying to set a new value.
2947  * String values are simply set to NULL pointers if they are not going
2948  * to be updated.
2949  *
2950  * \param init Party subaddress structure to initialize.
2951  * \param guide Source party subaddress to use as a guide in initializing.
2952  *
2953  * \return Nothing
2954  */
2955 void ast_party_subaddress_set_init(struct ast_party_subaddress *init, const struct ast_party_subaddress *guide);
2956
2957 /*!
2958  * \since 1.8
2959  * \brief Set the source party subaddress information into the destination party subaddress.
2960  *
2961  * \param dest The subaddress one wishes to update
2962  * \param src The new subaddress values to update the dest
2963  *
2964  * \return Nothing
2965  */
2966 void ast_party_subaddress_set(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
2967
2968 /*!
2969  * \since 1.8
2970  * \brief Destroy the party subaddress contents
2971  *
2972  * \param doomed The party subaddress to destroy.
2973  *
2974  * \return Nothing
2975  */
2976 void ast_party_subaddress_free(struct ast_party_subaddress *doomed);
2977
2978 /*!
2979  * \brief Set the update marker to update all information of a corresponding party id.
2980  * \since 11.0
2981  *
2982  * \param update_id The update marker for a corresponding party id.
2983  *
2984  * \return Nothing
2985  */
2986 void ast_set_party_id_all(struct ast_set_party_id *update_id);
2987
2988 /*!
2989  * \brief Initialize the given party id structure.
2990  * \since 1.8
2991  *
2992  * \param init Party id structure to initialize.
2993  *
2994  * \return Nothing
2995  */
2996 void ast_party_id_init(struct ast_party_id *init);
2997
2998 /*!
2999  * \brief Copy the source party id information to the destination party id.
3000  * \since 1.8
3001  *
3002  * \param dest Destination party id
3003  * \param src Source party id
3004  *
3005  * \return Nothing
3006  */
3007 void ast_party_id_copy(struct ast_party_id *dest, const struct ast_party_id *src);
3008
3009 /*!
3010  * \brief Initialize the given party id structure using the given guide
3011  * for a set update operation.
3012  * \since 1.8
3013  *
3014  * \details
3015  * The initialization is needed to allow a set operation to know if a
3016  * value needs to be updated.  Simple integers need the guide's original
3017  * value in case the set operation is not trying to set a new value.
3018  * String values are simply set to NULL pointers if they are not going
3019  * to be updated.
3020  *
3021  * \param init Party id structure to initialize.
3022  * \param guide Source party id to use as a guide in initializing.
3023  *
3024  * \return Nothing
3025  */
3026 void ast_party_id_set_init(struct ast_party_id *init, const struct ast_party_id *guide);
3027
3028 /*!
3029  * \brief Set the source party id information into the destination party id.
3030  * \since 1.8
3031  *
3032  * \param dest The id one wishes to update
3033  * \param src The new id values to update the dest
3034  * \param update What id information to update.  NULL if all.
3035  *
3036  * \return Nothing
3037  */
3038 void ast_party_id_set(struct ast_party_id *dest, const struct ast_party_id *src, const struct ast_set_party_id *update);
3039
3040 /*!
3041  * \brief Destroy the party id contents
3042  * \since 1.8
3043  *
3044  * \param doomed The party id to destroy.
3045  *
3046  * \return Nothing
3047  */
3048 void ast_party_id_free(struct ast_party_id *doomed);
3049
3050 /*!
3051  * \brief Determine the overall presentation value for the given party.
3052  * \since 1.8
3053  *
3054  * \param id Party to determine the overall presentation value.
3055  *
3056  * \return Overall presentation value for the given party.
3057  */
3058 int ast_party_id_presentation(const struct ast_party_id *id);
3059
3060 /*!
3061  * \brief Invalidate all components of the given party id.
3062  * \since 11.0
3063  *
3064  * \param id The party id to invalidate.
3065  *
3066  * \return Nothing
3067  */
3068 void ast_party_id_invalidate(struct ast_party_id *id);
3069
3070 /*!
3071  * \brief Destroy and initialize the given party id structure.
3072  * \since 11.0
3073  *
3074  * \param id The party id to reset.
3075  *
3076  * \return Nothing
3077  */
3078 void ast_party_id_reset(struct ast_party_id *id);
3079
3080 /*!
3081  * \brief Merge a given party id into another given party id.
3082  * \since 11.0
3083  *
3084  * \details
3085  * This function will generate an effective party id.
3086  *
3087  * Each party id component of the party id 'base' is overwritten
3088  * by components of the party id 'overlay' if the overlay
3089  * component is marked as valid.  However the component 'tag' of
3090  * the base party id remains untouched.
3091  *
3092  * \param base The party id which is merged.
3093  * \param overlay The party id which is used to merge into.
3094  *
3095  * \return The merged party id as a struct, not as a pointer.
3096  * \note The merged party id returned is a shallow copy and must not be freed.
3097  */
3098 struct ast_party_id ast_party_id_merge(struct ast_party_id *base, struct ast_party_id *overlay);
3099
3100 /*!
3101  * \brief Copy a merge of a given party id into another given party id to a given destination party id.
3102  * \since 11.0
3103  *
3104  * \details
3105  * Each party id component of the party id 'base' is overwritten by components
3106  * of the party id 'overlay' if the 'overlay' component is marked as valid.
3107  * However the component 'tag' of the 'base' party id remains untouched.
3108  * The result is copied into the given party id 'dest'.
3109  *
3110  * \note The resulting merged party id is a real copy and has to be freed.
3111  *
3112  * \param dest The resulting merged party id.
3113  * \param base The party id which is merged.
3114  * \param overlay The party id which is used to merge into.
3115  *
3116  * \return Nothing
3117  */
3118 void ast_party_id_merge_copy(struct ast_party_id *dest, struct ast_party_id *base, struct ast_party_id *overlay);
3119
3120 /*!
3121  * \brief Initialize the given dialed structure.
3122  * \since 1.8
3123  *
3124  * \param init Dialed structure to initialize.
3125  *
3126  * \return Nothing
3127  */
3128 void ast_party_dialed_init(struct ast_party_dialed *init);
3129
3130 /*!
3131  * \brief Copy the source dialed party information to the destination dialed party.
3132  * \since 1.8
3133  *
3134  * \param dest Destination dialed party
3135  * \param src Source dialed party
3136  *
3137  * \return Nothing
3138  */
3139 void ast_party_dialed_copy(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
3140
3141 /*!
3142  * \brief Initialize the given dialed structure using the given
3143  * guide for a set update operation.
3144  * \since 1.8
3145  *
3146  * \details
3147  * The initialization is needed to allow a set operation to know if a
3148  * value needs to be updated.  Simple integers need the guide's original
3149  * value in case the set operation is not trying to set a new value.
3150  * String values are simply set to NULL pointers if they are not going
3151  * to be updated.
3152  *
3153  * \param init Caller structure to initialize.
3154  * \param guide Source dialed to use as a guide in initializing.
3155  *
3156  * \return Nothing
3157  */
3158 void ast_party_dialed_set_init(struct ast_party_dialed *init, const struct ast_party_dialed *guide);
3159
3160 /*!
3161  * \brief Set the dialed information based on another dialed source
3162  * \since 1.8
3163  *
3164  * This is similar to ast_party_dialed_copy, except that NULL values for
3165  * strings in the src parameter indicate not to update the corresponding dest values.
3166  *
3167  * \param dest The dialed one wishes to update
3168  * \param src The new dialed values to update the dest
3169  *
3170  * \return Nada
3171  */
3172 void ast_party_dialed_set(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
3173
3174 /*!
3175  * \brief Destroy the dialed party contents
3176  * \since 1.8
3177  *
3178  * \param doomed The dialed party to destroy.
3179  *
3180  * \return Nothing
3181  */
3182 void ast_party_dialed_free(struct ast_party_dialed *doomed);
3183
3184 /*!
3185  * \since 1.8
3186  * \brief Initialize the given caller structure.
3187  *
3188  * \param init Caller structure to initialize.
3189  *
3190  * \return Nothing
3191  */
3192 void ast_party_caller_init(struct ast_party_caller *init);
3193
3194 /*!
3195  * \since 1.8
3196  * \brief Copy the source caller information to the destination caller.
3197  *
3198  * \param dest Destination caller
3199  * \param src Source caller
3200  *
3201  * \return Nothing
3202  */
3203 void ast_party_caller_copy(struct ast_party_caller *dest, const struct ast_party_caller *src);
3204
3205 /*!
3206  * \brief Initialize the given caller structure using the given
3207  * guide for a set update operation.
3208  * \since 1.8
3209  *
3210  * \details
3211  * The initialization is needed to allow a set operation to know if a
3212  * value needs to be updated.  Simple integers need the guide's original
3213  * value in case the set operation is not trying to set a new value.
3214  * String values are simply set to NULL pointers if they are not going
3215  * to be updated.
3216  *
3217  * \param init Caller structure to initialize.
3218  * \param guide Source caller to use as a guide in initializing.
3219  *
3220  * \return Nothing
3221  */
3222 void ast_party_caller_set_init(struct ast_party_caller *init, const struct ast_party_caller *guide);
3223
3224 /*!
3225  * \brief Set the caller information based on another caller source
3226  * \since 1.8
3227  *
3228  * This is similar to ast_party_caller_copy, except that NULL values for
3229  * strings in the src parameter indicate not to update the corresponding dest values.
3230  *
3231  * \param dest The caller one wishes to update
3232  * \param src The new caller values to update the dest
3233  * \param update What caller information to update.  NULL if all.
3234  *
3235  * \return Nada
3236  */
3237 void ast_party_caller_set(struct ast_party_caller *dest, const struct ast_party_caller *src, const struct ast_set_party_caller *update);
3238
3239 /*!
3240  * \brief Destroy the caller party contents
3241  * \since 1.8
3242  *
3243  * \param doomed The caller party to destroy.
3244  *
3245  * \return Nothing
3246  */
3247 void ast_party_caller_free(struct ast_party_caller *doomed);
3248
3249 /*!
3250  * \since 1.8
3251  * \brief Initialize the given connected line structure.
3252  *
3253  * \param init Connected line structure to initialize.
3254  *
3255  * \return Nothing
3256  */
3257 void ast_party_connected_line_init(struct ast_party_connected_line *init);
3258
3259 /*!
3260  * \since 1.8
3261  * \brief Copy the source connected line information to the destination connected line.
3262  *
3263  * \param dest Destination connected line
3264  * \param src Source connected line
3265  *
3266  * \return Nothing
3267  */
3268 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
3269
3270 /*!
3271  * \since 1.8
3272  * \brief Initialize the given connected line structure using the given
3273  * guide for a set update operation.
3274  *
3275  * \details
3276  * The initialization is needed to allow a set operation to know if a
3277  * value needs to be updated.  Simple integers need the guide's original
3278  * value in case the set operation is not trying to set a new value.
3279  * String values are simply set to NULL pointers if they are not going
3280  * to be updated.
3281  *
3282  * \param init Connected line structure to initialize.
3283  * \param guide Source connected line to use as a guide in initializing.
3284  *
3285  * \return Nothing
3286  */
3287 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
3288
3289 /*!
3290  * \since 1.8
3291  * \brief Set the connected line information based on another connected line source
3292  *
3293  * This is similar to ast_party_connected_line_copy, except that NULL values for
3294  * strings in the src parameter indicate not to update the corresponding dest values.
3295  *
3296  * \param dest The connected line one wishes to update
3297  * \param src The new connected line values to update the dest
3298  * \param update What connected line information to update.  NULL if all.
3299  *
3300  * \return Nothing
3301  */
3302 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);
3303
3304 /*!
3305  * \since 1.8
3306  * \brief Collect the caller party information into a connected line structure.
3307  *
3308  * \param connected Collected caller information for the connected line
3309  * \param caller Caller information.
3310  *
3311  * \return Nothing
3312  *
3313  * \warning This is a shallow copy.
3314  * \warning DO NOT call ast_party_connected_line_free() on the filled in
3315  * connected line structure!
3316  */
3317 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_party_caller *caller);
3318
3319 /*!
3320  * \since 1.8
3321  * \brief Destroy the connected line information contents
3322  *
3323  * \param doomed The connected line information to destroy.
3324  *
3325  * \return Nothing
3326  */
3327 void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
3328
3329 /*!
3330  * \brief Initialize the given redirecting reason structure
3331  *
3332  * \param init Redirecting reason structure to initialize
3333  *
3334  * \return Nothing
3335  */
3336 void ast_party_redirecting_reason_init(struct ast_party_redirecting_reason *init);
3337
3338 /*!
3339  * \brief Copy the source redirecting reason information to the destination redirecting reason.
3340  *
3341  * \param dest Destination redirecting reason
3342  * \param src Source redirecting reason
3343  *
3344  * \return Nothing
3345  */
3346 void ast_party_redirecting_reason_copy(struct ast_party_redirecting_reason *dest,
3347                 const struct ast_party_redirecting_reason *src);
3348
3349 /*!
3350  * \brief Initialize the given redirecting reason structure using the given guide
3351  * for a set update operation.
3352  *
3353  * \details
3354  * The initialization is needed to allow a set operation to know if a
3355  * value needs to be updated.  Simple integers need the guide's original
3356  * value in case the set operation is not trying to set a new value.
3357  * String values are simply set to NULL pointers if they are not going
3358  * to be updated.
3359  *
3360  * \param init Redirecting reason structure to initialize.
3361  * \param guide Source redirecting reason to use as a guide in initializing.
3362  *
3363  * \return Nothing
3364  */
3365 void ast_party_redirecting_reason_set_init(struct ast_party_redirecting_reason *init,
3366                 const struct ast_party_redirecting_reason *guide);
3367
3368 /*!
3369  * \brief Set the redirecting reason information based on another redirecting reason source
3370  *
3371  * This is similar to ast_party_redirecting_reason_copy, except that NULL values for
3372  * strings in the src parameter indicate not to update the corresponding dest values.
3373  *
3374  * \param dest The redirecting reason one wishes to update
3375  * \param src The new redirecting reason values to update the dest
3376  *
3377  * \return Nothing
3378  */
3379 void ast_party_redirecting_reason_set(struct ast_party_redirecting_reason *dest,
3380                 const struct ast_party_redirecting_reason *src);
3381
3382 /*!
3383  * \brief Destroy the redirecting reason contents
3384  *
3385  * \param doomed The redirecting reason to destroy.
3386  *
3387  * \return Nothing
3388  */
3389 void ast_party_redirecting_reason_free(struct ast_party_redirecting_reason *doomed);
3390
3391 /*!
3392  * \brief Initialize the given redirecting structure.
3393  * \since 1.8
3394  *
3395  * \param init Redirecting structure to initialize.
3396  *
3397  * \return Nothing
3398  */
3399 void ast_party_redirecting_init(struct ast_party_redirecting *init);
3400
3401 /*!
3402  * \since 1.8
3403  * \brief Copy the source redirecting information to the destination redirecting.
3404  *
3405  * \param dest Destination redirecting
3406  * \param src Source redirecting
3407  *
3408  * \return Nothing
3409  */
3410 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
3411
3412 /*!
3413  * \since 1.8
3414  * \brief Initialize the given redirecting id structure using the given guide
3415  * for a set update operation.
3416  *
3417  * \details
3418  * The initialization is needed to allow a set operation to know if a
3419  * value needs to be updated.  Simple integers need the guide's original
3420  * value in case the set operation is not trying to set a new value.
3421  * String values are simply set to NULL pointers if they are not going
3422  * to be updated.
3423  *
3424  * \param init Redirecting id structure to initialize.
3425  * \param guide Source redirecting id to use as a guide in initializing.
3426  *
3427  * \return Nothing
3428  */
3429 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
3430
3431 /*!
3432  * \brief Set the redirecting information based on another redirecting source
3433  * \since 1.8
3434  *
3435  * This is similar to ast_party_redirecting_copy, except that NULL values for
3436  * strings in the src parameter indicate not to update the corresponding dest values.
3437  *
3438  * \param dest The redirecting one wishes to update
3439  * \param src The new redirecting values to update the dest
3440  * \param update What redirecting information to update.  NULL if all.
3441  *
3442  * \return Nothing
3443  */
3444 void ast_party_redirecting_set(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src, const struct ast_set_party_redirecting *update);
3445
3446 /*!
3447  * \since 1.8
3448  * \brief Destroy the redirecting information contents
3449  *
3450  * \param doomed The redirecting information to destroy.
3451  *
3452  * \return Nothing
3453  */
3454 void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
3455
3456 /*!
3457  * \since 1.8
3458  * \brief Copy the caller information to the connected line information.
3459  *
3460  * \param dest Destination connected line information
3461  * \param src Source caller information
3462  *
3463  * \return Nothing
3464  *
3465  * \note Assumes locks are already acquired
3466  */
3467 void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_party_caller *src);
3468
3469 /*!
3470  * \since 1.8
3471  * \brief Copy the connected line information to the caller information.
3472  *
3473  * \param dest Destination caller information
3474  * \param src Source connected line information
3475  *
3476  * \return Nothing
3477  *
3478  * \note Assumes locks are already acquired
3479  */
3480 void ast_connected_line_copy_to_caller(struct ast_party_caller *dest, const struct ast_party_connected_line *src);
3481
3482 /*!
3483  * \since 1.8
3484  * \brief Set the connected line information in the Asterisk channel
3485  *
3486  * \param chan Asterisk channel to set connected line information
3487  * \param connected Connected line information
3488  * \param update What connected line information to update.  NULL if all.
3489  *
3490  * \return Nothing
3491  *
3492  * \note The channel does not need to be locked before calling this function.
3493  */
3494 void ast_channel_set_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
3495
3496 /*!
3497  * \since 1.8
3498  * \brief Build the connected line information data frame.
3499  *
3500  * \param data Buffer to fill with the frame data
3501  * \param datalen Size of the buffer to fill
3502  * \param connected Connected line information
3503  * \param update What connected line information to build.  NULL if all.
3504  *
3505  * \retval -1 if error
3506  * \retval Amount of data buffer used
3507  */
3508 int ast_connected_line_build_data(unsigned char *data, size_t datalen, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
3509
3510 /*!
3511  * \since 1.8
3512  * \brief Parse connected line indication frame data
3513  *
3514  * \param data Buffer with the frame data to parse
3515  * \param datalen Size of the buffer
3516  * \param connected Extracted connected line information
3517  *
3518  * \retval 0 on success.
3519  * \retval -1 on error.
3520  *
3521  * \note The filled in connected line structure needs to be initialized by
3522  * ast_party_connected_line_set_init() before calling.  If defaults are not
3523  * required use ast_party_connected_line_init().
3524  * \note The filled in connected line structure needs to be destroyed by
3525  * ast_party_connected_line_free() when it is no longer needed.
3526  */
3527 int ast_connected_line_parse_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
3528
3529 /*!
3530  * \since 1.8
3531  * \brief Indicate that the connected line information has changed
3532  *
3533  * \param chan Asterisk channel to indicate connected line information
3534  * \param connected Connected line information
3535  * \param update What connected line information to update.  NULL if all.
3536  *
3537  * \return Nothing
3538  */
3539 void ast_channel_update_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
3540
3541 /*!
3542  * \since 1.8
3543  * \brief Queue a connected line update frame on a channel
3544  *
3545  * \param chan Asterisk channel to indicate connected line information
3546  * \param connected Connected line information
3547  * \param update What connected line information to update.  NULL if all.
3548  *
3549  * \return Nothing
3550  */
3551 void ast_channel_queue_connected_line_update(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
3552
3553 /*!
3554  * \since 1.8
3555  * \brief Set the redirecting id information in the Asterisk channel
3556  *
3557  * \param chan Asterisk channel to set redirecting id information
3558  * \param redirecting Redirecting id information
3559  * \param update What redirecting information to update.  NULL if all.
3560  *
3561  * \return Nothing
3562  *
3563  * \note The channel does not need to be locked before calling this function.
3564  */
3565 void ast_channel_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3566
3567 /*!
3568  * \since 1.8
3569  * \brief Build the redirecting id data frame.
3570  *
3571  * \param data Buffer to fill with the frame data
3572  * \param datalen Size of the buffer to fill
3573  * \param redirecting Redirecting id information
3574  * \param update What redirecting information to build.  NULL if all.
3575  *
3576  * \retval -1 if error
3577  * \retval Amount of data buffer used
3578  */
3579 int ast_redirecting_build_data(unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3580
3581 /*!
3582  * \since 1.8
3583  * \brief Parse redirecting indication frame data
3584  *
3585  * \param data Buffer with the frame data to parse
3586  * \param datalen Size of the buffer
3587  * \param redirecting Extracted redirecting id information
3588  *
3589  * \retval 0 on success.
3590  * \retval -1 on error.
3591  *
3592  * \note The filled in id structure needs to be initialized by
3593  * ast_party_redirecting_set_init() before calling.
3594  * \note The filled in id structure needs to be destroyed by
3595  * ast_party_redirecting_free() when it is no longer needed.
3596  */
3597 int ast_redirecting_parse_data(const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting);
3598
3599 /*!
3600  * \since 1.8
3601  * \brief Indicate that the redirecting id has changed
3602  *
3603  * \param chan Asterisk channel to indicate redirecting id information
3604  * \param redirecting Redirecting id information
3605  * \param update What redirecting information to update.  NULL if all.
3606  *
3607  * \return Nothing
3608  */
3609 void ast_channel_update_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3610
3611 /*!
3612  * \since 1.8
3613  * \brief Queue a redirecting update frame on a channel
3614  *
3615  * \param chan Asterisk channel to indicate redirecting id information
3616  * \param redirecting Redirecting id information
3617  * \param update What redirecting information to update.  NULL if all.
3618  *
3619  * \return Nothing
3620  */
3621 void ast_channel_queue_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3622
3623 /*!
3624  * \since 1.8
3625  * \brief Run a connected line interception macro and update a channel's connected line
3626  * information
3627  * \deprecated You should use the ast_channel_connected_line_sub() function instead.
3628  *
3629  * Whenever we want to update a channel's connected line information, we may need to run
3630  * a macro so that an administrator can manipulate the information before sending it
3631  * out. This function both runs the macro and sends the update to the channel.
3632  *
3633  * \param autoservice_chan Channel to place into autoservice while the macro is running.
3634  * It is perfectly safe for this to be NULL
3635  * \param macro_chan The channel to run the macro on. Also the channel from which we
3636  * determine which macro we need to run.
3637  * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type
3638  * AST_CONTROL_CONNECTED_LINE
3639  * \param is_caller If true, then run CONNECTED_LINE_CALLER_SEND_MACRO with arguments from
3640  * CONNECTED_LINE_CALLER_SEND_MACRO_ARGS, otherwise run CONNECTED_LINE_CALLEE_SEND_MACRO
3641  * with arguments from CONNECTED_LINE_CALLEE_SEND_MACRO_ARGS
3642  * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an
3643  * ast_party_connected_line pointer.
3644  * \retval 0 Success
3645  * \retval -1 Either the macro does not exist, or there was an error while attempting to
3646  * run the macro
3647  *
3648  * \todo Have multiple return codes based on the MACRO_RESULT
3649  * \todo Make constants so that caller and frame can be more expressive than just '1' and
3650  * '0'
3651  */
3652 int ast_channel_connected_line_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const void *connected_info, int is_caller, int frame);
3653
3654 /*!
3655  * \since 11
3656  * \brief Run a connected line interception subroutine and update a channel's connected line
3657  * information
3658  *
3659  * Whenever we want to update a channel's connected line information, we may need to run
3660  * a subroutine so that an administrator can manipulate the information before sending it
3661  * out. This function both runs the subroutine specified by CONNECTED_LINE_SEND_SUB and
3662  * sends the update to the channel.
3663  *
3664  * \param autoservice_chan Channel to place into autoservice while the sub is running.
3665  * It is perfectly safe for this to be NULL
3666  * \param sub_chan The channel to run the subroutine on. Also the channel from which we
3667  * determine which subroutine we need to run.
3668  * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type
3669  * AST_CONTROL_CONNECTED_LINE
3670  * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an
3671  * ast_party_connected_line pointer.
3672  * \retval 0 Success
3673  * \retval -1 Either the subroutine does not exist, or there was an error while attempting to
3674  * run the subroutine
3675  */
3676 int ast_channel_connected_line_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *connected_info, int frame);
3677
3678 /*!
3679  * \brief Insert into an astdata tree, the channel structure.
3680  * \param[in] tree The ast data tree.
3681  * \param[in] chan The channel structure to add to tree.
3682  * \param[in] add_bridged Add the bridged channel to the structure.
3683  * \retval <0 on error.
3684  * \retval 0 on success.
3685  */
3686 int ast_channel_data_add_structure(struct ast_data *tree, struct ast_channel *chan, int add_bridged);
3687
3688 /*!
3689  * \brief Compare to channel structures using the data api.
3690  * \param[in] tree The search tree generated by the data api.
3691  * \param[in] chan The channel to compare.
3692  * \param[in] structure_name The name of the node of the channel structure.
3693  * \retval 0 The structure matches.
3694  * \retval 1 The structure doesn't matches.
3695  */
3696 int ast_channel_data_cmp_structure(const struct ast_data_search *tree, struct ast_channel *chan,
3697         const char *structure_name);
3698
3699 /*!
3700  * \since 1.8
3701  * \brief Run a redirecting interception macro and update a channel's redirecting information
3702  * \deprecated You should use the ast_channel_redirecting_sub() function instead.
3703  *
3704  * \details
3705  * Whenever we want to update a channel's redirecting information, we may need to run
3706  * a macro so that an administrator can manipulate the information before sending it
3707  * out. This function both runs the macro and sends the update to the channel.
3708  *
3709  * \param autoservice_chan Channel to place into autoservice while the macro is running.
3710  * It is perfectly safe for this to be NULL
3711  * \param macro_chan The channel to run the macro on. Also the channel from which we
3712  * determine which macro we need to run.
3713  * \param redirecting_info Either an ast_party_redirecting or ast_frame pointer of type
3714  * AST_CONTROL_REDIRECTING
3715  * \param is_caller If true, then run REDIRECTING_CALLER_SEND_MACRO with arguments from
3716  * REDIRECTING_CALLER_SEND_MACRO_ARGS, otherwise run REDIRECTING_CALLEE_SEND_MACRO with
3717  * arguments from REDIRECTING_CALLEE_SEND_MACRO_ARGS
3718  * \param is_frame If true, then redirecting_info is an ast_frame pointer, otherwise it is an
3719  * ast_party_redirecting pointer.
3720  *
3721  * \retval 0 Success
3722  * \retval -1 Either the macro does not exist, or there was an error while attempting to
3723  * run the macro
3724  *
3725  * \todo Have multiple return codes based on the MACRO_RESULT
3726  * \todo Make constants so that caller and frame can be more expressive than just '1' and
3727  * '0'
3728  */
3729 int ast_channel_redirecting_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const void *redirecting_info, int is_caller, int is_frame);
3730
3731 /*!
3732  * \since 11
3733  * \brief Run a redirecting interception subroutine and update a channel's redirecting information
3734  *
3735  * \details
3736  * Whenever we want to update a channel's redirecting information, we may need to run
3737  * a subroutine so that an administrator can manipulate the information before sending it
3738  * out. This function both runs the subroutine specified by REDIRECTING_SEND_SUB and
3739  * sends the update to the channel.
3740  *
3741  * \param autoservice_chan Channel to place into autoservice while the subroutine is running.
3742  * It is perfectly safe for this to be NULL
3743  * \param sub_chan The channel to run the subroutine on. Also the channel from which we
3744  * determine which subroutine we need to run.
3745  * \param redirecting_info Either an ast_party_redirecting or ast_frame pointer of type
3746  * AST_CONTROL_REDIRECTING
3747  * \param is_frame If true, then redirecting_info is an ast_frame pointer, otherwise it is an
3748  * ast_party_redirecting pointer.
3749  *
3750  * \retval 0 Success
3751  * \retval -1 Either the subroutine does not exist, or there was an error while attempting to
3752  * run the subroutine
3753  */
3754 int ast_channel_redirecting_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *redirecting_info, int is_frame);
3755
3756 #include "asterisk/ccss.h"
3757
3758 /*!
3759  * \since 1.8
3760  * \brief Set up datastore with CCSS parameters for a channel
3761  *
3762  * \note
3763  * If base_params is NULL, the channel will get the default
3764  * values for all CCSS parameters.
3765  *
3766  * \details
3767  * This function makes use of datastore operations on the channel, so
3768  * it is important to lock the channel before calling this function.
3769  *
3770  * \param chan The channel to create the datastore on
3771  * \param base_params CCSS parameters we wish to copy into the channel
3772  * \retval 0 Success
3773  * \retval -1 Failure
3774  */
3775 int ast_channel_cc_params_init(struct ast_channel *chan,
3776                 const struct ast_cc_config_params *base_params);
3777
3778 /*!
3779  * \since 1.8
3780  * \brief Get the CCSS parameters from a channel
3781  *
3782  * \details
3783  * This function makes use of datastore operations on the channel, so
3784  * it is important to lock the channel before calling this function.
3785  *
3786  * \param chan Channel to retrieve parameters from
3787  * \retval NULL Failure
3788  * \retval non-NULL The parameters desired
3789  */
3790 struct ast_cc_config_params *ast_channel_get_cc_config_params(struct ast_channel *chan);
3791
3792
3793 /*!
3794  * \since 1.8
3795  * \brief Get a device name given its channel structure
3796  *
3797  * \details
3798  * A common practice in Asterisk is to determine the device being talked
3799  * to by dissecting the channel name. For certain channel types, this is not
3800  * accurate. For instance, an ISDN channel is named based on what B channel is
3801  * used, not the device being communicated with.
3802  *
3803  * This function interfaces with a channel tech's queryoption callback to
3804  * retrieve the name of the device being communicated with. If the channel does not
3805  * implement this specific option, then the traditional method of using the channel
3806  * name is used instead.
3807  *
3808  * \param chan The channel to retrieve the information from
3809  * \param[out] device_name The buffer to place the device's name into
3810  * \param name_buffer_length The allocated space for the device_name
3811  * \return 0 always
3812  */
3813 int ast_channel_get_device_name(struct ast_channel *chan, char *device_name, size_t name_buffer_length);
3814
3815 /*!
3816  * \since 1.8
3817  * \brief Find the appropriate CC agent type to use given a channel
3818  *
3819  * \details
3820  * During call completion, we will need to create a call completion agent structure. To
3821  * figure out the type of agent to construct, we need to ask the channel driver for the
3822  * appropriate type.
3823  *
3824  * Prior to adding this function, the call completion core attempted to figure this
3825  * out for itself by stripping the technology off the channel's name. However, in the
3826  * case of chan_dahdi, there are multiple agent types registered, and so simply searching
3827  * for an agent type called "DAHDI" is not possible. In a case where multiple agent types
3828  * are defined, the channel driver must have a queryoption callback defined in its
3829  * channel_tech, and the queryoption callback must handle AST_OPTION_CC_AGENT_TYPE
3830  *
3831  * If a channel driver does not have a queryoption callback or if the queryoption callback
3832  * does not handle AST_OPTION_CC_AGENT_TYPE, then the old behavior of using the technology
3833  * portion of the channel name is used instead. This is perfectly suitable for channel drivers
3834  * whose channel technologies are a one-to-one match with the agent types defined within.
3835  *
3836  * Note that this function is only called when the agent policy on a given channel is set
3837  * to "native." Generic agents' type can be determined automatically by the core.
3838  *
3839  * \param chan The channel for which we wish to retrieve the agent type
3840  * \param[out] agent_type The type of agent the channel driver wants us to use
3841  * \param size The size of the buffer to write to
3842  */
3843 int ast_channel_get_cc_agent_type(struct ast_channel *chan, char *agent_type, size_t size);
3844 #if defined(__cplusplus) || defined(c_plusplus)
3845 }
3846 #endif
3847
3848 /*!
3849  * \brief Remove a channel from the global channels container
3850  *
3851  * \param chan channel to remove
3852  *
3853  * In a case where it is desired that a channel not be available in any lookups
3854  * in the global channels conatiner, use this function.
3855  */
3856 void ast_channel_unlink(struct ast_channel *chan);
3857
3858 /*!
3859  * \brief Sets the HANGUPCAUSE hash and optionally the SIP_CAUSE hash
3860  * on the given channel
3861  *
3862  * \param chan channel on which to set the cause information
3863  * \param cause_code ast_control_pvt_cause_code structure containing cause information
3864  * \param datalen total length of the structure since it may vary
3865  */
3866 void ast_channel_hangupcause_hash_set(struct ast_channel *chan, const struct ast_control_pvt_cause_code *cause_code, int datalen);
3867
3868 /*!
3869  * \since 12
3870  * \brief Convert a string to a detail record AMA flag
3871  *
3872  * \param flag string form of flag
3873  *
3874  * \retval the enum (integer) form of the flag
3875  */
3876 enum ama_flags ast_channel_string2amaflag(const char *flag);
3877
3878 /*!
3879  * \since 12
3880  * \brief Convert the enum representation of an AMA flag to a string representation
3881  *
3882  * \param flags integer flag
3883  *
3884  * \retval A string representation of the flag
3885  */
3886 const char *ast_channel_amaflags2string(enum ama_flags flags);
3887
3888 /* ACCESSOR FUNTIONS */
3889 /*! \brief Set the channel name */
3890 void ast_channel_name_set(struct ast_channel *chan, const char *name);
3891
3892 #define DECLARE_STRINGFIELD_SETTERS_FOR(field)  \
3893         void ast_channel_##field##_set(struct ast_channel *chan, const char *field); \
3894         void ast_channel_##field##_build_va(struct ast_channel *chan, const char *fmt, va_list ap) __attribute__((format(printf, 2, 0))); \
3895         void ast_channel_##field##_build(struct ast_channel *chan, const char *fmt, ...) __attribute__((format(printf, 2, 3)))
3896
3897 /*!
3898  * The following string fields result in channel snapshot creation and
3899  * should have the channel locked when called:
3900  *
3901  * \li language
3902  * \li accountcode
3903  * \li peeracccount
3904  * \li linkedid
3905  */
3906 DECLARE_STRINGFIELD_SETTERS_FOR(name);
3907 DECLARE_STRINGFIELD_SETTERS_FOR(language);
3908 DECLARE_STRINGFIELD_SETTERS_FOR(musicclass);
3909 DECLARE_STRINGFIELD_SETTERS_FOR(latest_musicclass);
3910 DECLARE_STRINGFIELD_SETTERS_FOR(accountcode);
3911 DECLARE_STRINGFIELD_SETTERS_FOR(peeraccount);
3912 DECLARE_STRINGFIELD_SETTERS_FOR(userfield);
3913 DECLARE_STRINGFIELD_SETTERS_FOR(call_forward);
3914 DECLARE_STRINGFIELD_SETTERS_FOR(uniqueid);
3915 DECLARE_STRINGFIELD_SETTERS_FOR(linkedid);
3916 DECLARE_STRINGFIELD_SETTERS_FOR(parkinglot);
3917 DECLARE_STRINGFIELD_SETTERS_FOR(hangupsource);
3918 DECLARE_STRINGFIELD_SETTERS_FOR(dialcontext);
3919
3920 const char *ast_channel_name(const struct ast_channel *chan);
3921 const char *ast_channel_language(const struct ast_channel *chan);
3922 const char *ast_channel_musicclass(const struct ast_channel *chan);
3923 const char *ast_channel_latest_musicclass(const struct ast_channel *chan);
3924 const char *ast_channel_accountcode(const struct ast_channel *chan);
3925 const char *ast_channel_peeraccount(const struct ast_channel *chan);
3926 const char *ast_channel_userfield(const struct ast_channel *chan);
3927 const char *ast_channel_call_forward(const struct ast_channel *chan);
3928 const char *ast_channel_uniqueid(const struct ast_channel *chan);
3929 const char *ast_channel_linkedid(const struct ast_channel *chan);
3930 const char *ast_channel_parkinglot(const struct ast_channel *chan);
3931 const char *ast_channel_hangupsource(const struct ast_channel *chan);
3932 const char *ast_channel_dialcontext(const struct ast_channel *chan);
3933
3934 const char *ast_channel_appl(const struct ast_channel *chan);
3935 void ast_channel_appl_set(struct ast_channel *chan, const char *value);
3936 const char *ast_channel_blockproc(const struct ast_channel *chan);
3937 void ast_channel_blockproc_set(struct ast_channel *chan, const char *value);
3938 const char *ast_channel_data(const struct ast_channel *chan);
3939 void ast_channel_data_set(struct ast_channel *chan, const char *value);
3940
3941 const char *ast_channel_context(const struct ast_channel *chan);
3942 void ast_channel_context_set(struct ast_channel *chan, const char *value);
3943 const char *ast_channel_exten(const struct ast_channel *chan);
3944 void ast_channel_exten_set(struct ast_channel *chan, const char *value);
3945 const char *ast_channel_macrocontext(const struct ast_channel *chan);
3946 void ast_channel_macrocontext_set(struct ast_channel *chan, const char *value);
3947 const char *ast_channel_macroexten(const struct ast_channel *chan);
3948 void ast_channel_macroexten_set(struct ast_channel *chan, const char *value);
3949
3950 char ast_channel_dtmf_digit_to_emulate(const struct ast_channel *chan);
3951 void ast_channel_dtmf_digit_to_emulate_set(struct ast_channel *chan, char value);
3952 char ast_channel_sending_dtmf_digit(const struct ast_channel *chan);
3953 void ast_channel_sending_dtmf_digit_set(struct ast_channel *chan, char value);
3954 struct timeval ast_channel_sending_dtmf_tv(const struct ast_channel *chan);
3955 void ast_channel_sending_dtmf_tv_set(struct ast_channel *chan, struct timeval value);
3956 enum ama_flags ast_channel_amaflags(const struct ast_channel *chan);
3957
3958 /*!
3959  * \pre chan is locked
3960  */
3961 void ast_channel_amaflags_set(struct ast_channel *chan, enum ama_flags value);
3962 int ast_channel_epfd(const struct ast_channel *chan);
3963 void ast_channel_epfd_set(struct ast_channel *chan, int value);
3964 int ast_channel_fdno(const struct ast_channel *chan);
3965 void ast_channel_fdno_set(struct ast_channel *chan, int value);
3966 int ast_channel_hangupcause(const struct ast_channel *chan);
3967 void ast_channel_hangupcause_set(struct ast_channel *chan, int value);
3968 int ast_channel_macropriority(const struct ast_channel *chan);
3969 void ast_channel_macropriority_set(struct ast_channel *chan, int value);
3970 int ast_channel_priority(const struct ast_channel *chan);
3971 void ast_channel_priority_set(struct ast_channel *chan, int value);
3972 int ast_channel_rings(const struct ast_channel *chan);
3973 void ast_channel_rings_set(struct ast_channel *chan, int value);
3974 int ast_channel_streamid(const struct ast_channel *chan);
3975 void ast_channel_streamid_set(struct ast_channel *chan, int value);
3976 int ast_channel_timingfd(const struct ast_channel *chan);
3977 void ast_channel_timingfd_set(struct ast_channel *chan, int value);
3978 int ast_channel_visible_indication(const struct ast_channel *chan);
3979 void ast_channel_visible_indication_set(struct ast_channel *chan, int value);
3980 int ast_channel_hold_state(const struct ast_channel *chan);
3981 void ast_channel_hold_state_set(struct ast_channel *chan, int value);
3982 int ast_channel_vstreamid(const struct ast_channel *chan);
3983 void ast_channel_vstreamid_set(struct ast_channel *chan, int value);
3984 unsigned short ast_channel_transfercapability(const struct ast_channel *chan);
3985 void ast_channel_transfercapability_set(struct ast_channel *chan, unsigned short value);
3986 unsigned int ast_channel_emulate_dtmf_duration(const struct ast_channel *chan);
3987 void ast_channel_emulate_dtmf_duration_set(struct ast_channel *chan, unsigned int value);
3988 unsigned int ast_channel_fin(const struct ast_channel *chan);
3989 void ast_channel_fin_set(struct ast_channel *chan, unsigned int value);
3990 unsigned int ast_channel_fout(const struct ast_channel *chan);
3991 void ast_channel_fout_set(struct ast_channel *chan, unsigned int value);
3992 unsigned long ast_channel_insmpl(const struct ast_channel *chan);
3993 void ast_channel_insmpl_set(struct ast_channel *chan, unsigned long value);
3994 unsigned long ast_channel_outsmpl(const struct ast_channel *chan);
3995 void ast_channel_outsmpl_set(struct ast_channel *chan, unsigned long value);
3996 void *ast_channel_generatordata(const struct ast_channel *chan);
3997 void ast_channel_generatordata_set(struct ast_channel *chan, void *value);
3998 void *ast_channel_music_state(const struct ast_channel *chan);
3999 void ast_channel_music_state_set(struct ast_channel *chan, void *value);
4000 void *ast_channel_tech_pvt(const struct ast_channel *chan);
4001 void ast_channel_tech_pvt_set(struct ast_channel *chan, void *value);
4002 void *ast_channel_timingdata(const struct ast_channel *chan);
4003 void ast_channel_timingdata_set(struct ast_channel *chan, void *value);
4004 struct ast_audiohook_list *ast_channel_audiohooks(const struct ast_channel *chan);
4005 void ast_channel_audiohooks_set(struct ast_channel *chan, struct ast_audiohook_list *value);
4006 struct ast_cdr *ast_channel_cdr(const struct ast_channel *chan);
4007 void ast_channel_cdr_set(struct ast_channel *chan, struct ast_cdr *value);
4008 struct ast_channel *ast_channel__bridge(const struct ast_channel *chan);
4009 void ast_channel__bridge_set(struct ast_channel *chan, struct ast_channel *value);
4010 struct ast_channel *ast_channel_masq(const struct ast_channel *chan);
4011 void ast_channel_masq_set(struct ast_channel *chan, struct ast_channel *value);
4012 struct ast_channel *ast_channel_masqr(const struct ast_channel *chan);
4013 void ast_channel_masqr_set(struct ast_channel *chan, struct ast_channel *value);
4014 struct ast_channel_monitor *ast_channel_monitor(const struct ast_channel *chan);
4015 void ast_channel_monitor_set(struct ast_channel *chan, struct ast_channel_monitor *value);
4016 struct ast_filestream *ast_channel_stream(const struct ast_channel *chan);
4017 void ast_channel_stream_set(struct ast_channel *chan, struct ast_filestream *value);
4018 struct ast_filestream *ast_channel_vstream(const struct ast_channel *chan);
4019 void ast_channel_vstream_set(struct ast_channel *chan, struct ast_filestream *value);
4020 struct ast_format_cap *ast_channel_nativeformats(const struct ast_channel *chan);
4021 void ast_channel_nativeformats_set(struct ast_channel *chan, struct ast_format_cap *value);
4022 struct ast_framehook_list *ast_channel_framehooks(const struct ast_channel *chan);
4023 void ast_channel_framehooks_set(struct ast_channel *chan, struct ast_framehook_list *value);
4024 struct ast_generator *ast_channel_generator(const struct ast_channel *chan);
4025 void ast_channel_generator_set(struct ast_channel *chan, struct ast_generator *value);
4026 struct ast_pbx *ast_channel_pbx(const struct ast_channel *chan);
4027 void ast_channel_pbx_set(struct ast_channel *chan, struct ast_pbx *value);
4028 struct ast_sched_context *ast_channel_sched(const struct ast_channel *chan);
4029 void ast_channel_sched_set(struct ast_channel *chan, struct ast_sched_context *value);
4030 struct ast_timer *ast_channel_timer(const struct ast_channel *chan);
4031 void ast_channel_timer_set(struct ast_channel *chan, struct ast_timer *value);
4032 struct ast_tone_zone *ast_channel_zone(const struct ast_channel *chan);
4033 void ast_channel_zone_set(struct ast_channel *chan, struct ast_tone_zone *value);
4034 struct ast_trans_pvt *ast_channel_readtrans(const struct ast_channel *chan);
4035 void ast_channel_readtrans_set(struct ast_channel *chan, struct ast_trans_pvt *value);
4036 struct ast_trans_pvt *ast_channel_writetrans(const struct ast_channel *chan);
4037 void ast_channel_writetrans_set(struct ast_channel *chan, struct ast_trans_pvt *value);
4038 const struct ast_channel_tech *ast_channel_tech(const struct ast_channel *chan);
4039 void ast_channel_tech_set(struct ast_channel *chan, const struct ast_channel_tech *value);
4040 enum ast_channel_adsicpe ast_channel_adsicpe(const struct ast_channel *chan);
4041 void ast_channel_adsicpe_set(struct ast_channel *chan, enum ast_channel_adsicpe value);
4042 enum ast_channel_state ast_channel_state(const struct ast_channel *chan);
4043 ast_callid ast_channel_callid(const struct ast_channel *chan);
4044
4045 /*!
4046  * \pre chan is locked
4047  */
4048 void ast_channel_callid_set(struct ast_channel *chan, ast_callid value);
4049
4050 /* XXX Internal use only, make sure to move later */
4051 void ast_channel_state_set(struct ast_channel *chan, enum ast_channel_state);
4052 void ast_channel_softhangup_internal_flag_set(struct ast_channel *chan, int value);
4053 void ast_channel_softhangup_internal_flag_add(struct ast_channel *chan, int value);
4054 void ast_channel_softhangup_internal_flag_clear(struct ast_channel *chan, int value);
4055 void ast_channel_callid_cleanup(struct ast_channel *chan);
4056 int ast_channel_softhangup_internal_flag(struct ast_channel *chan);
4057
4058 /* Format getters */
4059 struct ast_format *ast_channel_oldwriteformat(struct ast_channel *chan);
4060 struct ast_format *ast_channel_rawreadformat(struct ast_channel *chan);
4061 struct ast_format *ast_channel_rawwriteformat(struct ast_channel *chan);
4062 struct ast_format *ast_channel_readformat(struct ast_channel *chan);
4063 struct ast_format *ast_channel_writeformat(struct ast_channel *chan);
4064
4065 /* Format setters - all of these functions will increment the reference count of the format passed in */
4066 void ast_channel_set_oldwriteformat(struct ast_channel *chan, struct ast_format *format);
4067 void ast_channel_set_rawreadformat(struct ast_channel *chan, struct ast_format *format);
4068 void ast_channel_set_rawwriteformat(struct ast_channel *chan, struct ast_format *format);
4069 void ast_channel_set_readf