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