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