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