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