add 'systemname' option to prefix channel unique IDs with (issue #5825)
[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, ZAP, 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 \ref channel_drivers - Implemented channel drivers
82         \arg \ref Def_Frame Asterisk Multimedia Frames
83
84 */
85
86 #ifndef _ASTERISK_CHANNEL_H
87 #define _ASTERISK_CHANNEL_H
88
89 #include <unistd.h>
90 #ifdef POLLCOMPAT 
91 #include "asterisk/poll-compat.h"
92 #else
93 #include <sys/poll.h>
94 #endif
95
96 #if defined(__cplusplus) || defined(c_plusplus)
97 extern "C" {
98 #endif
99
100 /*! Max length of an extension */
101 #define AST_MAX_EXTENSION       80
102
103 #define AST_MAX_CONTEXT         80
104
105 #define AST_CHANNEL_NAME        80
106
107 #include "asterisk/compat.h"
108 #include "asterisk/frame.h"
109 #include "asterisk/sched.h"
110 #include "asterisk/chanvars.h"
111 #include "asterisk/config.h"
112 #include "asterisk/lock.h"
113 #include "asterisk/cdr.h"
114 #include "asterisk/utils.h"
115 #include "asterisk/linkedlists.h"
116 #include "asterisk/stringfields.h"
117
118 #define MAX_LANGUAGE            20
119
120 #define MAX_MUSICCLASS          20
121
122 #define AST_MAX_FDS             8
123 /*
124  * We have AST_MAX_FDS file descriptors in a channel.
125  * Some of them have a fixed use:
126  */
127 #define AST_ALERT_FD    (AST_MAX_FDS-1)         /* used for alertpipe */
128 #define AST_TIMING_FD   (AST_MAX_FDS-2)         /* used for timingfd */
129 #define AST_AGENT_FD    (AST_MAX_FDS-3) /* used by agents for pass thru */
130 #define AST_GENERATOR_FD        (AST_MAX_FDS-4) /* used by generator */
131
132 enum ast_bridge_result {
133         AST_BRIDGE_COMPLETE = 0,
134         AST_BRIDGE_FAILED = -1,
135         AST_BRIDGE_FAILED_NOWARN = -2,
136         AST_BRIDGE_RETRY = -3,
137 };
138
139 typedef unsigned long long ast_group_t;
140
141 struct ast_generator {
142         void *(*alloc)(struct ast_channel *chan, void *params);
143         void (*release)(struct ast_channel *chan, void *data);
144         int (*generate)(struct ast_channel *chan, void *data, int len, int samples);
145 };
146
147 /*! Structure for all kinds of caller ID identifications */
148 struct ast_callerid {
149         /*! Malloc'd Dialed Number Identifier */
150         char *cid_dnid;                         
151         /*! Malloc'd Caller Number */
152         char *cid_num;
153         /*! Malloc'd Caller Name */
154         char *cid_name;
155         /*! Malloc'd ANI */
156         char *cid_ani;                  
157         /*! Malloc'd RDNIS */
158         char *cid_rdnis;
159         /*! Callerid presentation/screening */
160         int cid_pres;
161         /*! Callerid ANI 2 (Info digits) */
162         int cid_ani2;
163         /*! Callerid Type of Number */
164         int cid_ton;
165         /*! Callerid Transit Network Select */
166         int cid_tns;
167 };
168
169 /*! Structure to describe a channel "technology", ie a channel driver 
170         See
171         \arg chan_iax2.c - The Inter-Asterisk exchange protocol
172         \arg chan_sip.c - The SIP channel driver
173         \arg chan_zap.c - PSTN connectivity (TDM, PRI, T1/E1, FXO, FXS)
174
175         If you develop your own channel driver, this is where you
176         tell the PBX at registration of your driver what properties
177         this driver supports and where different callbacks are 
178         implemented.
179 */
180         
181
182 struct ast_channel_tech {
183         const char * const type;
184         const char * const description;
185
186         /*! Bitmap of formats this channel can handle */
187         int capabilities;
188
189         /*! Technology Properties */
190         int properties;
191
192         /*! Requester - to set up call data structures (pvt's) */
193         struct ast_channel *(* const requester)(const char *type, int format, void *data, int *cause);
194
195         /*! Devicestate call back */
196         int (* const devicestate)(void *data);
197
198         /*! Send a literal DTMF digit */
199         int (* const send_digit)(struct ast_channel *chan, char digit);
200
201         /*! Start sending a literal DTMF digit */
202         int (* const send_digit_begin)(struct ast_channel *chan, char digit);
203
204         /*! Stop sending the last literal DTMF digit */
205         int (* const send_digit_end)(struct ast_channel *chan);
206
207         /*! Call a given phone number (address, etc), but don't
208            take longer than timeout seconds to do so.  */
209         int (* const call)(struct ast_channel *chan, char *addr, int timeout);
210
211         /*! Hangup (and possibly destroy) the channel */
212         int (* const hangup)(struct ast_channel *chan);
213
214         /*! Answer the channel */
215         int (* const answer)(struct ast_channel *chan);
216
217         /*! Read a frame, in standard format (see frame.h) */
218         struct ast_frame * (* const read)(struct ast_channel *chan);
219
220         /*! Write a frame, in standard format (see frame.h) */
221         int (* const write)(struct ast_channel *chan, struct ast_frame *frame);
222
223         /*! Display or transmit text */
224         int (* const send_text)(struct ast_channel *chan, const char *text);
225
226         /*! Display or send an image */
227         int (* const send_image)(struct ast_channel *chan, struct ast_frame *frame);
228
229         /*! Send HTML data */
230         int (* const send_html)(struct ast_channel *chan, int subclass, const char *data, int len);
231
232         /*! Handle an exception, reading a frame */
233         struct ast_frame * (* const exception)(struct ast_channel *chan);
234
235         /*! Bridge two channels of the same type together */
236         enum ast_bridge_result (* const bridge)(struct ast_channel *c0, struct ast_channel *c1, int flags,
237                                                 struct ast_frame **fo, struct ast_channel **rc, int timeoutms);
238
239         /*! Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTION */
240         int (* const indicate)(struct ast_channel *c, int condition);
241
242         /*! Fix up a channel:  If a channel is consumed, this is called.  Basically update any ->owner links */
243         int (* const fixup)(struct ast_channel *oldchan, struct ast_channel *newchan);
244
245         /*! Set a given option */
246         int (* const setoption)(struct ast_channel *chan, int option, void *data, int datalen);
247
248         /*! Query a given option */
249         int (* const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen);
250
251         /*! Blind transfer other side (see app_transfer.c and ast_transfer() */
252         int (* const transfer)(struct ast_channel *chan, const char *newdest);
253
254         /*! Write a frame, in standard format */
255         int (* const write_video)(struct ast_channel *chan, struct ast_frame *frame);
256
257         /*! Find bridged channel */
258         struct ast_channel *(* const bridged_channel)(struct ast_channel *chan, struct ast_channel *bridge);
259
260         /*! Provide additional items for CHANNEL() dialplan function */
261         int (* func_channel_read)(struct ast_channel *chan, char *function, char *data, char *buf, size_t len);
262         int (* func_channel_write)(struct ast_channel *chan, char *function, char *data, const char *value);
263 };
264
265 struct ast_channel_spy_list;
266
267 /*! Main Channel structure associated with a channel. 
268  * This is the side of it mostly used by the pbx and call management.
269  *
270  * \note XXX It is important to remember to increment .cleancount each time
271  *       this structure is changed. XXX
272  */
273 struct ast_channel {
274         /*! Technology (point to channel driver) */
275         const struct ast_channel_tech *tech;
276
277         /*! Private data used by the technology driver */
278         void *tech_pvt;
279
280         AST_DECLARE_STRING_FIELDS(
281                 AST_STRING_FIELD(name);                 /*! ASCII unique channel name */
282                 AST_STRING_FIELD(language);             /*! Language requested for voice prompts */
283                 AST_STRING_FIELD(musicclass);           /*! Default music class */
284                 AST_STRING_FIELD(accountcode);          /*! Account code for billing */
285                 AST_STRING_FIELD(call_forward);         /*! Where to forward to if asked to dial on this interface */
286                 AST_STRING_FIELD(uniqueid);             /*! Unique Channel Identifier */
287         );
288         
289         /*! File descriptor for channel -- Drivers will poll on these file descriptors, so at least one must be non -1.  */
290         int fds[AST_MAX_FDS];                   
291
292         /*! Music State*/
293         void *music_state;
294         /*! Current generator data if there is any */
295         void *generatordata;
296         /*! Current active data generator */
297         struct ast_generator *generator;
298
299         /*! Who are we bridged to, if we're bridged  Do not access directly,
300             use ast_bridged_channel(chan) */
301         struct ast_channel *_bridge;
302         /*! Channel that will masquerade as us */
303         struct ast_channel *masq;               
304         /*! Who we are masquerading as */
305         struct ast_channel *masqr;              
306         /*! Call Detail Record Flags */
307         int cdrflags;                                                                              
308         /*! Whether or not we have been hung up...  Do not set this value
309             directly, use ast_softhangup */
310         int _softhangup;
311         /*! Non-zero, set to actual time when channel is to be hung up */
312         time_t  whentohangup;
313         /*! If anyone is blocking, this is them */
314         pthread_t blocker;                      
315         /*! Lock, can be used to lock a channel for some operations */
316         ast_mutex_t lock;                       
317         /*! Procedure causing blocking */
318         const char *blockproc;                  
319
320         /*! Current application */
321         char *appl;                             
322         /*! Data passed to current application */
323         char *data;                             
324         
325         /*! Which fd had an event detected on */
326         int fdno;                               
327         /*! Schedule context */
328         struct sched_context *sched;            
329         /*! For streaming playback, the schedule ID */
330         int streamid;                           
331         /*! Stream itself. */
332         struct ast_filestream *stream;          
333         /*! For streaming video playback, the schedule ID */
334         int vstreamid;                          
335         /*! Video Stream itself. */
336         struct ast_filestream *vstream;         
337         /*! Original writer format */
338         int oldwriteformat;                     
339         
340         /*! Timing fd */
341         int timingfd;
342         int (*timingfunc)(void *data);
343         void *timingdata;
344
345         /*! State of line -- Don't write directly, use ast_setstate */
346         int _state;                             
347         /*! Number of rings so far */
348         int rings;                              
349
350         /*! Kinds of data this channel can natively handle */
351         int nativeformats;                      
352         /*! Requested read format */
353         int readformat;                         
354         /*! Requested write format */
355         int writeformat;                        
356
357         struct ast_callerid cid;
358                 
359         /*! Current extension context */
360         char context[AST_MAX_CONTEXT];
361         /*! Current non-macro context */
362         char macrocontext[AST_MAX_CONTEXT];     
363         /*! Current non-macro extension */
364         char macroexten[AST_MAX_EXTENSION];
365         /*! Current non-macro priority */
366         int macropriority;
367         /*! Current extension number */
368         char exten[AST_MAX_EXTENSION];          
369         /* Current extension priority */
370         int priority;                                           
371         /*! Any/all queued DTMF characters */
372         char dtmfq[AST_MAX_EXTENSION];          
373         /*! DTMF frame */
374         struct ast_frame dtmff;                 
375
376         /*! PBX private structure */
377         struct ast_pbx *pbx;
378         /*! Set BEFORE PBX is started to determine AMA flags */
379         int amaflags;                   
380         /*! Call Detail Record */
381         struct ast_cdr *cdr;                    
382         /*! Whether or not ADSI is detected on CPE */
383         int adsicpe;
384
385         /*! Tone zone as set in indications.conf */
386         struct tone_zone *zone;
387
388         /* Channel monitoring */
389         struct ast_channel_monitor *monitor;
390
391         /*! Track the read/written samples for monitor use */
392         unsigned long insmpl;
393         unsigned long outsmpl;
394
395         /* Frames in/out counters */
396         unsigned int fin;
397         unsigned int fout;
398
399         /* Why is the channel hanged up */
400         int hangupcause;
401         
402         /* A linked list for variables */
403         struct varshead varshead;
404
405         unsigned int callgroup;
406         unsigned int pickupgroup;
407
408         /*! channel flags of AST_FLAG_ type */
409         unsigned int flags;
410         
411         /*! ISDN Transfer Capbility - AST_FLAG_DIGITAL is not enough */
412         unsigned short transfercapability;
413
414         struct ast_frame *readq;
415         int alertpipe[2];
416         /*! Write translation path */
417         struct ast_trans_pvt *writetrans;
418         /*! Read translation path */
419         struct ast_trans_pvt *readtrans;
420         /*! Raw read format */
421         int rawreadformat;
422         /*! Raw write format */
423         int rawwriteformat;
424
425         /*! Chan Spy stuff */
426         struct ast_channel_spy_list *spies;
427
428         /*! For easy linking */
429         AST_LIST_ENTRY(ast_channel) list;
430 };
431
432 /* \defgroup chanprop Channel tech properties:
433         \brief Channels have this property if they can accept input with jitter; i.e. most VoIP channels */
434 /* @{ */
435 #define AST_CHAN_TP_WANTSJITTER (1 << 0)        
436
437 /* This flag has been deprecated by the transfercapbilty data member in struct ast_channel */
438 /* #define AST_FLAG_DIGITAL     (1 << 0) */     /* if the call is a digital ISDN call */
439 #define AST_FLAG_DEFER_DTMF     (1 << 1)        /*!< if dtmf should be deferred */
440 #define AST_FLAG_WRITE_INT      (1 << 2)        /*!< if write should be interrupt generator */
441 #define AST_FLAG_BLOCKING       (1 << 3)        /*!< if we are blocking */
442 #define AST_FLAG_ZOMBIE         (1 << 4)        /*!< if we are a zombie */
443 #define AST_FLAG_EXCEPTION      (1 << 5)        /*!< if there is a pending exception */
444 #define AST_FLAG_MOH            (1 << 6)        /*!< XXX anthm promises me this will disappear XXX listening to moh */
445 #define AST_FLAG_SPYING         (1 << 7)        /*!< XXX might also go away XXX is spying on someone */
446 #define AST_FLAG_NBRIDGE        (1 << 8)        /*!< is it in a native bridge */
447 #define AST_FLAG_IN_AUTOLOOP    (1 << 9)        /*!< the channel is in an auto-incrementing dialplan processor,
448                                                    so when ->priority is set, it will get incremented before
449                                                    finding the next priority to run
450                                                 */
451 /* @} */
452
453 #define AST_FEATURE_PLAY_WARNING        (1 << 0)
454 #define AST_FEATURE_REDIRECT            (1 << 1)
455 #define AST_FEATURE_DISCONNECT          (1 << 2)
456 #define AST_FEATURE_ATXFER              (1 << 3)
457 #define AST_FEATURE_AUTOMON             (1 << 4)
458
459 #define AST_FEATURE_FLAG_NEEDSDTMF      (1 << 0)
460 #define AST_FEATURE_FLAG_CALLEE         (1 << 1)
461 #define AST_FEATURE_FLAG_CALLER         (1 << 2)
462
463 struct ast_bridge_config {
464         struct ast_flags features_caller;
465         struct ast_flags features_callee;
466         struct timeval start_time;
467         long feature_timer;
468         long timelimit;
469         long play_warning;
470         long warning_freq;
471         const char *warning_sound;
472         const char *end_sound;
473         const char *start_sound;
474         int firstpass;
475         unsigned int flags;
476 };
477
478 struct chanmon;
479
480 #define LOAD_OH(oh) {   \
481         oh.context = context; \
482         oh.exten = exten; \
483         oh.priority = priority; \
484         oh.cid_num = cid_num; \
485         oh.cid_name = cid_name; \
486         oh.account = account; \
487         oh.vars = vars; \
488         oh.parent_channel = NULL; \
489
490
491 struct outgoing_helper {
492         const char *context;
493         const char *exten;
494         int priority;
495         const char *cid_num;
496         const char *cid_name;
497         const char *account;
498         struct ast_variable *vars;
499         struct ast_channel *parent_channel;
500 };
501
502 #define AST_CDR_TRANSFER        (1 << 0)
503 #define AST_CDR_FORWARD         (1 << 1)
504 #define AST_CDR_CALLWAIT        (1 << 2)
505 #define AST_CDR_CONFERENCE      (1 << 3)
506
507 #define AST_ADSI_UNKNOWN        (0)
508 #define AST_ADSI_AVAILABLE      (1)
509 #define AST_ADSI_UNAVAILABLE    (2)
510 #define AST_ADSI_OFFHOOKONLY    (3)
511
512 #define AST_SOFTHANGUP_DEV              (1 << 0)        /*!< Soft hangup by device */
513 #define AST_SOFTHANGUP_ASYNCGOTO        (1 << 1)        /*!< Soft hangup for async goto */
514 #define AST_SOFTHANGUP_SHUTDOWN         (1 << 2)
515 #define AST_SOFTHANGUP_TIMEOUT          (1 << 3)
516 #define AST_SOFTHANGUP_APPUNLOAD        (1 << 4)
517 #define AST_SOFTHANGUP_EXPLICIT         (1 << 5)
518 #define AST_SOFTHANGUP_UNBRIDGE     (1 << 6)
519
520
521 /*! \defgroup ChanState Channel states
522 \brief Bits 0-15 of state are reserved for the state (up/down) of the line */
523 /*! @{ */
524 /*! Channel is down and available */
525 #define AST_STATE_DOWN          0               
526 /*! Channel is down, but reserved */
527 #define AST_STATE_RESERVED      1               
528 /*! Channel is off hook */
529 #define AST_STATE_OFFHOOK       2               
530 /*! Digits (or equivalent) have been dialed */
531 #define AST_STATE_DIALING       3               
532 /*! Line is ringing */
533 #define AST_STATE_RING          4               
534 /*! Remote end is ringing */
535 #define AST_STATE_RINGING       5               
536 /*! Line is up */
537 #define AST_STATE_UP            6               
538 /*! Line is busy */
539 #define AST_STATE_BUSY          7               
540 /*! Digits (or equivalent) have been dialed while offhook */
541 #define AST_STATE_DIALING_OFFHOOK       8
542 /*! Channel has detected an incoming call and is waiting for ring */
543 #define AST_STATE_PRERING       9
544
545 /* Bits 16-32 of state are reserved for flags (See \ref ChanState ) */
546 /*! Do not transmit voice data */
547 #define AST_STATE_MUTE          (1 << 16)       
548 /*! @} */
549
550 /*! \brief Channel reload reasons for manager events at load or reload of configuration */
551 enum channelreloadreason {
552         CHANNEL_MODULE_LOAD,
553         CHANNEL_MODULE_RELOAD,
554         CHANNEL_CLI_RELOAD,
555         CHANNEL_MANAGER_RELOAD,
556 };
557
558 /*! \brief Change the state of a channel */
559 int ast_setstate(struct ast_channel *chan, int state);
560
561 /*! \brief Create a channel structure 
562     \return Returns NULL on failure to allocate.
563         \note New channels are 
564         by default set to the "default" context and
565         extension "s"
566  */
567 struct ast_channel *ast_channel_alloc(int needalertpipe);
568
569 /*! \brief Queue an outgoing frame */
570 int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f);
571
572 /*! \brief Queue a hangup frame */
573 int ast_queue_hangup(struct ast_channel *chan);
574
575 /*! \brief Queue a control frame */
576 int ast_queue_control(struct ast_channel *chan, int control);
577
578
579 /*! \brief Change channel name */
580 void ast_change_name(struct ast_channel *chan, char *newname);
581
582 /*! \brief Free a channel structure */
583 void  ast_channel_free(struct ast_channel *);
584
585 /*! \brief Requests a channel 
586  * \param type type of channel to request
587  * \param format requested channel format
588  * \param data data to pass to the channel requester
589  * \param status status
590  * Request a channel of a given type, with data as optional information used 
591  * by the low level module
592  * \return Returns an ast_channel on success, NULL on failure.
593  */
594 struct ast_channel *ast_request(const char *type, int format, void *data, int *status);
595
596 /*!
597  * \brief Request a channel of a given type, with data as optional information used 
598  * by the low level module and attempt to place a call on it
599  * \param type type of channel to request
600  * \param format requested channel format
601  * \param data data to pass to the channel requester
602  * \param timeout maximum amount of time to wait for an answer
603  * \param reason why unsuccessful (if unsuceessful)
604  * \param cidnum Caller-ID Number
605  * \param cidname Caller-ID Name
606  * \return Returns an ast_channel on success or no answer, NULL on failure.  Check the value of chan->_state
607  * to know if the call was answered or not.
608  */
609 struct ast_channel *ast_request_and_dial(const char *type, int format, void *data, int timeout, int *reason, const char *cidnum, const char *cidname);
610
611 struct ast_channel *__ast_request_and_dial(const char *type, int format, void *data, int timeout, int *reason, const char *cidnum, const char *cidname, struct outgoing_helper *oh);
612
613 /*!\brief Register a channel technology (a new channel driver)
614  * Called by a channel module to register the kind of channels it supports.
615  * \param tech Structure defining channel technology or "type"
616  * \return Returns 0 on success, -1 on failure.
617  */
618 int ast_channel_register(const struct ast_channel_tech *tech);
619
620 /*! \brief Unregister a channel technology 
621  * \param tech Structure defining channel technology or "type" that was previously registered
622  * \return No return value.
623  */
624 void ast_channel_unregister(const struct ast_channel_tech *tech);
625
626 /*! \brief Get a channel technology structure by name
627  * \param name name of technology to find
628  * \return a pointer to the structure, or NULL if no matching technology found
629  */
630 const struct ast_channel_tech *ast_get_channel_tech(const char *name);
631
632 /*! \brief Hang up a channel  
633  * \note This function performs a hard hangup on a channel.  Unlike the soft-hangup, this function
634  * performs all stream stopping, etc, on the channel that needs to end.
635  * chan is no longer valid after this call.
636  * \param chan channel to hang up
637  * \return Returns 0 on success, -1 on failure.
638  */
639 int ast_hangup(struct ast_channel *chan);
640
641 /*! \brief Softly hangup up a channel 
642  * \param chan channel to be soft-hung-up
643  * Call the protocol layer, but don't destroy the channel structure (use this if you are trying to
644  * safely hangup a channel managed by another thread.
645  * \param cause Ast hangupcause for hangup
646  * \return Returns 0 regardless
647  */
648 int ast_softhangup(struct ast_channel *chan, int cause);
649
650 /*! \brief Softly hangup up a channel (no channel lock) 
651  * \param chan channel to be soft-hung-up
652  * \param cause Ast hangupcause for hangup (see cause.h) */
653 int ast_softhangup_nolock(struct ast_channel *chan, int cause);
654
655 /*! \brief Check to see if a channel is needing hang up 
656  * \param chan channel on which to check for hang up
657  * This function determines if the channel is being requested to be hung up.
658  * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
659  */
660 int ast_check_hangup(struct ast_channel *chan);
661
662 /*! \brief Compare a offset with the settings of when to hang a channel up 
663  * \param chan channel on which to check for hang up
664  * \param offset offset in seconds from current time
665  * \return 1, 0, or -1
666  * This function compares a offset from current time with the absolute time 
667  * out on a channel (when to hang up). If the absolute time out on a channel
668  * is earlier than current time plus the offset, it returns 1, if the two
669  * time values are equal, it return 0, otherwise, it retturn -1.
670  */
671 int ast_channel_cmpwhentohangup(struct ast_channel *chan, time_t offset);
672
673 /*! \brief Set when to hang a channel up 
674  * \param chan channel on which to check for hang up
675  * \param offset offset in seconds from current time of when to hang up
676  * This function sets the absolute time out on a channel (when to hang up).
677  */
678 void ast_channel_setwhentohangup(struct ast_channel *chan, time_t offset);
679
680 /*! \brief Answer a ringing call 
681  * \param chan channel to answer
682  * This function answers a channel and handles all necessary call
683  * setup functions.
684  * \return Returns 0 on success, -1 on failure
685  */
686 int ast_answer(struct ast_channel *chan);
687
688 /*! \brief Make a call 
689  * \param chan which channel to make the call on
690  * \param addr destination of the call
691  * \param timeout time to wait on for connect
692  * Place a call, take no longer than timeout ms. 
693    \return Returns -1 on failure, 0 on not enough time 
694    (does not automatically stop ringing), and  
695    the number of seconds the connect took otherwise.
696    */
697 int ast_call(struct ast_channel *chan, char *addr, int timeout);
698
699 /*! \brief Indicates condition of channel 
700  * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
701  * \param chan channel to change the indication
702  * \param condition which condition to indicate on the channel
703  * \return Returns 0 on success, -1 on failure
704  */
705 int ast_indicate(struct ast_channel *chan, int condition);
706
707 /* Misc stuff ------------------------------------------------ */
708
709 /*! \brief Wait for input on a channel 
710  * \param chan channel to wait on
711  * \param ms length of time to wait on the channel
712  * Wait for input on a channel for a given # of milliseconds (<0 for indefinite). 
713   \return Returns < 0 on  failure, 0 if nothing ever arrived, and the # of ms remaining otherwise */
714 int ast_waitfor(struct ast_channel *chan, int ms);
715
716 /*! \brief Wait for a specied amount of time, looking for hangups 
717  * \param chan channel to wait for
718  * \param ms length of time in milliseconds to sleep
719  * Waits for a specified amount of time, servicing the channel as required.
720  * \return returns -1 on hangup, otherwise 0.
721  */
722 int ast_safe_sleep(struct ast_channel *chan, int ms);
723
724 /*! \brief Wait for a specied amount of time, looking for hangups and a condition argument 
725  * \param chan channel to wait for
726  * \param ms length of time in milliseconds to sleep
727  * \param cond a function pointer for testing continue condition
728  * \param data argument to be passed to the condition test function
729  * \return returns -1 on hangup, otherwise 0.
730  * Waits for a specified amount of time, servicing the channel as required. If cond
731  * returns 0, this function returns.
732  */
733 int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
734
735 /*! \brief Waits for activity on a group of channels 
736  * \param chan an array of pointers to channels
737  * \param n number of channels that are to be waited upon
738  * \param fds an array of fds to wait upon
739  * \param nfds the number of fds to wait upon
740  * \param exception exception flag
741  * \param outfd fd that had activity on it
742  * \param ms how long the wait was
743  * Big momma function here.  Wait for activity on any of the n channels, or any of the nfds
744    file descriptors.
745    \return Returns the channel with activity, or NULL on error or if an FD
746    came first.  If the FD came first, it will be returned in outfd, otherwise, outfd
747    will be -1 */
748 struct ast_channel *ast_waitfor_nandfds(struct ast_channel **chan, int n, int *fds, int nfds, int *exception, int *outfd, int *ms);
749
750 /*! Waits for input on a group of channels */
751 /*! Wait for input on an array of channels for a given # of milliseconds. Return channel
752    with activity, or NULL if none has activity.  time "ms" is modified in-place, if applicable */
753 struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
754
755 /*! Waits for input on an fd */
756 /*! This version works on fd's only.  Be careful with it. */
757 int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
758
759
760 /*! Reads a frame */
761 /*!
762  * \param chan channel to read a frame from
763  * Read a frame.  Returns a frame, or NULL on error.  If it returns NULL, you
764    best just stop reading frames and assume the channel has been
765    disconnected. */
766 struct ast_frame *ast_read(struct ast_channel *chan);
767
768 /*! Reads a frame, returning AST_FRAME_NULL frame if audio. */
769 /*!
770  * \param chan channel to read a frame from
771  * Read a frame.  Returns a frame, or NULL on error.  If it returns NULL, you
772    best just stop reading frames and assume the channel has been
773    disconnected.  Audio is replaced with AST_FRAME_NULL to avoid 
774    transcode when the resulting audio is not necessary. */
775 struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
776
777 /*! Write a frame to a channel */
778 /*!
779  * \param chan destination channel of the frame
780  * \param frame frame that will be written
781  * This function writes the given frame to the indicated channel.
782  * It returns 0 on success, -1 on failure.
783  */
784 int ast_write(struct ast_channel *chan, struct ast_frame *frame);
785
786 /*! Write video frame to a channel */
787 /*!
788  * \param chan destination channel of the frame
789  * \param frame frame that will be written
790  * This function writes the given frame to the indicated channel.
791  * It returns 1 on success, 0 if not implemented, and -1 on failure.
792  */
793 int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
794
795 /* Send empty audio to prime a channel driver */
796 int ast_prod(struct ast_channel *chan);
797
798 /*! Sets read format on channel chan */
799 /*! 
800  * \param chan channel to change
801  * \param format format to change to
802  * Set read format for channel to whichever component of "format" is best. 
803  * Returns 0 on success, -1 on failure
804  */
805 int ast_set_read_format(struct ast_channel *chan, int format);
806
807 /*! Sets write format on channel chan */
808 /*! 
809  * \param chan channel to change
810  * \param format new format for writing
811  * Set write format for channel to whichever compoent of "format" is best. 
812  * Returns 0 on success, -1 on failure
813  */
814 int ast_set_write_format(struct ast_channel *chan, int format);
815
816 /*! Sends text to a channel */
817 /*! 
818  * \param chan channel to act upon
819  * \param text string of text to send on the channel
820  * Write text to a display on a channel
821  * Returns 0 on success, -1 on failure
822  */
823 int ast_sendtext(struct ast_channel *chan, const char *text);
824
825 /*! Receives a text character from a channel */
826 /*! 
827  * \param chan channel to act upon
828  * \param timeout timeout in milliseconds (0 for infinite wait)
829  * Read a char of text from a channel
830  * Returns 0 on success, -1 on failure
831  */
832 int ast_recvchar(struct ast_channel *chan, int timeout);
833
834 /*! Send a DTMF digit to a channel */
835 /*! 
836  * \param chan channel to act upon
837  * \param digit the DTMF digit to send, encoded in ASCII
838  * Send a DTMF digit to a channel.
839  * Returns 0 on success, -1 on failure
840  */
841 int ast_senddigit(struct ast_channel *chan, char digit);
842
843 /*! Receives a text string from a channel */
844 /*! 
845  * \param chan channel to act upon
846  * \param timeout timeout in milliseconds (0 for infinite wait)
847  * \return the received text, or NULL to signify failure.
848  * Read a string of text from a channel
849  */
850 char *ast_recvtext(struct ast_channel *chan, int timeout);
851
852 /*! Browse channels in use */
853 /*! 
854  * \param prev where you want to start in the channel list
855  * Browse the channels currently in use 
856  * Returns the next channel in the list, NULL on end.
857  * If it returns a channel, that channel *has been locked*!
858  */
859 struct ast_channel *ast_channel_walk_locked(const struct ast_channel *prev);
860
861 /*! Get channel by name (locks channel) */
862 struct ast_channel *ast_get_channel_by_name_locked(const char *chan);
863
864 /*! Get channel by name prefix (locks channel) */
865 struct ast_channel *ast_get_channel_by_name_prefix_locked(const char *name, const int namelen);
866
867 /*! Get channel by name prefix (locks channel) */
868 struct ast_channel *ast_walk_channel_by_name_prefix_locked(struct ast_channel *chan, const char *name, const int namelen);
869
870 /*--- ast_get_channel_by_exten_locked: Get channel by exten (and optionally context) and lock it */
871 struct ast_channel *ast_get_channel_by_exten_locked(const char *exten, const char *context);
872
873 /*! Waits for a digit */
874 /*! 
875  * \param c channel to wait for a digit on
876  * \param ms how many milliseconds to wait
877  * Wait for a digit.  Returns <0 on error, 0 on no entry, and the digit on success. */
878 int ast_waitfordigit(struct ast_channel *c, int ms);
879
880 /* Same as above with audio fd for outputing read audio and ctrlfd to monitor for
881    reading. Returns 1 if ctrlfd becomes available */
882 int ast_waitfordigit_full(struct ast_channel *c, int ms, int audiofd, int ctrlfd);
883
884 /*! Reads multiple digits */
885 /*! 
886  * \param c channel to read from
887  * \param s string to read in to.  Must be at least the size of your length
888  * \param len how many digits to read (maximum)
889  * \param timeout how long to timeout between digits
890  * \param rtimeout timeout to wait on the first digit
891  * \param enders digits to end the string
892  * Read in a digit string "s", max length "len", maximum timeout between 
893    digits "timeout" (-1 for none), terminated by anything in "enders".  Give them rtimeout
894    for the first digit.  Returns 0 on normal return, or 1 on a timeout.  In the case of
895    a timeout, any digits that were read before the timeout will still be available in s.  
896    RETURNS 2 in full version when ctrlfd is available, NOT 1*/
897 int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
898 int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
899
900 /*! Report DTMF on channel 0 */
901 #define AST_BRIDGE_DTMF_CHANNEL_0               (1 << 0)                
902 /*! Report DTMF on channel 1 */
903 #define AST_BRIDGE_DTMF_CHANNEL_1               (1 << 1)                
904 /*! Return all voice frames on channel 0 */
905 #define AST_BRIDGE_REC_CHANNEL_0                (1 << 2)                
906 /*! Return all voice frames on channel 1 */
907 #define AST_BRIDGE_REC_CHANNEL_1                (1 << 3)                
908 /*! Ignore all signal frames except NULL */
909 #define AST_BRIDGE_IGNORE_SIGS                  (1 << 4)                
910
911
912 /*! Makes two channel formats compatible */
913 /*! 
914  * \param c0 first channel to make compatible
915  * \param c1 other channel to make compatible
916  * Set two channels to compatible formats -- call before ast_channel_bridge in general .  Returns 0 on success
917    and -1 if it could not be done */
918 int ast_channel_make_compatible(struct ast_channel *c0, struct ast_channel *c1);
919
920 /*! Bridge two channels together */
921 /*! 
922  * \param c0 first channel to bridge
923  * \param c1 second channel to bridge
924  * \param config config for the channels
925  * \param fo destination frame(?)
926  * \param rc destination channel(?)
927  * Bridge two channels (c0 and c1) together.  If an important frame occurs, we return that frame in
928    *rf (remember, it could be NULL) and which channel (0 or 1) in rc */
929 /* int ast_channel_bridge(struct ast_channel *c0, struct ast_channel *c1, int flags, struct ast_frame **fo, struct ast_channel **rc); */
930 int ast_channel_bridge(struct ast_channel *c0,struct ast_channel *c1,struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc);
931
932 /*! Weird function made for call transfers */
933 /*! 
934  * \param original channel to make a copy of
935  * \param clone copy of the original channel
936  * This is a very strange and freaky function used primarily for transfer.  Suppose that
937    "original" and "clone" are two channels in random situations.  This function takes
938    the guts out of "clone" and puts them into the "original" channel, then alerts the
939    channel driver of the change, asking it to fixup any private information (like the
940    p->owner pointer) that is affected by the change.  The physical layer of the original
941    channel is hung up.  */
942 int ast_channel_masquerade(struct ast_channel *original, struct ast_channel *clone);
943
944 /*! Gives the string form of a given cause code */
945 /*! 
946  * \param state cause to get the description of
947  * Give a name to a cause code
948  * Returns the text form of the binary cause code given
949  */
950 const char *ast_cause2str(int state);
951
952 /*! Gives the string form of a given channel state */
953 /*! 
954  * \param state state to get the name of
955  * Give a name to a state 
956  * Returns the text form of the binary state given
957  */
958 char *ast_state2str(int state);
959
960 /*! Gives the string form of a given transfer capability */
961 /*!
962  * \param transfercapability transfercapabilty to get the name of
963  * Give a name to a transfercapbility
964  * See above
965  * Returns the text form of the binary transfer capbility
966  */
967 char *ast_transfercapability2str(int transfercapability);
968
969 /* Options: Some low-level drivers may implement "options" allowing fine tuning of the
970    low level channel.  See frame.h for options.  Note that many channel drivers may support
971    none or a subset of those features, and you should not count on this if you want your
972    asterisk application to be portable.  They're mainly useful for tweaking performance */
973
974 /*! Sets an option on a channel */
975 /*! 
976  * \param channel channel to set options on
977  * \param option option to change
978  * \param data data specific to option
979  * \param datalen length of the data
980  * \param block blocking or not
981  * Set an option on a channel (see frame.h), optionally blocking awaiting the reply 
982  * Returns 0 on success and -1 on failure
983  */
984 int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
985
986 /*! Pick the best codec  */
987 /* Choose the best codec...  Uhhh...   Yah. */
988 extern int ast_best_codec(int fmts);
989
990
991 /*! Checks the value of an option */
992 /*! 
993  * Query the value of an option, optionally blocking until a reply is received
994  * Works similarly to setoption except only reads the options.
995  */
996 struct ast_frame *ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
997
998 /*! Checks for HTML support on a channel */
999 /*! Returns 0 if channel does not support HTML or non-zero if it does */
1000 int ast_channel_supports_html(struct ast_channel *channel);
1001
1002 /*! Sends HTML on given channel */
1003 /*! Send HTML or URL on link.  Returns 0 on success or -1 on failure */
1004 int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
1005
1006 /*! Sends a URL on a given link */
1007 /*! Send URL on link.  Returns 0 on success or -1 on failure */
1008 int ast_channel_sendurl(struct ast_channel *channel, const char *url);
1009
1010 /*! Defers DTMF */
1011 /*! Defer DTMF so that you only read things like hangups and audio.  Returns
1012    non-zero if channel was already DTMF-deferred or 0 if channel is just now
1013    being DTMF-deferred */
1014 int ast_channel_defer_dtmf(struct ast_channel *chan);
1015
1016 /*! Undeos a defer */
1017 /*! Undo defer.  ast_read will return any dtmf characters that were queued */
1018 void ast_channel_undefer_dtmf(struct ast_channel *chan);
1019
1020 /*! Initiate system shutdown -- prevents new channels from being allocated.
1021     If "hangup" is non-zero, all existing channels will receive soft
1022      hangups */
1023 void ast_begin_shutdown(int hangup);
1024
1025 /*! Cancels an existing shutdown and returns to normal operation */
1026 void ast_cancel_shutdown(void);
1027
1028 /*! Returns number of active/allocated channels */
1029 int ast_active_channels(void);
1030
1031 /*! Returns non-zero if Asterisk is being shut down */
1032 int ast_shutting_down(void);
1033
1034 /*! Activate a given generator */
1035 int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
1036
1037 /*! Deactive an active generator */
1038 void ast_deactivate_generator(struct ast_channel *chan);
1039
1040 void ast_set_callerid(struct ast_channel *chan, const char *cidnum, const char *cidname, const char *ani);
1041
1042 /*! Start a tone going */
1043 int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1044 /*! Stop a tone from playing */
1045 void ast_tonepair_stop(struct ast_channel *chan);
1046 /*! Play a tone pair for a given amount of time */
1047 int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
1048
1049 /*! Automatically service a channel for us... */
1050 int ast_autoservice_start(struct ast_channel *chan);
1051
1052 /*! Stop servicing a channel for us...  Returns -1 on error or if channel has been hungup */
1053 int ast_autoservice_stop(struct ast_channel *chan);
1054
1055 /* If built with zaptel optimizations, force a scheduled expiration on the
1056    timer fd, at which point we call the callback function / data */
1057 int ast_settimeout(struct ast_channel *c, int samples, int (*func)(void *data), void *data);
1058
1059 /*!     \brief Transfer a channel (if supported).  Returns -1 on error, 0 if not supported
1060    and 1 if supported and requested 
1061         \param chan current channel
1062         \param dest destination extension for transfer
1063 */
1064 int ast_transfer(struct ast_channel *chan, char *dest);
1065
1066 /*!     \brief  Start masquerading a channel
1067         XXX This is a seriously wacked out operation.  We're essentially putting the guts of
1068            the clone channel into the original channel.  Start by killing off the original
1069            channel's backend.   I'm not sure we're going to keep this function, because
1070            while the features are nice, the cost is very high in terms of pure nastiness. XXX
1071         \param chan     Channel to masquerade
1072 */
1073 int ast_do_masquerade(struct ast_channel *chan);
1074
1075 /*!     \brief Find bridged channel 
1076         \param chan Current channel
1077 */
1078 struct ast_channel *ast_bridged_channel(struct ast_channel *chan);
1079
1080 /*!
1081   \brief Inherits channel variable from parent to child channel
1082   \param parent Parent channel
1083   \param child Child channel
1084
1085   Scans all channel variables in the parent channel, looking for those
1086   that should be copied into the child channel.
1087   Variables whose names begin with a single '_' are copied into the
1088   child channel with the prefix removed.
1089   Variables whose names begin with '__' are copied into the child
1090   channel with their names unchanged.
1091 */
1092 void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
1093
1094 /*!
1095   \brief adds a list of channel variables to a channel
1096   \param chan the channel
1097   \param vars a linked list of variables
1098
1099   Variable names can be for a regular channel variable or a dialplan function
1100   that has the ability to be written to.
1101 */
1102 void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
1103
1104 /*!
1105   \brief An opaque 'object' structure use by silence generators on channels.
1106  */
1107 struct ast_silence_generator;
1108
1109 /*!
1110   \brief Starts a silence generator on the given channel.
1111   \param chan The channel to generate silence on
1112   \return An ast_silence_generator pointer, or NULL if an error occurs
1113
1114   This function will cause SLINEAR silence to be generated on the supplied
1115   channel until it is disabled; if the channel cannot be put into SLINEAR
1116   mode then the function will fail.
1117
1118   The pointer returned by this function must be preserved and passed to
1119   ast_channel_stop_silence_generator when you wish to stop the silence
1120   generation.
1121  */
1122 struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
1123
1124 /*!
1125   \brief Stops a previously-started silence generator on the given channel.
1126   \param chan The channel to operate on
1127   \param state The ast_silence_generator pointer return by a previous call to
1128   ast_channel_start_silence_generator.
1129   \return nothing
1130
1131   This function will stop the operating silence generator and return the channel
1132   to its previous write format.
1133  */
1134 void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
1135
1136 /* Misc. functions below */
1137
1138 /* if fd is a valid descriptor, set *pfd with the descriptor
1139  * Return 1 (not -1!) if added, 0 otherwise (so we can add the
1140  * return value to the index into the array)
1141  */
1142 static inline int ast_add_fd(struct pollfd *pfd, int fd)
1143 {
1144         pfd->fd = fd;
1145         pfd->events = POLLIN | POLLPRI;
1146         return fd >= 0;
1147 }
1148
1149 /* Helper function for migrating select to poll */
1150 static inline int ast_fdisset(struct pollfd *pfds, int fd, int max, int *start)
1151 {
1152         int x;
1153         int dummy=0;
1154
1155         if (fd < 0)
1156                 return 0;
1157         if (!start)
1158                 start = &dummy;
1159         for (x = *start; x<max; x++)
1160                 if (pfds[x].fd == fd) {
1161                         if (x == *start)
1162                                 (*start)++;
1163                         return pfds[x].revents;
1164                 }
1165         return 0;
1166 }
1167
1168 #ifdef SOLARIS
1169 static inline void timersub(struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)
1170 {
1171         tvdiff->tv_sec = tvend->tv_sec - tvstart->tv_sec;
1172         tvdiff->tv_usec = tvend->tv_usec - tvstart->tv_usec;
1173         if (tvdiff->tv_usec < 0) {
1174                 tvdiff->tv_sec --;
1175                 tvdiff->tv_usec += 1000000;
1176         }
1177
1178 }
1179 #endif
1180
1181 /*! \brief Waits for activity on a group of channels 
1182  * \param nfds the maximum number of file descriptors in the sets
1183  * \param rfds file descriptors to check for read availability
1184  * \param wfds file descriptors to check for write availability
1185  * \param efds file descriptors to check for exceptions (OOB data)
1186  * \param tvp timeout while waiting for events
1187  * This is the same as a standard select(), except it guarantees the
1188  * behaviour where the passed struct timeval is updated with how much
1189  * time was not slept while waiting for the specified events
1190  */
1191 static inline int ast_select(int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
1192 {
1193 #ifdef __linux__
1194         return select(nfds, rfds, wfds, efds, tvp);
1195 #else
1196         if (tvp) {
1197                 struct timeval tv, tvstart, tvend, tvlen;
1198                 int res;
1199
1200                 tv = *tvp;
1201                 gettimeofday(&tvstart, NULL);
1202                 res = select(nfds, rfds, wfds, efds, tvp);
1203                 gettimeofday(&tvend, NULL);
1204                 timersub(&tvend, &tvstart, &tvlen);
1205                 timersub(&tv, &tvlen, tvp);
1206                 if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
1207                         tvp->tv_sec = 0;
1208                         tvp->tv_usec = 0;
1209                 }
1210                 return res;
1211         }
1212         else
1213                 return select(nfds, rfds, wfds, efds, NULL);
1214 #endif
1215 }
1216
1217 #ifdef DO_CRASH
1218 #define CRASH do { fprintf(stderr, "!! Forcing immediate crash a-la abort !!\n"); *((int *)0) = 0; } while(0)
1219 #else
1220 #define CRASH do { } while(0)
1221 #endif
1222
1223 #define CHECK_BLOCKING(c) {      \
1224                                                         if (ast_test_flag(c, AST_FLAG_BLOCKING)) {\
1225                                                                 ast_log(LOG_WARNING, "Thread %ld Blocking '%s', already blocked by thread %ld in procedure %s\n", (long) pthread_self(), (c)->name, (long) (c)->blocker, (c)->blockproc); \
1226                                                                 CRASH; \
1227                                                         } else { \
1228                                                                 (c)->blocker = pthread_self(); \
1229                                                                 (c)->blockproc = __PRETTY_FUNCTION__; \
1230                                                                         ast_set_flag(c, AST_FLAG_BLOCKING); \
1231                                                                         } }
1232
1233 extern ast_group_t ast_get_group(char *s);
1234
1235 /*! \brief print call- and pickup groups into buffer */
1236 extern char *ast_print_group(char *buf, int buflen, ast_group_t group);
1237
1238 /*! \brief Convert enum channelreloadreason to text string for manager event
1239         \param reason   Enum channelreloadreason - reason for reload (manager, cli, start etc)
1240 */
1241 const char *channelreloadreason2txt(enum channelreloadreason reason);
1242
1243 /*! \brief return an ast_variable list of channeltypes */
1244 extern struct ast_variable *ast_channeltype_list(void);
1245
1246 #if defined(__cplusplus) || defined(c_plusplus)
1247 }
1248 #endif
1249
1250 #endif /* _ASTERISK_CHANNEL_H */