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