3641a1be2fd1fcdb769b49c59aabb9d4b14fbc04
[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  * \since 1.8
454  * \brief Redirecting Line information.
455  * RDNIS (Redirecting Directory Number Information Service)
456  * Where a call diversion or transfer was invoked.
457  * \note All string fields here are malloc'ed, so they need to be
458  * freed when the structure is deleted.
459  * \note NULL and "" must be considered equivalent.
460  */
461 struct ast_party_redirecting {
462         /*! \brief Who originally redirected the call (Sent to the party the call is redirected toward) */
463         struct ast_party_id orig;
464
465         /*! \brief Who is redirecting the call (Sent to the party the call is redirected toward) */
466         struct ast_party_id from;
467
468         /*! \brief Call is redirecting to a new party (Sent to the caller) */
469         struct ast_party_id to;
470
471         /*! \brief Who originally redirected the call (Sent to the party the call is redirected toward) - private representation */
472         struct ast_party_id priv_orig;
473
474         /*! \brief Who is redirecting the call (Sent to the party the call is redirected toward) - private representation */
475         struct ast_party_id priv_from;
476
477         /*! \brief Call is redirecting to a new party (Sent to the caller)  - private representation */
478         struct ast_party_id priv_to;
479
480         /*! \brief Number of times the call was redirected */
481         int count;
482
483         /*! \brief enum AST_REDIRECTING_REASON value for redirection */
484         int reason;
485
486         /*! \brief enum AST_REDIRECTING_REASON value for redirection by original party */
487         int orig_reason;
488 };
489
490 /*!
491  * \since 1.8
492  * \brief Indicate what information in ast_party_redirecting should be set.
493  */
494 struct ast_set_party_redirecting {
495         /*! What redirecting-orig id information to set. */
496         struct ast_set_party_id orig;
497         /*! What redirecting-from id information to set. */
498         struct ast_set_party_id from;
499         /*! What redirecting-to id information to set. */
500         struct ast_set_party_id to;
501         /*! What private redirecting-orig id information to set. */
502         struct ast_set_party_id priv_orig;
503         /*! What private redirecting-from id information to set. */
504         struct ast_set_party_id priv_from;
505         /*! What private redirecting-to id information to set. */
506         struct ast_set_party_id priv_to;
507 };
508
509 /*!
510  * \brief Typedef for a custom read function
511  * \note data should be treated as const char *.
512  */
513 typedef int (*ast_acf_read_fn_t)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
514
515 /*!
516  * \brief Typedef for a custom read2 function
517  * \note data should be treated as const char *.
518  */
519 typedef int (*ast_acf_read2_fn_t)(struct ast_channel *chan, const char *cmd, char *data, struct ast_str **str, ssize_t len);
520
521 /*!
522  * \brief Typedef for a custom write function
523  * \note data should be treated as const char *.
524  */
525 typedef int (*ast_acf_write_fn_t)(struct ast_channel *chan, const char *function, char *data, const char *value);
526
527 /*! \brief Structure to handle passing func_channel_write info to channels via setoption */
528 typedef struct {
529         /*! \brief ast_chan_write_info_t version. Must be incremented if structure is changed */
530         #define AST_CHAN_WRITE_INFO_T_VERSION 1
531         uint32_t version;
532         ast_acf_write_fn_t write_fn;
533         struct ast_channel *chan;
534         const char *function;
535         char *data;
536         const char *value;
537 } ast_chan_write_info_t;
538
539 /*!
540  * \brief
541  * Structure to describe a channel "technology", ie a channel driver
542  * See for examples:
543  * \arg chan_iax2.c - The Inter-Asterisk exchange protocol
544  * \arg chan_sip.c - The SIP channel driver
545  * \arg chan_dahdi.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS)
546  *
547  * \details
548  * If you develop your own channel driver, this is where you
549  * tell the PBX at registration of your driver what properties
550  * this driver supports and where different callbacks are
551  * implemented.
552  */
553 struct ast_channel_tech {
554         const char * const type;
555         const char * const description;
556
557         struct ast_format_cap *capabilities;  /*!< format capabilities this channel can handle */
558
559         int properties;         /*!< Technology Properties */
560
561         /*!
562          * \brief Requester - to set up call data structures (pvt's)
563          *
564          * \param type type of channel to request
565          * \param cap Format capabilities for requested channel
566          * \param requestor channel asking for data
567          * \param addr destination of the call
568          * \param cause Cause of failure
569          *
570          * \details
571          * Request a channel of a given type, with addr as optional information used
572          * by the low level module
573          *
574          * \retval NULL failure
575          * \retval non-NULL channel on success
576          */
577         struct ast_channel *(* const requester)(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *addr, int *cause);
578
579         int (* const devicestate)(const char *device_number);   /*!< Devicestate call back */
580
581         /*!
582          * \brief Start sending a literal DTMF digit
583          *
584          * \note The channel is not locked when this function gets called.
585          */
586         int (* const send_digit_begin)(struct ast_channel *chan, char digit);
587
588         /*!
589          * \brief Stop sending a literal DTMF digit
590          *
591          * \note The channel is not locked when this function gets called.
592          */
593         int (* const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration);
594
595         /*!
596          * \brief Make a call
597          * \note The channel is locked when called.
598          * \param chan which channel to make the call on
599          * \param addr destination of the call
600          * \param timeout time to wait on for connect (Doesn't seem to be used.)
601          * \retval 0 on success
602          * \retval -1 on failure
603          */
604         int (* const call)(struct ast_channel *chan, const char *addr, int timeout);
605
606         /*! \brief Hangup (and possibly destroy) the channel */
607         int (* const hangup)(struct ast_channel *chan);
608
609         /*! \brief Answer the channel */
610         int (* const answer)(struct ast_channel *chan);
611
612         /*! \brief Read a frame, in standard format (see frame.h) */
613         struct ast_frame * (* const read)(struct ast_channel *chan);
614
615         /*! \brief Write a frame, in standard format (see frame.h) */
616         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
617
618         /*! \brief Display or transmit text */
619         int (* const send_text)(struct ast_channel *chan, const char *text);
620
621         /*! \brief Display or send an image */
622         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
623
624         /*! \brief Send HTML data */
625         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
626
627         /*! \brief Handle an exception, reading a frame */
628         struct ast_frame * (* const exception)(struct ast_channel *chan);
629
630         /*! \brief Bridge two channels of the same type together */
631         enum ast_bridge_result (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
632                                                 struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
633
634         /*! \brief Bridge two channels of the same type together (early) */
635         enum ast_bridge_result (* const early_bridge)(struct ast_channel *c0, struct ast_channel *c1);
636
637         /*! \brief Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
638         int (* const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen);
639
640         /*! \brief Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
641         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
642
643         /*! \brief Set a given option. Called with chan locked */
644         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
645
646         /*! \brief Query a given option. Called with chan locked */
647         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
648
649         /*! \brief Blind transfer other side (see app_transfer.c and ast_transfer() */
650         int (* const transfer)(struct ast_channel *chan, const char *newdest);
651
652         /*! \brief Write a frame, in standard format */
653         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
654
655         /*! \brief Write a text frame, in standard format */
656         int (* const write_text)(struct ast_channel *chan, struct ast_frame *frame);
657
658         /*! \brief Find bridged channel */
659         struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
660
661         /*!
662          * \brief Provide additional read items for CHANNEL() dialplan function
663          * \note data should be treated as a const char *.
664          */
665         int (* func_channel_read)(struct ast_channel *chan, const char *function, char *data, char *buf, size_t len);
666
667         /*!
668          * \brief Provide additional write items for CHANNEL() dialplan function
669          * \note data should be treated as a const char *.
670          */
671         int (* func_channel_write)(struct ast_channel *chan, const char *function, char *data, const char *value);
672
673         /*! \brief Retrieve base channel (agent and local) */
674         struct ast_channel* (* get_base_channel)(struct ast_channel *chan);
675
676         /*! \brief Set base channel (agent and local) */
677         int (* set_base_channel)(struct ast_channel *chan, struct ast_channel *base);
678
679         /*! \brief Get the unique identifier for the PVT, i.e. SIP call-ID for SIP */
680         const char * (* get_pvt_uniqueid)(struct ast_channel *chan);
681
682         /*! \brief Call a function with cc parameters as a function parameter
683          *
684          * \details
685          * This is a highly specialized callback that is not likely to be needed in many
686          * channel drivers. When dealing with a busy channel, for instance, most channel
687          * drivers will successfully return a channel to the requester. Once called, the channel
688          * can then queue a busy frame when it receives an appropriate message from the far end.
689          * In such a case, the channel driver has the opportunity to also queue a CC frame.
690          * The parameters for the CC channel can be retrieved from the channel structure.
691          *
692          * For other channel drivers, notably those that deal with "dumb" phones, the channel
693          * driver will not return a channel when one is requested. In such a scenario, there is never
694          * an opportunity for the channel driver to queue a CC frame since the channel is never
695          * called. Furthermore, it is not possible to retrieve the CC configuration parameters
696          * for the desired channel because no channel is ever allocated or returned to the
697          * requester. In such a case, call completion may still be a viable option. What we do is
698          * pass the same string that the requester used originally to request the channel to the
699          * channel driver. The channel driver can then find any potential channels/devices that
700          * match the input and return call the designated callback with the device's call completion
701          * parameters as a parameter.
702          */
703         int (* cc_callback)(struct ast_channel *inbound, const char *dest, ast_cc_callback_fn callback);
704
705         /*!
706          * \brief Execute a Gosub call on the channel in a technology specific way before a call is placed.
707          * \since 11.0
708          *
709          * \param chan Channel to execute Gosub in a tech specific way.
710          * \param sub_args Gosub application parameter string.
711          *
712          * \note The chan is locked before calling.
713          *
714          * \retval 0 on success.
715          * \retval -1 on error.
716          */
717         int (*pre_call)(struct ast_channel *chan, const char *sub_args);
718 };
719
720 /*! Kill the channel channel driver technology descriptor. */
721 extern const struct ast_channel_tech ast_kill_tech;
722
723 struct ast_epoll_data;
724
725 /*!
726  * The high bit of the frame count is used as a debug marker, so
727  * increments of the counters must be done with care.
728  * Please use c->fin = FRAMECOUNT_INC(c->fin) and the same for c->fout.
729  */
730 #define DEBUGCHAN_FLAG  0x80000000
731
732 /* XXX not ideal to evaluate x twice... */
733 #define FRAMECOUNT_INC(x)       ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
734
735 /*!
736  * The current value of the debug flags is stored in the two
737  * variables global_fin and global_fout (declared in main/channel.c)
738  */
739 extern unsigned long global_fin, global_fout;
740
741 enum ast_channel_adsicpe {
742         AST_ADSI_UNKNOWN,
743         AST_ADSI_AVAILABLE,
744         AST_ADSI_UNAVAILABLE,
745         AST_ADSI_OFFHOOKONLY,
746 };
747
748 /*!
749  * \brief Possible T38 states on channels
750  */
751 enum ast_t38_state {
752         T38_STATE_UNAVAILABLE,  /*!< T38 is unavailable on this channel or disabled by configuration */
753         T38_STATE_UNKNOWN,      /*!< The channel supports T38 but the current status is unknown */
754         T38_STATE_NEGOTIATING,  /*!< T38 is being negotiated */
755         T38_STATE_REJECTED,     /*!< Remote side has rejected our offer */
756         T38_STATE_NEGOTIATED,   /*!< T38 established */
757 };
758
759 /*! Hangup handler instance node. */
760 struct ast_hangup_handler {
761         /*! Next hangup handler node. */
762         AST_LIST_ENTRY(ast_hangup_handler) node;
763         /*! Hangup handler arg string passed to the Gosub application */
764         char args[0];
765 };
766
767 AST_LIST_HEAD_NOLOCK(ast_hangup_handler_list, ast_hangup_handler);
768 AST_LIST_HEAD_NOLOCK(ast_datastore_list, ast_datastore);
769 AST_LIST_HEAD_NOLOCK(ast_autochan_list, ast_autochan);
770 AST_LIST_HEAD_NOLOCK(ast_readq_list, ast_frame);
771
772 typedef int(*ast_timing_func_t)(const void *data);
773 /*!
774  * \page AstChannel ast_channel locking and reference tracking
775  *
776  * \par Creating Channels
777  * A channel is allocated using the ast_channel_alloc() function.  When created, it is
778  * automatically inserted into the main channels hash table that keeps track of all
779  * active channels in the system.  The hash key is based on the channel name.  Because
780  * of this, if you want to change the name, you _must_ use ast_change_name(), not change
781  * the name field directly.  When ast_channel_alloc() returns a channel pointer, you now
782  * hold a reference to that channel.  In most cases this reference is given to ast_pbx_run().
783  *
784  * \par Channel Locking
785  * There is a lock associated with every ast_channel.  It is allocated internally via astobj2.
786  * To lock or unlock a channel, you must use the ast_channel_lock() wrappers.
787  *
788  * Previously, before ast_channel was converted to astobj2, the channel lock was used in some
789  * additional ways that are no longer necessary.  Before, the only way to ensure that a channel
790  * did not disappear out from under you if you were working with a channel outside of the channel
791  * thread that owns it, was to hold the channel lock.  Now, that is no longer necessary.
792  * You simply must hold a reference to the channel to ensure it does not go away.
793  *
794  * The channel must be locked if you need to ensure that data that you reading from the channel
795  * does not change while you access it.  Further, you must hold the channel lock if you are
796  * making a non-atomic change to channel data.
797  *
798  * \par Channel References
799  * There are multiple ways to get a reference to a channel.  The first is that you hold a reference
800  * to a channel after creating it.  The other ways involve using the channel search or the channel
801  * traversal APIs.  These functions are the ast_channel_get_*() functions or ast_channel_iterator_*()
802  * functions.  Once a reference is retrieved by one of these methods, you know that the channel will
803  * not go away.  So, the channel should only get locked as needed for data access or modification.
804  * But, make sure that the reference gets released when you are done with it!
805  *
806  * There are different things you can do when you are done with a reference to a channel.  The first
807  * is to simply release the reference using ast_channel_unref().  The other option is to call
808  * ast_channel_release().  This function is generally used where ast_channel_free() was used in
809  * the past.  The release function releases a reference as well as ensures that the channel is no
810  * longer in the global channels container.  That way, the channel will get destroyed as soon as any
811  * other pending references get released.
812  *
813  * \par Exceptions to the rules
814  * Even though ast_channel is reference counted, there are some places where pointers to an ast_channel
815  * get stored, but the reference count does not reflect it.  The reason is mostly historical.
816  * The only places where this happens should be places where because of how the code works, we
817  * _know_ that the pointer to the channel will get removed before the channel goes away.  The main
818  * example of this is in channel drivers.  Channel drivers generally store a pointer to their owner
819  * ast_channel in their technology specific pvt struct.  In this case, the channel drivers _know_
820  * that this pointer to the channel will be removed in time, because the channel's hangup callback
821  * gets called before the channel goes away.
822  */
823
824 struct ast_channel;
825
826 /*! \brief ast_channel_tech Properties */
827 enum {
828         /*!
829      * \brief Channels have this property if they can accept input with jitter;
830          * i.e. most VoIP channels
831          */
832         AST_CHAN_TP_WANTSJITTER = (1 << 0),
833         /*!
834      * \brief Channels have this property if they can create jitter;
835          * i.e. most VoIP channels
836          */
837         AST_CHAN_TP_CREATESJITTER = (1 << 1),
838 };
839
840 /*! \brief ast_channel flags */
841 enum {
842         /*! Queue incoming DTMF, to be released when this flag is turned off */
843         AST_FLAG_DEFER_DTMF =    (1 << 1),
844         /*! write should be interrupt generator */
845         AST_FLAG_WRITE_INT =     (1 << 2),
846         /*! a thread is blocking on this channel */
847         AST_FLAG_BLOCKING =      (1 << 3),
848         /*! This is a zombie channel */
849         AST_FLAG_ZOMBIE =        (1 << 4),
850         /*! There is an exception pending */
851         AST_FLAG_EXCEPTION =     (1 << 5),
852         /*! Listening to moh XXX anthm promises me this will disappear XXX */
853         AST_FLAG_MOH =           (1 << 6),
854         /*! This channel is spying on another channel */
855         AST_FLAG_SPYING =        (1 << 7),
856         /*! This channel is in a native bridge */
857         AST_FLAG_NBRIDGE =       (1 << 8),
858         /*! the channel is in an auto-incrementing dialplan processor,
859          *  so when ->priority is set, it will get incremented before
860          *  finding the next priority to run */
861         AST_FLAG_IN_AUTOLOOP =   (1 << 9),
862         /*! This is an outgoing call */
863         AST_FLAG_OUTGOING =      (1 << 10),
864         /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
865         AST_FLAG_IN_DTMF =       (1 << 12),
866         /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is
867          *  currently being emulated */
868         AST_FLAG_EMULATE_DTMF =  (1 << 13),
869         /*! This is set to tell the channel not to generate DTMF begin frames, and
870          *  to instead only generate END frames. */
871         AST_FLAG_END_DTMF_ONLY = (1 << 14),
872         /* OBSOLETED in favor of AST_CAUSE_ANSWERED_ELSEWHERE
873         Flag to show channels that this call is hangup due to the fact that the call
874             was indeed answered, but in another channel */
875         /* AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15), */
876         /*! This flag indicates that on a masquerade, an active stream should not
877          *  be carried over */
878         AST_FLAG_MASQ_NOSTREAM = (1 << 16),
879         /*! This flag indicates that the hangup exten was run when the bridge terminated,
880          *  a message aimed at preventing a subsequent hangup exten being run at the pbx_run
881          *  level */
882         AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
883         /*! This flag indicates that the hangup exten should NOT be run when the
884          *  bridge terminates, this will allow the hangup in the pbx loop to be run instead.
885          *  */
886         AST_FLAG_BRIDGE_HANGUP_DONT = (1 << 18),
887         /*! Disable certain workarounds.  This reintroduces certain bugs, but allows
888          *  some non-traditional dialplans (like AGI) to continue to function.
889          */
890         AST_FLAG_DISABLE_WORKAROUNDS = (1 << 20),
891 };
892
893 /*! \brief ast_bridge_config flags */
894 enum {
895         AST_FEATURE_PLAY_WARNING = (1 << 0),
896         AST_FEATURE_REDIRECT =     (1 << 1),
897         AST_FEATURE_DISCONNECT =   (1 << 2),
898         AST_FEATURE_ATXFER =       (1 << 3),
899         AST_FEATURE_AUTOMON =      (1 << 4),
900         AST_FEATURE_PARKCALL =     (1 << 5),
901         AST_FEATURE_AUTOMIXMON =   (1 << 6),
902         AST_FEATURE_NO_H_EXTEN =   (1 << 7),
903         AST_FEATURE_WARNING_ACTIVE = (1 << 8),
904 };
905
906 /*! \brief bridge configuration */
907 struct ast_bridge_config {
908         struct ast_flags features_caller;
909         struct ast_flags features_callee;
910         struct timeval start_time;
911         struct timeval nexteventts;
912         struct timeval feature_start_time;
913         long feature_timer;
914         long timelimit;
915         long play_warning;
916         long warning_freq;
917         const char *warning_sound;
918         const char *end_sound;
919         const char *start_sound;
920         unsigned int flags;
921         void (* end_bridge_callback)(void *);   /*!< A callback that is called after a bridge attempt */
922         void *end_bridge_callback_data;         /*!< Data passed to the callback */
923         /*! If the end_bridge_callback_data refers to a channel which no longer is going to
924          * exist when the end_bridge_callback is called, then it needs to be fixed up properly
925          */
926         void (*end_bridge_callback_data_fixup)(struct ast_bridge_config *bconfig, struct ast_channel *originator, struct ast_channel *terminator);
927 };
928
929 struct chanmon;
930
931 struct outgoing_helper {
932         const char *context;
933         const char *exten;
934         int priority;
935         int connect_on_early_media;     /* If set, treat session progress as answer */
936         const char *cid_num;
937         const char *cid_name;
938         const char *account;
939         struct ast_variable *vars;
940         struct ast_channel *parent_channel;
941 };
942
943 enum {
944         /*!
945          * Soft hangup requested by device or other internal reason.
946          * Actual hangup needed.
947          */
948         AST_SOFTHANGUP_DEV =       (1 << 0),
949         /*!
950          * Used to break the normal frame flow so an async goto can be
951          * done instead of actually hanging up.
952          */
953         AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
954         /*!
955          * Soft hangup requested by system shutdown.  Actual hangup
956          * needed.
957          */
958         AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
959         /*!
960          * Used to break the normal frame flow after a timeout so an
961          * implicit async goto can be done to the 'T' exten if it exists
962          * instead of actually hanging up.  If the exten does not exist
963          * then actually hangup.
964          */
965         AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
966         /*!
967          * Soft hangup requested by application/channel-driver being
968          * unloaded.  Actual hangup needed.
969          */
970         AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
971         /*!
972          * Soft hangup requested by non-associated party.  Actual hangup
973          * needed.
974          */
975         AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
976         /*!
977          * Used to break a bridge so the channel can be spied upon
978          * instead of actually hanging up.
979          */
980         AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
981
982
983         /*!
984          * \brief All softhangup flags.
985          *
986          * This can be used as an argument to ast_channel_clear_softhangup()
987          * to clear all softhangup flags from a channel.
988          */
989         AST_SOFTHANGUP_ALL =       (0xFFFFFFFF)
990 };
991
992
993 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
994 enum channelreloadreason {
995         CHANNEL_MODULE_LOAD,
996         CHANNEL_MODULE_RELOAD,
997         CHANNEL_CLI_RELOAD,
998         CHANNEL_MANAGER_RELOAD,
999         CHANNEL_ACL_RELOAD,
1000 };
1001
1002
1003 /*! \brief Structure to handle ao2-container for named groups */
1004 struct namedgroup_entry {
1005         /*! string representation of group */
1006         char *name;
1007
1008         /*! pre-built hash of groupname string */
1009         unsigned int hash;
1010 };
1011
1012
1013 /*!
1014  * \note None of the datastore API calls lock the ast_channel they are using.
1015  *       So, the channel should be locked before calling the functions that
1016  *       take a channel argument.
1017  */
1018
1019 /*!
1020  * \brief Create a channel data store object
1021  * \deprecated You should use the ast_datastore_alloc() generic function instead.
1022  * \version 1.6.1 deprecated
1023  */
1024 struct ast_datastore * attribute_malloc ast_channel_datastore_alloc(const struct ast_datastore_info *info, const char *uid)
1025         __attribute__((deprecated));
1026
1027 /*!
1028  * \brief Free a channel data store object
1029  * \deprecated You should use the ast_datastore_free() generic function instead.
1030  * \version 1.6.1 deprecated
1031  */
1032 int ast_channel_datastore_free(struct ast_datastore *datastore)
1033         __attribute__((deprecated));
1034
1035 /*! \brief Inherit datastores from a parent to a child. */
1036 int ast_channel_datastore_inherit(struct ast_channel *from, struct ast_channel *to);
1037
1038 /*!
1039  * \brief Add a datastore to a channel
1040  *
1041  * \note The channel should be locked before calling this function.
1042  *
1043  * \retval 0 success
1044  * \retval non-zero failure
1045  */
1046 int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore);
1047
1048 /*!
1049  * \brief Remove a datastore from a channel
1050  *
1051  * \note The channel should be locked before calling this function.
1052  *
1053  * \retval 0 success
1054  * \retval non-zero failure
1055  */
1056 int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore);
1057
1058 /*!
1059  * \brief Find a datastore on a channel
1060  *
1061  * \note The channel should be locked before calling this function.
1062  *
1063  * \note The datastore returned from this function must not be used if the
1064  *       reference to the channel is released.
1065  *
1066  * \retval pointer to the datastore if found
1067  * \retval NULL if not found
1068  */
1069 struct ast_datastore *ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid);
1070
1071 /*!
1072  * \brief Create a channel structure
1073  * \since 1.8
1074  *
1075  * \retval NULL failure
1076  * \retval non-NULL successfully allocated channel
1077  *
1078  * \note Absolutely _NO_ channel locks should be held before calling this function.
1079  * \note By default, new channels are set to the "s" extension
1080  *       and "default" context.
1081  */
1082 struct ast_channel * attribute_malloc __attribute__((format(printf, 13, 14)))
1083         __ast_channel_alloc(int needqueue, int state, const char *cid_num,
1084                             const char *cid_name, const char *acctcode,
1085                             const char *exten, const char *context,
1086                             const char *linkedid, const int amaflag,
1087                             const char *file, int line, const char *function,
1088                             const char *name_fmt, ...);
1089
1090 /*!
1091  * \brief Create a channel structure
1092  *
1093  * \retval NULL failure
1094  * \retval non-NULL successfully allocated channel
1095  *
1096  * \note Absolutely _NO_ channel locks should be held before calling this function.
1097  * \note By default, new channels are set to the "s" extension
1098  *       and "default" context.
1099  */
1100 #define ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, ...) \
1101         __ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, \
1102                             __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)
1103
1104 #if defined(REF_DEBUG) || defined(__AST_DEBUG_MALLOC)
1105 /*!
1106  * \brief Create a fake channel structure
1107  *
1108  * \retval NULL failure
1109  * \retval non-NULL successfully allocated channel
1110  *
1111  * \note This function should ONLY be used to create a fake channel
1112  *       that can then be populated with data for use in variable
1113  *       substitution when a real channel does not exist.
1114  *
1115  * \note The created dummy channel should be destroyed by
1116  * ast_channel_unref().  Using ast_channel_release() needlessly
1117  * grabs the channel container lock and can cause a deadlock as
1118  * a result.  Also grabbing the channel container lock reduces
1119  * system performance.
1120  */
1121 #define ast_dummy_channel_alloc()       __ast_dummy_channel_alloc(__FILE__, __LINE__, __PRETTY_FUNCTION__)
1122 struct ast_channel *__ast_dummy_channel_alloc(const char *file, int line, const char *function);
1123 #else
1124 /*!
1125  * \brief Create a fake channel structure
1126  *
1127  * \retval NULL failure
1128  * \retval non-NULL successfully allocated channel
1129  *
1130  * \note This function should ONLY be used to create a fake channel
1131  *       that can then be populated with data for use in variable
1132  *       substitution when a real channel does not exist.
1133  *
1134  * \note The created dummy channel should be destroyed by
1135  * ast_channel_unref().  Using ast_channel_release() needlessly
1136  * grabs the channel container lock and can cause a deadlock as
1137  * a result.  Also grabbing the channel container lock reduces
1138  * system performance.
1139  */
1140 struct ast_channel *ast_dummy_channel_alloc(void);
1141 #endif
1142
1143 /*!
1144  * \brief Queue one or more frames to a channel's frame queue
1145  *
1146  * \param chan the channel to queue the frame(s) on
1147  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1148  *        by this function.  It is the responsibility of the caller to handle
1149  *        freeing the memory associated with the frame(s) being passed if
1150  *        necessary.
1151  *
1152  * \retval 0 success
1153  * \retval non-zero failure
1154  */
1155 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
1156
1157 /*!
1158  * \brief Queue one or more frames to the head of a channel's frame queue
1159  *
1160  * \param chan the channel to queue the frame(s) on
1161  * \param f the frame(s) to queue.  Note that the frame(s) will be duplicated
1162  *        by this function.  It is the responsibility of the caller to handle
1163  *        freeing the memory associated with the frame(s) being passed if
1164  *        necessary.
1165  *
1166  * \retval 0 success
1167  * \retval non-zero failure
1168  */
1169 int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *f);
1170
1171 /*!
1172  * \brief Queue a hangup frame
1173  *
1174  * \note The channel does not need to be locked before calling this function.
1175  */
1176 int ast_queue_hangup(struct ast_channel *chan);
1177
1178 /*!
1179  * \brief Queue a hangup frame with hangupcause set
1180  *
1181  * \note The channel does not need to be locked before calling this function.
1182  * \param[in] chan channel to queue frame onto
1183  * \param[in] cause the hangup cause
1184  * \return 0 on success, -1 on error
1185  * \since 1.6.1
1186  */
1187 int ast_queue_hangup_with_cause(struct ast_channel *chan, int cause);
1188
1189 /*!
1190  * \brief Queue a control frame with payload
1191  *
1192  * \param chan channel to queue frame onto
1193  * \param control type of control frame
1194  *
1195  * \note The channel does not need to be locked before calling this function.
1196  *
1197  * \retval zero on success
1198  * \retval non-zero on failure
1199  */
1200 int ast_queue_control(struct ast_channel *chan, enum ast_control_frame_type control);
1201
1202 /*!
1203  * \brief Queue a control frame with payload
1204  *
1205  * \param chan channel to queue frame onto
1206  * \param control type of control frame
1207  * \param data pointer to payload data to be included in frame
1208  * \param datalen number of bytes of payload data
1209  *
1210  * \retval 0 success
1211  * \retval non-zero failure
1212  *
1213  * \details
1214  * The supplied payload data is copied into the frame, so the caller's copy
1215  * is not modified nor freed, and the resulting frame will retain a copy of
1216  * the data even if the caller frees their local copy.
1217  *
1218  * \note This method should be treated as a 'network transport'; in other
1219  * words, your frames may be transferred across an IAX2 channel to another
1220  * system, which may be a different endianness than yours. Because of this,
1221  * you should ensure that either your frames will never be expected to work
1222  * across systems, or that you always put your payload data into 'network byte
1223  * order' before calling this function.
1224  *
1225  * \note The channel does not need to be locked before calling this function.
1226  */
1227 int ast_queue_control_data(struct ast_channel *chan, enum ast_control_frame_type control,
1228                            const void *data, size_t datalen);
1229
1230 /*!
1231  * \brief Change channel name
1232  *
1233  * \pre Absolutely all channels _MUST_ be unlocked before calling this function.
1234  *
1235  * \param chan the channel to change the name of
1236  * \param newname the name to change to
1237  *
1238  * \return nothing
1239  *
1240  * \note this function must _NEVER_ be used when any channels are locked
1241  * regardless if it is the channel who's name is being changed or not because
1242  * it invalidates our channel container locking order... lock container first,
1243  * then the individual channels, never the other way around.
1244  */
1245 void ast_change_name(struct ast_channel *chan, const char *newname);
1246
1247 /*!
1248  * \brief Unlink and release reference to a channel
1249  *
1250  * This function will unlink the channel from the global channels container
1251  * if it is still there and also release the current reference to the channel.
1252  *
1253  * \return NULL, convenient for clearing invalid pointers
1254  * \note Absolutely _NO_ channel locks should be held before calling this function.
1255  *
1256  * \since 1.8
1257  */
1258 struct ast_channel *ast_channel_release(struct ast_channel *chan);
1259
1260 /*!
1261  * \brief Requests a channel
1262  *
1263  * \param type type of channel to request
1264  * \param request_cap Format capabilities for requested channel
1265  * \param requestor channel asking for data
1266  * \param addr destination of the call
1267  * \param cause Cause of failure
1268  *
1269  * \details
1270  * Request a channel of a given type, with addr as optional information used
1271  * by the low level module
1272  *
1273  * \retval NULL failure
1274  * \retval non-NULL channel on success
1275  */
1276 struct ast_channel *ast_request(const char *type, struct ast_format_cap *request_cap, const struct ast_channel *requestor, const char *addr, int *cause);
1277
1278 /*!
1279  * \brief Request a channel of a given type, with data as optional information used
1280  *        by the low level module and attempt to place a call on it
1281  *
1282  * \param type type of channel to request
1283  * \param cap format capabilities for requested channel
1284  * \param requestor channel asking for data
1285  * \param addr destination of the call
1286  * \param timeout maximum amount of time to wait for an answer
1287  * \param reason why unsuccessful (if unsuccessful)
1288  * \param cid_num Caller-ID Number
1289  * \param cid_name Caller-ID Name (ascii)
1290  *
1291  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1292  * to know if the call was answered or not.
1293  */
1294 struct ast_channel *ast_request_and_dial(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *addr,
1295         int timeout, int *reason, const char *cid_num, const char *cid_name);
1296
1297 /*!
1298  * \brief Request a channel of a given type, with data as optional information used
1299  * by the low level module and attempt to place a call on it
1300  * \param type type of channel to request
1301  * \param cap format capabilities for requested channel
1302  * \param requestor channel requesting data
1303  * \param addr destination of the call
1304  * \param timeout maximum amount of time to wait for an answer
1305  * \param reason why unsuccessful (if unsuccessful)
1306  * \param cid_num Caller-ID Number
1307  * \param cid_name Caller-ID Name (ascii)
1308  * \param oh Outgoing helper
1309  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
1310  * to know if the call was answered or not.
1311  */
1312 struct ast_channel *__ast_request_and_dial(const char *type, struct ast_format_cap *cap, const struct ast_channel *requestor, const char *addr,
1313         int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
1314
1315 /*!
1316  * \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.
1317  * \param caller in channel that requested orig
1318  * \param orig channel being replaced by the call forward channel
1319  * \param timeout maximum amount of time to wait for setup of new forward channel
1320  * \param cap format capabilities for requested channel
1321  * \param oh outgoing helper used with original channel
1322  * \param outstate reason why unsuccessful (if uncuccessful)
1323  * \return Returns the forwarded call's ast_channel on success or NULL on failure
1324  */
1325 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);
1326
1327 /*!
1328  * \brief Register a channel technology (a new channel driver)
1329  * Called by a channel module to register the kind of channels it supports.
1330  * \param tech Structure defining channel technology or "type"
1331  * \return Returns 0 on success, -1 on failure.
1332  */
1333 int ast_channel_register(const struct ast_channel_tech *tech);
1334
1335 /*!
1336  * \brief Unregister a channel technology
1337  * \param tech Structure defining channel technology or "type" that was previously registered
1338  * \return No return value.
1339  */
1340 void ast_channel_unregister(const struct ast_channel_tech *tech);
1341
1342 /*!
1343  * \brief Get a channel technology structure by name
1344  * \param name name of technology to find
1345  * \return a pointer to the structure, or NULL if no matching technology found
1346  */
1347 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
1348
1349 #ifdef CHANNEL_TRACE
1350 /*!
1351  * \brief Update the context backtrace if tracing is enabled
1352  * \return Returns 0 on success, -1 on failure
1353  */
1354 int ast_channel_trace_update(struct ast_channel *chan);
1355
1356 /*!
1357  * \brief Enable context tracing in the channel
1358  * \return Returns 0 on success, -1 on failure
1359  */
1360 int ast_channel_trace_enable(struct ast_channel *chan);
1361
1362 /*!
1363  * \brief Disable context tracing in the channel.
1364  * \note Does not remove current trace entries
1365  * \return Returns 0 on success, -1 on failure
1366  */
1367 int ast_channel_trace_disable(struct ast_channel *chan);
1368
1369 /*!
1370  * \brief Whether or not context tracing is enabled
1371  * \return Returns -1 when the trace is enabled. 0 if not.
1372  */
1373 int ast_channel_trace_is_enabled(struct ast_channel *chan);
1374
1375 /*!
1376  * \brief Put the channel backtrace in a string
1377  * \return Returns the amount of lines in the backtrace. -1 on error.
1378  */
1379 int ast_channel_trace_serialize(struct ast_channel *chan, struct ast_str **out);
1380 #endif
1381
1382 /*!
1383  * \brief Hang up a channel
1384  * \note Absolutely _NO_ channel locks should be held before calling this function.
1385  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
1386  * performs all stream stopping, etc, on the channel that needs to end.
1387  * chan is no longer valid after this call.
1388  * \param chan channel to hang up
1389  * \return Returns 0 on success, -1 on failure.
1390  */
1391 int ast_hangup(struct ast_channel *chan);
1392
1393 /*!
1394  * \brief Softly hangup up a channel
1395  *
1396  * \param chan channel to be soft-hung-up
1397  * \param reason an AST_SOFTHANGUP_* reason code
1398  *
1399  * \details
1400  * Call the protocol layer, but don't destroy the channel structure
1401  * (use this if you are trying to
1402  * safely hangup a channel managed by another thread.
1403  *
1404  * \note The channel passed to this function does not need to be locked.
1405  *
1406  * \return Returns 0 regardless
1407  */
1408 int ast_softhangup(struct ast_channel *chan, int reason);
1409
1410 /*!
1411  * \brief Softly hangup up a channel (no channel lock)
1412  * \param chan channel to be soft-hung-up
1413  * \param reason an AST_SOFTHANGUP_* reason code
1414  */
1415 int ast_softhangup_nolock(struct ast_channel *chan, int reason);
1416
1417 /*!
1418  * \brief Clear a set of softhangup flags from a channel
1419  *
1420  * Never clear a softhangup flag from a channel directly.  Instead,
1421  * use this function.  This ensures that all aspects of the softhangup
1422  * process are aborted.
1423  *
1424  * \param chan the channel to clear the flag on
1425  * \param flag the flag or flags to clear
1426  *
1427  * \return Nothing.
1428  */
1429 void ast_channel_clear_softhangup(struct ast_channel *chan, int flag);
1430
1431 /*!
1432  * \brief Set the source of the hangup in this channel and it's bridge
1433  *
1434  * \param chan channel to set the field on
1435  * \param source a string describing the source of the hangup for this channel
1436  * \param force
1437  *
1438  * \note Absolutely _NO_ channel locks should be held before calling this function.
1439  *
1440  * \since 1.8
1441  *
1442  * Hangupsource is generally the channel name that caused the bridge to be
1443  * hung up, but it can also be other things such as "dialplan/agi"
1444  * This can then be logged in the CDR or CEL
1445  */
1446 void ast_set_hangupsource(struct ast_channel *chan, const char *source, int force);
1447
1448 /*! \brief Check to see if a channel is needing hang up
1449  * \param chan channel on which to check for hang up
1450  * This function determines if the channel is being requested to be hung up.
1451  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
1452  */
1453 int ast_check_hangup(struct ast_channel *chan);
1454
1455 int ast_check_hangup_locked(struct ast_channel *chan);
1456
1457 /*!
1458  * \brief Lock the given channel, then request softhangup on the channel with the given causecode
1459  * \param chan channel on which to hang up
1460  * \param causecode cause code to use (Zero if don't use cause code)
1461  * \return Nothing
1462  */
1463 void ast_channel_softhangup_withcause_locked(struct ast_channel *chan, int causecode);
1464
1465 /*!
1466  * \brief Compare a offset with the settings of when to hang a channel up
1467  * \param chan channel on which to check for hang up
1468  * \param offset offset in seconds from current time
1469  * \return 1, 0, or -1
1470  * \details
1471  * This function compares a offset from current time with the absolute time
1472  * out on a channel (when to hang up). If the absolute time out on a channel
1473  * is earlier than current time plus the offset, it returns 1, if the two
1474  * time values are equal, it return 0, otherwise, it return -1.
1475  * \sa ast_channel_cmpwhentohangup_tv()
1476  * \version 1.6.1 deprecated function (only had seconds precision)
1477  */
1478 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1479
1480 /*!
1481  * \brief Compare a offset with the settings of when to hang a channel up
1482  * \param chan channel on which to check for hangup
1483  * \param offset offset in seconds and microseconds from current time
1484  * \return 1, 0, or -1
1485  * This function compares a offset from current time with the absolute time
1486  * out on a channel (when to hang up). If the absolute time out on a channel
1487  * is earlier than current time plus the offset, it returns 1, if the two
1488  * time values are equal, it return 0, otherwise, it return -1.
1489  * \since 1.6.1
1490  */
1491 int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1492
1493 /*!
1494  * \brief Set when to hang a channel up
1495  *
1496  * \param chan channel on which to check for hang up
1497  * \param offset offset in seconds relative to the current time of when to hang up
1498  *
1499  * \details
1500  * This function sets the absolute time out on a channel (when to hang up).
1501  *
1502  * \note This function does not require that the channel is locked before
1503  *       calling it.
1504  *
1505  * \return Nothing
1506  * \sa ast_channel_setwhentohangup_tv()
1507  * \version 1.6.1 deprecated function (only had seconds precision)
1508  */
1509 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset) __attribute__((deprecated));
1510
1511 /*!
1512  * \brief Set when to hang a channel up
1513  *
1514  * \param chan channel on which to check for hang up
1515  * \param offset offset in seconds and useconds relative to the current time of when to hang up
1516  *
1517  * This function sets the absolute time out on a channel (when to hang up).
1518  *
1519  * \note This function does not require that the channel is locked before
1520  * calling it.
1521  *
1522  * \return Nothing
1523  * \since 1.6.1
1524  */
1525 void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1526
1527 /*!
1528  * \brief Answer a channel
1529  *
1530  * \param chan channel to answer
1531  *
1532  * \details
1533  * This function answers a channel and handles all necessary call
1534  * setup functions.
1535  *
1536  * \note The channel passed does not need to be locked, but is locked
1537  * by the function when needed.
1538  *
1539  * \note This function will wait up to 500 milliseconds for media to
1540  * arrive on the channel before returning to the caller, so that the
1541  * caller can properly assume the channel is 'ready' for media flow.
1542  *
1543  * \retval 0 on success
1544  * \retval non-zero on failure
1545  */
1546 int ast_answer(struct ast_channel *chan);
1547
1548 /*!
1549  * \brief Answer a channel
1550  *
1551  * \param chan channel to answer
1552  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
1553  *
1554  * This function answers a channel and handles all necessary call
1555  * setup functions.
1556  *
1557  * \note The channel passed does not need to be locked, but is locked
1558  * by the function when needed.
1559  *
1560  * \note Unlike ast_answer(), this function will not wait for media
1561  * flow to begin. The caller should be careful before sending media
1562  * to the channel before incoming media arrives, as the outgoing
1563  * media may be lost.
1564  *
1565  * \retval 0 on success
1566  * \retval non-zero on failure
1567  */
1568 int ast_raw_answer(struct ast_channel *chan, int cdr_answer);
1569
1570 /*!
1571  * \brief Answer a channel, with a selectable delay before returning
1572  *
1573  * \param chan channel to answer
1574  * \param delay maximum amount of time to wait for incoming media
1575  * \param cdr_answer flag to control whether any associated CDR should be marked as 'answered'
1576  *
1577  * This function answers a channel and handles all necessary call
1578  * setup functions.
1579  *
1580  * \note The channel passed does not need to be locked, but is locked
1581  * by the function when needed.
1582  *
1583  * \note This function will wait up to 'delay' milliseconds for media to
1584  * arrive on the channel before returning to the caller, so that the
1585  * caller can properly assume the channel is 'ready' for media flow. If
1586  * 'delay' is less than 500, the function will wait up to 500 milliseconds.
1587  *
1588  * \retval 0 on success
1589  * \retval non-zero on failure
1590  */
1591 int __ast_answer(struct ast_channel *chan, unsigned int delay, int cdr_answer);
1592
1593 /*!
1594  * \brief Execute a Gosub call on the channel before a call is placed.
1595  * \since 11.0
1596  *
1597  * \details
1598  * This is called between ast_request() and ast_call() to
1599  * execute a predial routine on the newly created channel.
1600  *
1601  * \param chan Channel to execute Gosub.
1602  * \param sub_args Gosub application parameter string.
1603  *
1604  * \note Absolutely _NO_ channel locks should be held before calling this function.
1605  *
1606  * \retval 0 on success.
1607  * \retval -1 on error.
1608  */
1609 int ast_pre_call(struct ast_channel *chan, const char *sub_args);
1610
1611 /*!
1612  * \brief Make a call
1613  * \note Absolutely _NO_ channel locks should be held before calling this function.
1614  * \param chan which channel to make the call on
1615  * \param addr destination of the call
1616  * \param timeout time to wait on for connect (Doesn't seem to be used.)
1617  * \details
1618  * Place a call, take no longer than timeout ms.
1619  * \retval 0 on success
1620  * \retval -1 on failure
1621  */
1622 int ast_call(struct ast_channel *chan, const char *addr, int timeout);
1623
1624 /*!
1625  * \brief Indicates condition of channel
1626  * \note Absolutely _NO_ channel locks should be held before calling this function.
1627  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
1628  * \param chan channel to change the indication
1629  * \param condition which condition to indicate on the channel
1630  * \return Returns 0 on success, -1 on failure
1631  */
1632 int ast_indicate(struct ast_channel *chan, int condition);
1633
1634 /*!
1635  * \brief Indicates condition of channel, with payload
1636  * \note Absolutely _NO_ channel locks should be held before calling this function.
1637  * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
1638  * \param chan channel to change the indication
1639  * \param condition which condition to indicate on the channel
1640  * \param data pointer to payload data
1641  * \param datalen size of payload data
1642  * \return Returns 0 on success, -1 on failure
1643  */
1644 int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
1645
1646 /* Misc stuff ------------------------------------------------ */
1647
1648 /*!
1649  * \brief Wait for input on a channel
1650  * \param chan channel to wait on
1651  * \param ms length of time to wait on the channel
1652  * \details
1653  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
1654  * \retval < 0 on failure
1655  * \retval 0 if nothing ever arrived
1656  * \retval the # of ms remaining otherwise
1657  */
1658 int ast_waitfor(struct ast_channel *chan, int ms);
1659
1660 /*!
1661  * \brief Should we keep this frame for later?
1662  *
1663  * There are functions such as ast_safe_sleep which will
1664  * service a channel to ensure that it does not have a
1665  * large backlog of queued frames. When this happens,
1666  * we want to hold on to specific frame types and just drop
1667  * others. This function will tell if the frame we just
1668  * read should be held onto.
1669  *
1670  * \param frame The frame we just read
1671  * \retval 1 frame should be kept
1672  * \retval 0 frame should be dropped
1673  */
1674 int ast_is_deferrable_frame(const struct ast_frame *frame);
1675
1676 /*!
1677  * \brief Wait for a specified amount of time, looking for hangups
1678  * \param chan channel to wait for
1679  * \param ms length of time in milliseconds to sleep
1680  * \details
1681  * Waits for a specified amount of time, servicing the channel as required.
1682  * \return returns -1 on hangup, otherwise 0.
1683  */
1684 int ast_safe_sleep(struct ast_channel *chan, int ms);
1685
1686 /*!
1687  * \brief Wait for a specified amount of time, looking for hangups and a condition argument
1688  * \param chan channel to wait for
1689  * \param ms length of time in milliseconds to sleep
1690  * \param cond a function pointer for testing continue condition
1691  * \param data argument to be passed to the condition test function
1692  * \return returns -1 on hangup, otherwise 0.
1693  * \details
1694  * Waits for a specified amount of time, servicing the channel as required. If cond
1695  * returns 0, this function returns.
1696  */
1697 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
1698
1699 /*!
1700  * \brief Waits for activity on a group of channels
1701  * \param chan an array of pointers to channels
1702  * \param n number of channels that are to be waited upon
1703  * \param fds an array of fds to wait upon
1704  * \param nfds the number of fds to wait upon
1705  * \param exception exception flag
1706  * \param outfd fd that had activity on it
1707  * \param ms how long the wait was
1708  * \details
1709  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
1710  * file descriptors.
1711  * \return Returns the channel with activity, or NULL on error or if an FD
1712  * came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
1713  * will be -1
1714  */
1715 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n,
1716         int *fds, int nfds, int *exception, int *outfd, int *ms);
1717
1718 /*!
1719  * \brief Waits for input on a group of channels
1720  * Wait for input on an array of channels for a given # of milliseconds.
1721  * \return Return channel with activity, or NULL if none has activity.
1722  * \param chan an array of pointers to channels
1723  * \param n number of channels that are to be waited upon
1724  * \param ms time "ms" is modified in-place, if applicable
1725  */
1726 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
1727
1728 /*!
1729  * \brief Waits for input on an fd
1730  * \note This version works on fd's only.  Be careful with it.
1731  */
1732 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
1733
1734
1735 /*!
1736  * \brief Reads a frame
1737  * \param chan channel to read a frame from
1738  * \return Returns a frame, or NULL on error.  If it returns NULL, you
1739  * best just stop reading frames and assume the channel has been
1740  * disconnected.
1741  */
1742 struct ast_frame *ast_read(struct ast_channel *chan);
1743
1744 /*!
1745  * \brief Reads a frame, returning AST_FRAME_NULL frame if audio.
1746  * \param chan channel to read a frame from
1747  * \return  Returns a frame, or NULL on error.  If it returns NULL, you
1748  * best just stop reading frames and assume the channel has been
1749  * disconnected.
1750  * \note Audio is replaced with AST_FRAME_NULL to avoid
1751  * transcode when the resulting audio is not necessary.
1752  */
1753 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
1754
1755 /*!
1756  * \brief Write a frame to a channel
1757  * This function writes the given frame to the indicated channel.
1758  * \param chan destination channel of the frame
1759  * \param frame frame that will be written
1760  * \return It returns 0 on success, -1 on failure.
1761  */
1762 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
1763
1764 /*!
1765  * \brief Write video frame to a channel
1766  * This function writes the given frame to the indicated channel.
1767  * \param chan destination channel of the frame
1768  * \param frame frame that will be written
1769  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1770  */
1771 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
1772
1773 /*!
1774  * \brief Write text frame to a channel
1775  * This function writes the given frame to the indicated channel.
1776  * \param chan destination channel of the frame
1777  * \param frame frame that will be written
1778  * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
1779  */
1780 int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
1781
1782 /*! \brief Send empty audio to prime a channel driver */
1783 int ast_prod(struct ast_channel *chan);
1784
1785 /*!
1786  * \brief Sets read format on channel chan from capabilities
1787  * Set read format for channel to whichever component of "format" is best.
1788  * \param chan channel to change
1789  * \param formats new formats to pick from for reading
1790  * \return Returns 0 on success, -1 on failure
1791  */
1792 int ast_set_read_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
1793
1794 /*!
1795  * \brief Sets read format on channel chan
1796  * \param chan channel to change
1797  * \param format format to set for reading
1798  * \return Returns 0 on success, -1 on failure
1799  */
1800 int ast_set_read_format(struct ast_channel *chan, struct ast_format *format);
1801
1802 /*!
1803  * \brief Sets read format on channel chan by id
1804  * \param chan channel to change
1805  * \param id format id to set for reading, only used for formats without attributes
1806  * \return Returns 0 on success, -1 on failure
1807  */
1808 int ast_set_read_format_by_id(struct ast_channel *chan, enum ast_format_id id);
1809
1810 /*!
1811  * \brief Sets write format on channel chan
1812  * Set write format for channel to whichever component of "format" is best.
1813  * \param chan channel to change
1814  * \param formats new formats to pick from for writing
1815  * \return Returns 0 on success, -1 on failure
1816  */
1817 int ast_set_write_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
1818
1819 /*!
1820  * \brief Sets write format on channel chan
1821  * \param chan channel to change
1822  * \param format format to set for writing
1823  * \return Returns 0 on success, -1 on failure
1824  */
1825 int ast_set_write_format(struct ast_channel *chan, struct ast_format *format);
1826
1827 /*!
1828  * \brief Sets write format on channel chan
1829  * \param chan channel to change
1830  * \param id format id to set for writing, only used for formats without attributes
1831  * \return Returns 0 on success, -1 on failure
1832  */
1833 int ast_set_write_format_by_id(struct ast_channel *chan, enum ast_format_id id);
1834
1835 /*!
1836  * \brief Sends text to a channel
1837  *
1838  * \param chan channel to act upon
1839  * \param text string of text to send on the channel
1840  *
1841  * \details
1842  * Write text to a display on a channel
1843  *
1844  * \note The channel does not need to be locked before calling this function.
1845  *
1846  * \retval 0 on success
1847  * \retval -1 on failure
1848  */
1849 int ast_sendtext(struct ast_channel *chan, const char *text);
1850
1851 /*!
1852  * \brief Receives a text character from a channel
1853  * \param chan channel to act upon
1854  * \param timeout timeout in milliseconds (0 for infinite wait)
1855  * \details
1856  * Read a char of text from a channel
1857  * \return 0 on success, -1 on failure
1858  */
1859 int ast_recvchar(struct ast_channel *chan, int timeout);
1860
1861 /*!
1862  * \brief Send a DTMF digit to a channel.
1863  * \param chan channel to act upon
1864  * \param digit the DTMF digit to send, encoded in ASCII
1865  * \param duration the duration of the digit ending in ms
1866  * \return 0 on success, -1 on failure
1867  */
1868 int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
1869
1870 /*!
1871  * \brief Send a DTMF digit to a channel.
1872  * \param chan channel to act upon
1873  * \param digit the DTMF digit to send, encoded in ASCII
1874  * \return 0 on success, -1 on failure
1875  */
1876 int ast_senddigit_begin(struct ast_channel *chan, char digit);
1877
1878 /*!
1879  * \brief Send a DTMF digit to a channel.
1880  * \param chan channel to act upon
1881  * \param digit the DTMF digit to send, encoded in ASCII
1882  * \param duration the duration of the digit ending in ms
1883  * \return Returns 0 on success, -1 on failure
1884  */
1885 int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
1886
1887 /*!
1888  * \brief Receives a text string from a channel
1889  * Read a string of text from a channel
1890  * \param chan channel to act upon
1891  * \param timeout timeout in milliseconds (0 for infinite wait)
1892  * \return the received text, or NULL to signify failure.
1893  */
1894 char *ast_recvtext(struct ast_channel *chan, int timeout);
1895
1896 /*!
1897  * \brief Waits for a digit
1898  * \param c channel to wait for a digit on
1899  * \param ms how many milliseconds to wait
1900  * \return Returns <0 on error, 0 on no entry, and the digit on success.
1901  */
1902 int ast_waitfordigit(struct ast_channel *c, int ms);
1903
1904 /*!
1905  * \brief Wait for a digit
1906  * Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
1907  * \param c channel to wait for a digit on
1908  * \param ms how many milliseconds to wait
1909  * \param audiofd audio file descriptor to write to if audio frames are received
1910  * \param ctrlfd control file descriptor to monitor for reading
1911  * \return Returns 1 if ctrlfd becomes available
1912  */
1913 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
1914
1915 /*!
1916  * \brief Reads multiple digits
1917  * \param c channel to read from
1918  * \param s string to read in to.  Must be at least the size of your length
1919  * \param len how many digits to read (maximum)
1920  * \param timeout how long to timeout between digits
1921  * \param rtimeout timeout to wait on the first digit
1922  * \param enders digits to end the string
1923  * \details
1924  * Read in a digit string "s", max length "len", maximum timeout between
1925  * digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
1926  * for the first digit.
1927  * \return Returns 0 on normal return, or 1 on a timeout.  In the case of
1928  * a timeout, any digits that were read before the timeout will still be available in s.
1929  * RETURNS 2 in full version when ctrlfd is available, NOT 1
1930  */
1931 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
1932 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
1933
1934 /*! \brief Report DTMF on channel 0 */
1935 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)
1936 /*! \brief Report DTMF on channel 1 */
1937 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)
1938 /*! \brief Return all voice frames on channel 0 */
1939 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)
1940 /*! \brief Return all voice frames on channel 1 */
1941 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)
1942 /*! \brief Ignore all signal frames except NULL */
1943 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)
1944
1945
1946 /*!
1947  * \brief Makes two channel formats compatible
1948  * \param c0 first channel to make compatible
1949  * \param c1 other channel to make compatible
1950  * \details
1951  * Set two channels to compatible formats -- call before ast_channel_bridge in general.
1952  * \return Returns 0 on success and -1 if it could not be done
1953  */
1954 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
1955
1956 /*!
1957  * \brief Bridge two channels together (early)
1958  * \param c0 first channel to bridge
1959  * \param c1 second channel to bridge
1960  * \details
1961  * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
1962  * \return Returns 0 on success and -1 if it could not be done
1963  */
1964 int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
1965
1966 /*!
1967  * \brief Bridge two channels together
1968  * \param c0 first channel to bridge
1969  * \param c1 second channel to bridge
1970  * \param config config for the channels
1971  * \param fo destination frame(?)
1972  * \param rc destination channel(?)
1973  * \details
1974  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
1975  * *rf (remember, it could be NULL) and which channel (0 or 1) in rc
1976  */
1977 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
1978 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,
1979         struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc);
1980
1981 /*!
1982  * \brief Weird function made for call transfers
1983  *
1984  * \param original channel to make a copy of
1985  * \param clone copy of the original channel
1986  *
1987  * \details
1988  * This is a very strange and freaky function used primarily for transfer.  Suppose that
1989  * "original" and "clone" are two channels in random situations.  This function takes
1990  * the guts out of "clone" and puts them into the "original" channel, then alerts the
1991  * channel driver of the change, asking it to fixup any private information (like the
1992  * p->owner pointer) that is affected by the change.  The physical layer of the original
1993  * channel is hung up.
1994  *
1995  * \note Neither channel passed here should be locked before
1996  * calling this function.  This function performs deadlock
1997  * avoidance involving these two channels.
1998  */
1999 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
2000
2001 /*!
2002  * \brief Setup a masquerade to transfer a call.
2003  * \since 1.8
2004  *
2005  * \param target_chan Target of the call transfer.  (Masquerade original channel)
2006  * \param target_id New connected line information for the target channel.
2007  * \param target_held TRUE if the target call is on hold.
2008  * \param transferee_chan Transferee of the call transfer. (Masquerade clone channel)
2009  * \param transferee_id New connected line information for the transferee channel.
2010  * \param transferee_held TRUE if the transferee call is on hold.
2011  *
2012  * \details
2013  * Party A - Transferee
2014  * Party B - Transferer
2015  * Party C - Target of transfer
2016  *
2017  * Party B transfers A to C.
2018  *
2019  * Party A is connected to bridged channel B1.
2020  * Party B is connected to channels C1 and C2.
2021  * Party C is connected to bridged channel B2.
2022  *
2023  * Party B -- C1 == B1 -- Party A
2024  *               __/
2025  *              /
2026  * Party B -- C2 == B2 -- Party C
2027  *
2028  * Bridged channel B1 is masqueraded into channel C2.  Where B1
2029  * is the masquerade clone channel and C2 is the masquerade
2030  * original channel.
2031  *
2032  * \see ast_channel_masquerade()
2033  *
2034  * \note Has the same locking requirements as ast_channel_masquerade().
2035  *
2036  * \retval 0 on success.
2037  * \retval -1 on error.
2038  */
2039 int ast_channel_transfer_masquerade(
2040         struct ast_channel *target_chan,
2041         const struct ast_party_connected_line *target_id,
2042         int target_held,
2043         struct ast_channel *transferee_chan,
2044         const struct ast_party_connected_line *transferee_id,
2045         int transferee_held);
2046
2047 /*!
2048  * \brief Gives the string form of a given cause code.
2049  *
2050  * \param state cause to get the description of
2051  * \return the text form of the binary cause code given
2052  */
2053 const char *ast_cause2str(int state) attribute_pure;
2054
2055 /*!
2056  * \brief Convert the string form of a cause code to a number
2057  *
2058  * \param name string form of the cause
2059  * \return the cause code
2060  */
2061 int ast_str2cause(const char *name) attribute_pure;
2062
2063 /*!
2064  * \brief Gives the string form of a given channel state
2065  *
2066  * \param ast_channel_state state to get the name of
2067  * \return the text form of the binary state given
2068  */
2069 const char *ast_state2str(enum ast_channel_state);
2070
2071 /*!
2072  * \brief Gives the string form of a given transfer capability
2073  *
2074  * \param transfercapability transfer capability to get the name of
2075  * \return the text form of the binary transfer capability
2076  */
2077 char *ast_transfercapability2str(int transfercapability) attribute_const;
2078
2079 /*
2080  * Options: Some low-level drivers may implement "options" allowing fine tuning of the
2081  * low level channel.  See frame.h for options.  Note that many channel drivers may support
2082  * none or a subset of those features, and you should not count on this if you want your
2083  * asterisk application to be portable.  They're mainly useful for tweaking performance
2084  */
2085
2086 /*!
2087  * \brief Sets an option on a channel
2088  *
2089  * \param channel channel to set options on
2090  * \param option option to change
2091  * \param data data specific to option
2092  * \param datalen length of the data
2093  * \param block blocking or not
2094  * \details
2095  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply
2096  * \return 0 on success and -1 on failure
2097  */
2098 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
2099
2100 /*!
2101  * \brief Pick the best codec
2102  *
2103  * \param cap capabilities to pick best codec out of
2104  * \param result stucture to store the best codec in.
2105  * \retval on success, pointer to result structure
2106  * \retval on failure, NULL
2107  */
2108 struct ast_format *ast_best_codec(struct ast_format_cap *cap, struct ast_format *result);
2109
2110
2111 /*!
2112  * \brief Checks the value of an option
2113  *
2114  * Query the value of an option
2115  * Works similarly to setoption except only reads the options.
2116  */
2117 int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
2118
2119 /*!
2120  * \brief Checks for HTML support on a channel
2121  * \return 0 if channel does not support HTML or non-zero if it does
2122  */
2123 int ast_channel_supports_html(struct ast_channel *channel);
2124
2125 /*!
2126  * \brief Sends HTML on given channel
2127  * Send HTML or URL on link.
2128  * \return 0 on success or -1 on failure
2129  */
2130 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
2131
2132 /*!
2133  * \brief Sends a URL on a given link
2134  * Send URL on link.
2135  * \return 0 on success or -1 on failure
2136  */
2137 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
2138
2139 /*!
2140  * \brief Defers DTMF so that you only read things like hangups and audio.
2141  * \return non-zero if channel was already DTMF-deferred or
2142  * 0 if channel is just now being DTMF-deferred
2143  */
2144 int ast_channel_defer_dtmf(struct ast_channel *chan);
2145
2146 /*! Undo defer.  ast_read will return any DTMF characters that were queued */
2147 void ast_channel_undefer_dtmf(struct ast_channel *chan);
2148
2149 /*! Initiate system shutdown -- prevents new channels from being allocated.
2150  * \param hangup  If "hangup" is non-zero, all existing channels will receive soft
2151  *  hangups */
2152 void ast_begin_shutdown(int hangup);
2153
2154 /*! Cancels an existing shutdown and returns to normal operation */
2155 void ast_cancel_shutdown(void);
2156
2157 /*! \return number of channels available for lookup */
2158 int ast_active_channels(void);
2159
2160 /*! \return the number of channels not yet destroyed */
2161 int ast_undestroyed_channels(void);
2162
2163 /*! \return non-zero if Asterisk is being shut down */
2164 int ast_shutting_down(void);
2165
2166 /*! Activate a given generator */
2167 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
2168
2169 /*! Deactivate an active generator */
2170 void ast_deactivate_generator(struct ast_channel *chan);
2171
2172 /*!
2173  * \brief Set caller ID number, name and ANI and generate AMI event.
2174  *
2175  * \note Use ast_channel_set_caller() and ast_channel_set_caller_event() instead.
2176  * \note The channel does not need to be locked before calling this function.
2177  */
2178 void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
2179
2180 /*!
2181  * \brief Set the caller id information in the Asterisk channel
2182  * \since 1.8
2183  *
2184  * \param chan Asterisk channel to set caller id information
2185  * \param caller Caller id information
2186  * \param update What caller information to update.  NULL if all.
2187  *
2188  * \return Nothing
2189  *
2190  * \note The channel does not need to be locked before calling this function.
2191  */
2192 void ast_channel_set_caller(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2193
2194 /*!
2195  * \brief Set the caller id information in the Asterisk channel and generate an AMI event
2196  * if the caller id name or number changed.
2197  * \since 1.8
2198  *
2199  * \param chan Asterisk channel to set caller id information
2200  * \param caller Caller id information
2201  * \param update What caller information to update.  NULL if all.
2202  *
2203  * \return Nothing
2204  *
2205  * \note The channel does not need to be locked before calling this function.
2206  */
2207 void ast_channel_set_caller_event(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2208
2209 /*! Set the file descriptor on the channel */
2210 void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
2211
2212 /*! Add a channel to an optimized waitfor */
2213 void ast_poll_channel_add(struct ast_channel *chan0, struct ast_channel *chan1);
2214
2215 /*! Delete a channel from an optimized waitfor */
2216 void ast_poll_channel_del(struct ast_channel *chan0, struct ast_channel *chan1);
2217
2218 /*! Start a tone going */
2219 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2220 /*! Stop a tone from playing */
2221 void ast_tonepair_stop(struct ast_channel *chan);
2222 /*! Play a tone pair for a given amount of time */
2223 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2224
2225 /*!
2226  * \brief Automatically service a channel for us...
2227  *
2228  * \retval 0 success
2229  * \retval -1 failure, or the channel is already being autoserviced
2230  */
2231 int ast_autoservice_start(struct ast_channel *chan);
2232
2233 /*!
2234  * \brief Stop servicing a channel for us...
2235  *
2236  * \note if chan is locked prior to calling ast_autoservice_stop, it
2237  * is likely that there will be a deadlock between the thread that calls
2238  * ast_autoservice_stop and the autoservice thread. It is important
2239  * that chan is not locked prior to this call
2240  *
2241  * \param chan
2242  * \retval 0 success
2243  * \retval -1 error, or the channel has been hungup
2244  */
2245 int ast_autoservice_stop(struct ast_channel *chan);
2246
2247 /*!
2248  * \brief Put chan into autoservice while hanging up peer.
2249  * \since 11.0
2250  *
2251  * \param chan Chan to put into autoservice.
2252  * \param peer Chan to run hangup handlers and hangup.
2253  *
2254  * \return Nothing
2255  */
2256 void ast_autoservice_chan_hangup_peer(struct ast_channel *chan, struct ast_channel *peer);
2257
2258 /*!
2259  * \brief Ignore certain frame types
2260  * \note Normally, we cache DTMF, IMAGE, HTML, TEXT, and CONTROL frames
2261  * while a channel is in autoservice and queue them up when taken out of
2262  * autoservice.  When this is not desireable, this API may be used to
2263  * cause the channel to ignore those frametypes after the channel is put
2264  * into autoservice, but before autoservice is stopped.
2265  * \retval 0 success
2266  * \retval -1 channel is not in autoservice
2267  */
2268 int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype);
2269
2270 /*!
2271  * \brief Enable or disable timer ticks for a channel
2272  *
2273  * \param c channel
2274  * \param rate number of timer ticks per second
2275  * \param func callback function
2276  * \param data
2277  *
2278  * \details
2279  * If timers are supported, force a scheduled expiration on the
2280  * timer fd, at which point we call the callback function / data
2281  *
2282  * \note Call this function with a rate of 0 to turn off the timer ticks
2283  *
2284  * \version 1.6.1 changed samples parameter to rate, accomodates new timing methods
2285  */
2286 int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
2287
2288 /*!
2289  * \brief Transfer a channel (if supported).
2290  * \retval -1 on error
2291  * \retval 0 if not supported
2292  * \retval 1 if supported and requested
2293  * \param chan current channel
2294  * \param dest destination extension for transfer
2295  */
2296 int ast_transfer(struct ast_channel *chan, char *dest);
2297
2298 /*!
2299  * \brief Start masquerading a channel
2300  * \note absolutely _NO_ channel locks should be held before calling this function.
2301  * \details
2302  * XXX This is a seriously whacked out operation.  We're essentially putting the guts of
2303  *     the clone channel into the original channel.  Start by killing off the original
2304  *     channel's backend.   I'm not sure we're going to keep this function, because
2305  *     while the features are nice, the cost is very high in terms of pure nastiness. XXX
2306  * \param chan Channel to masquerade
2307  */
2308 int ast_do_masquerade(struct ast_channel *chan);
2309
2310 /*!
2311  * \brief Find bridged channel
2312  *
2313  * \note This function does _not_ return a reference to the bridged channel.
2314  * The reason for this is mostly historical.  It _should_ return a reference,
2315  * but it will take a lot of work to make the code base account for that.
2316  * So, for now, the old rules still apply for how to handle this function.
2317  * If this function is being used from the channel thread that owns the channel,
2318  * then a reference is already held, and channel locking is not required to
2319  * guarantee that the channel will stay around.  If this function is used
2320  * outside of the associated channel thread, the channel parameter 'chan'
2321  * MUST be locked before calling this function.  Also, 'chan' must remain locked
2322  * for the entire time that the result of this function is being used.
2323  *
2324  * \param chan Current channel
2325  *
2326  * \return A pointer to the bridged channel
2327 */
2328 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
2329
2330 /*!
2331  * \brief Inherits channel variable from parent to child channel
2332  * \param parent Parent channel
2333  * \param child Child channel
2334  *
2335  * \details
2336  * Scans all channel variables in the parent channel, looking for those
2337  * that should be copied into the child channel.
2338  * Variables whose names begin with a single '_' are copied into the
2339  * child channel with the prefix removed.
2340  * Variables whose names begin with '__' are copied into the child
2341  * channel with their names unchanged.
2342  */
2343 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
2344
2345 /*!
2346  * \brief adds a list of channel variables to a channel
2347  * \param chan the channel
2348  * \param vars a linked list of variables
2349  *
2350  * \details
2351  * Variable names can be for a regular channel variable or a dialplan function
2352  * that has the ability to be written to.
2353  */
2354 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
2355
2356 /*!
2357  * \brief An opaque 'object' structure use by silence generators on channels.
2358  */
2359 struct ast_silence_generator;
2360
2361 /*!
2362  * \brief Starts a silence generator on the given channel.
2363  * \param chan The channel to generate silence on
2364  * \return An ast_silence_generator pointer, or NULL if an error occurs
2365  *
2366  * \details
2367  * This function will cause SLINEAR silence to be generated on the supplied
2368  * channel until it is disabled; if the channel cannot be put into SLINEAR
2369  * mode then the function will fail.
2370  *
2371  * \note
2372  * The pointer returned by this function must be preserved and passed to
2373  * ast_channel_stop_silence_generator when you wish to stop the silence
2374  * generation.
2375  */
2376 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
2377
2378 /*!
2379  * \brief Stops a previously-started silence generator on the given channel.
2380  * \param chan The channel to operate on
2381  * \param state The ast_silence_generator pointer return by a previous call to
2382  * ast_channel_start_silence_generator.
2383  * \return nothing
2384  *
2385  * \details
2386  * This function will stop the operating silence generator and return the channel
2387  * to its previous write format.
2388  */
2389 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
2390
2391 /*!
2392  * \brief Check if the channel can run in internal timing mode.
2393  * \param chan The channel to check
2394  * \return boolean
2395  *
2396  * \details
2397  * This function will return 1 if internal timing is enabled and the timing
2398  * device is available.
2399  */
2400 int ast_internal_timing_enabled(struct ast_channel *chan);
2401
2402 /* Misc. functions below */
2403
2404 /*!
2405  * \brief if fd is a valid descriptor, set *pfd with the descriptor
2406  * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
2407  * return value to the index into the array)
2408  */
2409 static inline int ast_add_fd(struct pollfd *pfd, int fd)
2410 {
2411         pfd->fd = fd;
2412         pfd->events = POLLIN | POLLPRI;
2413         return fd >= 0;
2414 }
2415
2416 /*! \brief Helper function for migrating select to poll */
2417 static inline int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
2418 {
2419         int x;
2420         int dummy = 0;
2421
2422         if (fd < 0)
2423                 return 0;
2424         if (!start)
2425                 start = &dummy;
2426         for (x = *start; x < maximum; x++)
2427                 if (pfds[x].fd == fd) {
2428                         if (x == *start)
2429                                 (*start)++;
2430                         return pfds[x].revents;
2431                 }
2432         return 0;
2433 }
2434
2435 /*! \brief Retrieves the current T38 state of a channel */
2436 static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
2437 {
2438         enum ast_t38_state state = T38_STATE_UNAVAILABLE;
2439         int datalen = sizeof(state);
2440
2441         ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
2442
2443         return state;
2444 }
2445
2446 #define CHECK_BLOCKING(c) do {   \
2447         if (ast_test_flag(ast_channel_flags(c), AST_FLAG_BLOCKING)) {\
2448                 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)); \
2449         } else { \
2450                 ast_channel_blocker_set((c), pthread_self()); \
2451                 ast_channel_blockproc_set((c), __PRETTY_FUNCTION__); \
2452                 ast_set_flag(ast_channel_flags(c), AST_FLAG_BLOCKING); \
2453         } } while (0)
2454
2455 ast_group_t ast_get_group(const char *s);
2456
2457 /*! \brief Print call- and pickup groups into buffer */
2458 char *ast_print_group(char *buf, int buflen, ast_group_t group);
2459
2460 /*! \brief Opaque struct holding a namedgroups set, i.e. a set of group names */
2461 struct ast_namedgroups;
2462
2463 /*! \brief Create an ast_namedgroups set with group name from comma separated string s */
2464 struct ast_namedgroups *ast_get_namedgroups(const char *s);
2465 struct ast_namedgroups *ast_unref_namedgroups(struct ast_namedgroups *groups);
2466 struct ast_namedgroups *ast_ref_namedgroups(struct ast_namedgroups *groups);
2467 /*! \brief Return TRUE if group a and b contain at least one common groupname */
2468 int ast_namedgroups_intersect(struct ast_namedgroups *a, struct ast_namedgroups *b);
2469
2470 /*! \brief Print named call groups and named pickup groups ---*/
2471 char *ast_print_namedgroups(struct ast_str **buf, struct ast_namedgroups *groups);
2472
2473 /*!
2474  * \brief Convert enum channelreloadreason to text string for manager event
2475  * \param reason The reason for reload (manager, cli, start etc)
2476  */
2477 const char *channelreloadreason2txt(enum channelreloadreason reason);
2478
2479 /*! \brief return an ast_variable list of channeltypes */
2480 struct ast_variable *ast_channeltype_list(void);
2481
2482 /*!
2483  * \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
2484  * \param reason  The integer argument, usually taken from AST_CONTROL_ macros
2485  * \return char pointer explaining the code
2486  */
2487 const char *ast_channel_reason2str(int reason);
2488
2489 /*! \brief channel group info */
2490 struct ast_group_info {
2491         struct ast_channel *chan;
2492         char *category;
2493         char *group;
2494         AST_LIST_ENTRY(ast_group_info) group_list;
2495 };
2496
2497 #define ast_channel_lock(chan) ao2_lock(chan)
2498 #define ast_channel_unlock(chan) ao2_unlock(chan)
2499 #define ast_channel_trylock(chan) ao2_trylock(chan)
2500
2501 /*!
2502  * \brief Lock two channels.
2503  */
2504 #define ast_channel_lock_both(chan1, chan2) do { \
2505                 ast_channel_lock(chan1); \
2506                 while (ast_channel_trylock(chan2)) { \
2507                         ast_channel_unlock(chan1); \
2508                         sched_yield(); \
2509                         ast_channel_lock(chan1); \
2510                 } \
2511         } while (0)
2512
2513 /*!
2514  * \brief Increase channel reference count
2515  *
2516  * \param c the channel
2517  *
2518  * \retval c always
2519  *
2520  * \since 1.8
2521  */
2522 #define ast_channel_ref(c) ({ ao2_ref(c, +1); (c); })
2523
2524 /*!
2525  * \brief Decrease channel reference count
2526  *
2527  * \param c the channel
2528  *
2529  * \retval NULL always
2530  *
2531  * \since 1.8
2532  */
2533 #define ast_channel_unref(c) ({ ao2_ref(c, -1); (struct ast_channel *) (NULL); })
2534
2535 /*! Channel Iterating @{ */
2536
2537 /*!
2538  * \brief A channel iterator
2539  *
2540  * This is an opaque type.
2541  */
2542 struct ast_channel_iterator;
2543
2544 /*!
2545  * \brief Destroy a channel iterator
2546  *
2547  * \param i the itereator to destroy
2548  *
2549  * \details
2550  * This function is used to destroy a channel iterator that was retrieved by
2551  * using one of the channel_iterator_xxx_new() functions.
2552  *
2553  * \return NULL, for convenience to clear out the pointer to the iterator that
2554  * was just destroyed.
2555  *
2556  * \since 1.8
2557  */
2558 struct ast_channel_iterator *ast_channel_iterator_destroy(struct ast_channel_iterator *i);
2559
2560 /*!
2561  * \brief Create a new channel iterator based on extension
2562  *
2563  * \param exten The extension that channels must be in
2564  * \param context The context that channels must be in
2565  *
2566  * \details
2567  * After creating an iterator using this function, the ast_channel_iterator_next()
2568  * function can be used to iterate through all channels that are currently
2569  * in the specified context and extension.
2570  *
2571  * \note You must call ast_channel_iterator_destroy() when done.
2572  *
2573  * \retval NULL on failure
2574  * \retval a new channel iterator based on the specified parameters
2575  *
2576  * \since 1.8
2577  */
2578 struct ast_channel_iterator *ast_channel_iterator_by_exten_new(const char *exten, const char *context);
2579
2580 /*!
2581  * \brief Create a new channel iterator based on name
2582  *
2583  * \param name channel name or channel uniqueid to match
2584  * \param name_len number of characters in the channel name to match on.  This
2585  *      would be used to match based on name prefix.  If matching on the full
2586  *      channel name is desired, then this parameter should be 0.
2587  *
2588  * \details
2589  * After creating an iterator using this function, the ast_channel_iterator_next()
2590  * function can be used to iterate through all channels that exist that have
2591  * the specified name or name prefix.
2592  *
2593  * \note You must call ast_channel_iterator_destroy() when done.
2594  *
2595  * \retval NULL on failure
2596  * \retval a new channel iterator based on the specified parameters
2597  *
2598  * \since 1.8
2599  */
2600 struct ast_channel_iterator *ast_channel_iterator_by_name_new(const char *name, size_t name_len);
2601
2602 /*!
2603  * \brief Create a new channel iterator
2604  *
2605  * \details
2606  * After creating an iterator using this function, the ast_channel_iterator_next()
2607  * function can be used to iterate through all channels that exist.
2608  *
2609  * \note You must call ast_channel_iterator_destroy() when done.
2610  *
2611  * \retval NULL on failure
2612  * \retval a new channel iterator
2613  *
2614  * \since 1.8
2615  */
2616 struct ast_channel_iterator *ast_channel_iterator_all_new(void);
2617
2618 /*!
2619  * \brief Get the next channel for a channel iterator
2620  *
2621  * \param i the channel iterator that was created using one of the
2622  *  channel_iterator_xxx_new() functions.
2623  *
2624  * \details
2625  * This function should be used to iterate through all channels that match a
2626  * specified set of parameters that were provided when the iterator was created.
2627  *
2628  * \retval the next channel that matches the parameters used when the iterator
2629  *         was created.
2630  * \retval NULL, if no more channels match the iterator parameters.
2631  *
2632  * \since 1.8
2633  */
2634 struct ast_channel *ast_channel_iterator_next(struct ast_channel_iterator *i);
2635
2636 /*! @} End channel iterator definitions. */
2637
2638 /*!
2639  * \brief Call a function with every active channel
2640  *
2641  * \details
2642  * This function executes a callback one time for each active channel on the
2643  * system.  The channel is provided as an argument to the function.
2644  *
2645  * \note Absolutely _NO_ channel locks should be held before calling this function.
2646  * \since 1.8
2647  */
2648 struct ast_channel *ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg,
2649                 void *data, int ao2_flags);
2650
2651 /*! @{ Channel search functions */
2652
2653 /*!
2654  * \brief Find a channel by name
2655  *
2656  * \param name the name or uniqueid of the channel to search for
2657  *
2658  * \details
2659  * Find a channel that has the same name as the provided argument.
2660  *
2661  * \retval a channel with the name specified by the argument
2662  * \retval NULL if no channel was found
2663  *
2664  * \since 1.8
2665  */
2666 struct ast_channel *ast_channel_get_by_name(const char *name);
2667
2668 /*!
2669  * \brief Find a channel by a name prefix
2670  *
2671  * \param name The channel name or uniqueid prefix to search for
2672  * \param name_len Only search for up to this many characters from the name
2673  *
2674  * \details
2675  * Find a channel that has the same name prefix as specified by the arguments.
2676  *
2677  * \retval a channel with the name prefix specified by the arguments
2678  * \retval NULL if no channel was found
2679  *
2680  * \since 1.8
2681  */
2682 struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len);
2683
2684 /*!
2685  * \brief Find a channel by extension and context
2686  *
2687  * \param exten the extension to search for
2688  * \param context the context to search for
2689  *
2690  * \details
2691  * Return a channel that is currently at the specified extension and context.
2692  *
2693  * \retval a channel that is at the specified extension and context
2694  * \retval NULL if no channel was found
2695  *
2696  * \since 1.8
2697  */
2698 struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context);
2699
2700 /*! @} End channel search functions. */
2701
2702 /*!
2703   \brief propagate the linked id between chan and peer
2704  */
2705 void ast_channel_set_linkgroup(struct ast_channel *chan, struct ast_channel *peer);
2706
2707
2708 /*!
2709  * \brief Initialize the given name structure.
2710  * \since 1.8
2711  *
2712  * \param init Name structure to initialize.
2713  *
2714  * \return Nothing
2715  */
2716 void ast_party_name_init(struct ast_party_name *init);
2717
2718 /*!
2719  * \brief Copy the source party name information to the destination party name.
2720  * \since 1.8
2721  *
2722  * \param dest Destination party name
2723  * \param src Source party name
2724  *
2725  * \return Nothing
2726  */
2727 void ast_party_name_copy(struct ast_party_name *dest, const struct ast_party_name *src);
2728
2729 /*!
2730  * \brief Initialize the given party name structure using the given guide
2731  * for a set update operation.
2732  * \since 1.8
2733  *
2734  * \details
2735  * The initialization is needed to allow a set operation to know if a
2736  * value needs to be updated.  Simple integers need the guide's original
2737  * value in case the set operation is not trying to set a new value.
2738  * String values are simply set to NULL pointers if they are not going
2739  * to be updated.
2740  *
2741  * \param init Party name structure to initialize.
2742  * \param guide Source party name to use as a guide in initializing.
2743  *
2744  * \return Nothing
2745  */
2746 void ast_party_name_set_init(struct ast_party_name *init, const struct ast_party_name *guide);
2747
2748 /*!
2749  * \brief Set the source party name information into the destination party name.
2750  * \since 1.8
2751  *
2752  * \param dest The name one wishes to update
2753  * \param src The new name values to update the dest
2754  *
2755  * \return Nothing
2756  */
2757 void ast_party_name_set(struct ast_party_name *dest, const struct ast_party_name *src);
2758
2759 /*!
2760  * \brief Destroy the party name contents
2761  * \since 1.8
2762  *
2763  * \param doomed The party name to destroy.
2764  *
2765  * \return Nothing
2766  */
2767 void ast_party_name_free(struct ast_party_name *doomed);
2768
2769 /*!
2770  * \brief Initialize the given number structure.
2771  * \since 1.8
2772  *
2773  * \param init Number structure to initialize.
2774  *
2775  * \return Nothing
2776  */
2777 void ast_party_number_init(struct ast_party_number *init);
2778
2779 /*!
2780  * \brief Copy the source party number information to the destination party number.
2781  * \since 1.8
2782  *
2783  * \param dest Destination party number
2784  * \param src Source party number
2785  *
2786  * \return Nothing
2787  */
2788 void ast_party_number_copy(struct ast_party_number *dest, const struct ast_party_number *src);
2789
2790 /*!
2791  * \brief Initialize the given party number structure using the given guide
2792  * for a set update operation.
2793  * \since 1.8
2794  *
2795  * \details
2796  * The initialization is needed to allow a set operation to know if a
2797  * value needs to be updated.  Simple integers need the guide's original
2798  * value in case the set operation is not trying to set a new value.
2799  * String values are simply set to NULL pointers if they are not going
2800  * to be updated.
2801  *
2802  * \param init Party number structure to initialize.
2803  * \param guide Source party number to use as a guide in initializing.
2804  *
2805  * \return Nothing
2806  */
2807 void ast_party_number_set_init(struct ast_party_number *init, const struct ast_party_number *guide);
2808
2809 /*!
2810  * \brief Set the source party number information into the destination party number.
2811  * \since 1.8
2812  *
2813  * \param dest The number one wishes to update
2814  * \param src The new number values to update the dest
2815  *
2816  * \return Nothing
2817  */
2818 void ast_party_number_set(struct ast_party_number *dest, const struct ast_party_number *src);
2819
2820 /*!
2821  * \brief Destroy the party number contents
2822  * \since 1.8
2823  *
2824  * \param doomed The party number to destroy.
2825  *
2826  * \return Nothing
2827  */
2828 void ast_party_number_free(struct ast_party_number *doomed);
2829
2830 /*!
2831  * \since 1.8
2832  * \brief Initialize the given subaddress structure.
2833  *
2834  * \param init Subaddress structure to initialize.
2835  *
2836  * \return Nothing
2837  */
2838 void ast_party_subaddress_init(struct ast_party_subaddress *init);
2839
2840 /*!
2841  * \since 1.8
2842  * \brief Copy the source party subaddress information to the destination party subaddress.
2843  *
2844  * \param dest Destination party subaddress
2845  * \param src Source party subaddress
2846  *
2847  * \return Nothing
2848  */
2849 void ast_party_subaddress_copy(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
2850
2851 /*!
2852  * \since 1.8
2853  * \brief Initialize the given party subaddress structure using the given guide
2854  * for a set update operation.
2855  *
2856  * \details
2857  * The initialization is needed to allow a set operation to know if a
2858  * value needs to be updated.  Simple integers need the guide's original
2859  * value in case the set operation is not trying to set a new value.
2860  * String values are simply set to NULL pointers if they are not going
2861  * to be updated.
2862  *
2863  * \param init Party subaddress structure to initialize.
2864  * \param guide Source party subaddress to use as a guide in initializing.
2865  *
2866  * \return Nothing
2867  */
2868 void ast_party_subaddress_set_init(struct ast_party_subaddress *init, const struct ast_party_subaddress *guide);
2869
2870 /*!
2871  * \since 1.8
2872  * \brief Set the source party subaddress information into the destination party subaddress.
2873  *
2874  * \param dest The subaddress one wishes to update
2875  * \param src The new subaddress values to update the dest
2876  *
2877  * \return Nothing
2878  */
2879 void ast_party_subaddress_set(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
2880
2881 /*!
2882  * \since 1.8
2883  * \brief Destroy the party subaddress contents
2884  *
2885  * \param doomed The party subaddress to destroy.
2886  *
2887  * \return Nothing
2888  */
2889 void ast_party_subaddress_free(struct ast_party_subaddress *doomed);
2890
2891 /*!
2892  * \brief Set the update marker to update all information of a corresponding party id.
2893  * \since 11.0
2894  *
2895  * \param update_id The update marker for a corresponding party id.
2896  *
2897  * \return Nothing
2898  */
2899 void ast_set_party_id_all(struct ast_set_party_id *update_id);
2900
2901 /*!
2902  * \brief Initialize the given party id structure.
2903  * \since 1.8
2904  *
2905  * \param init Party id structure to initialize.
2906  *
2907  * \return Nothing
2908  */
2909 void ast_party_id_init(struct ast_party_id *init);
2910
2911 /*!
2912  * \brief Copy the source party id information to the destination party id.
2913  * \since 1.8
2914  *
2915  * \param dest Destination party id
2916  * \param src Source party id
2917  *
2918  * \return Nothing
2919  */
2920 void ast_party_id_copy(struct ast_party_id *dest, const struct ast_party_id *src);
2921
2922 /*!
2923  * \brief Initialize the given party id structure using the given guide
2924  * for a set update operation.
2925  * \since 1.8
2926  *
2927  * \details
2928  * The initialization is needed to allow a set operation to know if a
2929  * value needs to be updated.  Simple integers need the guide's original
2930  * value in case the set operation is not trying to set a new value.
2931  * String values are simply set to NULL pointers if they are not going
2932  * to be updated.
2933  *
2934  * \param init Party id structure to initialize.
2935  * \param guide Source party id to use as a guide in initializing.
2936  *
2937  * \return Nothing
2938  */
2939 void ast_party_id_set_init(struct ast_party_id *init, const struct ast_party_id *guide);
2940
2941 /*!
2942  * \brief Set the source party id information into the destination party id.
2943  * \since 1.8
2944  *
2945  * \param dest The id one wishes to update
2946  * \param src The new id values to update the dest
2947  * \param update What id information to update.  NULL if all.
2948  *
2949  * \return Nothing
2950  */
2951 void ast_party_id_set(struct ast_party_id *dest, const struct ast_party_id *src, const struct ast_set_party_id *update);
2952
2953 /*!
2954  * \brief Destroy the party id contents
2955  * \since 1.8
2956  *
2957  * \param doomed The party id to destroy.
2958  *
2959  * \return Nothing
2960  */
2961 void ast_party_id_free(struct ast_party_id *doomed);
2962
2963 /*!
2964  * \brief Determine the overall presentation value for the given party.
2965  * \since 1.8
2966  *
2967  * \param id Party to determine the overall presentation value.
2968  *
2969  * \return Overall presentation value for the given party.
2970  */
2971 int ast_party_id_presentation(const struct ast_party_id *id);
2972
2973 /*!
2974  * \brief Invalidate all components of the given party id.
2975  * \since 11.0
2976  *
2977  * \param id The party id to invalidate.
2978  *
2979  * \return Nothing
2980  */
2981 void ast_party_id_invalidate(struct ast_party_id *id);
2982
2983 /*!
2984  * \brief Destroy and initialize the given party id structure.
2985  * \since 11.0
2986  *
2987  * \param id The party id to reset.
2988  *
2989  * \return Nothing
2990  */
2991 void ast_party_id_reset(struct ast_party_id *id);
2992
2993 /*!
2994  * \brief Merge a given party id into another given party id.
2995  * \since 11.0
2996  *
2997  * \details
2998  * This function will generate an effective party id.
2999  * 
3000  * Each party id component of the party id 'base' is overwritten
3001  * by components of the party id 'overlay' if the overlay
3002  * component is marked as valid.  However the component 'tag' of
3003  * the base party id remains untouched.
3004  *
3005  * \param base The party id which is merged.
3006  * \param overlay The party id which is used to merge into.
3007  *
3008  * \return The merged party id as a struct, not as a pointer.
3009  * \note The merged party id returned is a shallow copy and must not be freed.
3010  */
3011 struct ast_party_id ast_party_id_merge(struct ast_party_id *base, struct ast_party_id *overlay);
3012
3013 /*!
3014  * \brief Copy a merge of a given party id into another given party id to a given destination party id.
3015  * \since 11.0
3016  *
3017  * \details
3018  * Each party id component of the party id 'base' is overwritten by components
3019  * of the party id 'overlay' if the 'overlay' component is marked as valid.
3020  * However the component 'tag' of the 'base' party id remains untouched.
3021  * The result is copied into the given party id 'dest'.
3022  *
3023  * \note The resulting merged party id is a real copy and has to be freed.
3024  *
3025  * \param dest The resulting merged party id.
3026  * \param base The party id which is merged.
3027  * \param overlay The party id which is used to merge into.
3028  *
3029  * \return Nothing
3030  */
3031 void ast_party_id_merge_copy(struct ast_party_id *dest, struct ast_party_id *base, struct ast_party_id *overlay);
3032
3033 /*!
3034  * \brief Initialize the given dialed structure.
3035  * \since 1.8
3036  *
3037  * \param init Dialed structure to initialize.
3038  *
3039  * \return Nothing
3040  */
3041 void ast_party_dialed_init(struct ast_party_dialed *init);
3042
3043 /*!
3044  * \brief Copy the source dialed party information to the destination dialed party.
3045  * \since 1.8
3046  *
3047  * \param dest Destination dialed party
3048  * \param src Source dialed party
3049  *
3050  * \return Nothing
3051  */
3052 void ast_party_dialed_copy(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
3053
3054 /*!
3055  * \brief Initialize the given dialed structure using the given
3056  * guide for a set update operation.
3057  * \since 1.8
3058  *
3059  * \details
3060  * The initialization is needed to allow a set operation to know if a
3061  * value needs to be updated.  Simple integers need the guide's original
3062  * value in case the set operation is not trying to set a new value.
3063  * String values are simply set to NULL pointers if they are not going
3064  * to be updated.
3065  *
3066  * \param init Caller structure to initialize.
3067  * \param guide Source dialed to use as a guide in initializing.
3068  *
3069  * \return Nothing
3070  */
3071 void ast_party_dialed_set_init(struct ast_party_dialed *init, const struct ast_party_dialed *guide);
3072
3073 /*!
3074  * \brief Set the dialed information based on another dialed source
3075  * \since 1.8
3076  *
3077  * This is similar to ast_party_dialed_copy, except that NULL values for
3078  * strings in the src parameter indicate not to update the corresponding dest values.
3079  *
3080  * \param dest The dialed one wishes to update
3081  * \param src The new dialed values to update the dest
3082  *
3083  * \return Nada
3084  */
3085 void ast_party_dialed_set(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
3086
3087 /*!
3088  * \brief Destroy the dialed party contents
3089  * \since 1.8
3090  *
3091  * \param doomed The dialed party to destroy.
3092  *
3093  * \return Nothing
3094  */
3095 void ast_party_dialed_free(struct ast_party_dialed *doomed);
3096
3097 /*!
3098  * \since 1.8
3099  * \brief Initialize the given caller structure.
3100  *
3101  * \param init Caller structure to initialize.
3102  *
3103  * \return Nothing
3104  */
3105 void ast_party_caller_init(struct ast_party_caller *init);
3106
3107 /*!
3108  * \since 1.8
3109  * \brief Copy the source caller information to the destination caller.
3110  *
3111  * \param dest Destination caller
3112  * \param src Source caller
3113  *
3114  * \return Nothing
3115  */
3116 void ast_party_caller_copy(struct ast_party_caller *dest, const struct ast_party_caller *src);
3117
3118 /*!
3119  * \brief Initialize the given caller structure using the given
3120  * guide for a set update operation.
3121  * \since 1.8
3122  *
3123  * \details
3124  * The initialization is needed to allow a set operation to know if a
3125  * value needs to be updated.  Simple integers need the guide's original
3126  * value in case the set operation is not trying to set a new value.
3127  * String values are simply set to NULL pointers if they are not going
3128  * to be updated.
3129  *
3130  * \param init Caller structure to initialize.
3131  * \param guide Source caller to use as a guide in initializing.
3132  *
3133  * \return Nothing
3134  */
3135 void ast_party_caller_set_init(struct ast_party_caller *init, const struct ast_party_caller *guide);
3136
3137 /*!
3138  * \brief Set the caller information based on another caller source
3139  * \since 1.8
3140  *
3141  * This is similar to ast_party_caller_copy, except that NULL values for
3142  * strings in the src parameter indicate not to update the corresponding dest values.
3143  *
3144  * \param dest The caller one wishes to update
3145  * \param src The new caller values to update the dest
3146  * \param update What caller information to update.  NULL if all.
3147  *
3148  * \return Nada
3149  */
3150 void ast_party_caller_set(struct ast_party_caller *dest, const struct ast_party_caller *src, const struct ast_set_party_caller *update);
3151
3152 /*!
3153  * \brief Destroy the caller party contents
3154  * \since 1.8
3155  *
3156  * \param doomed The caller party to destroy.
3157  *
3158  * \return Nothing
3159  */
3160 void ast_party_caller_free(struct ast_party_caller *doomed);
3161
3162 /*!
3163  * \since 1.8
3164  * \brief Initialize the given connected line structure.
3165  *
3166  * \param init Connected line structure to initialize.
3167  *
3168  * \return Nothing
3169  */
3170 void ast_party_connected_line_init(struct ast_party_connected_line *init);
3171
3172 /*!
3173  * \since 1.8
3174  * \brief Copy the source connected line information to the destination connected line.
3175  *
3176  * \param dest Destination connected line
3177  * \param src Source connected line
3178  *
3179  * \return Nothing
3180  */
3181 void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
3182
3183 /*!
3184  * \since 1.8
3185  * \brief Initialize the given connected line structure using the given
3186  * guide for a set update operation.
3187  *
3188  * \details
3189  * The initialization is needed to allow a set operation to know if a
3190  * value needs to be updated.  Simple integers need the guide's original
3191  * value in case the set operation is not trying to set a new value.
3192  * String values are simply set to NULL pointers if they are not going
3193  * to be updated.
3194  *
3195  * \param init Connected line structure to initialize.
3196  * \param guide Source connected line to use as a guide in initializing.
3197  *
3198  * \return Nothing
3199  */
3200 void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
3201
3202 /*!
3203  * \since 1.8
3204  * \brief Set the connected line information based on another connected line source
3205  *
3206  * This is similar to ast_party_connected_line_copy, except that NULL values for
3207  * strings in the src parameter indicate not to update the corresponding dest values.
3208  *
3209  * \param dest The connected line one wishes to update
3210  * \param src The new connected line values to update the dest
3211  * \param update What connected line information to update.  NULL if all.
3212  *
3213  * \return Nothing
3214  */
3215 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);
3216
3217 /*!
3218  * \since 1.8
3219  * \brief Collect the caller party information into a connected line structure.
3220  *
3221  * \param connected Collected caller information for the connected line
3222  * \param caller Caller information.
3223  *
3224  * \return Nothing
3225  *
3226  * \warning This is a shallow copy.
3227  * \warning DO NOT call ast_party_connected_line_free() on the filled in
3228  * connected line structure!
3229  */
3230 void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_party_caller *caller);
3231
3232 /*!
3233  * \since 1.8
3234  * \brief Destroy the connected line information contents
3235  *
3236  * \param doomed The connected line information to destroy.
3237  *
3238  * \return Nothing
3239  */
3240 void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
3241
3242 /*!
3243  * \brief Initialize the given redirecting structure.
3244  * \since 1.8
3245  *
3246  * \param init Redirecting structure to initialize.
3247  *
3248  * \return Nothing
3249  */
3250 void ast_party_redirecting_init(struct ast_party_redirecting *init);
3251
3252 /*!
3253  * \since 1.8
3254  * \brief Copy the source redirecting information to the destination redirecting.
3255  *
3256  * \param dest Destination redirecting
3257  * \param src Source redirecting
3258  *
3259  * \return Nothing
3260  */
3261 void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
3262
3263 /*!
3264  * \since 1.8
3265  * \brief Initialize the given redirecting id structure using the given guide
3266  * for a set update operation.
3267  *
3268  * \details
3269  * The initialization is needed to allow a set operation to know if a
3270  * value needs to be updated.  Simple integers need the guide's original
3271  * value in case the set operation is not trying to set a new value.
3272  * String values are simply set to NULL pointers if they are not going
3273  * to be updated.
3274  *
3275  * \param init Redirecting id structure to initialize.
3276  * \param guide Source redirecting id to use as a guide in initializing.
3277  *
3278  * \return Nothing
3279  */
3280 void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
3281
3282 /*!
3283  * \brief Set the redirecting information based on another redirecting source
3284  * \since 1.8
3285  *
3286  * This is similar to ast_party_redirecting_copy, except that NULL values for
3287  * strings in the src parameter indicate not to update the corresponding dest values.
3288  *
3289  * \param dest The redirecting one wishes to update
3290  * \param src The new redirecting values to update the dest
3291  * \param update What redirecting information to update.  NULL if all.
3292  *
3293  * \return Nothing
3294  */
3295 void ast_party_redirecting_set(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src, const struct ast_set_party_redirecting *update);
3296
3297 /*!
3298  * \since 1.8
3299  * \brief Destroy the redirecting information contents
3300  *
3301  * \param doomed The redirecting information to destroy.
3302  *
3303  * \return Nothing
3304  */
3305 void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
3306
3307 /*!
3308  * \since 1.8
3309  * \brief Copy the caller information to the connected line information.
3310  *
3311  * \param dest Destination connected line information
3312  * \param src Source caller information
3313  *
3314  * \return Nothing
3315  *
3316  * \note Assumes locks are already acquired
3317  */
3318 void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_party_caller *src);
3319
3320 /*!
3321  * \since 1.8
3322  * \brief Copy the connected line information to the caller information.
3323  *
3324  * \param dest Destination caller information
3325  * \param src Source connected line information
3326  *
3327  * \return Nothing
3328  *
3329  * \note Assumes locks are already acquired
3330  */
3331 void ast_connected_line_copy_to_caller(struct ast_party_caller *dest, const struct ast_party_connected_line *src);
3332
3333 /*!
3334  * \since 1.8
3335  * \brief Set the connected line information in the Asterisk channel
3336  *
3337  * \param chan Asterisk channel to set connected line information
3338  * \param connected Connected line information
3339  * \param update What connected line information to update.  NULL if all.
3340  *
3341  * \return Nothing
3342  *
3343  * \note The channel does not need to be locked before calling this function.
3344  */
3345 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);
3346
3347 /*!
3348  * \since 1.8
3349  * \brief Build the connected line information data frame.
3350  *
3351  * \param data Buffer to fill with the frame data
3352  * \param datalen Size of the buffer to fill
3353  * \param connected Connected line information
3354  * \param update What connected line information to build.  NULL if all.
3355  *
3356  * \retval -1 if error
3357  * \retval Amount of data buffer used
3358  */
3359 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);
3360
3361 /*!
3362  * \since 1.8
3363  * \brief Parse connected line indication frame data
3364  *
3365  * \param data Buffer with the frame data to parse
3366  * \param datalen Size of the buffer
3367  * \param connected Extracted connected line information
3368  *
3369  * \retval 0 on success.
3370  * \retval -1 on error.
3371  *
3372  * \note The filled in connected line structure needs to be initialized by
3373  * ast_party_connected_line_set_init() before calling.  If defaults are not
3374  * required use ast_party_connected_line_init().
3375  * \note The filled in connected line structure needs to be destroyed by
3376  * ast_party_connected_line_free() when it is no longer needed.
3377  */
3378 int ast_connected_line_parse_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
3379
3380 /*!
3381  * \since 1.8
3382  * \brief Indicate that the connected line information has changed
3383  *
3384  * \param chan Asterisk channel to indicate connected line information
3385  * \param connected Connected line information
3386  * \param update What connected line information to update.  NULL if all.
3387  *
3388  * \return Nothing
3389  */
3390 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);
3391
3392 /*!
3393  * \since 1.8
3394  * \brief Queue a connected line update frame on a channel
3395  *
3396  * \param chan Asterisk channel to indicate connected line information
3397  * \param connected Connected line information
3398  * \param update What connected line information to update.  NULL if all.
3399  *
3400  * \return Nothing
3401  */
3402 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);
3403
3404 /*!
3405  * \since 1.8
3406  * \brief Set the redirecting id information in the Asterisk channel
3407  *
3408  * \param chan Asterisk channel to set redirecting id information
3409  * \param redirecting Redirecting id information
3410  * \param update What redirecting information to update.  NULL if all.
3411  *
3412  * \return Nothing
3413  *
3414  * \note The channel does not need to be locked before calling this function.
3415  */
3416 void ast_channel_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3417
3418 /*!
3419  * \since 1.8
3420  * \brief Build the redirecting id data frame.
3421  *
3422  * \param data Buffer to fill with the frame data
3423  * \param datalen Size of the buffer to fill
3424  * \param redirecting Redirecting id information
3425  * \param update What redirecting information to build.  NULL if all.
3426  *
3427  * \retval -1 if error
3428  * \retval Amount of data buffer used
3429  */
3430 int ast_redirecting_build_data(unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3431
3432 /*!
3433  * \since 1.8
3434  * \brief Parse redirecting indication frame data
3435  *
3436  * \param data Buffer with the frame data to parse
3437  * \param datalen Size of the buffer
3438  * \param redirecting Extracted redirecting id information
3439  *
3440  * \retval 0 on success.
3441  * \retval -1 on error.
3442  *
3443  * \note The filled in id structure needs to be initialized by
3444  * ast_party_redirecting_set_init() before calling.
3445  * \note The filled in id structure needs to be destroyed by
3446  * ast_party_redirecting_free() when it is no longer needed.
3447  */
3448 int ast_redirecting_parse_data(const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting);
3449
3450 /*!
3451  * \since 1.8
3452  * \brief Indicate that the redirecting id has changed
3453  *
3454  * \param chan Asterisk channel to indicate redirecting id information
3455  * \param redirecting Redirecting id information
3456  * \param update What redirecting information to update.  NULL if all.
3457  *
3458  * \return Nothing
3459  */
3460 void ast_channel_update_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3461
3462 /*!
3463  * \since 1.8
3464  * \brief Queue a redirecting update frame on a channel
3465  *
3466  * \param chan Asterisk channel to indicate redirecting id information
3467  * \param redirecting Redirecting id information
3468  * \param update What redirecting information to update.  NULL if all.
3469  *
3470  * \return Nothing
3471  */
3472 void ast_channel_queue_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3473
3474 /*!
3475  * \since 1.8
3476  * \brief Run a connected line interception macro and update a channel's connected line
3477  * information
3478  * \deprecated You should use the ast_channel_connected_line_sub() function instead.
3479  *
3480  * Whenever we want to update a channel's connected line information, we may need to run
3481  * a macro so that an administrator can manipulate the information before sending it
3482  * out. This function both runs the macro and sends the update to the channel.
3483  *
3484  * \param autoservice_chan Channel to place into autoservice while the macro is running.
3485  * It is perfectly safe for this to be NULL
3486  * \param macro_chan The channel to run the macro on. Also the channel from which we
3487  * determine which macro we need to run.
3488  * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type
3489  * AST_CONTROL_CONNECTED_LINE
3490  * \param is_caller If true, then run CONNECTED_LINE_CALLER_SEND_MACRO with arguments from
3491  * CONNECTED_LINE_CALLER_SEND_MACRO_ARGS, otherwise run CONNECTED_LINE_CALLEE_SEND_MACRO
3492  * with arguments from CONNECTED_LINE_CALLEE_SEND_MACRO_ARGS
3493  * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an
3494  * ast_party_connected_line pointer.
3495  * \retval 0 Success
3496  * \retval -1 Either the macro does not exist, or there was an error while attempting to
3497  * run the macro
3498  *
3499  * \todo Have multiple return codes based on the MACRO_RESULT
3500  * \todo Make constants so that caller and frame can be more expressive than just '1' and
3501  * '0'
3502  */
3503 int ast_channel_connected_line_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const void *connected_info, int is_caller, int frame);
3504
3505 /*!
3506  * \since 11
3507  * \brief Run a connected line interception subroutine and update a channel's connected line
3508  * information
3509  *
3510  * Whenever we want to update a channel's connected line information, we may need to run
3511  * a subroutine so that an administrator can manipulate the information before sending it
3512  * out. This function both runs the subroutine specified by CONNECTED_LINE_SEND_SUB and
3513  * sends the update to the channel.
3514  *
3515  * \param autoservice_chan Channel to place into autoservice while the sub is running.
3516  * It is perfectly safe for this to be NULL
3517  * \param sub_chan The channel to run the subroutine on. Also the channel from which we
3518  * determine which subroutine we need to run.
3519  * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type
3520  * AST_CONTROL_CONNECTED_LINE
3521  * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an
3522  * ast_party_connected_line pointer.
3523  * \retval 0 Success
3524  * \retval -1 Either the subroutine does not exist, or there was an error while attempting to
3525  * run the subroutine
3526  */
3527 int ast_channel_connected_line_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *connected_info, int frame);
3528
3529 /*!
3530  * \brief Insert into an astdata tree, the channel structure.
3531  * \param[in] tree The ast data tree.
3532  * \param[in] chan The channel structure to add to tree.
3533  * \param[in] add_bridged Add the bridged channel to the structure.
3534  * \retval <0 on error.
3535  * \retval 0 on success.
3536  */
3537 int ast_channel_data_add_structure(struct ast_data *tree, struct ast_channel *chan, int add_bridged);
3538
3539 /*!
3540  * \brief Compare to channel structures using the data api.
3541  * \param[in] tree The search tree generated by the data api.
3542  * \param[in] chan The channel to compare.
3543  * \param[in] structure_name The name of the node of the channel structure.
3544  * \retval 0 The structure matches.
3545  * \retval 1 The structure doesn't matches.
3546  */
3547 int ast_channel_data_cmp_structure(const struct ast_data_search *tree, struct ast_channel *chan,
3548         const char *structure_name);
3549
3550 /*!
3551  * \since 1.8
3552  * \brief Run a redirecting interception macro and update a channel's redirecting information
3553  * \deprecated You should use the ast_channel_redirecting_sub() function instead.
3554  *
3555  * \details
3556  * Whenever we want to update a channel's redirecting information, we may need to run
3557  * a macro so that an administrator can manipulate the information before sending it
3558  * out. This function both runs the macro and sends the update to the channel.
3559  *
3560  * \param autoservice_chan Channel to place into autoservice while the macro is running.
3561  * It is perfectly safe for this to be NULL
3562  * \param macro_chan The channel to run the macro on. Also the channel from which we
3563  * determine which macro we need to run.
3564  * \param redirecting_info Either an ast_party_redirecting or ast_frame pointer of type
3565  * AST_CONTROL_REDIRECTING
3566  * \param is_caller If true, then run REDIRECTING_CALLER_SEND_MACRO with arguments from
3567  * REDIRECTING_CALLER_SEND_MACRO_ARGS, otherwise run REDIRECTING_CALLEE_SEND_MACRO with
3568  * arguments from REDIRECTING_CALLEE_SEND_MACRO_ARGS
3569  * \param is_frame If true, then redirecting_info is an ast_frame pointer, otherwise it is an
3570  * ast_party_redirecting pointer.
3571  *
3572  * \retval 0 Success
3573  * \retval -1 Either the macro does not exist, or there was an error while attempting to
3574  * run the macro
3575  *
3576  * \todo Have multiple return codes based on the MACRO_RESULT
3577  * \todo Make constants so that caller and frame can be more expressive than just '1' and
3578  * '0'
3579  */
3580 int ast_channel_redirecting_macro(struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const void *redirecting_info, int is_caller, int is_frame);
3581
3582 /*!
3583  * \since 11
3584  * \brief Run a redirecting interception subroutine and update a channel's redirecting information
3585  *
3586  * \details
3587  * Whenever we want to update a channel's redirecting information, we may need to run
3588  * a subroutine so that an administrator can manipulate the information before sending it
3589  * out. This function both runs the subroutine specified by REDIRECTING_SEND_SUB and
3590  * sends the update to the channel.
3591  *
3592  * \param autoservice_chan Channel to place into autoservice while the subroutine is running.
3593  * It is perfectly safe for this to be NULL
3594  * \param sub_chan The channel to run the subroutine on. Also the channel from which we
3595  * determine which subroutine we need to run.
3596  * \param redirecting_info Either an ast_party_redirecting or ast_frame pointer of type
3597  * AST_CONTROL_REDIRECTING
3598  * \param is_frame If true, then redirecting_info is an ast_frame pointer, otherwise it is an
3599  * ast_party_redirecting pointer.
3600  *
3601  * \retval 0 Success
3602  * \retval -1 Either the subroutine does not exist, or there was an error while attempting to
3603  * run the subroutine
3604  */
3605 int ast_channel_redirecting_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *redirecting_info, int is_frame);
3606
3607 #include "asterisk/ccss.h"
3608
3609 /*!
3610  * \since 1.8
3611  * \brief Set up datastore with CCSS parameters for a channel
3612  *
3613  * \note
3614  * If base_params is NULL, the channel will get the default
3615  * values for all CCSS parameters.
3616  *
3617  * \details
3618  * This function makes use of datastore operations on the channel, so
3619  * it is important to lock the channel before calling this function.
3620  *
3621  * \param chan The channel to create the datastore on
3622  * \param base_params CCSS parameters we wish to copy into the channel
3623  * \retval 0 Success
3624  * \retval -1 Failure
3625  */
3626 int ast_channel_cc_params_init(struct ast_channel *chan,
3627                 const struct ast_cc_config_params *base_params);
3628
3629 /*!
3630  * \since 1.8
3631  * \brief Get the CCSS parameters from a channel
3632  *
3633  * \details
3634  * This function makes use of datastore operations on the channel, so
3635  * it is important to lock the channel before calling this function.
3636  *
3637  * \param chan Channel to retrieve parameters from
3638  * \retval NULL Failure
3639  * \retval non-NULL The parameters desired
3640  */
3641 struct ast_cc_config_params *ast_channel_get_cc_config_params(struct ast_channel *chan);
3642
3643
3644 /*!
3645  * \since 1.8
3646  * \brief Get a device name given its channel structure
3647  *
3648  * \details
3649  * A common practice in Asterisk is to determine the device being talked
3650  * to by dissecting the channel name. For certain channel types, this is not
3651  * accurate. For instance, an ISDN channel is named based on what B channel is
3652  * used, not the device being communicated with.
3653  *
3654  * This function interfaces with a channel tech's queryoption callback to
3655  * retrieve the name of the device being communicated with. If the channel does not
3656  * implement this specific option, then the traditional method of using the channel
3657  * name is used instead.
3658  *
3659  * \param chan The channel to retrieve the information from
3660  * \param[out] device_name The buffer to place the device's name into
3661  * \param name_buffer_length The allocated space for the device_name
3662  * \return 0 always
3663  */
3664 int ast_channel_get_device_name(struct ast_channel *chan, char *device_name, size_t name_buffer_length);
3665
3666 /*!
3667  * \since 1.8
3668  * \brief Find the appropriate CC agent type to use given a channel
3669  *
3670  * \details
3671  * During call completion, we will need to create a call completion agent structure. To
3672  * figure out the type of agent to construct, we need to ask the channel driver for the
3673  * appropriate type.
3674  *
3675  * Prior to adding this function, the call completion core attempted to figure this
3676  * out for itself by stripping the technology off the channel's name. However, in the
3677  * case of chan_dahdi, there are multiple agent types registered, and so simply searching
3678  * for an agent type called "DAHDI" is not possible. In a case where multiple agent types
3679  * are defined, the channel driver must have a queryoption callback defined in its
3680  * channel_tech, and the queryoption callback must handle AST_OPTION_CC_AGENT_TYPE
3681  *
3682  * If a channel driver does not have a queryoption callback or if the queryoption callback
3683  * does not handle AST_OPTION_CC_AGENT_TYPE, then the old behavior of using the technology
3684  * portion of the channel name is used instead. This is perfectly suitable for channel drivers
3685  * whose channel technologies are a one-to-one match with the agent types defined within.
3686  *
3687  * Note that this function is only called when the agent policy on a given channel is set
3688  * to "native." Generic agents' type can be determined automatically by the core.
3689  *
3690  * \param chan The channel for which we wish to retrieve the agent type
3691  * \param[out] agent_type The type of agent the channel driver wants us to use
3692  * \param size The size of the buffer to write to
3693  */
3694 int ast_channel_get_cc_agent_type(struct ast_channel *chan, char *agent_type, size_t size);
3695 #if defined(__cplusplus) || defined(c_plusplus)
3696 }
3697 #endif
3698
3699 /*!
3700  * \brief Remove a channel from the global channels container
3701  *
3702  * \param chan channel to remove
3703  *
3704  * In a case where it is desired that a channel not be available in any lookups
3705  * in the global channels conatiner, use this function.
3706  */
3707 void ast_channel_unlink(struct ast_channel *chan);
3708
3709 /*!
3710  * \brief Sets the HANGUPCAUSE hash and optionally the SIP_CAUSE hash 
3711  * on the given channel
3712  *
3713  * \param chan channel on which to set the cause information
3714  * \param cause_code ast_control_pvt_cause_code structure containing cause information
3715  * \param datalen total length of the structure since it may vary
3716  */
3717 void ast_channel_hangupcause_hash_set(struct ast_channel *chan, const struct ast_control_pvt_cause_code *cause_code, int datalen);
3718
3719 /* ACCESSOR FUNTIONS */
3720 /*! \brief Set the channel name */
3721 void ast_channel_name_set(struct ast_channel *chan, const char *name);
3722
3723 #define DECLARE_STRINGFIELD_SETTERS_FOR(field)  \
3724         void ast_channel_##field##_set(struct ast_channel *chan, const char *field); \
3725         void ast_channel_##field##_build_va(struct ast_channel *chan, const char *fmt, va_list ap) __attribute__((format(printf, 2, 0))); \
3726         void ast_channel_##field##_build(struct ast_channel *chan, const char *fmt, ...) __attribute__((format(printf, 2, 3)))
3727
3728 DECLARE_STRINGFIELD_SETTERS_FOR(name);
3729 DECLARE_STRINGFIELD_SETTERS_FOR(language);
3730 DECLARE_STRINGFIELD_SETTERS_FOR(musicclass);
3731 DECLARE_STRINGFIELD_SETTERS_FOR(accountcode);
3732 DECLARE_STRINGFIELD_SETTERS_FOR(peeraccount);
3733 DECLARE_STRINGFIELD_SETTERS_FOR(userfield);
3734 DECLARE_STRINGFIELD_SETTERS_FOR(call_forward);
3735 DECLARE_STRINGFIELD_SETTERS_FOR(uniqueid);
3736 DECLARE_STRINGFIELD_SETTERS_FOR(linkedid);
3737 DECLARE_STRINGFIELD_SETTERS_FOR(parkinglot);
3738 DECLARE_STRINGFIELD_SETTERS_FOR(hangupsource);
3739 DECLARE_STRINGFIELD_SETTERS_FOR(dialcontext);
3740
3741 const char *ast_channel_name(const struct ast_channel *chan);
3742 const char *ast_channel_language(const struct ast_channel *chan);
3743 const char *ast_channel_musicclass(const struct ast_channel *chan);
3744 const char *ast_channel_accountcode(const struct ast_channel *chan);
3745 const char *ast_channel_peeraccount(const struct ast_channel *chan);
3746 const char *ast_channel_userfield(const struct ast_channel *chan);
3747 const char *ast_channel_call_forward(const struct ast_channel *chan);
3748 const char *ast_channel_uniqueid(const struct ast_channel *chan);
3749 const char *ast_channel_linkedid(const struct ast_channel *chan);
3750 const char *ast_channel_parkinglot(const struct ast_channel *chan);
3751 const char *ast_channel_hangupsource(const struct ast_channel *chan);
3752 const char *ast_channel_dialcontext(const struct ast_channel *chan);
3753
3754 const char *ast_channel_appl(const struct ast_channel *chan);
3755 void ast_channel_appl_set(struct ast_channel *chan, const char *value);
3756 const char *ast_channel_blockproc(const struct ast_channel *chan);
3757 void ast_channel_blockproc_set(struct ast_channel *chan, const char *value);
3758 const char *ast_channel_data(const struct ast_channel *chan);
3759 void ast_channel_data_set(struct ast_channel *chan, const char *value);
3760
3761 const char *ast_channel_context(const struct ast_channel *chan);
3762 void ast_channel_context_set(struct ast_channel *chan, const char *value);
3763 const char *ast_channel_exten(const struct ast_channel *chan);
3764 void ast_channel_exten_set(struct ast_channel *chan, const char *value);
3765 const char *ast_channel_macrocontext(const struct ast_channel *chan);
3766 void ast_channel_macrocontext_set(struct ast_channel *chan, const char *value);
3767 const char *ast_channel_macroexten(const struct ast_channel *chan);
3768 void ast_channel_macroexten_set(struct ast_channel *chan, const char *value);
3769
3770 char ast_channel_dtmf_digit_to_emulate(const struct ast_channel *chan);
3771 void ast_channel_dtmf_digit_to_emulate_set(struct ast_channel *chan, char value);
3772 int ast_channel_amaflags(const struct ast_channel *chan);
3773 void ast_channel_amaflags_set(struct ast_channel *chan, int value);
3774 int ast_channel_epfd(const struct ast_channel *chan);
3775 void ast_channel_epfd_set(struct ast_channel *chan, int value);
3776 int ast_channel_fdno(const struct ast_channel *chan);
3777 void ast_channel_fdno_set(struct ast_channel *chan, int value);
3778 int ast_channel_hangupcause(const struct ast_channel *chan);
3779 void ast_channel_hangupcause_set(struct ast_channel *chan, int value);
3780 int ast_channel_macropriority(const struct ast_channel *chan);
3781 void ast_channel_macropriority_set(struct ast_channel *chan, int value);
3782 int ast_channel_priority(const struct ast_channel *chan);
3783 void ast_channel_priority_set(struct ast_channel *chan, int value);
3784 int ast_channel_rings(const struct ast_channel *chan);
3785 void ast_channel_rings_set(struct ast_channel *chan, int value);
3786 int ast_channel_streamid(const struct ast_channel *chan);
3787 void ast_channel_streamid_set(struct ast_channel *chan, int value);
3788 int ast_channel_timingfd(const struct ast_channel *chan);
3789 void ast_channel_timingfd_set(struct ast_channel *chan, int value);
3790 int ast_channel_visible_indication(const struct ast_channel *chan);
3791 void ast_channel_visible_indication_set(struct ast_channel *chan, int value);
3792 int ast_channel_vstreamid(const struct ast_channel *chan);
3793 void ast_channel_vstreamid_set(struct ast_channel *chan, int value);
3794 unsigned short ast_channel_transfercapability(const struct ast_channel *chan);
3795 void ast_channel_transfercapability_set(struct ast_channel *chan, unsigned short value);
3796 unsigned int ast_channel_emulate_dtmf_duration(const struct ast_channel *chan);
3797 void ast_channel_emulate_dtmf_duration_set(struct ast_channel *chan, unsigned int value);
3798 unsigned int ast_channel_fin(const struct ast_channel *chan);
3799 void ast_channel_fin_set(struct ast_channel *chan, unsigned int value);
3800 unsigned int ast_channel_fout(const struct ast_channel *chan);
3801 void ast_channel_fout_set(struct ast_channel *chan, unsigned int value);
3802 unsigned long ast_channel_insmpl(const struct ast_channel *chan);
3803 void ast_channel_insmpl_set(struct ast_channel *chan, unsigned long value);
3804 unsigned long ast_channel_outsmpl(const struct ast_channel *chan);
3805 void ast_channel_outsmpl_set(struct ast_channel *chan, unsigned long value);
3806 void *ast_channel_generatordata(const struct ast_channel *chan);
3807 void ast_channel_generatordata_set(struct ast_channel *chan, void *value);
3808 void *ast_channel_music_state(const struct ast_channel *chan);
3809 void ast_channel_music_state_set(struct ast_channel *chan, void *value);
3810 void *ast_channel_tech_pvt(const struct ast_channel *chan);
3811 void ast_channel_tech_pvt_set(struct ast_channel *chan, void *value);
3812 void *ast_channel_timingdata(const struct ast_channel *chan);
3813 void ast_channel_timingdata_set(struct ast_channel *chan, void *value);
3814 struct ast_audiohook_list *ast_channel_audiohooks(const struct ast_channel *chan);
3815 void ast_channel_audiohooks_set(struct ast_channel *chan, struct ast_audiohook_list *value);
3816 struct ast_cdr *ast_channel_cdr(const struct ast_channel *chan);
3817 void ast_channel_cdr_set(struct ast_channel *chan, struct ast_cdr *value);
3818 struct ast_channel *ast_channel__bridge(const struct ast_channel *chan);
3819 void ast_channel__bridge_set(struct ast_channel *chan, struct ast_channel *value);
3820 struct ast_channel *ast_channel_masq(const struct ast_channel *chan);
3821 void ast_channel_masq_set(struct ast_channel *chan, struct ast_channel *value);
3822 struct ast_channel *ast_channel_masqr(const struct ast_channel *chan);
3823 void ast_channel_masqr_set(struct ast_channel *chan, struct ast_channel *value);
3824 struct ast_channel_monitor *ast_channel_monitor(const struct ast_channel *chan);
3825 void ast_channel_monitor_set(struct ast_channel *chan, struct ast_channel_monitor *value);
3826 struct ast_filestream *ast_channel_stream(const struct ast_channel *chan);
3827 void ast_channel_stream_set(struct ast_channel *chan, struct ast_filestream *value);
3828 struct ast_filestream *ast_channel_vstream(const struct ast_channel *chan);
3829 void ast_channel_vstream_set(struct ast_channel *chan, struct ast_filestream *value);
3830 struct ast_format_cap *ast_channel_nativeformats(const struct ast_channel *chan);
3831 void ast_channel_nativeformats_set(struct ast_channel *chan, struct ast_format_cap *value);
3832 struct ast_framehook_list *ast_channel_framehooks(const struct ast_channel *chan);
3833 void ast_channel_framehooks_set(struct ast_channel *chan, struct ast_framehook_list *value);
3834 struct ast_generator *ast_channel_generator(const struct ast_channel *chan);
3835 void ast_channel_generator_set(struct ast_channel *chan, struct ast_generator *value);
3836 struct ast_pbx *ast_channel_pbx(const struct ast_channel *chan);
3837 void ast_channel_pbx_set(struct ast_channel *chan, struct ast_pbx *value);
3838 struct ast_sched_context *ast_channel_sched(const struct ast_channel *chan);
3839 void ast_channel_sched_set(struct ast_channel *chan, struct ast_sched_context *value);
3840 struct ast_timer *ast_channel_timer(const struct ast_channel *chan);
3841 void ast_channel_timer_set(struct ast_channel *chan, struct ast_timer *value);
3842 struct ast_tone_zone *ast_channel_zone(const struct ast_channel *chan);
3843 void ast_channel_zone_set(struct ast_channel *chan, struct ast_tone_zone *value);
3844 struct ast_trans_pvt *ast_channel_readtrans(const struct ast_channel *chan);
3845 void ast_channel_readtrans_set(struct ast_channel *chan, struct ast_trans_pvt *value);
3846 struct ast_trans_pvt *ast_channel_writetrans(const struct ast_channel *chan);
3847 void ast_channel_writetrans_set(struct ast_channel *chan, struct ast_trans_pvt *value);
3848 const struct ast_channel_tech *ast_channel_tech(const struct ast_channel *chan);
3849 void ast_channel_tech_set(struct ast_channel *chan, const struct ast_channel_tech *value);
3850 enum ast_channel_adsicpe ast_channel_adsicpe(const struct ast_channel *chan);
3851 void ast_channel_adsicpe_set(struct ast_channel *chan, enum ast_channel_adsicpe value);
3852 enum ast_channel_state ast_channel_state(const struct ast_channel *chan);
3853 struct ast_callid *ast_channel_callid(const struct ast_channel *chan);
3854 void ast_channel_callid_set(struct ast_channel *chan, struct ast_callid *value);
3855
3856 /* XXX Internal use only, make sure to move later */
3857 void ast_channel_state_set(struct ast_channel *chan, enum ast_channel_state);
3858 void ast_channel_softhangup_internal_flag_set(struct ast_channel *chan, int value);
3859 void ast_channel_softhangup_internal_flag_add(struct ast_channel *chan, int value);
3860 void ast_channel_softhangup_internal_flag_clear(struct ast_channel *chan, int value);
3861 void ast_channel_callid_cleanup(struct ast_channel *chan);
3862 int ast_channel_softhangup_internal_flag(struct ast_channel *chan);
3863
3864 /* Format getters */
3865 struct ast_format *ast_channel_oldwriteformat(struct ast_channel *chan);
3866 struct ast_format *ast_channel_rawreadformat(struct ast_channel *chan);
3867 struct ast_format *ast_channel_rawwriteformat(struct ast_channel *chan);
3868 struct ast_format *ast_channel_readformat(struct ast_channel *chan);
3869 struct ast_format *ast_channel_writeformat(struct ast_channel *chan);
3870
3871 /* Other struct getters */
3872 struct ast_frame *ast_channel_dtmff(struct ast_channel *chan);
3873 struct ast_jb *ast_channel_jb(struct ast_channel *chan);
3874 struct ast_party_caller *ast_channel_caller(struct ast_channel *chan);
3875 struct ast_party_connected_line *ast_channel_connected(struct ast_channel *chan);
3876 struct ast_party_id ast_channel_connected_effective_id(struct ast_channel *chan);
3877 struct ast_party_dialed *ast_channel_dialed(struct ast_channel *chan);
3878 struct ast_party_redirecting *ast_channel_redirecting(struct ast_channel *chan);
3879 struct ast_party_id ast_channel_redirecting_effective_orig(struct ast_channel *chan);
3880 struct ast_party_id ast_channel_redirecting_effective_from(struct ast_channel *chan);
3881 struct ast_party_id ast_channel_redirecting_effective_to(struct ast_channel *chan);
3882 struct timeval *ast_channel_dtmf_tv(struct ast_channel *chan);
3883 struct timeval *ast_channel_whentohangup(struct ast_channel *chan);
3884 struct varshead *ast_channel_varshead(struct ast_channel *chan);
3885
3886 void ast_channel_dtmff_set(struct ast_channel *chan, struct ast_frame *value);
3887 void ast_channel_jb_set(struct ast_channel *chan, struct ast_jb *value);
3888 void ast_channel_caller_set(struct ast_channel *chan, struct ast_party_caller *value);
3889 void ast_channel_connected_set(struct ast_channel *chan, struct ast_party_connected_line *value);
3890 void ast_channel_dialed_set(struct ast_channel *chan, struct ast_party_dialed *value);
3891 void ast_channel_redirecting_set(struct ast_channel *chan, struct ast_party_redirecting *value);
3892 void ast_channel_dtmf_tv_set(struct ast_channel *chan, struct timeval *value);
3893 void ast_channel_whentohangup_set(struct ast_channel *chan, struct timeval *value);
3894 void ast_channel_varshead_set(struct ast_channel *chan, struct varshead *value);
3895 struct timeval ast_channel_creationtime(struct ast_channel *chan);
3896 void ast_channel_creationtime_set(struct ast_channel *chan, struct timeval *value);
3897
3898 /* List getters */
3899 struct ast_hangup_handler_list *ast_channel_hangup_handlers(struct ast_channel *chan);
3900 struct ast_datastore_list *ast_channel_datastores(struct ast_channel *chan);
3901 struct ast_autochan_list *ast_channel_autochans(struct ast_channel *chan);
3902 struct ast_readq_list *ast_channel_readq(struct ast_channel *chan);
3903
3904 /* Typedef accessors */
3905 ast_group_t ast_channel_callgroup(const struct ast_channel *chan);
3906 void ast_channel_callgroup_set(struct ast_channel *chan, ast_group_t value);
3907 ast_group_t ast_channel_pickupgroup(const struct ast_channel *chan);
3908 void ast_channel_pickupgroup_set(struct ast_channel *chan, ast_group_t value);
3909 struct ast_namedgroups *ast_channel_named_callgroups(const struct ast_channel *chan);
3910 void ast_channel_named_callgroups_set(struct ast_channel *chan, struct ast_namedgroups *value);
3911 struct ast_namedgroups *ast_channel_named_pickupgroups(const struct ast_channel *chan);
3912 void ast_channel_named_pickupgroups_set(struct ast_channel *chan, struct ast_namedgroups *value);
3913
3914 /* Alertpipe accessors--the "internal" functions for channel.c use only */
3915 typedef enum {
3916         AST_ALERT_READ_SUCCESS = 0,
3917         AST_ALERT_NOT_READABLE,
3918         AST_ALERT_READ_FAIL,
3919         AST_ALERT_READ_FATAL,
3920 } ast_alert_status_t;
3921 int ast_channel_alert_write(struct ast_channel *chan);
3922 int ast_channel_alert_writable(struct ast_channel *chan);
3923 ast_alert_status_t ast_channel_internal_alert_read(struct ast_channel *chan);
3924 int ast_channel_internal_alert_readable(struct ast_channel *chan);
3925 void ast_channel_internal_alertpipe_clear(struct ast_channel *chan);
3926 void ast_channel_internal_alertpipe_close(struct ast_channel *chan);
3927 int ast_channel_internal_alert_readfd(struct ast_channel *chan);
3928 int ast_channel_internal_alertpipe_init(struct ast_channel *chan);
3929 /*! \brief Swap the interal alertpipe between two channels
3930  * \note Handle all of the necessary locking before calling this
3931  */
3932 void ast_channel_internal_alertpipe_swap(struct ast_channel *chan1, struct ast_channel *chan2);
3933
3934 /* file descriptor array accessors */
3935 void ast_channel_internal_fd_clear(struct ast_channel *chan, int which);
3936 void ast_channel_internal_fd_clear_all(struct ast_channel *chan);
3937 void ast_channel_internal_fd_set(struct ast_channel *chan, int which, int value);
3938 int ast_channel_fd(const struct ast_channel *chan, int which);
3939 int ast_channel_fd_isset(const struct ast_channel *chan, int which);
3940
3941 /* epoll data internal accessors */
3942 #ifdef HAVE_EPOLL
3943 struct ast_epoll_data *ast_channel_internal_epfd_data(const struct ast_channel *chan, int which);
3944 void ast_channel_internal_epfd_data_set(struct ast_channel *chan, int which , struct ast_epoll_data *value);
3945 #endif
3946
3947 pthread_t ast_channel_blocker(const struct ast_channel *chan);
3948 void ast_channel_blocker_set(struct ast_channel *chan, pthread_t value);
3949
3950 ast_timing_func_t ast_channel_timingfunc(const struct ast_channel *chan);
3951 void ast_channel_timingfunc_set(struct ast_channel *chan, ast_timing_func_t value);
3952
3953 struct ast_bridge *ast_channel_internal_bridge(const struct ast_channel *chan);
3954 void ast_channel_internal_bridge_set(struct ast_channel *chan, struct ast_bridge *value);
3955
3956 struct ast_channel *ast_channel_internal_bridged_channel(const struct ast_channel *chan);
3957 void ast_channel_internal_bridged_channel_set(struct ast_channel *chan, struct ast_channel *value);
3958
3959 /*!
3960  * \since 11
3961  * \brief Retreive a comma-separated list of channels for which dialed cause information is available
3962  *
3963  * \details
3964  * This function makes use of datastore operations on the channel, so
3965  * it is important to lock the channel before calling this function.
3966  *
3967  * \param chan The channel from which to retreive information
3968  * \retval NULL on allocation failure
3969  * \retval Pointer to an ast_str object containing the desired information which must be freed
3970  */
3971 struct ast_str *ast_channel_dialed_causes_channels(const struct ast_channel *chan);
3972
3973 /*!
3974  * \since 11
3975  * \brief Retreive a ref-counted cause code information structure
3976  *
3977  * \details
3978  * This function makes use of datastore operations on the channel, so
3979  * it is important to lock the channel before calling this function.
3980  * This function increases the ref count of the returned object, so the
3981  * calling function must decrease the reference count when it is finished
3982  * with the object.
3983  *
3984  * \param chan The channel from which to retreive information
3985  * \param chan_name The name of the channel about which to retreive information
3986  * \retval NULL on search failure
3987  * \retval Pointer to a ref-counted ast_control_pvt_cause_code object containing the desired information
3988  */
3989 struct ast_control_pvt_cause_code *ast_channel_dialed_causes_find(const struct ast_channel *chan, const char *chan_name);
3990
3991 /*!
3992  * \since 11
3993  * \brief Add cause code information to the channel
3994  *
3995  * \details
3996  * This function makes use of datastore operations on the channel, so
3997  * it is important to lock the channel before calling this function.
3998  * The passed in data is copied and so is still owned by the caller.
3999  *
4000  * \param chan The channel on which to add information
4001  * \param cause_code The cause information to be added to the channel
4002  * \param datalen The total length of the structure since its length is variable
4003  * \retval 0 on success
4004  * \retval -1 on error
4005  */
4006 int ast_channel_dialed_causes_add(const struct ast_channel *chan, const struct ast_control_pvt_cause_code *cause_code, int datalen);
4007
4008 /*!
4009  * \since 11
4010  * \brief Clear all cause information from the channel
4011  *
4012  * \details
4013  * This function makes use of datastore operations on the channel, so
4014  * it is important to lock the channel before calling this function.
4015  *
4016  * \param chan The channel from which to clear information
4017  */
4018 void ast_channel_dialed_causes_clear(const struct ast_channel *chan);
4019
4020 struct ast_flags *ast_channel_flags(struct ast_channel *chan);
4021 #endif /* _ASTERISK_CHANNEL_H */