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