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