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