bridge_native_rtp: Deadlock during 4-way conference creation
[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          * Channel snapshot should not be published, it is being staged for an explicit
928          * publish.
929          */
930         AST_FLAG_SNAPSHOT_STAGE = (1 << 25),
931 };
932
933 /*! \brief ast_bridge_config flags */
934 enum {
935         AST_FEATURE_PLAY_WARNING = (1 << 0),
936         AST_FEATURE_REDIRECT =     (1 << 1),
937         AST_FEATURE_DISCONNECT =   (1 << 2),
938         AST_FEATURE_ATXFER =       (1 << 3),
939         AST_FEATURE_AUTOMON =      (1 << 4),
940         AST_FEATURE_PARKCALL =     (1 << 5),
941         AST_FEATURE_AUTOMIXMON =   (1 << 6),
942 };
943
944 #define AST_FEATURE_DTMF_MASK (AST_FEATURE_REDIRECT | AST_FEATURE_DISCONNECT |\
945         AST_FEATURE_ATXFER | AST_FEATURE_AUTOMON | AST_FEATURE_PARKCALL | AST_FEATURE_AUTOMIXMON)
946
947 /*! \brief bridge configuration */
948 struct ast_bridge_config {
949         struct ast_flags features_caller;
950         struct ast_flags features_callee;
951         struct timeval start_time;
952         struct timeval nexteventts;
953         struct timeval feature_start_time;
954         long feature_timer;
955         long timelimit;
956         long play_warning;
957         long warning_freq;
958         const char *warning_sound;
959         const char *end_sound;
960         const char *start_sound;
961         unsigned int flags;
962         void (* end_bridge_callback)(void *);   /*!< A callback that is called after a bridge attempt */
963         void *end_bridge_callback_data;         /*!< Data passed to the callback */
964         /*! If the end_bridge_callback_data refers to a channel which no longer is going to
965          * exist when the end_bridge_callback is called, then it needs to be fixed up properly
966          */
967         void (*end_bridge_callback_data_fixup)(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator);
968 };
969
970 struct chanmon;
971
972 struct outgoing_helper {
973         const char *context;
974         const char *exten;
975         int priority;
976         int connect_on_early_media;     /* If set, treat session progress as answer */
977         const char *cid_num;
978         const char *cid_name;
979         const char *account;
980         struct ast_variable *vars;
981         struct ast_channel *parent_channel;
982 };
983
984 enum {
985         /*!
986          * Soft hangup requested by device or other internal reason.
987          * Actual hangup needed.
988          */
989         AST_SOFTHANGUP_DEV =       (1 << 0),
990         /*!
991          * Used to break the normal frame flow so an async goto can be
992          * done instead of actually hanging up.
993          */
994         AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
995         /*!
996          * Soft hangup requested by system shutdown.  Actual hangup
997          * needed.
998          */
999         AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
1000         /*!
1001          * Used to break the normal frame flow after a timeout so an
1002          * implicit async goto can be done to the 'T' exten if it exists
1003          * instead of actually hanging up.  If the exten does not exist
1004          * then actually hangup.
1005          */
1006         AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
1007         /*!
1008          * Soft hangup requested by application/channel-driver being
1009          * unloaded.  Actual hangup needed.
1010          */
1011         AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
1012         /*!
1013          * Soft hangup requested by non-associated party.  Actual hangup
1014          * needed.
1015          */
1016         AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
1017         /*!
1018          * Used to break a bridge so the channel can be spied upon
1019          * instead of actually hanging up.
1020          */
1021         AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
1022         /*!
1023          * Used to indicate that the channel is currently executing hangup
1024          * logic in the dialplan. The channel has been hungup when this is
1025          * set.
1026          */
1027         AST_SOFTHANGUP_HANGUP_EXEC = (1 << 7),
1028         /*!
1029          * \brief All softhangup flags.
1030          *
1031          * This can be used as an argument to ast_channel_clear_softhangup()
1032          * to clear all softhangup flags from a channel.
1033          */
1034         AST_SOFTHANGUP_ALL =       (0xFFFFFFFF)
1035 };
1036
1037
1038 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
1039 enum channelreloadreason {
1040         CHANNEL_MODULE_LOAD,
1041         CHANNEL_MODULE_RELOAD,
1042         CHANNEL_CLI_RELOAD,
1043         CHANNEL_MANAGER_RELOAD,
1044         CHANNEL_ACL_RELOAD,
1045 };
1046
1047 /*!
1048  * \brief Channel AMA Flags
1049  */
1050 enum ama_flags {
1051         AST_AMA_NONE = 0,
1052         AST_AMA_OMIT,
1053         AST_AMA_BILLING,
1054         AST_AMA_DOCUMENTATION,
1055 };
1056
1057 /*!
1058  * \note None of the datastore API calls lock the ast_channel they are using.
1059  *       So, the channel should be locked before calling the functions that
1060  *       take a channel argument.
1061  */
1062
1063 /*!
1064  * \brief Create a channel data store object
1065  * \deprecated You should use the ast_datastore_alloc() generic function instead.
1066  * \version 1.6.1 deprecated
1067  */
1068 struct ast_datastore * attribute_malloc ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
1069         __attribute__((deprecated));
1070
1071 /*!
1072  * \brief Free a channel data store object
1073  * \deprecated You should use the ast_datastore_free() generic function instead.
1074  * \version 1.6.1 deprecated
1075  */
1076 int ast_channel_datastore_free(struct ast_datastore *datastore)
1077         __attribute__((deprecated));
1078
1079 /*! \brief Inherit datastores from a parent to a child. */
1080 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to);
1081
1082 /*!
1083  * \brief Add a datastore to a channel
1084  *
1085  * \note The channel should be locked before calling this function.
1086  *
1087  * \retval 0 success
1088  * \retval non-zero failure
1089  */
1090 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore);
1091
1092 /*!
1093  * \brief Remove a datastore from a channel
1094  *
1095  * \note The channel should be locked before calling this function.
1096  *
1097  * \retval 0 success
1098  * \retval non-zero failure
1099  */
1100 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore);
1101
1102 /*!
1103  * \brief Find a datastore on a channel
1104  *
1105  * \note The channel should be locked before calling this function.
1106  *
1107  * \note The datastore returned from this function must not be used if the
1108  *       reference to the channel is released.
1109  *
1110  * \retval pointer to the datastore if found
1111  * \retval NULL if not found
1112  */
1113 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid);
1114
1115 /*!
1116  * \brief Create a channel structure
1117  * \since 1.8
1118  *
1119  * \retval NULL failure
1120  * \retval non-NULL successfully allocated channel
1121  *
1122  * \note Absolutely _NO_ channel locks should be held before calling this function.
1123  * \note By default, new channels are set to the "s" extension
1124  *       and "default" context.
1125  */
1126 struct ast_channel * attribute_malloc __attribute__((format(printf, 13, 14)))
1127         __ast_channel_alloc(int needqueue, int state, const char *cid_num,
1128                 const char *cid_name, const char *acctcode,
1129                 const char *exten, const char *context,
1130                 const char *linkedid, enum ama_flags amaflag,
1131                 const char *file, int line, const char *function,
1132                 const char *name_fmt, ...);
1133
1134 /*!
1135  * \brief Create a channel structure
1136  *
1137  * \retval NULL failure
1138  * \retval non-NULL successfully allocated channel
1139  *
1140  * \note Absolutely _NO_ channel locks should be held before calling this function.
1141  * \note By default, new channels are set to the "s" extension
1142  *       and "default" context.
1143  */
1144 #define ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, ...) \
1145         __ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, \
1146                 __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
1147
1148 #if defined(REF_DEBUG) || defined(__AST_DEBUG_MALLOC)
1149 /*!
1150  * \brief Create a fake channel structure
1151  *
1152  * \retval NULL failure
1153  * \retval non-NULL successfully allocated channel
1154  *
1155  * \note This function should ONLY be used to create a fake channel
1156  *       that can then be populated with data for use in variable
1157  *       substitution when a real channel does not exist.
1158  *
1159  * \note The created dummy channel should be destroyed by
1160  * ast_channel_unref().  Using ast_channel_release() needlessly
1161  * grabs the channel container lock and can cause a deadlock as
1162  * a result.  Also grabbing the channel container lock reduces
1163  * system performance.
1164  */
1165 #define ast_dummy_channel_alloc()       __ast_dummy_channel_alloc(__FILE__, __LINE__, __PRETTY_FUNCTION__)
1166 struct ast_channel *__ast_dummy_channel_alloc(const char *file, int line, const char *function);
1167 #else
1168 /*!
1169  * \brief Create a fake channel structure
1170  *
1171  * \retval NULL failure
1172  * \retval non-NULL successfully allocated channel
1173  *
1174  * \note This function should ONLY be used to create a fake channel
1175  *       that can then be populated with data for use in variable
1176  *       substitution when a real channel does not exist.
1177  *
1178  * \note The created dummy channel should be destroyed by
1179  * ast_channel_unref().  Using ast_channel_release() needlessly
1180  * grabs the channel container lock and can cause a deadlock as
1181  * a result.  Also grabbing the channel container lock reduces
1182  * system performance.
1183  */
1184 struct ast_channel *ast_dummy_channel_alloc(void);
1185 #endif
1186
1187 /*!
1188  * \brief Queue one or more frames to a channel's frame queue
1189  *
1190  * \param chan the channel to queue the frame(s) on
1191  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1192  *        by this function.  It is the responsibility of the caller to handle
1193  *        freeing the memory associated with the frame(s) being passed if
1194  *        necessary.
1195  *
1196  * \retval 0 success
1197  * \retval non-zero failure
1198  */
1199 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
1200
1201 /*!
1202  * \brief Queue one or more frames to the head of a channel's frame queue
1203  *
1204  * \param chan the channel to queue the frame(s) on
1205  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1206  *        by this function.  It is the responsibility of the caller to handle
1207  *        freeing the memory associated with the frame(s) being passed if
1208  *        necessary.
1209  *
1210  * \retval 0 success
1211  * \retval non-zero failure
1212  */
1213 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *f);
1214
1215 /*!
1216  * \brief Queue a hangup frame
1217  *
1218  * \note The channel does not need to be locked before calling this function.
1219  */
1220 int ast_queue_hangup(struct ast_channel *chan);
1221
1222 /*!
1223  * \brief Queue a hangup frame with hangupcause set
1224  *
1225  * \note The channel does not need to be locked before calling this function.
1226  * \param[in] chan channel to queue frame onto
1227  * \param[in] cause the hangup cause
1228  * \return 0 on success, -1 on error
1229  * \since 1.6.1
1230  */
1231 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause);
1232
1233 /*!
1234  * \brief Queue a hold frame
1235  *
1236  * \param chan channel to queue frame onto
1237  * \param musicclass The suggested musicclass for the other end to use
1238  *
1239  * \note The channel does not need to be locked before calling this function.
1240  *
1241  * \retval zero on success
1242  * \retval non-zero on failure
1243  */
1244 int ast_queue_hold(struct ast_channel *chan, const char *musicclass);
1245
1246 /*!
1247  * \brief Queue an unhold frame
1248  *
1249  * \param chan channel to queue frame onto
1250  *
1251  * \note The channel does not need to be locked before calling this function.
1252  *
1253  * \retval zero on success
1254  * \retval non-zero on failure
1255  */
1256 int ast_queue_unhold(struct ast_channel *chan);
1257
1258 /*!
1259  * \brief Queue a control frame without payload
1260  *
1261  * \param chan channel to queue frame onto
1262  * \param control type of control frame
1263  *
1264  * \note The channel does not need to be locked before calling this function.
1265  *
1266  * \retval zero on success
1267  * \retval non-zero on failure
1268  */
1269 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control);
1270
1271 /*!
1272  * \brief Queue a control frame with payload
1273  *
1274  * \param chan channel to queue frame onto
1275  * \param control type of control frame
1276  * \param data pointer to payload data to be included in frame
1277  * \param datalen number of bytes of payload data
1278  *
1279  * \retval 0 success
1280  * \retval non-zero failure
1281  *
1282  * \details
1283  * The supplied payload data is copied into the frame, so the caller's copy
1284  * is not modified nor freed, and the resulting frame will retain a copy of
1285  * the data even if the caller frees their local copy.
1286  *
1287  * \note This method should be treated as a 'network transport'; in other
1288  * words, your frames may be transferred across an IAX2 channel to another
1289  * system, which may be a different endianness than yours. Because of this,
1290  * you should ensure that either your frames will never be expected to work
1291  * across systems, or that you always put your payload data into 'network byte
1292  * order' before calling this function.
1293  *
1294  * \note The channel does not need to be locked before calling this function.
1295  */
1296 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
1297                            const void *data, size_t datalen);
1298
1299 /*!
1300  * \brief Change channel name
1301  *
1302  * \pre Absolutely all channels _MUST_ be unlocked before calling this function.
1303  *
1304  * \param chan the channel to change the name of
1305  * \param newname the name to change to
1306  *
1307  * \return nothing
1308  *
1309  * \note this function must _NEVER_ be used when any channels are locked
1310  * regardless if it is the channel who's name is being changed or not because
1311  * it invalidates our channel container locking order... lock container first,
1312  * then the individual channels, never the other way around.
1313  */
1314 void ast_change_name(struct ast_channel *chan, const char *newname);
1315
1316 /*!
1317  * \brief Unlink and release reference to a channel
1318  *
1319  * This function will unlink the channel from the global channels container
1320  * if it is still there and also release the current reference to the channel.
1321  *
1322  * \return NULL, convenient for clearing invalid pointers
1323  * \note Absolutely _NO_ channel locks should be held before calling this function.
1324  *
1325  * \since 1.8
1326  */
1327 struct ast_channel *ast_channel_release(struct ast_channel *chan);
1328
1329 /*!
1330  * \brief Requests a channel
1331  *
1332  * \param type type of channel to request
1333  * \param request_cap Format capabilities for requested channel
1334  * \param requestor channel asking for data
1335  * \param addr destination of the call
1336  * \param cause Cause of failure
1337  *
1338  * \details
1339  * Request a channel of a given type, with addr as optional information used
1340  * by the low level module
1341  *
1342  * \retval NULL failure
1343  * \retval non-NULL channel on success
1344  */
1345 struct ast_channel *ast_request(const char *type, struct ast_format_cap *request_cap, const struct ast_channel *requestor, const char *addr, int *cause);
1346
1347 /*!
1348  * \brief Request a channel of a given type, with data as optional information used
1349  *        by the low level module and attempt to place a call on it
1350  *
1351  * \param type type of channel to request
1352  * \param cap format capabilities for requested channel
1353  * \param requestor channel asking for data
1354  * \param addr destination of the call
1355  * \param timeout maximum amount of time to wait for an answer
1356  * \param reason why unsuccessful (if unsuccessful)
1357  * \param cid_num Caller-ID Number
1358  * \param cid_name Caller-ID Name (ascii)
1359  *
1360  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1361  * to know if the call was answered or not.
1362  */
1363 struct ast_channel *ast_request_and_dial(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *addr,
1364         int timeout, int *reason, const char *cid_num, const char *cid_name);
1365
1366 /*!
1367  * \brief Request a channel of a given type, with data as optional information used
1368  * by the low level module and attempt to place a call on it
1369  * \param type type of channel to request
1370  * \param cap format capabilities for requested channel
1371  * \param requestor channel requesting data
1372  * \param addr destination of the call
1373  * \param timeout maximum amount of time to wait for an answer
1374  * \param reason why unsuccessful (if unsuccessful)
1375  * \param cid_num Caller-ID Number
1376  * \param cid_name Caller-ID Name (ascii)
1377  * \param oh Outgoing helper
1378  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1379  * to know if the call was answered or not.
1380  */
1381 struct ast_channel *__ast_request_and_dial(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *addr,
1382         int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
1383
1384 /*!
1385  * \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.
1386  * \param caller in channel that requested orig
1387  * \param orig channel being replaced by the call forward channel
1388  * \param timeout maximum amount of time to wait for setup of new forward channel
1389  * \param cap format capabilities for requested channel
1390  * \param oh outgoing helper used with original channel
1391  * \param outstate reason why unsuccessful (if uncuccessful)
1392  * \return Returns the forwarded call's ast_channel on success or NULL on failure
1393  */
1394 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);
1395
1396 /*!
1397  * \brief Register a channel technology (a new channel driver)
1398  * Called by a channel module to register the kind of channels it supports.
1399  * \param tech Structure defining channel technology or "type"
1400  * \return Returns 0 on success, -1 on failure.
1401  */
1402 int ast_channel_register(const struct ast_channel_tech *tech);
1403
1404 /*!
1405  * \brief Unregister a channel technology
1406  * \param tech Structure defining channel technology or "type" that was previously registered
1407  * \return No return value.
1408  */
1409 void ast_channel_unregister(const struct ast_channel_tech *tech);
1410
1411 /*!
1412  * \brief Get a channel technology structure by name
1413  * \param name name of technology to find
1414  * \return a pointer to the structure, or NULL if no matching technology found
1415  */
1416 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
1417
1418 /*!
1419  * \brief Hang up a channel
1420  * \note Absolutely _NO_ channel locks should be held before calling this function.
1421  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
1422  * performs all stream stopping, etc, on the channel that needs to end.
1423  * chan is no longer valid after this call.
1424  * \param chan channel to hang up (NULL tolerant)
1425  * \return Nothing
1426  */
1427 void ast_hangup(struct ast_channel *chan);
1428
1429 /*!
1430  * \brief Softly hangup up a channel
1431  *
1432  * \param chan channel to be soft-hung-up
1433  * \param reason an AST_SOFTHANGUP_* reason code
1434  *
1435  * \details
1436  * Call the protocol layer, but don't destroy the channel structure
1437  * (use this if you are trying to
1438  * safely hangup a channel managed by another thread.
1439  *
1440  * \note The channel passed to this function does not need to be locked.
1441  *
1442  * \return Returns 0 regardless
1443  */
1444 int ast_softhangup(struct ast_channel *chan, int reason);
1445
1446 /*!
1447  * \brief Softly hangup up a channel (no channel lock)
1448  * \param chan channel to be soft-hung-up
1449  * \param reason an AST_SOFTHANGUP_* reason code
1450  */
1451 int ast_softhangup_nolock(struct ast_channel *chan, int reason);
1452
1453 /*!
1454  * \brief Clear a set of softhangup flags from a channel
1455  *
1456  * Never clear a softhangup flag from a channel directly.  Instead,
1457  * use this function.  This ensures that all aspects of the softhangup
1458  * process are aborted.
1459  *
1460  * \param chan the channel to clear the flag on
1461  * \param flag the flag or flags to clear
1462  *
1463  * \return Nothing.
1464  */
1465 void ast_channel_clear_softhangup(struct ast_channel *chan, int flag);
1466
1467 /*!
1468  * \brief Set the source of the hangup in this channel and it's bridge
1469  *
1470  * \param chan channel to set the field on
1471  * \param source a string describing the source of the hangup for this channel
1472  * \param force
1473  *
1474  * \note Absolutely _NO_ channel locks should be held before calling this function.
1475  *
1476  * \since 1.8
1477  *
1478  * Hangupsource is generally the channel name that caused the bridge to be
1479  * hung up, but it can also be other things such as "dialplan/agi"
1480  * This can then be logged in the CDR or CEL
1481  */
1482 void ast_set_hangupsource(struct ast_channel *chan, const char *source, int force);
1483
1484 /*! \brief Check to see if a channel is needing hang up
1485  * \param chan channel on which to check for hang up
1486  * This function determines if the channel is being requested to be hung up.
1487  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
1488  */
1489 int ast_check_hangup(struct ast_channel *chan);
1490
1491 int ast_check_hangup_locked(struct ast_channel *chan);
1492
1493 /*!
1494  * \brief Lock the given channel, then request softhangup on the channel with the given causecode
1495  * \param chan channel on which to hang up
1496  * \param causecode cause code to use (Zero if don't use cause code)
1497  * \return Nothing
1498  */
1499 void ast_channel_softhangup_withcause_locked(struct ast_channel *chan, int causecode);
1500
1501 /*!
1502  * \brief Compare a offset with the settings of when to hang a channel up
1503  * \param chan channel on which to check for hang up
1504  * \param offset offset in seconds from current time
1505  * \return 1, 0, or -1
1506  * \details
1507  * This function compares a offset from current time with the absolute time
1508  * out on a channel (when to hang up). If the absolute time out on a channel
1509  * is earlier than current time plus the offset, it returns 1, if the two
1510  * time values are equal, it return 0, otherwise, it return -1.
1511  * \sa ast_channel_cmpwhentohangup_tv()
1512  * \version 1.6.1 deprecated function (only had seconds precision)
1513  */
1514 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1515
1516 /*!
1517  * \brief Compare a offset with the settings of when to hang a channel up
1518  * \param chan channel on which to check for hangup
1519  * \param offset offset in seconds and microseconds from current time
1520  * \return 1, 0, or -1
1521  * This function compares a offset from current time with the absolute time
1522  * out on a channel (when to hang up). If the absolute time out on a channel
1523  * is earlier than current time plus the offset, it returns 1, if the two
1524  * time values are equal, it return 0, otherwise, it return -1.
1525  * \since 1.6.1
1526  */
1527 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1528
1529 /*!
1530  * \brief Set when to hang a channel up
1531  *
1532  * \param chan channel on which to check for hang up
1533  * \param offset offset in seconds relative to the current time of when to hang up
1534  *
1535  * \details
1536  * This function sets the absolute time out on a channel (when to hang up).
1537  *
1538  * \note This function does not require that the channel is locked before
1539  *       calling it.
1540  *
1541  * \return Nothing
1542  * \sa ast_channel_setwhentohangup_tv()
1543  * \version 1.6.1 deprecated function (only had seconds precision)
1544  */
1545 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1546
1547 /*!
1548  * \brief Set when to hang a channel up
1549  *
1550  * \param chan channel on which to check for hang up
1551  * \param offset offset in seconds and useconds relative to the current time of when to hang up
1552  *
1553  * This function sets the absolute time out on a channel (when to hang up).
1554  *
1555  * \note This function does not require that the channel is locked before
1556  * calling it.
1557  *
1558  * \return Nothing
1559  * \since 1.6.1
1560  */
1561 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1562
1563 /*!
1564  * \brief Answer a channel
1565  *
1566  * \param chan channel to answer
1567  *
1568  * \details
1569  * This function answers a channel and handles all necessary call
1570  * setup functions.
1571  *
1572  * \note The channel passed does not need to be locked, but is locked
1573  * by the function when needed.
1574  *
1575  * \note This function will wait up to 500 milliseconds for media to
1576  * arrive on the channel before returning to the caller, so that the
1577  * caller can properly assume the channel is 'ready' for media flow.
1578  *
1579  * \retval 0 on success
1580  * \retval non-zero on failure
1581  */
1582 int ast_answer(struct ast_channel *chan);
1583
1584 /*!
1585  * \brief Answer a channel, if it's not already answered.
1586  *
1587  * \param chan channel to answer
1588  *
1589  * \details See ast_answer()
1590  *
1591  * \retval 0 on success
1592  * \retval non-zero on failure
1593  */
1594 int ast_auto_answer(struct ast_channel *chan);
1595
1596 /*!
1597  * \brief Answer a channel
1598  *
1599  * \param chan channel to answer
1600  *
1601  * This function answers a channel and handles all necessary call
1602  * setup functions.
1603  *
1604  * \note The channel passed does not need to be locked, but is locked
1605  * by the function when needed.
1606  *
1607  * \note Unlike ast_answer(), this function will not wait for media
1608  * flow to begin. The caller should be careful before sending media
1609  * to the channel before incoming media arrives, as the outgoing
1610  * media may be lost.
1611  *
1612  * \retval 0 on success
1613  * \retval non-zero on failure
1614  */
1615 int ast_raw_answer(struct ast_channel *chan);
1616
1617 /*!
1618  * \brief Answer a channel, with a selectable delay before returning
1619  *
1620  * \param chan channel to answer
1621  * \param delay maximum amount of time to wait for incoming media
1622  *
1623  * This function answers a channel and handles all necessary call
1624  * setup functions.
1625  *
1626  * \note The channel passed does not need to be locked, but is locked
1627  * by the function when needed.
1628  *
1629  * \note This function will wait up to 'delay' milliseconds for media to
1630  * arrive on the channel before returning to the caller, so that the
1631  * caller can properly assume the channel is 'ready' for media flow. If
1632  * 'delay' is less than 500, the function will wait up to 500 milliseconds.
1633  *
1634  * \retval 0 on success
1635  * \retval non-zero on failure
1636  */
1637 int __ast_answer(struct ast_channel *chan, unsigned int delay);
1638
1639 /*!
1640  * \brief Execute a Gosub call on the channel before a call is placed.
1641  * \since 11.0
1642  *
1643  * \details
1644  * This is called between ast_request() and ast_call() to
1645  * execute a predial routine on the newly created channel.
1646  *
1647  * \param chan Channel to execute Gosub.
1648  * \param sub_args Gosub application parameter string.
1649  *
1650  * \note Absolutely _NO_ channel locks should be held before calling this function.
1651  *
1652  * \retval 0 on success.
1653  * \retval -1 on error.
1654  */
1655 int ast_pre_call(struct ast_channel *chan, const char *sub_args);
1656
1657 /*!
1658  * \brief Make a call
1659  * \note Absolutely _NO_ channel locks should be held before calling this function.
1660  * \param chan which channel to make the call on
1661  * \param addr destination of the call
1662  * \param timeout time to wait on for connect (Doesn't seem to be used.)
1663  * \details
1664  * Place a call, take no longer than timeout ms.
1665  * \retval 0 on success
1666  * \retval -1 on failure
1667  */
1668 int ast_call(struct ast_channel *chan, const char *addr, int timeout);
1669
1670 /*!
1671  * \brief Indicates condition of channel
1672  * \note Absolutely _NO_ channel locks should be held before calling this function.
1673  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
1674  * \param chan channel to change the indication
1675  * \param condition which condition to indicate on the channel
1676  * \return Returns 0 on success, -1 on failure
1677  */
1678 int ast_indicate(struct ast_channel *chan, int condition);
1679
1680 /*!
1681  * \brief Indicates condition of channel, with payload
1682  * \note Absolutely _NO_ channel locks should be held before calling this function.
1683  * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
1684  * \param chan channel to change the indication
1685  * \param condition which condition to indicate on the channel
1686  * \param data pointer to payload data
1687  * \param datalen size of payload data
1688  * \return Returns 0 on success, -1 on failure
1689  */
1690 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
1691
1692 /* Misc stuff ------------------------------------------------ */
1693
1694 /*!
1695  * \brief Wait for input on a channel
1696  * \param chan channel to wait on
1697  * \param ms length of time to wait on the channel
1698  * \details
1699  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
1700  * \retval < 0 on failure
1701  * \retval 0 if nothing ever arrived
1702  * \retval the # of ms remaining otherwise
1703  */
1704 int ast_waitfor(struct ast_channel *chan, int ms);
1705
1706 /*!
1707  * \brief Should we keep this frame for later?
1708  *
1709  * There are functions such as ast_safe_sleep which will
1710  * service a channel to ensure that it does not have a
1711  * large backlog of queued frames. When this happens,
1712  * we want to hold on to specific frame types and just drop
1713  * others. This function will tell if the frame we just
1714  * read should be held onto.
1715  *
1716  * \param frame The frame we just read
1717  * \retval 1 frame should be kept
1718  * \retval 0 frame should be dropped
1719  */
1720 int ast_is_deferrable_frame(const struct ast_frame *frame);
1721
1722 /*!
1723  * \brief Wait for a specified amount of time, looking for hangups
1724  * \param chan channel to wait for
1725  * \param ms length of time in milliseconds to sleep. This should never be less than zero.
1726  * \details
1727  * Waits for a specified amount of time, servicing the channel as required.
1728  * \return returns -1 on hangup, otherwise 0.
1729  */
1730 int ast_safe_sleep(struct ast_channel *chan, int ms);
1731
1732 /*!
1733  * \brief Wait for a specified amount of time, looking for hangups and a condition argument
1734  * \param chan channel to wait for
1735  * \param ms length of time in milliseconds to sleep.
1736  * \param cond a function pointer for testing continue condition
1737  * \param data argument to be passed to the condition test function
1738  * \return returns -1 on hangup, otherwise 0.
1739  * \details
1740  * Waits for a specified amount of time, servicing the channel as required. If cond
1741  * returns 0, this function returns.
1742  */
1743 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
1744
1745 /*!
1746  * \brief Waits for activity on a group of channels
1747  * \param chan an array of pointers to channels
1748  * \param n number of channels that are to be waited upon
1749  * \param fds an array of fds to wait upon
1750  * \param nfds the number of fds to wait upon
1751  * \param exception exception flag
1752  * \param outfd fd that had activity on it
1753  * \param ms how long the wait was
1754  * \details
1755  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
1756  * file descriptors.
1757  * \return Returns the channel with activity, or NULL on error or if an FD
1758  * came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
1759  * will be -1
1760  */
1761 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n,
1762         int *fds, int nfds, int *exception, int *outfd, int *ms);
1763
1764 /*!
1765  * \brief Waits for input on a group of channels
1766  * Wait for input on an array of channels for a given # of milliseconds.
1767  * \return Return channel with activity, or NULL if none has activity.
1768  * \param chan an array of pointers to channels
1769  * \param n number of channels that are to be waited upon
1770  * \param ms time "ms" is modified in-place, if applicable
1771  */
1772 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
1773
1774 /*!
1775  * \brief Waits for input on an fd
1776  * \note This version works on fd's only.  Be careful with it.
1777  */
1778 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
1779
1780
1781 /*!
1782  * \brief Reads a frame
1783  * \param chan channel to read a frame from
1784  * \return Returns a frame, or NULL on error.  If it returns NULL, you
1785  * best just stop reading frames and assume the channel has been
1786  * disconnected.
1787  */
1788 struct ast_frame *ast_read(struct ast_channel *chan);
1789
1790 /*!
1791  * \brief Reads a frame, returning AST_FRAME_NULL frame if audio.
1792  * \param chan channel to read a frame from
1793  * \return  Returns a frame, or NULL on error.  If it returns NULL, you
1794  * best just stop reading frames and assume the channel has been
1795  * disconnected.
1796  * \note Audio is replaced with AST_FRAME_NULL to avoid
1797  * transcode when the resulting audio is not necessary.
1798  */
1799 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
1800
1801 /*!
1802  * \brief Write a frame to a channel
1803  * This function writes the given frame to the indicated channel.
1804  * \param chan destination channel of the frame
1805  * \param frame frame that will be written
1806  * \return It returns 0 on success, -1 on failure.
1807  */
1808 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
1809
1810 /*!
1811  * \brief Write video frame to a channel
1812  * This function writes the given frame to the indicated channel.
1813  * \param chan destination channel of the frame
1814  * \param frame frame that will be written
1815  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1816  */
1817 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
1818
1819 /*!
1820  * \brief Write text frame to a channel
1821  * This function writes the given frame to the indicated channel.
1822  * \param chan destination channel of the frame
1823  * \param frame frame that will be written
1824  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1825  */
1826 int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
1827
1828 /*! \brief Send empty audio to prime a channel driver */
1829 int ast_prod(struct ast_channel *chan);
1830
1831 /*!
1832  * \brief Sets read format on channel chan from capabilities
1833  * Set read format for channel to whichever component of "format" is best.
1834  * \param chan channel to change
1835  * \param formats new formats to pick from for reading
1836  * \return Returns 0 on success, -1 on failure
1837  */
1838 int ast_set_read_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
1839
1840 /*!
1841  * \brief Sets read format on channel chan
1842  * \param chan channel to change
1843  * \param format format to set for reading
1844  * \return Returns 0 on success, -1 on failure
1845  */
1846 int ast_set_read_format(struct ast_channel *chan, struct ast_format *format);
1847
1848 /*!
1849  * \brief Sets read format on channel chan by id
1850  * \param chan channel to change
1851  * \param id format id to set for reading, only used for formats without attributes
1852  * \return Returns 0 on success, -1 on failure
1853  */
1854 int ast_set_read_format_by_id(struct ast_channel *chan, enum ast_format_id id);
1855
1856 /*!
1857  * \brief Sets write format on channel chan
1858  * Set write format for channel to whichever component of "format" is best.
1859  * \param chan channel to change
1860  * \param formats new formats to pick from for writing
1861  * \return Returns 0 on success, -1 on failure
1862  */
1863 int ast_set_write_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
1864
1865 /*!
1866  * \brief Sets write format on channel chan
1867  * \param chan channel to change
1868  * \param format format to set for writing
1869  * \return Returns 0 on success, -1 on failure
1870  */
1871 int ast_set_write_format(struct ast_channel *chan, struct ast_format *format);
1872
1873 /*!
1874  * \brief Sets write format on channel chan
1875  * \param chan channel to change
1876  * \param id format id to set for writing, only used for formats without attributes
1877  * \return Returns 0 on success, -1 on failure
1878  */
1879 int ast_set_write_format_by_id(struct ast_channel *chan, enum ast_format_id id);
1880
1881 /*!
1882  * \brief Sends text to a channel
1883  *
1884  * \param chan channel to act upon
1885  * \param text string of text to send on the channel
1886  *
1887  * \details
1888  * Write text to a display on a channel
1889  *
1890  * \note The channel does not need to be locked before calling this function.
1891  *
1892  * \retval 0 on success
1893  * \retval -1 on failure
1894  */
1895 int ast_sendtext(struct ast_channel *chan, const char *text);
1896
1897 /*!
1898  * \brief Receives a text character from a channel
1899  * \param chan channel to act upon
1900  * \param timeout timeout in milliseconds (0 for infinite wait)
1901  * \details
1902  * Read a char of text from a channel
1903  * \return 0 on success, -1 on failure
1904  */
1905 int ast_recvchar(struct ast_channel *chan, int timeout);
1906
1907 /*!
1908  * \brief Send a DTMF digit to a channel.
1909  * \param chan channel to act upon
1910  * \param digit the DTMF digit to send, encoded in ASCII
1911  * \param duration the duration of the digit ending in ms
1912  * \return 0 on success, -1 on failure
1913  */
1914 int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
1915
1916 /*!
1917  * \brief Send a DTMF digit to a channel.
1918  * \param chan channel to act upon
1919  * \param digit the DTMF digit to send, encoded in ASCII
1920  * \return 0 on success, -1 on failure
1921  */
1922 int ast_senddigit_begin(struct ast_channel *chan, char digit);
1923
1924 /*!
1925  * \brief Send a DTMF digit to a channel.
1926  * \param chan channel to act upon
1927  * \param digit the DTMF digit to send, encoded in ASCII
1928  * \param duration the duration of the digit ending in ms
1929  * \return Returns 0 on success, -1 on failure
1930  */
1931 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
1932
1933 /*!
1934  * \brief Receives a text string from a channel
1935  * Read a string of text from a channel
1936  * \param chan channel to act upon
1937  * \param timeout timeout in milliseconds (0 for infinite wait)
1938  * \return the received text, or NULL to signify failure.
1939  */
1940 char *ast_recvtext(struct ast_channel *chan, int timeout);
1941
1942 /*!
1943  * \brief Waits for a digit
1944  * \param c channel to wait for a digit on
1945  * \param ms how many milliseconds to wait (<0 for indefinite).
1946  * \return Returns <0 on error, 0 on no entry, and the digit on success.
1947  */
1948 int ast_waitfordigit(struct ast_channel *c, int ms);
1949
1950 /*!
1951  * \brief Wait for a digit
1952  * Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
1953  * \param c channel to wait for a digit on
1954  * \param ms how many milliseconds to wait (<0 for indefinite).
1955  * \param audiofd audio file descriptor to write to if audio frames are received
1956  * \param ctrlfd control file descriptor to monitor for reading
1957  * \return Returns 1 if ctrlfd becomes available
1958  */
1959 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
1960
1961 /*!
1962  * \brief Reads multiple digits
1963  * \param c channel to read from
1964  * \param s string to read in to.  Must be at least the size of your length
1965  * \param len how many digits to read (maximum)
1966  * \param timeout how long to timeout between digits
1967  * \param rtimeout timeout to wait on the first digit
1968  * \param enders digits to end the string
1969  * \details
1970  * Read in a digit string "s", max length "len", maximum timeout between
1971  * digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
1972  * for the first digit.
1973  * \return Returns 0 on normal return, or 1 on a timeout.  In the case of
1974  * a timeout, any digits that were read before the timeout will still be available in s.
1975  * RETURNS 2 in full version when ctrlfd is available, NOT 1
1976  */
1977 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
1978 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
1979
1980 /*! \brief Report DTMF on channel 0 */
1981 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)
1982 /*! \brief Report DTMF on channel 1 */
1983 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)
1984
1985
1986 /*!
1987  * \brief Make the frame formats of two channels compatible.
1988  *
1989  * \param chan First channel to make compatible.  Should be the calling party.
1990  * \param peer Other channel to make compatible.  Should be the called party.
1991  *
1992  * \note Absolutely _NO_ channel locks should be held before calling this function.
1993  *
1994  * \details
1995  * Set two channels to compatible frame formats in both
1996  * directions.  The path from peer to chan is made compatible
1997  * first to allow for in-band audio in case the other direction
1998  * cannot be made compatible.
1999  *
2000  * \retval 0 on success.
2001  * \retval -1 on error.
2002  */
2003 int ast_channel_make_compatible(struct ast_channel *chan, struct ast_channel *peer);
2004
2005 /*!
2006  * \brief Bridge two channels together (early)
2007  * \param c0 first channel to bridge
2008  * \param c1 second channel to bridge
2009  * \details
2010  * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
2011  * \return Returns 0 on success and -1 if it could not be done
2012  */
2013 int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
2014
2015 /*!
2016  * \brief Weird function made for call transfers
2017  *
2018  * \param original channel to make a copy of
2019  * \param clone copy of the original channel
2020  *
2021  * \details
2022  * This is a very strange and freaky function used primarily for transfer.  Suppose that
2023  * "original" and "clone" are two channels in random situations.  This function takes
2024  * the guts out of "clone" and puts them into the "original" channel, then alerts the
2025  * channel driver of the change, asking it to fixup any private information (like the
2026  * p->owner pointer) that is affected by the change.  The physical layer of the original
2027  * channel is hung up.
2028  *
2029  * \note Neither channel passed here should be locked before
2030  * calling this function.  This function performs deadlock
2031  * avoidance involving these two channels.
2032  */
2033 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
2034
2035 /*!
2036  * \brief Gives the string form of a given cause code.
2037  *
2038  * \param state cause to get the description of
2039  * \return the text form of the binary cause code given
2040  */
2041 const char *ast_cause2str(int state) attribute_pure;
2042
2043 /*!
2044  * \brief Convert the string form of a cause code to a number
2045  *
2046  * \param name string form of the cause
2047  * \return the cause code
2048  */
2049 int ast_str2cause(const char *name) attribute_pure;
2050
2051 /*!
2052  * \brief Gives the string form of a given channel state
2053  *
2054  * \param ast_channel_state state to get the name of
2055  * \return the text form of the binary state given
2056  */
2057 const char *ast_state2str(enum ast_channel_state);
2058
2059 /*!
2060  * \brief Gives the string form of a given transfer capability
2061  *
2062  * \param transfercapability transfer capability to get the name of
2063  * \return the text form of the binary transfer capability
2064  */
2065 char *ast_transfercapability2str(int transfercapability) attribute_const;
2066
2067 /*
2068  * Options: Some low-level drivers may implement "options" allowing fine tuning of the
2069  * low level channel.  See frame.h for options.  Note that many channel drivers may support
2070  * none or a subset of those features, and you should not count on this if you want your
2071  * asterisk application to be portable.  They're mainly useful for tweaking performance
2072  */
2073
2074 /*!
2075  * \brief Sets an option on a channel
2076  *
2077  * \param channel channel to set options on
2078  * \param option option to change
2079  * \param data data specific to option
2080  * \param datalen length of the data
2081  * \param block blocking or not
2082  * \details
2083  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply
2084  * \return 0 on success and -1 on failure
2085  */
2086 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
2087
2088 /*!
2089  * \brief Pick the best codec
2090  *
2091  * \param cap capabilities to pick best codec out of
2092  * \param result stucture to store the best codec in.
2093  * \retval on success, pointer to result structure
2094  * \retval on failure, NULL
2095  */
2096 struct ast_format *ast_best_codec(struct ast_format_cap *cap, struct ast_format *result);
2097
2098
2099 /*!
2100  * \brief Checks the value of an option
2101  *
2102  * Query the value of an option
2103  * Works similarly to setoption except only reads the options.
2104  */
2105 int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
2106
2107 /*!
2108  * \brief Checks for HTML support on a channel
2109  * \return 0 if channel does not support HTML or non-zero if it does
2110  */
2111 int ast_channel_supports_html(struct ast_channel *channel);
2112
2113 /*!
2114  * \brief Sends HTML on given channel
2115  * Send HTML or URL on link.
2116  * \return 0 on success or -1 on failure
2117  */
2118 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
2119
2120 /*!
2121  * \brief Sends a URL on a given link
2122  * Send URL on link.
2123  * \return 0 on success or -1 on failure
2124  */
2125 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
2126
2127 /*!
2128  * \brief Defers DTMF so that you only read things like hangups and audio.
2129  * \return non-zero if channel was already DTMF-deferred or
2130  * 0 if channel is just now being DTMF-deferred
2131  */
2132 int ast_channel_defer_dtmf(struct ast_channel *chan);
2133
2134 /*! Undo defer.  ast_read will return any DTMF characters that were queued */
2135 void ast_channel_undefer_dtmf(struct ast_channel *chan);
2136
2137 /*! Initiate system shutdown -- prevents new channels from being allocated.
2138  * \param hangup  If "hangup" is non-zero, all existing channels will receive soft
2139  *  hangups */
2140 void ast_begin_shutdown(int hangup);
2141
2142 /*! Cancels an existing shutdown and returns to normal operation */
2143 void ast_cancel_shutdown(void);
2144
2145 /*! \return number of channels available for lookup */
2146 int ast_active_channels(void);
2147
2148 /*! \return the number of channels not yet destroyed */
2149 int ast_undestroyed_channels(void);
2150
2151 /*! \return non-zero if Asterisk is being shut down */
2152 int ast_shutting_down(void);
2153
2154 /*! Activate a given generator */
2155 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
2156
2157 /*! Deactivate an active generator */
2158 void ast_deactivate_generator(struct ast_channel *chan);
2159
2160 /*!
2161  * \since 12
2162  * \brief Obtain how long the channel since the channel was created
2163  *
2164  * \param chan The channel object
2165  *
2166  * \retval 0 if the time value cannot be computed (or you called this really fast)
2167  * \retval The number of seconds the channel has been up
2168  */
2169 int ast_channel_get_duration(struct ast_channel *chan);
2170
2171 /*!
2172  * \since 12
2173  * \brief Obtain how long it has been since the channel was answered
2174  *
2175  * \param chan The channel object
2176  *
2177  * \retval 0 if the channel isn't answered (or you called this really fast)
2178  * \retval The number of seconds the channel has been up
2179  */
2180 int ast_channel_get_up_time(struct ast_channel *chan);
2181
2182 /*!
2183  * \brief Set caller ID number, name and ANI and generate AMI event.
2184  *
2185  * \note Use ast_channel_set_caller() and ast_channel_set_caller_event() instead.
2186  * \note The channel does not need to be locked before calling this function.
2187  */
2188 void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
2189
2190 /*!
2191  * \brief Set the caller id information in the Asterisk channel
2192  * \since 1.8
2193  *
2194  * \param chan Asterisk channel to set caller id information
2195  * \param caller Caller id information
2196  * \param update What caller information to update.  NULL if all.
2197  *
2198  * \return Nothing
2199  *
2200  * \note The channel does not need to be locked before calling this function.
2201  */
2202 void ast_channel_set_caller(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2203
2204 /*!
2205  * \brief Set the caller id information in the Asterisk channel and generate an AMI event
2206  * if the caller id name or number changed.
2207  * \since 1.8
2208  *
2209  * \param chan Asterisk channel to set caller id information
2210  * \param caller Caller id information
2211  * \param update What caller information to update.  NULL if all.
2212  *
2213  * \return Nothing
2214  *
2215  * \note The channel does not need to be locked before calling this function.
2216  */
2217 void ast_channel_set_caller_event(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2218
2219 /*! Set the file descriptor on the channel */
2220 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
2221
2222 /*! Add a channel to an optimized waitfor */
2223 void ast_poll_channel_add(struct ast_channel *chan0, struct ast_channel *chan1);
2224
2225 /*! Delete a channel from an optimized waitfor */
2226 void ast_poll_channel_del(struct ast_channel *chan0, struct ast_channel *chan1);
2227
2228 /*! Start a tone going */
2229 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2230 /*! Stop a tone from playing */
2231 void ast_tonepair_stop(struct ast_channel *chan);
2232 /*! Play a tone pair for a given amount of time */
2233 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2234
2235 /*!
2236  * \brief Automatically service a channel for us...
2237  *
2238  * \retval 0 success
2239  * \retval -1 failure, or the channel is already being autoserviced
2240  */
2241 int ast_autoservice_start(struct ast_channel *chan);
2242
2243 /*!
2244  * \brief Stop servicing a channel for us...
2245  *
2246  * \note if chan is locked prior to calling ast_autoservice_stop, it
2247  * is likely that there will be a deadlock between the thread that calls
2248  * ast_autoservice_stop and the autoservice thread. It is important
2249  * that chan is not locked prior to this call
2250  *
2251  * \param chan
2252  * \retval 0 success
2253  * \retval -1 error, or the channel has been hungup
2254  */
2255 int ast_autoservice_stop(struct ast_channel *chan);
2256
2257 /*!
2258  * \brief Put chan into autoservice while hanging up peer.
2259  * \since 11.0
2260  *
2261  * \param chan Chan to put into autoservice.
2262  * \param peer Chan to run hangup handlers and hangup.
2263  *
2264  * \return Nothing
2265  */
2266 void ast_autoservice_chan_hangup_peer(struct ast_channel *chan, struct ast_channel *peer);
2267
2268 /*!
2269  * \brief Ignore certain frame types
2270  * \note Normally, we cache DTMF, IMAGE, HTML, TEXT, and CONTROL frames
2271  * while a channel is in autoservice and queue them up when taken out of
2272  * autoservice.  When this is not desireable, this API may be used to
2273  * cause the channel to ignore those frametypes after the channel is put
2274  * into autoservice, but before autoservice is stopped.
2275  * \retval 0 success
2276  * \retval -1 channel is not in autoservice
2277  */
2278 int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype);
2279
2280 /*!
2281  * \brief Enable or disable timer ticks for a channel
2282  *
2283  * \param c channel
2284  * \param rate number of timer ticks per second
2285  * \param func callback function
2286  * \param data
2287  *
2288  * \details
2289  * If timers are supported, force a scheduled expiration on the
2290  * timer fd, at which point we call the callback function / data
2291  *
2292  * \note Call this function with a rate of 0 to turn off the timer ticks
2293  *
2294  * \version 1.6.1 changed samples parameter to rate, accomodates new timing methods
2295  */
2296 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
2297
2298 /*!
2299  * \brief Transfer a channel (if supported).
2300  * \retval -1 on error
2301  * \retval 0 if not supported
2302  * \retval 1 if supported and requested
2303  * \param chan current channel
2304  * \param dest destination extension for transfer
2305  */
2306 int ast_transfer(struct ast_channel *chan, char *dest);
2307
2308 /*!
2309  * \brief Start masquerading a channel
2310  * \note absolutely _NO_ channel locks should be held before calling this function.
2311  * \details
2312  * XXX This is a seriously whacked out operation.  We're essentially putting the guts of
2313  *     the clone channel into the original channel.  Start by killing off the original
2314  *     channel's backend.   I'm not sure we're going to keep this function, because
2315  *     while the features are nice, the cost is very high in terms of pure nastiness. XXX
2316  * \param chan Channel to masquerade
2317  */
2318 void ast_do_masquerade(struct ast_channel *chan);
2319
2320 /*!
2321  * \brief Inherits channel variable from parent to child channel
2322  * \param parent Parent channel
2323  * \param child Child channel
2324  *
2325  * \details
2326  * Scans all channel variables in the parent channel, looking for those
2327  * that should be copied into the child channel.
2328  * Variables whose names begin with a single '_' are copied into the
2329  * child channel with the prefix removed.
2330  * Variables whose names begin with '__' are copied into the child
2331  * channel with their names unchanged.
2332  */
2333 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
2334
2335 /*!
2336  * \brief adds a list of channel variables to a channel
2337  * \param chan the channel
2338  * \param vars a linked list of variables
2339  *
2340  * \details
2341  * Variable names can be for a regular channel variable or a dialplan function
2342  * that has the ability to be written to.
2343  */
2344 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
2345
2346 /*!
2347  * \brief An opaque 'object' structure use by silence generators on channels.
2348  */
2349 struct ast_silence_generator;
2350
2351 /*!
2352  * \brief Starts a silence generator on the given channel.
2353  * \param chan The channel to generate silence on
2354  * \return An ast_silence_generator pointer, or NULL if an error occurs
2355  *
2356  * \details
2357  * This function will cause SLINEAR silence to be generated on the supplied
2358  * channel until it is disabled; if the channel cannot be put into SLINEAR
2359  * mode then the function will fail.
2360  *
2361  * \note
2362  * The pointer returned by this function must be preserved and passed to
2363  * ast_channel_stop_silence_generator when you wish to stop the silence
2364  * generation.
2365  */
2366 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
2367
2368 /*!
2369  * \brief Stops a previously-started silence generator on the given channel.
2370  * \param chan The channel to operate on
2371  * \param state The ast_silence_generator pointer return by a previous call to
2372  * ast_channel_start_silence_generator.
2373  * \return nothing
2374  *
2375  * \details
2376  * This function will stop the operating silence generator and return the channel
2377  * to its previous write format.
2378  */
2379 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
2380
2381 /*!
2382  * \brief Check if the channel can run in internal timing mode.
2383  * \param chan The channel to check
2384  * \return boolean
2385  *
2386  * \details
2387  * This function will return 1 if internal timing is enabled and the timing
2388  * device is available.
2389  */
2390 int ast_internal_timing_enabled(struct ast_channel *chan);
2391
2392 /* Misc. functions below */
2393
2394 /*!
2395  * \brief if fd is a valid descriptor, set *pfd with the descriptor
2396  * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
2397  * return value to the index into the array)
2398  */
2399 static inline int ast_add_fd(struct pollfd *pfd, int fd)
2400 {
2401         pfd->fd = fd;
2402         pfd->events = POLLIN | POLLPRI;
2403         return fd >= 0;
2404 }
2405
2406 /*! \brief Helper function for migrating select to poll */
2407 static inline int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
2408 {
2409         int x;
2410         int dummy = 0;
2411
2412         if (fd < 0)
2413                 return 0;
2414         if (!start)
2415                 start = &dummy;
2416         for (x = *start; x < maximum; x++)
2417                 if (pfds[x].fd == fd) {
2418                         if (x == *start)
2419                                 (*start)++;
2420                         return pfds[x].revents;
2421                 }
2422         return 0;
2423 }
2424
2425 /*! \brief Retrieves the current T38 state of a channel */
2426 static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
2427 {
2428         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
2429         int datalen = sizeof(state);
2430
2431         ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
2432
2433         return state;
2434 }
2435
2436 #define CHECK_BLOCKING(c) do {   \
2437         if (ast_test_flag(ast_channel_flags(c), AST_FLAG_BLOCKING)) {\
2438                 ast_debug(1, "Thread %p is blocking '%s', already blocked by thread %p in procedure %s\n", \
2439                         (void *) pthread_self(), ast_channel_name(c), (void *) ast_channel_blocker(c), ast_channel_blockproc(c)); \
2440         } else { \
2441                 ast_channel_blocker_set((c), pthread_self()); \
2442                 ast_channel_blockproc_set((c), __PRETTY_FUNCTION__); \
2443                 ast_set_flag(ast_channel_flags(c), AST_FLAG_BLOCKING); \
2444         } } while (0)
2445
2446 ast_group_t ast_get_group(const char *s);
2447
2448 /*! \brief Print call and pickup groups into buffer */
2449 char *ast_print_group(char *buf, int buflen, ast_group_t group);
2450
2451 /*! \brief Opaque struct holding a namedgroups set, i.e. a set of group names */
2452 struct ast_namedgroups;
2453
2454 /*! \brief Create an ast_namedgroups set with group names from comma separated string */
2455 struct ast_namedgroups *ast_get_namedgroups(const char *s);
2456 struct ast_namedgroups *ast_unref_namedgroups(struct ast_namedgroups *groups);
2457 struct ast_namedgroups *ast_ref_namedgroups(struct ast_namedgroups *groups);
2458 /*! \brief Return TRUE if group a and b contain at least one common groupname */
2459 int ast_namedgroups_intersect(struct ast_namedgroups *a, struct ast_namedgroups *b);
2460
2461 /*! \brief Print named call groups and named pickup groups */
2462 char *ast_print_namedgroups(struct ast_str **buf, struct ast_namedgroups *groups);
2463
2464 /*!
2465  * \brief Convert enum channelreloadreason to text string for manager event
2466  * \param reason The reason for reload (manager, cli, start etc)
2467  */
2468 const char *channelreloadreason2txt(enum channelreloadreason reason);
2469
2470 /*! \brief return an ast_variable list of channeltypes */
2471 struct ast_variable *ast_channeltype_list(void);
2472
2473 /*!
2474  * \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
2475  * \param reason  The integer argument, usually taken from AST_CONTROL_ macros
2476  * \return char pointer explaining the code
2477  */
2478 const char *ast_channel_reason2str(int reason);
2479
2480 /*! \brief channel group info */
2481 struct ast_group_info {
2482         struct ast_channel *chan;
2483         char *category;
2484         char *group;
2485         AST_LIST_ENTRY(ast_group_info) group_list;
2486 };
2487
2488 #define ast_channel_lock(chan) ao2_lock(chan)
2489 #define ast_channel_unlock(chan) ao2_unlock(chan)
2490 #define ast_channel_trylock(chan) ao2_trylock(chan)
2491
2492 /*!
2493  * \brief Lock two channels.
2494  */
2495 #define ast_channel_lock_both(chan1, chan2) do { \
2496                 ast_channel_lock(chan1); \
2497                 while (ast_channel_trylock(chan2)) { \
2498                         ast_channel_unlock(chan1); \
2499                         sched_yield(); \
2500                         ast_channel_lock(chan1); \
2501                 } \
2502         } while (0)
2503
2504 /*!
2505  * \brief Increase channel reference count
2506  *
2507  * \param c the channel
2508  *
2509  * \retval c always
2510  *
2511  * \since 1.8
2512  */
2513 #define ast_channel_ref(c) ({ ao2_ref(c, +1); (c); })
2514
2515 /*!
2516  * \brief Decrease channel reference count
2517  *
2518  * \param c the channel
2519  *
2520  * \retval NULL always
2521  *
2522  * \since 1.8
2523  */
2524 #define ast_channel_unref(c) ({ ao2_ref(c, -1); (struct ast_channel *) (NULL); })
2525
2526 /*!
2527  * \brief Cleanup a channel reference
2528  *
2529  * \param c the channel (NULL tolerant)
2530  *
2531  * \retval NULL always
2532  *
2533  * \since 12.0.0
2534  */
2535 #define ast_channel_cleanup(c) ({ ao2_cleanup(c); (struct ast_channel *) (NULL); })
2536
2537 /*! Channel Iterating @{ */
2538
2539 /*!
2540  * \brief A channel iterator
2541  *
2542  * This is an opaque type.
2543  */
2544 struct ast_channel_iterator;
2545
2546 /*!
2547  * \brief Destroy a channel iterator
2548  *
2549  * \param i the itereator to destroy
2550  *
2551  * \details
2552  * This function is used to destroy a channel iterator that was retrieved by
2553  * using one of the channel_iterator_xxx_new() functions.
2554  *
2555  * \return NULL, for convenience to clear out the pointer to the iterator that
2556  * was just destroyed.
2557  *
2558  * \since 1.8
2559  */
2560 struct ast_channel_iterator *ast_channel_iterator_destroy(struct ast_channel_iterator *i);
2561
2562 /*!
2563  * \brief Create a new channel iterator based on extension
2564  *
2565  * \param exten The extension that channels must be in
2566  * \param context The context that channels must be in
2567  *
2568  * \details
2569  * After creating an iterator using this function, the ast_channel_iterator_next()
2570  * function can be used to iterate through all channels that are currently
2571  * in the specified context and extension.
2572  *
2573  * \note You must call ast_channel_iterator_destroy() when done.
2574  *
2575  * \retval NULL on failure
2576  * \retval a new channel iterator based on the specified parameters
2577  *
2578  * \since 1.8
2579  */
2580 struct ast_channel_iterator *ast_channel_iterator_by_exten_new(const char *exten, const char *context);
2581
2582 /*!
2583  * \brief Create a new channel iterator based on name
2584  *
2585  * \param name channel name or channel uniqueid to match
2586  * \param name_len number of characters in the channel name to match on.  This
2587  *      would be used to match based on name prefix.  If matching on the full
2588  *      channel name is desired, then this parameter should be 0.
2589  *
2590  * \details
2591  * After creating an iterator using this function, the ast_channel_iterator_next()
2592  * function can be used to iterate through all channels that exist that have
2593  * the specified name or name prefix.
2594  *
2595  * \note You must call ast_channel_iterator_destroy() when done.
2596  *
2597  * \retval NULL on failure
2598  * \retval a new channel iterator based on the specified parameters
2599  *
2600  * \since 1.8
2601  */
2602 struct ast_channel_iterator *ast_channel_iterator_by_name_new(const char *name, size_t name_len);
2603
2604 /*!
2605  * \brief Create a new channel iterator
2606  *
2607  * \details
2608  * After creating an iterator using this function, the ast_channel_iterator_next()
2609  * function can be used to iterate through all channels that exist.
2610  *
2611  * \note You must call ast_channel_iterator_destroy() when done.
2612  *
2613  * \retval NULL on failure
2614  * \retval a new channel iterator
2615  *
2616  * \since 1.8
2617  */
2618 struct ast_channel_iterator *ast_channel_iterator_all_new(void);
2619
2620 /*!
2621  * \brief Get the next channel for a channel iterator
2622  *
2623  * \param i the channel iterator that was created using one of the
2624  *  channel_iterator_xxx_new() functions.
2625  *
2626  * \details
2627  * This function should be used to iterate through all channels that match a
2628  * specified set of parameters that were provided when the iterator was created.
2629  *
2630  * \retval the next channel that matches the parameters used when the iterator
2631  *         was created.
2632  * \retval NULL, if no more channels match the iterator parameters.
2633  *
2634  * \since 1.8
2635  */
2636 struct ast_channel *ast_channel_iterator_next(struct ast_channel_iterator *i);
2637
2638 /*! @} End channel iterator definitions. */
2639
2640 /*!
2641  * \brief Call a function with every active channel
2642  *
2643  * \details
2644  * This function executes a callback one time for each active channel on the
2645  * system.  The channel is provided as an argument to the function.
2646  *
2647  * \note Absolutely _NO_ channel locks should be held before calling this function.
2648  * \since 1.8
2649  */
2650 struct ast_channel *ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg,
2651                 void *data, int ao2_flags);
2652
2653 /*! @{ Channel search functions */
2654
2655 /*!
2656  * \brief Find a channel by name
2657  *
2658  * \param name the name or uniqueid of the channel to search for
2659  *
2660  * \details
2661  * Find a channel that has the same name as the provided argument.
2662  *
2663  * \retval a channel with the name specified by the argument
2664  * \retval NULL if no channel was found
2665  *
2666  * \since 1.8
2667  */
2668 struct ast_channel *ast_channel_get_by_name(const char *name);
2669
2670 /*!
2671  * \brief Find a channel by a name prefix
2672  *
2673  * \param name The channel name or uniqueid prefix to search for
2674  * \param name_len Only search for up to this many characters from the name
2675  *
2676  * \details
2677  * Find a channel that has the same name prefix as specified by the arguments.
2678  *
2679  * \retval a channel with the name prefix specified by the arguments
2680  * \retval NULL if no channel was found
2681  *
2682  * \since 1.8
2683  */
2684 struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len);
2685
2686 /*!
2687  * \brief Find a channel by extension and context
2688  *
2689  * \param exten the extension to search for
2690  * \param context the context to search for
2691  *
2692  * \details
2693  * Return a channel that is currently at the specified extension and context.
2694  *
2695  * \retval a channel that is at the specified extension and context
2696  * \retval NULL if no channel was found
2697  *
2698  * \since 1.8
2699  */
2700 struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context);
2701
2702 /*! @} End channel search functions. */
2703
2704 /*!
2705  * \brief Initialize the given name structure.
2706  * \since 1.8
2707  *
2708  * \param init Name structure to initialize.
2709  *
2710  * \return Nothing
2711  */
2712 void ast_party_name_init(struct ast_party_name *init);
2713
2714 /*!
2715  * \brief Copy the source party name information to the destination party name.
2716  * \since 1.8
2717  *
2718  * \param dest Destination party name
2719  * \param src Source party name
2720  *
2721  * \return Nothing
2722  */
2723 void ast_party_name_copy(struct ast_party_name *dest, const struct ast_party_name *src);
2724
2725 /*!
2726  * \brief Initialize the given party name structure using the given guide
2727  * for a set update operation.
2728  * \since 1.8
2729  *
2730  * \details
2731  * The initialization is needed to allow a set operation to know if a
2732  * value needs to be updated.  Simple integers need the guide's original
2733  * value in case the set operation is not trying to set a new value.
2734  * String values are simply set to NULL pointers if they are not going
2735  * to be updated.
2736  *
2737  * \param init Party name structure to initialize.
2738  * \param guide Source party name to use as a guide in initializing.
2739  *
2740  * \return Nothing
2741  */
2742 void ast_party_name_set_init(struct ast_party_name *init, const struct ast_party_name *guide);
2743
2744 /*!
2745  * \brief Set the source party name information into the destination party name.
2746  * \since 1.8
2747  *
2748  * \param dest The name one wishes to update
2749  * \param src The new name values to update the dest
2750  *
2751  * \return Nothing
2752  */
2753 void ast_party_name_set(struct ast_party_name *dest, const struct ast_party_name *src);
2754
2755 /*!
2756  * \brief Destroy the party name contents
2757  * \since 1.8
2758  *
2759  * \param doomed The party name to destroy.
2760  *
2761  * \return Nothing
2762  */
2763 void ast_party_name_free(struct ast_party_name *doomed);
2764
2765 /*!
2766  * \brief Initialize the given number structure.
2767  * \since 1.8
2768  *
2769  * \param init Number structure to initialize.
2770  *
2771  * \return Nothing
2772  */
2773 void ast_party_number_init(struct ast_party_number *init);
2774
2775 /*!
2776  * \brief Copy the source party number information to the destination party number.
2777  * \since 1.8
2778  *
2779  * \param dest Destination party number
2780  * \param src Source party number
2781  *
2782  * \return Nothing
2783  */
2784 void ast_party_number_copy(struct ast_party_number *dest, const struct ast_party_number *src);
2785
2786 /*!
2787  * \brief Initialize the given party number structure using the given guide
2788  * for a set update operation.
2789  * \since 1.8
2790  *
2791  * \details
2792  * The initialization is needed to allow a set operation to know if a
2793  * value needs to be updated.  Simple integers need the guide's original
2794  * value in case the set operation is not trying to set a new value.
2795  * String values are simply set to NULL pointers if they are not going
2796  * to be updated.
2797  *
2798  * \param init Party number structure to initialize.
2799  * \param guide Source party number to use as a guide in initializing.
2800  *
2801  * \return Nothing
2802  */
2803 void ast_party_number_set_init(struct ast_party_number *init, const struct ast_party_number *guide);
2804
2805 /*!
2806  * \brief Set the source party number information into the destination party number.
2807  * \since 1.8
2808  *
2809  * \param dest The number one wishes to update
2810  * \param src The new number values to update the dest
2811  *
2812  * \return Nothing
2813  */
2814 void ast_party_number_set(struct ast_party_number *dest, const struct ast_party_number *src);
2815
2816 /*!
2817  * \brief Destroy the party number contents
2818  * \since 1.8
2819  *
2820  * \param doomed The party number to destroy.
2821  *
2822  * \return Nothing
2823  */
2824 void ast_party_number_free(struct ast_party_number *doomed);
2825
2826 /*!
2827  * \since 1.8
2828  * \brief Initialize the given subaddress structure.
2829  *
2830  * \param init Subaddress structure to initialize.
2831  *
2832  * \return Nothing
2833  */
2834 void ast_party_subaddress_init(struct ast_party_subaddress *init);
2835
2836 /*!
2837  * \since 1.8
2838  * \brief Copy the source party subaddress information to the destination party subaddress.
2839  *
2840  * \param dest Destination party subaddress
2841  * \param src Source party subaddress
2842  *
2843  * \return Nothing
2844  */
2845 void ast_party_subaddress_copy(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
2846
2847 /*!
2848  * \since 1.8
2849  * \brief Initialize the given party subaddress structure using the given guide
2850  * for a set update operation.
2851  *
2852  * \details
2853  * The initialization is needed to allow a set operation to know if a
2854  * value needs to be updated.  Simple integers need the guide's original
2855  * value in case the set operation is not trying to set a new value.
2856  * String values are simply set to NULL pointers if they are not going
2857  * to be updated.
2858  *
2859  * \param init Party subaddress structure to initialize.
2860  * \param guide Source party subaddress to use as a guide in initializing.
2861  *
2862  * \return Nothing
2863  */
2864 void ast_party_subaddress_set_init(struct ast_party_subaddress *init, const struct ast_party_subaddress *guide);
2865
2866 /*!
2867  * \since 1.8
2868  * \brief Set the source party subaddress information into the destination party subaddress.
2869  *
2870  * \param dest The subaddress one wishes to update
2871  * \param src The new subaddress values to update the dest
2872  *
2873  * \return Nothing
2874  */
2875 void ast_party_subaddress_set(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
2876
2877 /*!
2878  * \since 1.8
2879  * \brief Destroy the party subaddress contents
2880  *
2881  * \param doomed The party subaddress to destroy.
2882  *
2883  * \return Nothing
2884  */
2885 void ast_party_subaddress_free(struct ast_party_subaddress *doomed);
2886
2887 /*!
2888  * \brief Set the update marker to update all information of a corresponding party id.
2889  * \since 11.0
2890  *
2891  * \param update_id The update marker for a corresponding party id.
2892  *
2893  * \return Nothing
2894  */
2895 void ast_set_party_id_all(struct ast_set_party_id *update_id);
2896
2897 /*!
2898  * \brief Initialize the given party id structure.
2899  * \since 1.8
2900  *
2901  * \param init Party id structure to initialize.
2902  *
2903  * \return Nothing
2904  */
2905 void ast_party_id_init(struct ast_party_id *init);
2906
2907 /*!
2908  * \brief Copy the source party id information to the destination party id.
2909  * \since 1.8
2910  *
2911  * \param dest Destination party id
2912  * \param src Source party id
2913  *
2914  * \return Nothing
2915  */
2916 void ast_party_id_copy(struct ast_party_id *dest, const struct ast_party_id *src);
2917
2918 /*!
2919  * \brief Initialize the given party id structure using the given guide
2920  * for a set update operation.
2921  * \since 1.8
2922  *
2923  * \details
2924  * The initialization is needed to allow a set operation to know if a
2925  * value needs to be updated.  Simple integers need the guide's original
2926  * value in case the set operation is not trying to set a new value.
2927  * String values are simply set to NULL pointers if they are not going
2928  * to be updated.
2929  *
2930  * \param init Party id structure to initialize.
2931  * \param guide Source party id to use as a guide in initializing.
2932  *
2933  * \return Nothing
2934  */
2935 void ast_party_id_set_init(struct ast_party_id *init, const struct ast_party_id *guide);
2936
2937 /*!
2938  * \brief Set the source party id information into the destination party id.
2939  * \since 1.8
2940  *
2941  * \param dest The id one wishes to update
2942  * \param src The new id values to update the dest
2943  * \param update What id information to update.  NULL if all.
2944  *
2945  * \return Nothing
2946  */
2947 void ast_party_id_set(struct ast_party_id *dest, const struct ast_party_id *src, const struct ast_set_party_id *update);
2948
2949 /*!
2950  * \brief Destroy the party id contents
2951  * \since 1.8
2952  *
2953  * \param doomed The party id to destroy.
2954  *
2955  * \return Nothing
2956  */
2957 void ast_party_id_free(struct ast_party_id *doomed);
2958
2959 /*!
2960  * \brief Determine the overall presentation value for the given party.
2961  * \since 1.8
2962  *
2963  * \param id Party to determine the overall presentation value.
2964  *
2965  * \return Overall presentation value for the given party.
2966  */
2967 int ast_party_id_presentation(const struct ast_party_id *id);
2968
2969 /*!
2970  * \brief Invalidate all components of the given party id.
2971  * \since 11.0
2972  *
2973  * \param id The party id to invalidate.
2974  *
2975  * \return Nothing
2976  */
2977 void ast_party_id_invalidate(struct ast_party_id *id);
2978
2979 /*!
2980  * \brief Destroy and initialize the given party id structure.
2981  * \since 11.0
2982  *
2983  * \param id The party id to reset.
2984  *
2985  * \return Nothing
2986  */
2987 void ast_party_id_reset(struct ast_party_id *id);
2988
2989 /*!
2990  * \brief Merge a given party id into another given party id.
2991  * \since 11.0
2992  *
2993  * \details
2994  * This function will generate an effective party id.
2995  *
2996  * Each party id component of the party id 'base' is overwritten
2997  * by components of the party id 'overlay' if the overlay
2998  * component is marked as valid.  However the component 'tag' of
2999  * the base party id remains untouched.
3000  *
3001  * \param base The party id which is merged.
3002  * \param overlay The party id which is used to merge into.
3003  *
3004  * \return The merged party id as a struct, not as a pointer.
3005  * \note The merged party id returned is a shallow copy and must not be freed.
3006  */
3007 struct ast_party_id ast_party_id_merge(struct ast_party_id *base, struct ast_party_id *overlay);
3008
3009 /*!
3010  * \brief Copy a merge of a given party id into another given party id to a given destination party id.
3011  * \since 11.0
3012  *
3013  * \details
3014  * Each party id component of the party id 'base' is overwritten by components
3015  * of the party id 'overlay' if the 'overlay' component is marked as valid.
3016  * However the component 'tag' of the 'base' party id remains untouched.
3017  * The result is copied into the given party id 'dest'.
3018  *
3019  * \note The resulting merged party id is a real copy and has to be freed.
3020  *
3021  * \param dest The resulting merged party id.
3022  * \param base The party id which is merged.
3023  * \param overlay The party id which is used to merge into.
3024  *
3025  * \return Nothing
3026  */
3027 void ast_party_id_merge_copy(struct ast_party_id *dest, struct ast_party_id *base, struct ast_party_id *overlay);
3028
3029 /*!
3030  * \brief Initialize the given dialed structure.
3031  * \since 1.8
3032  *
3033  * \param init Dialed structure to initialize.
3034  *
3035  * \return Nothing
3036  */
3037 void ast_party_dialed_init(struct ast_party_dialed *init);
3038
3039 /*!
3040  * \brief Copy the source dialed party information to the destination dialed party.
3041  * \since 1.8
3042  *
3043  * \param dest Destination dialed party
3044  * \param src Source dialed party
3045  *
3046  * \return Nothing
3047  */
3048 void ast_party_dialed_copy(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
3049
3050 /*!
3051  * \brief Initialize the given dialed structure using the given
3052  * guide for a set update operation.
3053  * \since 1.8
3054  *
3055  * \details
3056  * The initialization is needed to allow a set operation to know if a
3057  * value needs to be updated.  Simple integers need the guide's original
3058  * value in case the set operation is not trying to set a new value.
3059  * String values are simply set to NULL pointers if they are not going
3060  * to be updated.
3061  *
3062  * \param init Caller structure to initialize.
3063  * \param guide Source dialed to use as a guide in initializing.
3064  *
3065  * \return Nothing
3066  */
3067 void ast_party_dialed_set_init(struct ast_party_dialed *init, const struct ast_party_dialed *guide);
3068
3069 /*!
3070  * \brief Set the dialed information based on another dialed source
3071  * \since 1.8
3072  *
3073  * This is similar to ast_party_dialed_copy, except that NULL values for
3074  * strings in the src parameter indicate not to update the corresponding dest values.
3075  *
3076  * \param dest The dialed one wishes to update
3077  * \param src The new dialed values to update the dest
3078  *
3079  * \return Nada
3080  */
3081 void ast_party_dialed_set(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
3082
3083 /*!
3084  * \brief Destroy the dialed party contents
3085  * \since 1.8
3086  *
3087  * \param doomed The dialed party to destroy.
3088  *
3089  * \return Nothing
3090  */
3091 void ast_party_dialed_free(struct ast_party_dialed *doomed);
3092
3093 /*!
3094  * \since 1.8
3095  * \brief Initialize the given caller structure.
3096  *
3097  * \param init Caller structure to initialize.
3098  *
3099  * \return Nothing
3100  */
3101 void ast_party_caller_init(struct ast_party_caller *init);
3102
3103 /*!
3104  * \since 1.8
3105  * \brief Copy the source caller information to the destination caller.
3106  *
3107  * \param dest Destination caller
3108  * \param src Source caller
3109  *
3110  * \return Nothing
3111  */
3112 void ast_party_caller_copy(struct ast_party_caller *dest, const struct ast_party_caller *src);
3113
3114 /*!
3115  * \brief Initialize the given caller structure using the given
3116  * guide for a set update operation.
3117  * \since 1.8
3118  *
3119  * \details
3120  * The initialization is needed to allow a set operation to know if a
3121  * value needs to be updated.  Simple integers need the guide's original
3122  * value in case the set operation is not trying to set a new value.
3123  * String values are simply set to NULL pointers if they are not going
3124  * to be updated.
3125  *
3126  * \param init Caller structure to initialize.
3127  * \param guide Source caller to use as a guide in initializing.
3128  *
3129  * \return Nothing
3130  */
3131 void ast_party_caller_set_init(struct ast_party_caller *init, const struct ast_party_caller *guide);
3132
3133 /*!
3134  * \brief Set the caller information based on another caller source
3135  * \since 1.8
3136  *
3137  * This is similar to ast_party_caller_copy, except that NULL values for
3138  * strings in the src parameter indicate not to update the corresponding dest values.
3139  *
3140  * \param dest The caller one wishes to update
3141  * \param src The new caller values to update the dest
3142  * \param update What caller information to update.  NULL if all.
3143  *
3144  * \return Nada
3145  */
3146 void ast_party_caller_set(struct ast_party_caller *dest, const struct ast_party_caller *src, const struct ast_set_party_caller *update);
3147
3148 /*!
3149  * \brief Destroy the caller party contents
3150  * \since 1.8
3151  *
3152  * \param doomed The caller party to destroy.
3153  *
3154  * \return Nothing
3155  */
3156 void ast_party_caller_free(struct ast_party_caller *doomed);
3157
3158 /*!
3159  * \since 1.8
3160  * \brief Initialize the given connected line structure.
3161  *
3162  * \param init Connected line structure to initialize.
3163  *
3164  * \return Nothing
3165  */
3166 void ast_party_connected_line_init(struct ast_party_connected_line *init);
3167
3168 /*!
3169  * \since 1.8
3170  * \brief Copy the source connected line information to the destination connected line.
3171  *
3172  * \param dest Destination connected line
3173  * \param src Source connected line
3174  *
3175  * \return Nothing
3176  */
3177 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
3178
3179 /*!
3180  * \since 1.8
3181  * \brief Initialize the given connected line structure using the given
3182  * guide for a set update operation.
3183  *
3184  * \details
3185  * The initialization is needed to allow a set operation to know if a
3186  * value needs to be updated.  Simple integers need the guide's original
3187  * value in case the set operation is not trying to set a new value.
3188  * String values are simply set to NULL pointers if they are not going
3189  * to be updated.
3190  *
3191  * \param init Connected line structure to initialize.
3192  * \param guide Source connected line to use as a guide in initializing.
3193  *
3194  * \return Nothing
3195  */
3196 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
3197
3198 /*!
3199  * \since 1.8
3200  * \brief Set the connected line information based on another connected line source
3201  *
3202  * This is similar to ast_party_connected_line_copy, except that NULL values for
3203  * strings in the src parameter indicate not to update the corresponding dest values.
3204  *
3205  * \param dest The connected line one wishes to update
3206  * \param src The new connected line values to update the dest
3207  * \param update What connected line information to update.  NULL if all.
3208  *
3209  * \return Nothing
3210  */
3211 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);
3212
3213 /*!
3214  * \since 1.8
3215  * \brief Collect the caller party information into a connected line structure.
3216  *
3217  * \param connected Collected caller information for the connected line
3218  * \param caller Caller information.
3219  *
3220  * \return Nothing
3221  *
3222  * \warning This is a shallow copy.
3223  * \warning DO NOT call ast_party_connected_line_free() on the filled in
3224  * connected line structure!
3225  */
3226 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_party_caller *caller);
3227
3228 /*!
3229  * \since 1.8
3230  * \brief Destroy the connected line information contents
3231  *
3232  * \param doomed The connected line information to destroy.
3233  *
3234  * \return Nothing
3235  */
3236 void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
3237
3238 /*!
3239  * \brief Initialize the given redirecting reason structure
3240  *
3241  * \param init Redirecting reason structure to initialize
3242  *
3243  * \return Nothing
3244  */
3245 void ast_party_redirecting_reason_init(struct ast_party_redirecting_reason *init);
3246
3247 /*!
3248  * \brief Copy the source redirecting reason information to the destination redirecting reason.
3249  *
3250  * \param dest Destination redirecting reason
3251  * \param src Source redirecting reason
3252  *
3253  * \return Nothing
3254  */
3255 void ast_party_redirecting_reason_copy(struct ast_party_redirecting_reason *dest,
3256                 const struct ast_party_redirecting_reason *src);
3257
3258 /*!
3259  * \brief Initialize the given redirecting reason structure using the given guide
3260  * for a set update operation.
3261  *
3262  * \details
3263  * The initialization is needed to allow a set operation to know if a
3264  * value needs to be updated.  Simple integers need the guide's original
3265  * value in case the set operation is not trying to set a new value.
3266  * String values are simply set to NULL pointers if they are not going
3267  * to be updated.
3268  *
3269  * \param init Redirecting reason structure to initialize.
3270  * \param guide Source redirecting reason to use as a guide in initializing.
3271  *
3272  * \return Nothing
3273  */
3274 void ast_party_redirecting_reason_set_init(struct ast_party_redirecting_reason *init,
3275                 const struct ast_party_redirecting_reason *guide);
3276
3277 /*!
3278  * \brief Set the redirecting reason information based on another redirecting reason source
3279  *
3280  * This is similar to ast_party_redirecting_reason_copy, except that NULL values for
3281  * strings in the src parameter indicate not to update the corresponding dest values.
3282  *
3283  * \param dest The redirecting reason one wishes to update
3284  * \param src The new redirecting reason values to update the dest
3285  *
3286  * \return Nothing
3287  */
3288 void ast_party_redirecting_reason_set(struct ast_party_redirecting_reason *dest,
3289                 const struct ast_party_redirecting_reason *src);
3290
3291 /*!
3292  * \brief Destroy the redirecting reason contents
3293  *
3294  * \param doomed The redirecting reason to destroy.
3295  *
3296  * \return Nothing
3297  */
3298 void ast_party_redirecting_reason_free(struct ast_party_redirecting_reason *doomed);
3299
3300 /*!
3301  * \brief Initialize the given redirecting structure.
3302  * \since 1.8
3303  *
3304  * \param init Redirecting structure to initialize.
3305  *
3306  * \return Nothing
3307  */
3308 void ast_party_redirecting_init(struct ast_party_redirecting *init);
3309
3310 /*!
3311  * \since 1.8
3312  * \brief Copy the source redirecting information to the destination redirecting.
3313  *
3314  * \param dest Destination redirecting
3315  * \param src Source redirecting
3316  *
3317  * \return Nothing
3318  */
3319 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
3320
3321 /*!
3322  * \since 1.8
3323  * \brief Initialize the given redirecting id structure using the given guide
3324  * for a set update operation.
3325  *
3326  * \details
3327  * The initialization is needed to allow a set operation to know if a
3328  * value needs to be updated.  Simple integers need the guide's original
3329  * value in case the set operation is not trying to set a new value.
3330  * String values are simply set to NULL pointers if they are not going
3331  * to be updated.
3332  *
3333  * \param init Redirecting id structure to initialize.
3334  * \param guide Source redirecting id to use as a guide in initializing.
3335  *
3336  * \return Nothing
3337  */
3338 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
3339
3340 /*!
3341  * \brief Set the redirecting information based on another redirecting source
3342  * \since 1.8
3343  *
3344  * This is similar to ast_party_redirecting_copy, except that NULL values for
3345  * strings in the src parameter indicate not to update the corresponding dest values.
3346  *
3347  * \param dest The redirecting one wishes to update
3348  * \param src The new redirecting values to update the dest
3349  * \param update What redirecting information to update.  NULL if all.
3350  *
3351  * \return Nothing
3352  */
3353 void ast_party_redirecting_set(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src, const struct ast_set_party_redirecting *update);
3354
3355 /*!
3356  * \since 1.8
3357  * \brief Destroy the redirecting information contents
3358  *
3359  * \param doomed The redirecting information to destroy.
3360  *
3361  * \return Nothing
3362  */
3363 void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
3364
3365 /*!
3366  * \since 1.8
3367  * \brief Copy the caller information to the connected line information.
3368  *
3369  * \param dest Destination connected line information
3370  * \param src Source caller information
3371  *
3372  * \return Nothing
3373  *
3374  * \note Assumes locks are already acquired
3375  */
3376 void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_party_caller *src);
3377
3378 /*!
3379  * \since 1.8
3380  * \brief Copy the connected line information to the caller information.
3381  *
3382  * \param dest Destination caller information
3383  * \param src Source connected line information
3384  *
3385  * \return Nothing
3386  *
3387  * \note Assumes locks are already acquired
3388  */
3389 void ast_connected_line_copy_to_caller(struct ast_party_caller *dest, const struct ast_party_connected_line *src);
3390
3391 /*!
3392  * \since 1.8
3393  * \brief Set the connected line information in the Asterisk channel
3394  *
3395  * \param chan Asterisk channel to set connected line information
3396  * \param connected Connected line information
3397  * \param update What connected line information to update.  NULL if all.
3398  *
3399  * \return Nothing
3400  *
3401  * \note The channel does not need to be locked before calling this function.
3402  */
3403 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);
3404
3405 /*!
3406  * \since 1.8
3407  * \brief Build the connected line information data frame.
3408  *
3409  * \param data Buffer to fill with the frame data
3410  * \param datalen Size of the buffer to fill
3411  * \param connected Connected line information
3412  * \param update What connected line information to build.  NULL if all.
3413  *
3414  * \retval -1 if error
3415  * \retval Amount of data buffer used
3416  */
3417 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);
3418
3419 /*!
3420  * \since 1.8
3421  * \brief Parse connected line indication frame data
3422  *
3423  * \param data Buffer with the frame data to parse
3424  * \param datalen Size of the buffer
3425  * \param connected Extracted connected line information
3426  *
3427  * \retval 0 on success.
3428  * \retval -1 on error.
3429  *
3430  * \note The filled in connected line structure needs to be initialized by
3431  * ast_party_connected_line_set_init() before calling.  If defaults are not
3432  * required use ast_party_connected_line_init().
3433  * \note The filled in connected line structure needs to be destroyed by
3434  * ast_party_connected_line_free() when it is no longer needed.
3435  */
3436 int ast_connected_line_parse_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
3437
3438 /*!
3439  * \since 1.8
3440  * \brief Indicate that the connected line information has changed
3441  *
3442  * \param chan Asterisk channel to indicate connected line information
3443  * \param connected Connected line information
3444  * \param update What connected line information to update.  NULL if all.
3445  *
3446  * \return Nothing
3447  */
3448 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);
3449
3450 /*!
3451  * \since 1.8
3452  * \brief Queue a connected line update frame on a channel
3453  *
3454  * \param chan Asterisk channel to indicate connected line information
3455  * \param connected Connected line information
3456  * \param update What connected line information to update.  NULL if all.
3457  *
3458  * \return Nothing
3459  */
3460 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);
3461
3462 /*!
3463  * \since 1.8
3464  * \brief Set the redirecting id information in the Asterisk channel
3465  *
3466  * \param chan Asterisk channel to set redirecting id information
3467  * \param redirecting Redirecting id information
3468  * \param update What redirecting information to update.  NULL if all.
3469  *
3470  * \return Nothing
3471  *
3472  * \note The channel does not need to be locked before calling this function.
3473  */
3474 void ast_channel_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3475
3476 /