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