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