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