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