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