Mon Nov 24 15:34:35 2008

Asterisk developer's documentation


channel.h File Reference

General Asterisk PBX channel definitions. More...

#include "asterisk/abstract_jb.h"
#include <unistd.h>
#include <sys/poll.h>
#include "asterisk/compat.h"
#include "asterisk/frame.h"
#include "asterisk/sched.h"
#include "asterisk/chanvars.h"
#include "asterisk/config.h"
#include "asterisk/lock.h"
#include "asterisk/cdr.h"
#include "asterisk/utils.h"
#include "asterisk/linkedlists.h"
#include "asterisk/stringfields.h"
#include "asterisk/compiler.h"

Go to the source code of this file.

Data Structures

struct  ast_bridge_config
struct  ast_callerid
 Structure for all kinds of caller ID identifications. More...
struct  ast_channel
 Main Channel structure associated with a channel. This is the side of it mostly used by the pbx and call management. More...
struct  ast_channel_tech
 Structure to describe a channel "technology", ie a channel driver See for examples:. More...
struct  ast_datastore
 Structure for a channel data store. More...
struct  ast_datastore_info
 Structure for a data store type. More...
struct  ast_generator
struct  outgoing_helper

Defines

#define AST_AGENT_FD   (AST_MAX_FDS-3)
#define AST_ALERT_FD   (AST_MAX_FDS-1)
#define AST_BRIDGE_DTMF_CHANNEL_0   (1 << 0)
 Report DTMF on channel 0.
#define AST_BRIDGE_DTMF_CHANNEL_1   (1 << 1)
 Report DTMF on channel 1.
#define AST_BRIDGE_IGNORE_SIGS   (1 << 4)
 Ignore all signal frames except NULL.
#define AST_BRIDGE_REC_CHANNEL_0   (1 << 2)
 Return all voice frames on channel 0.
#define AST_BRIDGE_REC_CHANNEL_1   (1 << 3)
 Return all voice frames on channel 1.
#define AST_CHANNEL_NAME   80
#define AST_GENERATOR_FD   (AST_MAX_FDS-4)
#define AST_MAX_CONTEXT   80
#define AST_MAX_EXTENSION   80
#define AST_MAX_FDS   8
#define AST_TIMING_FD   (AST_MAX_FDS-2)
#define CHECK_BLOCKING(c)
#define DATASTORE_INHERIT_FOREVER   INT_MAX
#define DEBUGCHAN_FLAG   0x80000000
#define FRAMECOUNT_INC(x)   ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
#define LOAD_OH(oh)
#define MAX_LANGUAGE   20
#define MAX_MUSICCLASS   80

Typedefs

typedef unsigned long long ast_group_t

Enumerations

enum  { AST_CHAN_TP_WANTSJITTER = (1 << 0), AST_CHAN_TP_CREATESJITTER = (1 << 1) }
 ast_channel_tech Properties More...
enum  {
  AST_FLAG_DEFER_DTMF = (1 << 1), AST_FLAG_WRITE_INT = (1 << 2), AST_FLAG_BLOCKING = (1 << 3), AST_FLAG_ZOMBIE = (1 << 4),
  AST_FLAG_EXCEPTION = (1 << 5), AST_FLAG_MOH = (1 << 6), AST_FLAG_SPYING = (1 << 7), AST_FLAG_NBRIDGE = (1 << 8),
  AST_FLAG_IN_AUTOLOOP = (1 << 9), AST_FLAG_OUTGOING = (1 << 10), AST_FLAG_WHISPER = (1 << 11), AST_FLAG_IN_DTMF = (1 << 12),
  AST_FLAG_EMULATE_DTMF = (1 << 13), AST_FLAG_END_DTMF_ONLY = (1 << 14), AST_FLAG_MASQ_NOSTREAM = (1 << 15)
}
 ast_channel flags More...
enum  {
  AST_FEATURE_PLAY_WARNING = (1 << 0), AST_FEATURE_REDIRECT = (1 << 1), AST_FEATURE_DISCONNECT = (1 << 2), AST_FEATURE_ATXFER = (1 << 3),
  AST_FEATURE_AUTOMON = (1 << 4), AST_FEATURE_PARKCALL = (1 << 5)
}
 ast_bridge_config flags More...
enum  { AST_CDR_TRANSFER = (1 << 0), AST_CDR_FORWARD = (1 << 1), AST_CDR_CALLWAIT = (1 << 2), AST_CDR_CONFERENCE = (1 << 3) }
enum  {
  AST_SOFTHANGUP_DEV = (1 << 0), AST_SOFTHANGUP_ASYNCGOTO = (1 << 1), AST_SOFTHANGUP_SHUTDOWN = (1 << 2), AST_SOFTHANGUP_TIMEOUT = (1 << 3),
  AST_SOFTHANGUP_APPUNLOAD = (1 << 4), AST_SOFTHANGUP_EXPLICIT = (1 << 5), AST_SOFTHANGUP_UNBRIDGE = (1 << 6)
}
enum  ast_bridge_result { AST_BRIDGE_COMPLETE = 0, AST_BRIDGE_FAILED = -1, AST_BRIDGE_FAILED_NOWARN = -2, AST_BRIDGE_RETRY = -3 }
enum  ast_channel_adsicpe { AST_ADSI_UNKNOWN, AST_ADSI_AVAILABLE, AST_ADSI_UNAVAILABLE, AST_ADSI_OFFHOOKONLY }
enum  ast_channel_state {
  AST_STATE_DOWN, AST_STATE_RESERVED, AST_STATE_OFFHOOK, AST_STATE_DIALING,
  AST_STATE_RING, AST_STATE_RINGING, AST_STATE_UP, AST_STATE_BUSY,
  AST_STATE_DIALING_OFFHOOK, AST_STATE_PRERING, AST_STATE_MUTE = (1 << 16)
}
 ast_channel states More...
enum  channelreloadreason { CHANNEL_MODULE_LOAD, CHANNEL_MODULE_RELOAD, CHANNEL_CLI_RELOAD, CHANNEL_MANAGER_RELOAD }
 Channel reload reasons for manager events at load or reload of configuration. More...

Functions

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)
int ast_activate_generator (struct ast_channel *chan, struct ast_generator *gen, void *params)
int ast_active_channels (void)
 returns number of active/allocated channels
static int ast_add_fd (struct pollfd *pfd, int fd)
 if fd is a valid descriptor, set *pfd with the descriptor
int ast_answer (struct ast_channel *chan)
 Answer a ringing call.
int ast_autoservice_start (struct ast_channel *chan)
 Automatically service a channel for us...
int ast_autoservice_stop (struct ast_channel *chan)
 Stop servicing a channel for us...
void ast_begin_shutdown (int hangup)
 Initiate system shutdown.
int ast_best_codec (int fmts)
 Pick the best audio codec.
ast_channelast_bridged_channel (struct ast_channel *chan)
 Find bridged channel.
int ast_call (struct ast_channel *chan, char *addr, int timeout)
 Make a call.
void ast_cancel_shutdown (void)
 Cancel a shutdown in progress.
const char * ast_cause2str (int state) attribute_pure
 Gives the string form of a given hangup cause.
void ast_change_name (struct ast_channel *chan, char *newname)
 Change channel name.
ast_channelast_channel_alloc (int needqueue, int state, const char *cid_num, const char *cid_name, const char *acctcode, const char *exten, const char *context, const int amaflag, const char *name_fmt,...)
 Create a channel structure.
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)
 Bridge two channels together.
int ast_channel_cmpwhentohangup (struct ast_channel *chan, time_t offset)
 Compare a offset with the settings of when to hang a channel up.
int ast_channel_datastore_add (struct ast_channel *chan, struct ast_datastore *datastore)
 Add a datastore to a channel.
ast_datastoreast_channel_datastore_alloc (const struct ast_datastore_info *info, char *uid)
 Create a channel datastore structure.
ast_datastoreast_channel_datastore_find (struct ast_channel *chan, const struct ast_datastore_info *info, char *uid)
 Find a datastore on a channel.
int ast_channel_datastore_free (struct ast_datastore *datastore)
 Free a channel datastore structure.
int ast_channel_datastore_inherit (struct ast_channel *from, struct ast_channel *to)
 Inherit datastores from a parent to a child.
int ast_channel_datastore_remove (struct ast_channel *chan, struct ast_datastore *datastore)
 Remove a datastore from a channel.
int ast_channel_defer_dtmf (struct ast_channel *chan)
 Set defer DTMF flag on channel.
void ast_channel_free (struct ast_channel *)
 Free a channel structure.
void ast_channel_inherit_variables (const struct ast_channel *parent, struct ast_channel *child)
 Inherits channel variable from parent to child channel.
int ast_channel_make_compatible (struct ast_channel *c0, struct ast_channel *c1)
 Makes two channel formats compatible.
int ast_channel_masquerade (struct ast_channel *original, struct ast_channel *clone)
 Weird function made for call transfers.
ast_frameast_channel_queryoption (struct ast_channel *channel, int option, void *data, int *datalen, int block)
char * ast_channel_reason2str (int reason)
 return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
int ast_channel_register (const struct ast_channel_tech *tech)
 Register a channel technology (a new channel driver) Called by a channel module to register the kind of channels it supports.
int ast_channel_sendhtml (struct ast_channel *channel, int subclass, const char *data, int datalen)
int ast_channel_sendurl (struct ast_channel *channel, const char *url)
int ast_channel_setoption (struct ast_channel *channel, int option, void *data, int datalen, int block)
 Sets an option on a channel.
void ast_channel_setwhentohangup (struct ast_channel *chan, time_t offset)
 Set when to hang a channel up.
ast_silence_generatorast_channel_start_silence_generator (struct ast_channel *chan)
 Starts a silence generator on the given channel.
void ast_channel_stop_silence_generator (struct ast_channel *chan, struct ast_silence_generator *state)
 Stops a previously-started silence generator on the given channel.
int ast_channel_supports_html (struct ast_channel *channel)
void ast_channel_undefer_dtmf (struct ast_channel *chan)
 Unset defer DTMF flag on channel.
void ast_channel_unregister (const struct ast_channel_tech *tech)
 Unregister a channel technology.
ast_channelast_channel_walk_locked (const struct ast_channel *prev)
 Browse channels in use Browse the channels currently in use.
int ast_channel_whisper_feed (struct ast_channel *chan, struct ast_frame *f)
 Feed an audio frame into the whisper buffer on a channel.
int ast_channel_whisper_start (struct ast_channel *chan)
 Begin 'whispering' onto a channel.
void ast_channel_whisper_stop (struct ast_channel *chan)
 Stop 'whispering' onto a channel.
ast_variableast_channeltype_list (void)
 return an ast_variable list of channeltypes
int ast_check_hangup (struct ast_channel *chan)
 Check to see if a channel is needing hang up.
void ast_deactivate_generator (struct ast_channel *chan)
int ast_do_masquerade (struct ast_channel *chan)
 Start masquerading a channel XXX This is a seriously wacked out operation. We're essentially putting the guts of the clone channel into the original channel. Start by killing off the original channel's backend. I'm not sure we're going to keep this function, because while the features are nice, the cost is very high in terms of pure nastiness. XXX.
static int ast_fdisset (struct pollfd *pfds, int fd, int max, int *start)
 Helper function for migrating select to poll.
ast_channelast_get_channel_by_exten_locked (const char *exten, const char *context)
 Get channel by exten (and optionally context) and lock it.
ast_channelast_get_channel_by_name_locked (const char *chan)
 Get channel by name (locks channel).
ast_channelast_get_channel_by_name_prefix_locked (const char *name, const int namelen)
 Get channel by name prefix (locks channel).
ast_channel_techast_get_channel_tech (const char *name)
 Get a channel technology structure by name.
ast_group_t ast_get_group (const char *s)
int ast_hangup (struct ast_channel *chan)
 Hang up a channel.
int ast_indicate (struct ast_channel *chan, int condition)
 Indicates condition of channel.
int ast_indicate_data (struct ast_channel *chan, int condition, const void *data, size_t datalen)
 Indicates condition of channel, with payload.
int ast_internal_timing_enabled (struct ast_channel *chan)
 Check if the channel can run in internal timing mode.
char * ast_print_group (char *buf, int buflen, ast_group_t group)
 print call- and pickup groups into buffer
int ast_prod (struct ast_channel *chan)
 Send empty audio to prime a channel driver.
int ast_queue_control (struct ast_channel *chan, enum ast_control_frame_type control)
 Queue a control frame with payload.
int ast_queue_control_data (struct ast_channel *chan, enum ast_control_frame_type control, const void *data, size_t datalen)
 Queue a control frame with payload.
int ast_queue_frame (struct ast_channel *chan, struct ast_frame *f)
 Queue an outgoing frame.
int ast_queue_hangup (struct ast_channel *chan)
 Queue a hangup frame.
ast_frameast_read (struct ast_channel *chan)
 Reads a frame.
ast_frameast_read_noaudio (struct ast_channel *chan)
 Reads a frame, returning AST_FRAME_NULL frame if audio. Read a frame.
int ast_readstring (struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders)
int ast_readstring_full (struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd)
int ast_recvchar (struct ast_channel *chan, int timeout)
 Receives a text character from a channel.
char * ast_recvtext (struct ast_channel *chan, int timeout)
 Receives a text string from a channel Read a string of text from a channel.
ast_channelast_request (const char *type, int format, void *data, int *status)
 Requests a channel.
ast_channelast_request_and_dial (const char *type, int format, void *data, int timeout, int *reason, const char *cidnum, const char *cidname)
 Request a channel of a given type, with data as optional information used by the low level module and attempt to place a call on it.
int ast_safe_sleep (struct ast_channel *chan, int ms)
 Wait for a specied amount of time, looking for hangups.
int ast_safe_sleep_conditional (struct ast_channel *chan, int ms, int(*cond)(void *), void *data)
 Wait for a specied amount of time, looking for hangups and a condition argument.
char * ast_safe_string_alloc (const char *fmt,...)
 printf the string into a correctly sized mallocd buffer, and return the buffer
static int ast_select (int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
 Waits for activity on a group of channels.
int ast_senddigit (struct ast_channel *chan, char digit)
 Send a DTMF digit to a channel Send a DTMF digit to a channel.
int ast_senddigit_begin (struct ast_channel *chan, char digit)
int ast_senddigit_end (struct ast_channel *chan, char digit, unsigned int duration)
int ast_sendtext (struct ast_channel *chan, const char *text)
 Sends text to a channel Write text to a display on a channel.
void ast_set_callerid (struct ast_channel *chan, const char *cidnum, const char *cidname, const char *ani)
int ast_set_read_format (struct ast_channel *chan, int format)
 Sets read format on channel chan Set read format for channel to whichever component of "format" is best.
void ast_set_variables (struct ast_channel *chan, struct ast_variable *vars)
 adds a list of channel variables to a channel
int ast_set_write_format (struct ast_channel *chan, int format)
 Sets write format on channel chan Set write format for channel to whichever compoent of "format" is best.
int ast_setstate (struct ast_channel *chan, enum ast_channel_state)
 Change the state of a channel.
int ast_settimeout (struct ast_channel *c, int samples, int(*func)(const void *data), void *data)
int ast_shutting_down (void)
 Returns non-zero if Asterisk is being shut down.
int ast_softhangup (struct ast_channel *chan, int cause)
 Softly hangup up a channel.
int ast_softhangup_nolock (struct ast_channel *chan, int cause)
 Softly hangup up a channel (no channel lock).
char * ast_state2str (enum ast_channel_state)
 Gives the string form of a given channel state.
int ast_str2cause (const char *name) attribute_pure
 Convert a symbolic hangup cause to number.
int ast_tonepair (struct ast_channel *chan, int freq1, int freq2, int duration, int vol)
int ast_tonepair_start (struct ast_channel *chan, int freq1, int freq2, int duration, int vol)
void ast_tonepair_stop (struct ast_channel *chan)
int ast_transfer (struct ast_channel *chan, char *dest)
 Transfer a channel (if supported). Returns -1 on error, 0 if not supported and 1 if supported and requested.
char * ast_transfercapability2str (int transfercapability) attribute_const
 Gives the string form of a given transfer capability.
int ast_waitfor (struct ast_channel *chan, int ms)
 Wait for input on a channel.
ast_channelast_waitfor_n (struct ast_channel **chan, int n, int *ms)
 Waits for input on a group of channels Wait for input on an array of channels for a given # of milliseconds.
int ast_waitfor_n_fd (int *fds, int n, int *ms, int *exception)
 Waits for input on an fd This version works on fd's only. Be careful with it.
ast_channelast_waitfor_nandfds (struct ast_channel **chan, int n, int *fds, int nfds, int *exception, int *outfd, int *ms)
 Waits for activity on a group of channels.
int ast_waitfordigit (struct ast_channel *c, int ms)
 Waits for a digit.
int ast_waitfordigit_full (struct ast_channel *c, int ms, int audiofd, int ctrlfd)
 Wait for a digit Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
ast_channelast_walk_channel_by_exten_locked (const struct ast_channel *chan, const char *exten, const char *context)
 Get next channel by exten (and optionally context) and lock it.
ast_channelast_walk_channel_by_name_prefix_locked (const struct ast_channel *chan, const char *name, const int namelen)
 Get channel by name prefix (locks channel).
int ast_write (struct ast_channel *chan, struct ast_frame *frame)
 Write a frame to a channel This function writes the given frame to the indicated channel.
int ast_write_video (struct ast_channel *chan, struct ast_frame *frame)
 Write video frame to a channel This function writes the given frame to the indicated channel.
const char * channelreloadreason2txt (enum channelreloadreason reason)
 Convert enum channelreloadreason to text string for manager event.


Detailed Description

General Asterisk PBX channel definitions.

See also:

Definition in file channel.h.


Define Documentation

#define AST_AGENT_FD   (AST_MAX_FDS-3)

used by agents for pass through

Definition at line 130 of file channel.h.

Referenced by agent_read().

#define AST_ALERT_FD   (AST_MAX_FDS-1)

used for alertpipe

Definition at line 128 of file channel.h.

Referenced by ast_channel_alloc(), and restore_channel().

#define AST_BRIDGE_DTMF_CHANNEL_0   (1 << 0)

Report DTMF on channel 0.

Definition at line 994 of file channel.h.

Referenced by ast_generic_bridge(), bridge_native_loop(), dahdi_bridge(), iax2_bridge(), misdn_bridge(), and set_config_flags().

#define AST_BRIDGE_DTMF_CHANNEL_1   (1 << 1)

Report DTMF on channel 1.

Definition at line 996 of file channel.h.

Referenced by ast_generic_bridge(), bridge_native_loop(), dahdi_bridge(), iax2_bridge(), misdn_bridge(), and set_config_flags().

#define AST_BRIDGE_IGNORE_SIGS   (1 << 4)

Ignore all signal frames except NULL.

Definition at line 1002 of file channel.h.

Referenced by bridge_native_loop().

#define AST_BRIDGE_REC_CHANNEL_0   (1 << 2)

Return all voice frames on channel 0.

Definition at line 998 of file channel.h.

#define AST_BRIDGE_REC_CHANNEL_1   (1 << 3)

Return all voice frames on channel 1.

Definition at line 1000 of file channel.h.

#define AST_CHANNEL_NAME   80

Max length of an ast_channel name

Definition at line 105 of file channel.h.

Referenced by agent_devicestate_cb(), ast_channel_free(), ast_parse_device_state(), ast_setstate(), create_jb(), fast_originate(), next_channel(), page_exec(), park_call_full(), and softhangup_exec().

#define AST_GENERATOR_FD   (AST_MAX_FDS-4)

used by generator

Definition at line 131 of file channel.h.

Referenced by __ast_read(), ast_deactivate_generator(), and ast_do_masquerade().

#define AST_MAX_CONTEXT   80

Max length of a context

Definition at line 104 of file channel.h.

Referenced by _macro_exec(), cleanup_stale_contexts(), conf_run(), gtalk_load_config(), reload_config(), and try_calling().

#define AST_MAX_EXTENSION   80

Max length of an extension

Definition at line 103 of file channel.h.

Referenced by add_extensions(), advanced_options(), ast_bridge_call(), ast_device_state_changed(), ast_extension_state2(), ast_hint_state_changed(), ast_ivr_menu_run_internal(), begin_dial(), conf_run(), destroy_station(), disa_exec(), do_parking_thread(), dundi_lookup_local(), forward_message(), function_enum(), get_destination(), gosub_exec(), load_config(), log_exec(), mgcp_ss(), park_add_hints(), park_call_exec(), phone_check_exception(), realtime_switch_common(), show_dialplan_helper(), skinny_answer(), skinny_indicate(), skinny_ss(), speech_background(), ss_thread(), transmit_state_notify(), try_calling(), vm_authenticate(), vmauthenticate(), and wait_for_answer().

#define AST_MAX_FDS   8

Definition at line 123 of file channel.h.

Referenced by ast_channel_alloc(), ast_do_masquerade(), ast_waitfor_nandfds(), do_parking_thread(), and update_features().

#define AST_TIMING_FD   (AST_MAX_FDS-2)

used for timingfd

Definition at line 129 of file channel.h.

Referenced by __ast_read(), agent_read(), ast_channel_alloc(), ast_do_masquerade(), and restore_channel().

#define CHECK_BLOCKING (  ) 

Definition at line 1343 of file channel.h.

Referenced by ast_sendtext(), ast_waitfor_nandfds(), ast_write(), dahdi_read(), and phone_read().

#define DATASTORE_INHERIT_FOREVER   INT_MAX

Definition at line 121 of file channel.h.

Referenced by ast_channel_datastore_inherit(), and try_calling().

#define DEBUGCHAN_FLAG   0x80000000

Definition at line 297 of file channel.h.

Referenced by __ast_read(), ast_write(), handle_core_set_debug_channel(), handle_debugchan_deprecated(), handle_nodebugchan_deprecated(), handle_showchan(), handle_showchan_deprecated(), and serialize_showchan().

#define FRAMECOUNT_INC (  )     ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )

Definition at line 298 of file channel.h.

Referenced by __ast_read(), and ast_write().

#define LOAD_OH ( oh   ) 

Definition at line 542 of file channel.h.

Referenced by ast_pbx_outgoing_exten().

#define MAX_LANGUAGE   20

Max length of the language setting

Definition at line 106 of file channel.h.

#define MAX_MUSICCLASS   80

Max length of the music class setting

Definition at line 107 of file channel.h.


Typedef Documentation

typedef unsigned long long ast_group_t

Definition at line 140 of file channel.h.


Enumeration Type Documentation

anonymous enum

ast_channel_tech Properties

Enumerator:
AST_CHAN_TP_WANTSJITTER  Channels have this property if they can accept input with jitter; i.e. most VoIP channels.
AST_CHAN_TP_CREATESJITTER  Channels have this property if they can create jitter; i.e. most VoIP channels.

Definition at line 467 of file channel.h.

00467      {
00468    /*! \brief Channels have this property if they can accept input with jitter; 
00469     *         i.e. most VoIP channels */
00470    AST_CHAN_TP_WANTSJITTER = (1 << 0),
00471    /*! \brief Channels have this property if they can create jitter; 
00472     *         i.e. most VoIP channels */
00473    AST_CHAN_TP_CREATESJITTER = (1 << 1),
00474 };

anonymous enum

ast_channel flags

Enumerator:
AST_FLAG_DEFER_DTMF  Queue incoming dtmf, to be released when this flag is turned off
AST_FLAG_WRITE_INT  write should be interrupt generator
AST_FLAG_BLOCKING  a thread is blocking on this channel
AST_FLAG_ZOMBIE  This is a zombie channel
AST_FLAG_EXCEPTION  There is an exception pending
AST_FLAG_MOH  Listening to moh XXX anthm promises me this will disappear XXX
AST_FLAG_SPYING  This channel is spying on another channel
AST_FLAG_NBRIDGE  This channel is in a native bridge
AST_FLAG_IN_AUTOLOOP  the channel is in an auto-incrementing dialplan processor, so when ->priority is set, it will get incremented before finding the next priority to run
AST_FLAG_OUTGOING  This is an outgoing call
AST_FLAG_WHISPER  This channel is being whispered on
AST_FLAG_IN_DTMF  A DTMF_BEGIN frame has been read from this channel, but not yet an END
AST_FLAG_EMULATE_DTMF  A DTMF_END was received when not IN_DTMF, so the length of the digit is currently being emulated
AST_FLAG_END_DTMF_ONLY  This is set to tell the channel not to generate DTMF begin frames, and to instead only generate END frames.
AST_FLAG_MASQ_NOSTREAM  This flag indicates that on a masquerade, an active stream should not be carried over

Definition at line 477 of file channel.h.

00477      {
00478    /*! Queue incoming dtmf, to be released when this flag is turned off */
00479    AST_FLAG_DEFER_DTMF =    (1 << 1),
00480    /*! write should be interrupt generator */
00481    AST_FLAG_WRITE_INT =     (1 << 2),
00482    /*! a thread is blocking on this channel */
00483    AST_FLAG_BLOCKING =      (1 << 3),
00484    /*! This is a zombie channel */
00485    AST_FLAG_ZOMBIE =        (1 << 4),
00486    /*! There is an exception pending */
00487    AST_FLAG_EXCEPTION =     (1 << 5),
00488    /*! Listening to moh XXX anthm promises me this will disappear XXX */
00489    AST_FLAG_MOH =           (1 << 6),
00490    /*! This channel is spying on another channel */
00491    AST_FLAG_SPYING =        (1 << 7),
00492    /*! This channel is in a native bridge */
00493    AST_FLAG_NBRIDGE =       (1 << 8),
00494    /*! the channel is in an auto-incrementing dialplan processor,
00495     *  so when ->priority is set, it will get incremented before
00496     *  finding the next priority to run */
00497    AST_FLAG_IN_AUTOLOOP =   (1 << 9),
00498    /*! This is an outgoing call */
00499    AST_FLAG_OUTGOING =      (1 << 10),
00500    /*! This channel is being whispered on */
00501    AST_FLAG_WHISPER =       (1 << 11),
00502    /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
00503    AST_FLAG_IN_DTMF =       (1 << 12),
00504    /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is 
00505     *  currently being emulated */
00506    AST_FLAG_EMULATE_DTMF =  (1 << 13),
00507    /*! This is set to tell the channel not to generate DTMF begin frames, and
00508     *  to instead only generate END frames. */
00509    AST_FLAG_END_DTMF_ONLY = (1 << 14),
00510    /*! This flag indicates that on a masquerade, an active stream should not
00511     *  be carried over */
00512    AST_FLAG_MASQ_NOSTREAM = (1 << 15),
00513 };

anonymous enum

ast_bridge_config flags

Enumerator:
AST_FEATURE_PLAY_WARNING 
AST_FEATURE_REDIRECT 
AST_FEATURE_DISCONNECT 
AST_FEATURE_ATXFER 
AST_FEATURE_AUTOMON 
AST_FEATURE_PARKCALL 

Definition at line 516 of file channel.h.

00516      {
00517    AST_FEATURE_PLAY_WARNING = (1 << 0),
00518    AST_FEATURE_REDIRECT =     (1 << 1),
00519    AST_FEATURE_DISCONNECT =   (1 << 2),
00520    AST_FEATURE_ATXFER =       (1 << 3),
00521    AST_FEATURE_AUTOMON =      (1 << 4),
00522    AST_FEATURE_PARKCALL =     (1 << 5),
00523 };

anonymous enum

Enumerator:
AST_CDR_TRANSFER 
AST_CDR_FORWARD 
AST_CDR_CALLWAIT 
AST_CDR_CONFERENCE 

Definition at line 564 of file channel.h.

00564      {
00565    AST_CDR_TRANSFER =   (1 << 0),
00566    AST_CDR_FORWARD =    (1 << 1),
00567    AST_CDR_CALLWAIT =   (1 << 2),
00568    AST_CDR_CONFERENCE = (1 << 3),
00569 };

anonymous enum

Enumerator:
AST_SOFTHANGUP_DEV  Soft hangup by device
AST_SOFTHANGUP_ASYNCGOTO  Soft hangup for async goto
AST_SOFTHANGUP_SHUTDOWN 
AST_SOFTHANGUP_TIMEOUT 
AST_SOFTHANGUP_APPUNLOAD 
AST_SOFTHANGUP_EXPLICIT 
AST_SOFTHANGUP_UNBRIDGE 

Definition at line 571 of file channel.h.

00571      {
00572    /*! Soft hangup by device */
00573    AST_SOFTHANGUP_DEV =       (1 << 0),
00574    /*! Soft hangup for async goto */
00575    AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
00576    AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
00577    AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
00578    AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
00579    AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
00580    AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
00581 };

enum ast_bridge_result

Enumerator:
AST_BRIDGE_COMPLETE 
AST_BRIDGE_FAILED 
AST_BRIDGE_FAILED_NOWARN 
AST_BRIDGE_RETRY 

Definition at line 133 of file channel.h.

00133                        {
00134    AST_BRIDGE_COMPLETE = 0,
00135    AST_BRIDGE_FAILED = -1,
00136    AST_BRIDGE_FAILED_NOWARN = -2,
00137    AST_BRIDGE_RETRY = -3,
00138 };

enum ast_channel_adsicpe

Enumerator:
AST_ADSI_UNKNOWN 
AST_ADSI_AVAILABLE 
AST_ADSI_UNAVAILABLE 
AST_ADSI_OFFHOOKONLY 

Definition at line 300 of file channel.h.

enum ast_channel_state

ast_channel states

Note:
Bits 0-15 of state are reserved for the state (up/down) of the line Bits 16-32 of state are reserved for flags
Enumerator:
AST_STATE_DOWN  Channel is down and available
AST_STATE_RESERVED  Channel is down, but reserved
AST_STATE_OFFHOOK  Channel is off hook
AST_STATE_DIALING  Digits (or equivalent) have been dialed
AST_STATE_RING  Line is ringing
AST_STATE_RINGING  Remote end is ringing
AST_STATE_UP  Line is up
AST_STATE_BUSY  Line is busy
AST_STATE_DIALING_OFFHOOK  Digits (or equivalent) have been dialed while offhook
AST_STATE_PRERING  Channel has detected an incoming call and is waiting for ring
AST_STATE_MUTE  Do not transmit voice data

Definition at line 313 of file channel.h.

00313                        {
00314    /*! Channel is down and available */
00315    AST_STATE_DOWN,
00316    /*! Channel is down, but reserved */
00317    AST_STATE_RESERVED,
00318    /*! Channel is off hook */
00319    AST_STATE_OFFHOOK,
00320    /*! Digits (or equivalent) have been dialed */
00321    AST_STATE_DIALING,
00322    /*! Line is ringing */
00323    AST_STATE_RING,
00324    /*! Remote end is ringing */
00325    AST_STATE_RINGING,
00326    /*! Line is up */
00327    AST_STATE_UP,
00328    /*! Line is busy */
00329    AST_STATE_BUSY,
00330    /*! Digits (or equivalent) have been dialed while offhook */
00331    AST_STATE_DIALING_OFFHOOK,
00332    /*! Channel has detected an incoming call and is waiting for ring */
00333    AST_STATE_PRERING,
00334 
00335    /*! Do not transmit voice data */
00336    AST_STATE_MUTE = (1 << 16),
00337 };

enum channelreloadreason

Channel reload reasons for manager events at load or reload of configuration.

Enumerator:
CHANNEL_MODULE_LOAD 
CHANNEL_MODULE_RELOAD 
CHANNEL_CLI_RELOAD 
CHANNEL_MANAGER_RELOAD 

Definition at line 585 of file channel.h.


Function Documentation

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 
)

Definition at line 2882 of file channel.c.

References ast_channel::_state, outgoing_helper::account, ast_call(), AST_CAUSE_BUSY, AST_CAUSE_CONGESTION, AST_CAUSE_NO_ANSWER, ast_cdr_alloc(), ast_cdr_disposition(), ast_cdr_end(), ast_cdr_failed(), ast_cdr_init(), ast_cdr_setaccount(), ast_cdr_setapp(), ast_cdr_start(), ast_cdr_update(), ast_channel_inherit_variables(), AST_CONTROL_ANSWER, AST_CONTROL_BUSY, AST_CONTROL_CONGESTION, AST_CONTROL_HANGUP, AST_CONTROL_HOLD, AST_CONTROL_PROCEEDING, AST_CONTROL_PROGRESS, AST_CONTROL_RINGING, AST_CONTROL_SRCUPDATE, AST_CONTROL_UNHOLD, AST_CONTROL_VIDUPDATE, AST_FRAME_CONTROL, ast_frfree, ast_hangup(), ast_log(), ast_read(), ast_request(), ast_set_callerid(), ast_set_variables(), AST_STATE_UP, ast_strlen_zero(), ast_waitfor(), ast_channel::cdr, outgoing_helper::cid_name, outgoing_helper::cid_num, ast_channel::context, outgoing_helper::context, ast_channel::exten, outgoing_helper::exten, f, ast_channel::hangupcause, LOG_NOTICE, outgoing_helper::parent_channel, ast_channel::priority, outgoing_helper::priority, and outgoing_helper::vars.

Referenced by ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_request_and_dial(), and parkandannounce_exec().

02883 {
02884    int dummy_outstate;
02885    int cause = 0;
02886    struct ast_channel *chan;
02887    int res = 0;
02888    int last_subclass = 0;
02889    
02890    if (outstate)
02891       *outstate = 0;
02892    else
02893       outstate = &dummy_outstate;   /* make outstate always a valid pointer */
02894 
02895    chan = ast_request(type, format, data, &cause);
02896    if (!chan) {
02897       ast_log(LOG_NOTICE, "Unable to request channel %s/%s\n", type, (char *)data);
02898       /* compute error and return */
02899       if (cause == AST_CAUSE_BUSY)
02900          *outstate = AST_CONTROL_BUSY;
02901       else if (cause == AST_CAUSE_CONGESTION)
02902          *outstate = AST_CONTROL_CONGESTION;
02903       return NULL;
02904    }
02905 
02906    if (oh) {
02907       if (oh->vars)  
02908          ast_set_variables(chan, oh->vars);
02909       /* XXX why is this necessary, for the parent_channel perhaps ? */
02910       if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name))
02911          ast_set_callerid(chan, oh->cid_num, oh->cid_name, oh->cid_num);
02912       if (oh->parent_channel)
02913          ast_channel_inherit_variables(oh->parent_channel, chan);
02914       if (oh->account)
02915          ast_cdr_setaccount(chan, oh->account); 
02916    }
02917    ast_set_callerid(chan, cid_num, cid_name, cid_num);
02918 
02919    if (ast_call(chan, data, 0)) {   /* ast_call failed... */
02920       ast_log(LOG_NOTICE, "Unable to call channel %s/%s\n", type, (char *)data);
02921    } else {
02922       res = 1; /* mark success in case chan->_state is already AST_STATE_UP */
02923       while (timeout && chan->_state != AST_STATE_UP) {
02924          struct ast_frame *f;
02925          res = ast_waitfor(chan, timeout);
02926          if (res <= 0) /* error, timeout, or done */
02927             break;
02928          if (timeout > -1)
02929             timeout = res;
02930          f = ast_read(chan);
02931          if (!f) {
02932             *outstate = AST_CONTROL_HANGUP;
02933             res = 0;
02934             break;
02935          }
02936          if (f->frametype == AST_FRAME_CONTROL) {
02937             switch (f->subclass) {
02938             case AST_CONTROL_RINGING:  /* record but keep going */
02939                *outstate = f->subclass;
02940                break;
02941 
02942             case AST_CONTROL_BUSY:
02943             case AST_CONTROL_CONGESTION:
02944             case AST_CONTROL_ANSWER:
02945                *outstate = f->subclass;
02946                timeout = 0;      /* trick to force exit from the while() */
02947                break;
02948 
02949             /* Ignore these */
02950             case AST_CONTROL_PROGRESS:
02951             case AST_CONTROL_PROCEEDING:
02952             case AST_CONTROL_HOLD:
02953             case AST_CONTROL_UNHOLD:
02954             case AST_CONTROL_VIDUPDATE:
02955             case AST_CONTROL_SRCUPDATE:
02956             case -1:       /* Ignore -- just stopping indications */
02957                break;
02958 
02959             default:
02960                ast_log(LOG_NOTICE, "Don't know what to do with control frame %d\n", f->subclass);
02961             }
02962             last_subclass = f->subclass;
02963          }
02964          ast_frfree(f);
02965       }
02966    }
02967 
02968    /* Final fixups */
02969    if (oh) {
02970       if (!ast_strlen_zero(oh->context))
02971          ast_copy_string(chan->context, oh->context, sizeof(chan->context));
02972       if (!ast_strlen_zero(oh->exten))
02973          ast_copy_string(chan->exten, oh->exten, sizeof(chan->exten));
02974       if (oh->priority) 
02975          chan->priority = oh->priority;
02976    }
02977    if (chan->_state == AST_STATE_UP)
02978       *outstate = AST_CONTROL_ANSWER;
02979 
02980    if (res <= 0) {
02981       if ( AST_CONTROL_RINGING == last_subclass ) 
02982          chan->hangupcause = AST_CAUSE_NO_ANSWER;
02983       if (!chan->cdr && (chan->cdr = ast_cdr_alloc()))
02984          ast_cdr_init(chan->cdr, chan);
02985       if (chan->cdr) {
02986          char tmp[256];
02987          snprintf(tmp, sizeof(tmp), "%s/%s", type, (char *)data);
02988          ast_cdr_setapp(chan->cdr,"Dial",tmp);
02989          ast_cdr_update(chan);
02990          ast_cdr_start(chan->cdr);
02991          ast_cdr_end(chan->cdr);
02992          /* If the cause wasn't handled properly */
02993          if (ast_cdr_disposition(chan->cdr,chan->hangupcause))
02994             ast_cdr_failed(chan->cdr);
02995       }
02996       ast_hangup(chan);
02997       chan = NULL;
02998    }
02999    return chan;
03000 }

int ast_activate_generator ( struct ast_channel chan,
struct ast_generator gen,
void *  params 
)

Activate a given generator

Definition at line 1616 of file channel.c.

References ast_generator::alloc, ast_channel_lock, ast_channel_unlock, ast_prod(), ast_settimeout(), gen, ast_channel::generator, generator_force(), ast_channel::generatordata, and ast_generator::release.

Referenced by app_exec(), ast_channel_start_silence_generator(), ast_linear_stream(), ast_playtones_start(), ast_tonepair_start(), channel_spy(), local_ast_moh_start(), and old_milliwatt_exec().

01617 {
01618    int res = 0;
01619 
01620    ast_channel_lock(chan);
01621 
01622    if (chan->generatordata) {
01623       if (chan->generator && chan->generator->release)
01624          chan->generator->release(chan, chan->generatordata);
01625       chan->generatordata = NULL;
01626    }
01627 
01628    ast_prod(chan);
01629    if (gen->alloc && !(chan->generatordata = gen->alloc(chan, params))) {
01630       res = -1;
01631    }
01632    
01633    if (!res) {
01634       ast_settimeout(chan, 160, generator_force, chan);
01635       chan->generator = gen;
01636    }
01637 
01638    ast_channel_unlock(chan);
01639 
01640    return res;
01641 }

int ast_active_channels ( void   ) 

returns number of active/allocated channels

Returns number of active/allocated channels

Definition at line 443 of file channel.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, and channels.

Referenced by action_corestatus(), dahdi_restart(), handle_show_settings(), and quit_handler().

00444 {
00445    struct ast_channel *c;
00446    int cnt = 0;
00447    AST_LIST_LOCK(&channels);
00448    AST_LIST_TRAVERSE(&channels, c, chan_list)
00449       cnt++;
00450    AST_LIST_UNLOCK(&channels);
00451    return cnt;
00452 }

static int ast_add_fd ( struct pollfd pfd,
int  fd 
) [inline, static]

if fd is a valid descriptor, set *pfd with the descriptor

Returns:
Return 1 (not -1!) if added, 0 otherwise (so we can add the return value to the index into the array)

Definition at line 1268 of file channel.h.

References pollfd::events, pollfd::fd, POLLIN, and POLLPRI.

Referenced by ast_waitfor_nandfds().

01269 {
01270    pfd->fd = fd;
01271    pfd->events = POLLIN | POLLPRI;
01272    return fd >= 0;
01273 }

int ast_answer ( struct ast_channel chan  ) 

Answer a ringing call.

Parameters:
chan channel to answer This function answers a channel and handles all necessary call setup functions.
Returns:
Returns 0 on success, -1 on failure

Definition at line 1538 of file channel.c.

References ast_channel::_state, ast_channel_tech::answer, ast_cdr_answer(), ast_channel_lock, ast_channel_unlock, ast_check_hangup(), AST_FLAG_OUTGOING, AST_FLAG_ZOMBIE, ast_setstate(), AST_STATE_RING, AST_STATE_RINGING, AST_STATE_UP, ast_test_flag, ast_channel::cdr, ast_channel::tech, and ast_channel::visible_indication.

Referenced by __login_exec(), agi_exec_full(), alarmreceiver_exec(), app_exec(), ast_bridge_call(), ast_control_streamfile(), ast_pickup_call(), auth_exec(), background_detect_exec(), builtin_parkcall(), common_exec(), conf_exec(), count_exec(), dictate_exec(), directory_exec(), disa_exec(), exec(), features_answer(), handle_answer(), ices_exec(), old_milliwatt_exec(), park_call_exec(), park_exec(), pbx_builtin_answer(), pbx_builtin_background(), pickup_do(), playback_exec(), privacy_exec(), read_exec(), run_station(), sayunixtime_exec(), send_waveform_to_channel(), skel_exec(), sla_handle_dial_state_event(), sla_station_exec(), speech_background(), testclient_exec(), testserver_exec(), vm_exec(), vm_execmain(), waitforsilence_exec(), and zapateller_exec().

01539 {
01540    int res = 0;
01541    ast_channel_lock(chan);
01542    /* You can't answer an outbound call */
01543    if (ast_test_flag(chan, AST_FLAG_OUTGOING)) {
01544       ast_channel_unlock(chan);
01545       return 0;
01546    }
01547    /* Stop if we're a zombie or need a soft hangup */
01548    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
01549       ast_channel_unlock(chan);
01550       return -1;
01551    }
01552    switch(chan->_state) {
01553    case AST_STATE_RINGING:
01554    case AST_STATE_RING:
01555       if (chan->tech->answer)
01556          res = chan->tech->answer(chan);
01557       ast_setstate(chan, AST_STATE_UP);
01558       ast_cdr_answer(chan->cdr);
01559       break;
01560    case AST_STATE_UP:
01561       break;
01562    default:
01563       break;
01564    }
01565    chan->visible_indication = 0;
01566    ast_channel_unlock(chan);
01567    return res;
01568 }

int ast_autoservice_start ( struct ast_channel chan  ) 

Automatically service a channel for us...

Return values:
0 success
-1 failure, or the channel is already being autoserviced

Definition at line 186 of file autoservice.c.

References as_cond, ast_calloc, ast_channel_lock, ast_channel_unlock, ast_cond_signal(), AST_FLAG_END_DTMF_ONLY, AST_LIST_EMPTY, AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_REMOVE, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), ast_pthread_create_background, AST_PTHREADT_NULL, ast_set_flag, ast_test_flag, asthread, autoservice_run(), asent::chan, free, LOG_WARNING, and asent::use_count.

Referenced by _macro_exec(), acf_curl_exec(), acf_cut_exec(), acf_odbc_read(), acf_odbc_write(), array(), ast_dtmf_stream(), ast_get_enum(), ast_get_srv(), ast_get_txt(), bridge_playfile(), builtin_automonitor(), builtin_blindtransfer(), conf_play(), do_atxfer(), feature_exec_app(), function_eval(), function_fieldqty(), function_realtime_read(), function_realtime_write(), osplookup_exec(), sla_station_exec(), smdi_msg_retrieve_read(), system_exec_helper(), and try_calling().

00187 {
00188    int res = 0;
00189    struct asent *as;
00190 
00191    /* Check if the channel already has autoservice */
00192    AST_LIST_LOCK(&aslist);
00193    AST_LIST_TRAVERSE(&aslist, as, list) {
00194       if (as->chan == chan) {
00195          as->use_count++;
00196          break;
00197       }
00198    }
00199    AST_LIST_UNLOCK(&aslist);
00200 
00201    if (as) {
00202       /* Entry exists, autoservice is already handling this channel */
00203       return 0;
00204    }
00205 
00206    if (!(as = ast_calloc(1, sizeof(*as))))
00207       return -1;
00208    
00209    /* New entry created */
00210    as->chan = chan;
00211    as->use_count = 1;
00212 
00213    ast_channel_lock(chan);
00214    as->orig_end_dtmf_flag = ast_test_flag(chan, AST_FLAG_END_DTMF_ONLY) ? 1 : 0;
00215    if (!as->orig_end_dtmf_flag)
00216       ast_set_flag(chan, AST_FLAG_END_DTMF_ONLY);
00217    ast_channel_unlock(chan);
00218 
00219    AST_LIST_LOCK(&aslist);
00220 
00221    if (AST_LIST_EMPTY(&aslist) && asthread != AST_PTHREADT_NULL) {
00222       ast_cond_signal(&as_cond);
00223    }
00224 
00225    AST_LIST_INSERT_HEAD(&aslist, as, list);
00226 
00227    if (asthread == AST_PTHREADT_NULL) { /* need start the thread */
00228       if (ast_pthread_create_background(&asthread, NULL, autoservice_run, NULL)) {
00229          ast_log(LOG_WARNING, "Unable to create autoservice thread :(\n");
00230          /* There will only be a single member in the list at this point,
00231             the one we just added. */
00232          AST_LIST_REMOVE(&aslist, as, list);
00233          free(as);
00234          asthread = AST_PTHREADT_NULL;
00235          res = -1;
00236       } else {
00237          pthread_kill(asthread, SIGURG);
00238       }
00239    }
00240 
00241    AST_LIST_UNLOCK(&aslist);
00242 
00243    return res;
00244 }

int ast_autoservice_stop ( struct ast_channel chan  ) 

Stop servicing a channel for us...

Return values:
0 success
-1 error, or the channel has been hungup

Definition at line 246 of file autoservice.c.

References ast_channel::_softhangup, as_chan_list_state, ast_clear_flag, AST_FLAG_END_DTMF_ONLY, ast_frfree, AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_REMOVE_HEAD, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, AST_PTHREADT_NULL, ast_queue_frame(), asthread, asent::chan, f, free, asent::orig_end_dtmf_flag, and asent::use_count.

Referenced by _macro_exec(), acf_curl_exec(), acf_cut_exec(), acf_odbc_read(), acf_odbc_write(), ast_dtmf_stream(), ast_get_srv(), ast_get_txt(), ast_hangup(), bridge_playfile(), builtin_automonitor(), conf_play(), do_atxfer(), feature_exec_app(), finishup(), function_eval(), function_fieldqty(), function_realtime_read(), function_realtime_write(), osplookup_exec(), sla_station_exec(), smdi_msg_retrieve_read(), system_exec_helper(), and try_calling().

00247 {
00248    int res = -1;
00249    struct asent *as, *removed = NULL;
00250    struct ast_frame *f;
00251    int chan_list_state;
00252 
00253    AST_LIST_LOCK(&aslist);
00254 
00255    /* Save the autoservice channel list state.  We _must_ verify that the channel
00256     * list has been rebuilt before we return.  Because, after we return, the channel
00257     * could get destroyed and we don't want our poor autoservice thread to step on
00258     * it after its gone! */
00259    chan_list_state = as_chan_list_state;
00260 
00261    /* Find the entry, but do not free it because it still can be in the
00262       autoservice thread array */
00263    AST_LIST_TRAVERSE_SAFE_BEGIN(&aslist, as, list) {  
00264       if (as->chan == chan) {
00265          as->use_count--;
00266          if (as->use_count < 1) {
00267             AST_LIST_REMOVE_CURRENT(&aslist, list);
00268             removed = as;
00269          }
00270          break;
00271       }
00272    }
00273    AST_LIST_TRAVERSE_SAFE_END
00274 
00275    if (removed && asthread != AST_PTHREADT_NULL) {
00276       pthread_kill(asthread, SIGURG);
00277    }
00278 
00279    AST_LIST_UNLOCK(&aslist);
00280 
00281    if (!removed) {
00282       return 0;
00283    }
00284 
00285    /* Wait while autoservice thread rebuilds its list. */
00286    while (chan_list_state == as_chan_list_state) {
00287       usleep(1000);
00288    }
00289 
00290    /* Now autoservice thread should have no references to our entry
00291       and we can safely destroy it */
00292 
00293    if (!chan->_softhangup) {
00294       res = 0;
00295    }
00296 
00297    if (!as->orig_end_dtmf_flag) {
00298       ast_clear_flag(chan, AST_FLAG_END_DTMF_ONLY);
00299    }
00300 
00301    while ((f = AST_LIST_REMOVE_HEAD(&as->deferred_frames, frame_list))) {
00302       ast_queue_frame(chan, f);
00303       ast_frfree(f);
00304    }
00305 
00306    free(as);
00307 
00308    return res;
00309 }

void ast_begin_shutdown ( int  hangup  ) 

Initiate system shutdown.

Initiate system shutdown -- prevents new channels from being allocated. If "hangup" is non-zero, all existing channels will receive soft hangups

Definition at line 430 of file channel.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_softhangup(), AST_SOFTHANGUP_SHUTDOWN, and channels.

Referenced by quit_handler().

00431 {
00432    struct ast_channel *c;
00433    shutting_down = 1;
00434    if (hangup) {
00435       AST_LIST_LOCK(&channels);
00436       AST_LIST_TRAVERSE(&channels, c, chan_list)
00437          ast_softhangup(c, AST_SOFTHANGUP_SHUTDOWN);
00438       AST_LIST_UNLOCK(&channels);
00439    }
00440 }

int ast_best_codec ( int  fmts  ) 

Pick the best audio codec.

Pick the best codec

Okay, ulaw is used by all telephony equipment, so start with it

Unless of course, you're a silly European, so then prefer ALAW

G.722 is better then all below, but not as common as the above... so give ulaw and alaw priority

Okay, well, signed linear is easy to translate into other stuff

G.726 is standard ADPCM, in RFC3551 packing order

G.726 is standard ADPCM, in AAL2 packing order

ADPCM has great sound quality and is still pretty easy to translate

Okay, we're down to vocoders now, so pick GSM because it's small and easier to translate and sounds pretty good

iLBC is not too bad

Speex is free, but computationally more expensive than GSM

Ick, LPC10 sounds terrible, but at least we have code for it, if you're tacky enough to use it

G.729a is faster than 723 and slightly less expensive

Down to G.723.1 which is proprietary but at least designed for voice

Definition at line 655 of file channel.c.

References AST_FORMAT_ADPCM, AST_FORMAT_ALAW, AST_FORMAT_AUDIO_MASK, AST_FORMAT_G722, AST_FORMAT_G723_1, AST_FORMAT_G726, AST_FORMAT_G726_AAL2, AST_FORMAT_G729A, AST_FORMAT_GSM, AST_FORMAT_ILBC, AST_FORMAT_LPC10, AST_FORMAT_SLINEAR, AST_FORMAT_SPEEX, AST_FORMAT_ULAW, ast_log(), LOG_WARNING, and prefs.

Referenced by __login_exec(), __oh323_new(), agent_call(), ast_codec_choose(), ast_iax2_new(), do_atxfer(), echo_exec(), findmeexec(), gtalk_new(), handle_open_receive_channel_ack_message(), iax2_request(), local_new(), mgcp_new(), sip_new(), skinny_new(), socket_process(), and transmit_connect().

00656 {
00657    /* This just our opinion, expressed in code.  We are asked to choose
00658       the best codec to use, given no information */
00659    int x;
00660    static int prefs[] =
00661    {
00662       /*! Okay, ulaw is used by all telephony equipment, so start with it */
00663       AST_FORMAT_ULAW,
00664       /*! Unless of course, you're a silly European, so then prefer ALAW */
00665       AST_FORMAT_ALAW,
00666       /*! G.722 is better then all below, but not as common as the above... so give ulaw and alaw priority */
00667       AST_FORMAT_G722,
00668       /*! Okay, well, signed linear is easy to translate into other stuff */
00669       AST_FORMAT_SLINEAR,
00670       /*! G.726 is standard ADPCM, in RFC3551 packing order */
00671       AST_FORMAT_G726,
00672       /*! G.726 is standard ADPCM, in AAL2 packing order */
00673       AST_FORMAT_G726_AAL2,
00674       /*! ADPCM has great sound quality and is still pretty easy to translate */
00675       AST_FORMAT_ADPCM,
00676       /*! Okay, we're down to vocoders now, so pick GSM because it's small and easier to
00677           translate and sounds pretty good */
00678       AST_FORMAT_GSM,
00679       /*! iLBC is not too bad */
00680       AST_FORMAT_ILBC,
00681       /*! Speex is free, but computationally more expensive than GSM */
00682       AST_FORMAT_SPEEX,
00683       /*! Ick, LPC10 sounds terrible, but at least we have code for it, if you're tacky enough
00684           to use it */
00685       AST_FORMAT_LPC10,
00686       /*! G.729a is faster than 723 and slightly less expensive */
00687       AST_FORMAT_G729A,
00688       /*! Down to G.723.1 which is proprietary but at least designed for voice */
00689       AST_FORMAT_G723_1,
00690    };
00691 
00692    /* Strip out video */
00693    fmts &= AST_FORMAT_AUDIO_MASK;
00694    
00695    /* Find the first preferred codec in the format given */
00696    for (x=0; x < (sizeof(prefs) / sizeof(prefs[0]) ); x++)
00697       if (fmts & prefs[x])
00698          return prefs[x];
00699    ast_log(LOG_WARNING, "Don't know any of 0x%x formats\n", fmts);
00700    return 0;
00701 }

struct ast_channel* ast_bridged_channel ( struct ast_channel chan  ) 

Find bridged channel.

Parameters:
chan Current channel

Definition at line 3718 of file channel.c.

References ast_channel::_bridge, ast_channel_tech::bridged_channel, and ast_channel::tech.

Referenced by __dahdi_exception(), action_agents(), agents_show(), agents_show_online(), ast_channel_masquerade(), attempt_transfer(), cb_events(), check_bridge(), common_exec(), console_transfer(), console_transfer_deprecated(), create_jb(), dahdi_handle_event(), dahdi_hangup(), export_aoc_vars(), handle_chanlist(), handle_chanlist_deprecated(), handle_hd_hf(), handle_invite_replaces(), handle_request(), handle_request_bye(), handle_request_info(), handle_request_invite(), handle_request_refer(), handle_response_invite(), handle_showchan(), handle_showchan_deprecated(), local_attended_transfer(), mgcp_hangup(), mgcp_ss(), misdn_transfer_bc(), mixmonitor_thread(), park_call_full(), schedule_delivery(), sip_read(), socket_process(), ss_thread(), start_spying(), and startmon().

03719 {
03720    struct ast_channel *bridged;
03721    bridged = chan->_bridge;
03722    if (bridged && bridged->tech->bridged_channel)
03723       bridged = bridged->tech->bridged_channel(chan, bridged);
03724    return bridged;
03725 }

int ast_call ( struct ast_channel chan,
char *  addr,
int  timeout 
)

Make a call.

Parameters:
chan which channel to make the call on
addr destination of the call
timeout time to wait on for connect Place a call, take no longer than timeout ms.
Returns:
Returns -1 on failure, 0 on not enough time (does not automatically stop ringing), and the number of seconds the connect took otherwise.

Definition at line 3057 of file channel.c.

References AST_CDR_FLAG_DIALED, ast_channel_lock, ast_channel_unlock, ast_check_hangup(), AST_FLAG_OUTGOING, AST_FLAG_ZOMBIE, ast_set_flag, ast_test_flag, ast_channel_tech::call, ast_channel::cdr, and ast_channel::tech.

Referenced by __ast_request_and_dial(), agent_call(), ast_feature_request_and_dial(), attempt_reconnect(), begin_dial(), connect_link(), features_call(), findmeexec(), ring_entry(), rpt(), and wait_for_answer().

03058 {
03059    /* Place an outgoing call, but don't wait any longer than timeout ms before returning.
03060       If the remote end does not answer within the timeout, then do NOT hang up, but
03061       return anyway.  */
03062    int res = -1;
03063    /* Stop if we're a zombie or need a soft hangup */
03064    ast_channel_lock(chan);
03065    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
03066       if (chan->cdr)
03067          ast_set_flag(chan->cdr, AST_CDR_FLAG_DIALED);
03068       if (chan->tech->call)
03069          res = chan->tech->call(chan, addr, timeout);
03070       ast_set_flag(chan, AST_FLAG_OUTGOING);
03071    }
03072    ast_channel_unlock(chan);
03073    return res;
03074 }

void ast_cancel_shutdown ( void   ) 

Cancel a shutdown in progress.

Cancels an existing shutdown and returns to normal operation

Definition at line 455 of file channel.c.

Referenced by handle_abort_halt().

00456 {
00457    shutting_down = 0;
00458 }

const char* ast_cause2str ( int  state  ) 

Gives the string form of a given hangup cause.

Parameters:
state cause to get the description of Give a name to a cause code Returns the text form of the binary cause code given

Definition at line 575 of file channel.c.

References causes, and desc.

Referenced by __transmit_response(), ast_do_masquerade(), ast_hangup(), findmeexec(), pbx_retrieve_variable(), sip_hangup(), and transmit_request_with_auth().

00576 {
00577    int x;
00578 
00579    for (x=0; x < sizeof(causes) / sizeof(causes[0]); x++) {
00580       if (causes[x].cause == cause)
00581          return causes[x].desc;
00582    }
00583 
00584    return "Unknown";
00585 }

void ast_change_name ( struct ast_channel chan,
char *  newname 
)

Change channel name.

Definition at line 3307 of file channel.c.

References ast_string_field_set, EVENT_FLAG_CALL, manager_event(), and name.

03308 {
03309    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", chan->name, newname, chan->uniqueid);
03310    ast_string_field_set(chan, name, newname);
03311 }

struct ast_channel* ast_channel_alloc ( int  needqueue,
int  state,
const char *  cid_num,
const char *  cid_name,
const char *  acctcode,
const char *  exten,
const char *  context,
const int  amaflag,
const char *  name_fmt,
  ... 
)

Create a channel structure.

Returns:
Returns NULL on failure to allocate.
Note:
New channels are by default set to the "default" context and extension "s"

Definition at line 709 of file channel.c.

References accountcode, AST_ALERT_FD, ast_calloc, ast_cdr_alloc(), ast_cdr_init(), ast_cdr_start(), ast_config_AST_SYSTEM_NAME, ast_default_accountcode, ast_default_amaflags, AST_LIST_HEAD_INIT_NOLOCK, AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_log(), AST_MAX_FDS, ast_mutex_init(), ast_state2str(), ast_strdup, ast_string_field_build, ast_string_field_build_va, ast_string_field_free_memory, ast_string_field_init, ast_string_field_set, ast_strlen_zero(), AST_TIMING_FD, channels, defaultlanguage, errno, EVENT_FLAG_CALL, ast_channel::flags, free, HAVE_ZAPTEL, language, LOG_WARNING, manager_event(), name, null_tech, S_OR, sched_context_create(), and sched_context_destroy().

Referenced by __oh323_new(), acf_odbc_read(), acf_odbc_write(), agent_new(), alsa_new(), ast_async_goto(), ast_iax2_new(), ast_masq_park_call(), ast_pbx_outgoing_cdr_failed(), ast_pbx_outgoing_exten(), check_goto_on_transfer(), dahdi_new(), do_atxfer(), features_new(), gtalk_new(), iax_park(), local_new(), make_email_file(), mgcp_new(), misdn_new(), nbs_new(), oss_new(), pbx_substitute_variables_helper_full(), phone_new(), sendpage(), sip_new(), sip_park(), and skinny_new().

00710 {
00711    struct ast_channel *tmp;
00712    int x;
00713    int flags;
00714    struct varshead *headp;
00715    va_list ap1, ap2;
00716 
00717    /* If shutting down, don't allocate any new channels */
00718    if (shutting_down) {
00719       ast_log(LOG_WARNING, "Channel allocation failed: Refusing due to active shutdown\n");
00720       return NULL;
00721    }
00722 
00723    if (!(tmp = ast_calloc(1, sizeof(*tmp))))
00724       return NULL;
00725 
00726    if (!(tmp->sched = sched_context_create())) {
00727       ast_log(LOG_WARNING, "Channel allocation failed: Unable to create schedule context\n");
00728       free(tmp);
00729       return NULL;
00730    }
00731    
00732    if ((ast_string_field_init(tmp, 128))) {
00733       sched_context_destroy(tmp->sched);
00734       free(tmp);
00735       return NULL;
00736    }
00737 
00738    /* Don't bother initializing the last two FD here, because they
00739       will *always* be set just a few lines down (AST_TIMING_FD,
00740       AST_ALERT_FD). */
00741    for (x = 0; x < AST_MAX_FDS - 2; x++)
00742       tmp->fds[x] = -1;
00743 
00744 #ifdef HAVE_DAHDI
00745 
00746 #ifdef HAVE_ZAPTEL
00747    tmp->timingfd = open("/dev/zap/timer", O_RDWR);
00748 #else
00749    tmp->timingfd = open("/dev/dahdi/timer", O_RDWR);
00750 #endif
00751 
00752    if (tmp->timingfd > -1) {
00753       /* Check if timing interface supports new
00754          ping/pong scheme */
00755       flags = 1;
00756       if (!ioctl(tmp->timingfd, DAHDI_TIMERPONG, &flags))
00757          needqueue = 0;
00758    }
00759 #else
00760    tmp->timingfd = -1;              
00761 #endif               
00762 
00763    if (needqueue) {
00764       if (pipe(tmp->alertpipe)) {
00765          ast_log(LOG_WARNING, "Channel allocation failed: Can't create alert pipe!\n");
00766 alertpipe_failed:
00767 #ifdef HAVE_DAHDI
00768          if (tmp->timingfd > -1)
00769             close(tmp->timingfd);
00770 #endif
00771          sched_context_destroy(tmp->sched);
00772          ast_string_field_free_memory(tmp);
00773          free(tmp);
00774          return NULL;
00775       } else {
00776          flags = fcntl(tmp->alertpipe[0], F_GETFL);
00777          if (fcntl(tmp->alertpipe[0], F_SETFL, flags | O_NONBLOCK) < 0) {
00778             ast_log(LOG_WARNING, "Channel allocation failed: Unable to set alertpipe nonblocking! (%d: %s)\n", errno, strerror(errno));
00779             close(tmp->alertpipe[0]);
00780             close(tmp->alertpipe[1]);
00781             goto alertpipe_failed;
00782          }
00783          flags = fcntl(tmp->alertpipe[1], F_GETFL);
00784          if (fcntl(tmp->alertpipe[1], F_SETFL, flags | O_NONBLOCK) < 0) {
00785             ast_log(LOG_WARNING, "Channel allocation failed: Unable to set alertpipe nonblocking! (%d: %s)\n", errno, strerror(errno));
00786             close(tmp->alertpipe[0]);
00787             close(tmp->alertpipe[1]);
00788             goto alertpipe_failed;
00789          }
00790       }
00791    } else   /* Make sure we've got it done right if they don't */
00792       tmp->alertpipe[0] = tmp->alertpipe[1] = -1;
00793 
00794    /* Always watch the alertpipe */
00795    tmp->fds[AST_ALERT_FD] = tmp->alertpipe[0];
00796    /* And timing pipe */
00797    tmp->fds[AST_TIMING_FD] = tmp->timingfd;
00798    ast_string_field_set(tmp, name, "**Unknown**");
00799 
00800    /* Initial state */
00801    tmp->_state = state;
00802 
00803    tmp->streamid = -1;
00804    
00805    tmp->fin = global_fin;
00806    tmp->fout = global_fout;
00807 
00808    if (ast_strlen_zero(ast_config_AST_SYSTEM_NAME)) {
00809       ast_string_field_build(tmp, uniqueid, "%li.%d", (long) time(NULL), 
00810          ast_atomic_fetchadd_int(&uniqueint, 1));
00811    } else {
00812       ast_string_field_build(tmp, uniqueid, "%s-%li.%d", ast_config_AST_SYSTEM_NAME, 
00813          (long) time(NULL), ast_atomic_fetchadd_int(&uniqueint, 1));
00814    }
00815 
00816    tmp->cid.cid_name = ast_strdup(cid_name);
00817    tmp->cid.cid_num = ast_strdup(cid_num);
00818    
00819    if (!ast_strlen_zero(name_fmt)) {
00820       /* Almost every channel is calling this function, and setting the name via the ast_string_field_build() call.
00821        * And they all use slightly different formats for their name string.
00822        * This means, to set the name here, we have to accept variable args, and call the string_field_build from here.
00823        * This means, that the stringfields must have a routine that takes the va_lists directly, and 
00824        * uses them to build the string, instead of forming the va_lists internally from the vararg ... list.
00825        * This new function was written so this can be accomplished.
00826        */
00827       va_start(ap1, name_fmt);
00828       va_start(ap2, name_fmt);
00829       ast_string_field_build_va(tmp, name, name_fmt, ap1, ap2);
00830       va_end(ap1);
00831       va_end(ap2);
00832    }
00833 
00834    /* Reminder for the future: under what conditions do we NOT want to track cdrs on channels? */
00835 
00836    /* These 4 variables need to be set up for the cdr_init() to work right */
00837    if (amaflag)
00838       tmp->amaflags = amaflag;
00839    else
00840       tmp->amaflags = ast_default_amaflags;
00841    
00842    if (!ast_strlen_zero(acctcode))
00843       ast_string_field_set(tmp, accountcode, acctcode);
00844    else
00845       ast_string_field_set(tmp, accountcode, ast_default_accountcode);
00846       
00847    if (!ast_strlen_zero(context))
00848       ast_copy_string(tmp->context, context, sizeof(tmp->context));
00849    else
00850       strcpy(tmp->context, "default");
00851 
00852    if (!ast_strlen_zero(exten))
00853       ast_copy_string(tmp->exten, exten, sizeof(tmp->exten));
00854    else
00855       strcpy(tmp->exten, "s");
00856 
00857    tmp->priority = 1;
00858       
00859    tmp->cdr = ast_cdr_alloc();
00860    ast_cdr_init(tmp->cdr, tmp);
00861    ast_cdr_start(tmp->cdr);
00862    
00863    headp = &tmp->varshead;
00864    AST_LIST_HEAD_INIT_NOLOCK(headp);
00865    
00866    ast_mutex_init(&tmp->lock);
00867    
00868    AST_LIST_HEAD_INIT_NOLOCK(&tmp->datastores);
00869    
00870    ast_string_field_set(tmp, language, defaultlanguage);
00871 
00872    tmp->tech = &null_tech;
00873 
00874    AST_LIST_LOCK(&channels);
00875    AST_LIST_INSERT_HEAD(&channels, tmp, chan_list);
00876    AST_LIST_UNLOCK(&channels);
00877 
00878    /*\!note
00879     * and now, since the channel structure is built, and has its name, let's
00880     * call the manager event generator with this Newchannel event. This is the
00881     * proper and correct place to make this call, but you sure do have to pass
00882     * a lot of data into this func to do it here!
00883     */
00884    if (!ast_strlen_zero(name_fmt)) {
00885       manager_event(EVENT_FLAG_CALL, "Newchannel",
00886             "Channel: %s\r\n"
00887             "State: %s\r\n"
00888             "CallerIDNum: %s\r\n"
00889             "CallerIDName: %s\r\n"
00890             "Uniqueid: %s\r\n",
00891             tmp->name, ast_state2str(state),
00892             S_OR(cid_num, "<unknown>"),
00893             S_OR(cid_name, "<unknown>"),
00894             tmp->uniqueid);
00895    }
00896 
00897    return tmp;
00898 }

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 
)

Bridge two channels together.

Bridge two channels together

Parameters:
c0 first channel to bridge
c1 second channel to bridge
config config for the channels
fo destination frame(?)
rc destination channel(?) Bridge two channels (c0 and c1) together. If an important frame occurs, we return that frame in rf (remember, it could be NULL) and which channel (0 or 1) in rc

Definition at line 3913 of file channel.c.

References ast_channel::_bridge, ast_channel::_softhangup, AST_BRIDGE_COMPLETE, AST_BRIDGE_FAILED, AST_BRIDGE_FAILED_NOWARN, AST_BRIDGE_RETRY, ast_channel_make_compatible(), ast_check_hangup(), ast_check_hangup_locked(), ast_clear_flag, AST_CONTROL_SRCUPDATE, AST_FEATURE_PLAY_WARNING, AST_FEATURE_REDIRECT, AST_FLAG_END_DTMF_ONLY, AST_FLAG_NBRIDGE, AST_FLAG_ZOMBIE, ast_generic_bridge(), ast_indicate(), ast_log(), ast_set_flag, AST_SOFTHANGUP_UNBRIDGE, ast_strlen_zero(), ast_test_flag, ast_tvadd(), ast_tvsub(), ast_verbose(), ast_channel::audiohooks, ast_channel_tech::bridge, bridge_playfile(), ast_channel::cid, ast_callerid::cid_num, config, EVENT_FLAG_CALL, ast_channel::generator, LOG_DEBUG, LOG_WARNING, manager_event(), ast_channel::masq, ast_channel::masqr, ast_channel::monitor, ast_channel::nativeformats, option_debug, option_verbose, pbx_builtin_getvar_helper(), pbx_builtin_setvar_helper(), ast_channel::readformat, ast_channel_tech::send_digit_begin, t, ast_channel::tech, VERBOSE_PREFIX_3, and ast_channel::writeformat.

Referenced by ast_bridge_call().

03915 {
03916    struct ast_channel *who = NULL;
03917    enum ast_bridge_result res = AST_BRIDGE_COMPLETE;
03918    int nativefailed=0;
03919    int firstpass;
03920    int o0nativeformats;
03921    int o1nativeformats;
03922    long time_left_ms=0;
03923    struct timeval nexteventts = { 0, };
03924    char caller_warning = 0;
03925    char callee_warning = 0;
03926 
03927    if (c0->_bridge) {
03928       ast_log(LOG_WARNING, "%s is already in a bridge with %s\n",
03929          c0->name, c0->_bridge->name);
03930       return -1;
03931    }
03932    if (c1->_bridge) {
03933       ast_log(LOG_WARNING, "%s is already in a bridge with %s\n",
03934          c1->name, c1->_bridge->name);
03935       return -1;
03936    }
03937    
03938    /* Stop if we're a zombie or need a soft hangup */
03939    if (ast_test_flag(c0, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c0) ||
03940        ast_test_flag(c1, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c1))
03941       return -1;
03942 
03943    *fo = NULL;
03944    firstpass = config->firstpass;
03945    config->firstpass = 0;
03946 
03947    if (ast_tvzero(config->start_time))
03948       config->start_time = ast_tvnow();
03949    time_left_ms = config->timelimit;
03950 
03951    caller_warning = ast_test_flag(&config->features_caller, AST_FEATURE_PLAY_WARNING);
03952    callee_warning = ast_test_flag(&config->features_callee, AST_FEATURE_PLAY_WARNING);
03953 
03954    if (config->start_sound && firstpass) {
03955       if (caller_warning)
03956          bridge_playfile(c0, c1, config->start_sound, time_left_ms / 1000);
03957       if (callee_warning)
03958          bridge_playfile(c1, c0, config->start_sound, time_left_ms / 1000);
03959    }
03960 
03961    /* Keep track of bridge */
03962    c0->_bridge = c1;
03963    c1->_bridge = c0;
03964 
03965    /* \todo  XXX here should check that cid_num is not NULL */
03966    manager_event(EVENT_FLAG_CALL, "Link",
03967             "Channel1: %s\r\n"
03968             "Channel2: %s\r\n"
03969             "Uniqueid1: %s\r\n"
03970             "Uniqueid2: %s\r\n"
03971             "CallerID1: %s\r\n"
03972             "CallerID2: %s\r\n",
03973             c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
03974 
03975    o0nativeformats = c0->nativeformats;
03976    o1nativeformats = c1->nativeformats;
03977 
03978    if (config->feature_timer) {
03979       nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->feature_timer, 1000));
03980    } else if (config->timelimit) {
03981       nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->timelimit, 1000));
03982       if (caller_warning || callee_warning)
03983          nexteventts = ast_tvsub(nexteventts, ast_samp2tv(config->play_warning, 1000));
03984    }
03985 
03986    if (!c0->tech->send_digit_begin)
03987       ast_set_flag(c1, AST_FLAG_END_DTMF_ONLY);
03988    if (!c1->tech->send_digit_begin)
03989       ast_set_flag(c0, AST_FLAG_END_DTMF_ONLY);
03990 
03991    /* Before we enter in and bridge these two together tell them both the source of audio has changed */
03992    ast_indicate(c0, AST_CONTROL_SRCUPDATE);
03993    ast_indicate(c1, AST_CONTROL_SRCUPDATE);
03994 
03995    for (/* ever */;;) {
03996       struct timeval now = { 0, };
03997       int to;
03998 
03999       to = -1;
04000 
04001       if (!ast_tvzero(nexteventts)) {
04002          now = ast_tvnow();
04003          to = ast_tvdiff_ms(nexteventts, now);
04004          if (to <= 0) {
04005             if (!config->timelimit) {
04006                res = AST_BRIDGE_COMPLETE;
04007                break;
04008             }
04009             to = 0;
04010          }
04011       }
04012 
04013       if (config->timelimit) {
04014          time_left_ms = config->timelimit - ast_tvdiff_ms(now, config->start_time);
04015          if (time_left_ms < to)
04016             to = time_left_ms;
04017 
04018          if (time_left_ms <= 0) {
04019             if (caller_warning && config->end_sound)
04020                bridge_playfile(c0, c1, config->end_sound, 0);
04021             if (callee_warning && config->end_sound)
04022                bridge_playfile(c1, c0, config->end_sound, 0);
04023             *fo = NULL;
04024             if (who)
04025                *rc = who;
04026             res = 0;
04027             break;
04028          }
04029          
04030          if (!to) {
04031             if (time_left_ms >= 5000 && config->warning_sound && config->play_warning) {
04032                int t = (time_left_ms + 500) / 1000; /* round to nearest second */
04033                if (caller_warning)
04034                   bridge_playfile(c0, c1, config->warning_sound, t);
04035                if (callee_warning)
04036                   bridge_playfile(c1, c0, config->warning_sound, t);
04037             }
04038             if (config->warning_freq && (time_left_ms > (config->warning_freq + 5000)))
04039                nexteventts = ast_tvadd(nexteventts, ast_samp2tv(config->warning_freq, 1000));
04040             else
04041                nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->timelimit, 1000));
04042          }
04043       }
04044 
04045       if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE || c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE) {
04046          if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
04047             c0->_softhangup = 0;
04048          if (c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
04049             c1->_softhangup = 0;
04050          c0->_bridge = c1;
04051          c1->_bridge = c0;
04052          if (option_debug)
04053             ast_log(LOG_DEBUG, "Unbridge signal received. Ending native bridge.\n");
04054          continue;
04055       }
04056       
04057       /* Stop if we're a zombie or need a soft hangup */
04058       if (ast_test_flag(c0, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c0) ||
04059           ast_test_flag(c1, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c1)) {
04060          *fo = NULL;
04061          if (who)
04062             *rc = who;
04063          res = 0;
04064          if (option_debug)
04065             ast_log(LOG_DEBUG, "Bridge stops because we're zombie or need a soft hangup: c0=%s, c1=%s, flags: %s,%s,%s,%s\n",
04066                c0->name, c1->name,
04067                ast_test_flag(c0, AST_FLAG_ZOMBIE) ? "Yes" : "No",
04068                ast_check_hangup(c0) ? "Yes" : "No",
04069                ast_test_flag(c1, AST_FLAG_ZOMBIE) ? "Yes" : "No",
04070                ast_check_hangup(c1) ? "Yes" : "No");
04071          break;
04072       }
04073       
04074       /* See if the BRIDGEPEER variable needs to be updated */
04075       if (!ast_strlen_zero(pbx_builtin_getvar_helper(c0, "BRIDGEPEER")))
04076          pbx_builtin_setvar_helper(c0, "BRIDGEPEER", c1->name);
04077       if (!ast_strlen_zero(pbx_builtin_getvar_helper(c1, "BRIDGEPEER")))
04078          pbx_builtin_setvar_helper(c1, "BRIDGEPEER", c0->name);
04079       
04080       if (c0->tech->bridge &&
04081           (config->timelimit == 0) &&
04082           (c0->tech->bridge == c1->tech->bridge) &&
04083           !nativefailed && !c0->monitor && !c1->monitor &&
04084           !c0->audiohooks && !c1->audiohooks && !ast_test_flag(&(config->features_callee),AST_FEATURE_REDIRECT) &&
04085           !ast_test_flag(&(config->features_caller),AST_FEATURE_REDIRECT) &&
04086           !c0->masq && !c0->masqr && !c1->masq && !c1->masqr) {
04087          /* Looks like they share a bridge method and nothing else is in the way */
04088          ast_set_flag(c0, AST_FLAG_NBRIDGE);
04089          ast_set_flag(c1, AST_FLAG_NBRIDGE);
04090          if ((res = c0->tech->bridge(c0, c1, config->flags, fo, rc, to)) == AST_BRIDGE_COMPLETE) {
04091             /* \todo  XXX here should check that cid_num is not NULL */
04092             manager_event(EVENT_FLAG_CALL, "Unlink",
04093                      "Channel1: %s\r\n"
04094                      "Channel2: %s\r\n"
04095                      "Uniqueid1: %s\r\n"
04096                      "Uniqueid2: %s\r\n"
04097                      "CallerID1: %s\r\n"
04098                      "CallerID2: %s\r\n",
04099                      c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
04100             if (option_debug)
04101                ast_log(LOG_DEBUG, "Returning from native bridge, channels: %s, %s\n", c0->name, c1->name);
04102 
04103             ast_clear_flag(c0, AST_FLAG_NBRIDGE);
04104             ast_clear_flag(c1, AST_FLAG_NBRIDGE);
04105 
04106             if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE || c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
04107                continue;
04108 
04109             c0->_bridge = NULL;
04110             c1->_bridge = NULL;
04111 
04112             return res;
04113          } else {
04114             ast_clear_flag(c0, AST_FLAG_NBRIDGE);
04115             ast_clear_flag(c1, AST_FLAG_NBRIDGE);
04116          }
04117          switch (res) {
04118          case AST_BRIDGE_RETRY:
04119             continue;
04120          default:
04121             if (option_verbose > 2)
04122                ast_verbose(VERBOSE_PREFIX_3 "Native bridging %s and %s ended\n",
04123                       c0->name, c1->name);
04124             /* fallthrough */
04125          case AST_BRIDGE_FAILED_NOWARN:
04126             nativefailed++;
04127             break;
04128          }
04129       }
04130    
04131       if (((c0->writeformat != c1->readformat) || (c0->readformat != c1->writeformat) ||
04132           (c0->nativeformats != o0nativeformats) || (c1->nativeformats != o1nativeformats)) &&
04133           !(c0->generator || c1->generator)) {
04134          if (ast_channel_make_compatible(c0, c1)) {
04135             ast_log(LOG_WARNING, "Can't make %s and %s compatible\n", c0->name, c1->name);
04136             /* \todo  XXX here should check that cid_num is not NULL */
04137                                 manager_event(EVENT_FLAG_CALL, "Unlink",
04138                      "Channel1: %s\r\n"
04139                      "Channel2: %s\r\n"
04140                      "Uniqueid1: %s\r\n"
04141                      "Uniqueid2: %s\r\n"
04142                      "CallerID1: %s\r\n"
04143                      "CallerID2: %s\r\n",
04144                      c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
04145             return AST_BRIDGE_FAILED;
04146          }
04147          o0nativeformats = c0->nativeformats;
04148          o1nativeformats = c1->nativeformats;
04149       }
04150 
04151       if (!ast_strlen_zero(pbx_builtin_getvar_helper(c0, "BRIDGEPEER")))
04152          pbx_builtin_setvar_helper(c0, "BRIDGEPEER", c1->name);
04153       if (!ast_strlen_zero(pbx_builtin_getvar_helper(c1, "BRIDGEPEER")))
04154          pbx_builtin_setvar_helper(c1, "BRIDGEPEER", c0->name);
04155 
04156       res = ast_generic_bridge(c0, c1, config, fo, rc, nexteventts);
04157       if (res != AST_BRIDGE_RETRY)
04158          break;
04159    }
04160 
04161    ast_clear_flag(c0, AST_FLAG_END_DTMF_ONLY);
04162    ast_clear_flag(c1, AST_FLAG_END_DTMF_ONLY);
04163 
04164    /* Now that we have broken the bridge the source will change yet again */
04165    ast_indicate(c0, AST_CONTROL_SRCUPDATE);
04166    ast_indicate(c1, AST_CONTROL_SRCUPDATE);
04167 
04168    c0->_bridge = NULL;
04169    c1->_bridge = NULL;
04170 
04171    /* \todo  XXX here should check that cid_num is not NULL */
04172    manager_event(EVENT_FLAG_CALL, "Unlink",
04173             "Channel1: %s\r\n"
04174             "Channel2: %s\r\n"
04175             "Uniqueid1: %s\r\n"
04176             "Uniqueid2: %s\r\n"
04177             "CallerID1: %s\r\n"
04178             "CallerID2: %s\r\n",
04179             c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
04180    if (option_debug)
04181       ast_log(LOG_DEBUG, "Bridge stops bridging channels %s and %s\n", c0->name, c1->name);
04182 
04183    return res;
04184 }

int ast_channel_cmpwhentohangup ( struct ast_channel chan,
time_t  offset 
)

Compare a offset with the settings of when to hang a channel up.

Parameters:
chan channel on which to check for hang up
offset offset in seconds from current time
Returns:
1, 0, or -1 This function compares a offset from current time with the absolute time out on a channel (when to hang up). If the absolute time out on a channel is earlier than current time plus the offset, it returns 1, if the two time values are equal, it return 0, otherwise, it retturn -1.

Definition at line 475 of file channel.c.

References ast_channel::whentohangup.

00476 {
00477    time_t whentohangup;
00478 
00479    if (chan->whentohangup == 0) {
00480       return (offset == 0) ? 0 : -1;
00481    } else {
00482       if (offset == 0)  /* XXX why is this special ? */
00483          return (1);
00484       else {
00485          whentohangup = offset + time (NULL);
00486          if (chan->whentohangup < whentohangup)
00487             return (1);
00488          else if (chan->whentohangup == whentohangup)
00489             return (0);
00490          else
00491             return (-1);
00492       }
00493    }
00494 }

int ast_channel_datastore_add ( struct ast_channel chan,
struct ast_datastore datastore 
)

Add a datastore to a channel.

Definition at line 1355 of file channel.c.

References AST_LIST_INSERT_HEAD.

Referenced by setup_chanspy_ds(), setup_transfer_datastore(), smdi_msg_retrieve_read(), speech_create(), and try_calling().

01356 {
01357    int res = 0;
01358 
01359    AST_LIST_INSERT_HEAD(&chan->datastores, datastore, entry);
01360 
01361    return res;
01362 }

struct ast_datastore* ast_channel_datastore_alloc ( const struct ast_datastore_info info,
char *  uid 
)

Create a channel datastore structure.

Definition at line 1294 of file channel.c.

References ast_calloc, ast_strdup, and ast_datastore::info.

Referenced by ast_channel_datastore_inherit(), setup_chanspy_ds(), setup_transfer_datastore(), smdi_msg_retrieve_read(), speech_create(), and try_calling().

01295 {
01296    struct ast_datastore *datastore = NULL;
01297 
01298    /* Make sure we at least have type so we can identify this */
01299    if (info == NULL) {
01300       return NULL;
01301    }
01302 
01303    /* Allocate memory for datastore and clear it */
01304    datastore = ast_calloc(1, sizeof(*datastore));
01305    if (datastore == NULL) {
01306       return NULL;
01307    }
01308 
01309    datastore->info = info;
01310 
01311    datastore->uid = ast_strdup(uid);
01312 
01313    return datastore;
01314 }

struct ast_datastore* ast_channel_datastore_find ( struct ast_channel chan,
const struct ast_datastore_info info,
char *  uid 
)

Find a datastore on a channel.

Definition at line 1382 of file channel.c.

References AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_datastore::info, and ast_datastore::uid.

Referenced by attended_transfer_occurred(), chanspy_ds_free(), do_atxfer(), do_parking_thread(), find_speech(), queue_transfer_fixup(), smdi_msg_read(), speech_background(), speech_destroy(), and try_calling().

01383 {
01384    struct ast_datastore *datastore = NULL;
01385    
01386    if (info == NULL)
01387       return NULL;
01388 
01389    AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->datastores, datastore, entry) {
01390       if (datastore->info == info) {
01391          if (uid != NULL && datastore->uid != NULL) {
01392             if (!strcasecmp(uid, datastore->uid)) {
01393                /* Matched by type AND uid */
01394                break;
01395             }
01396          } else {
01397             /* Matched by type at least */
01398             break;
01399          }
01400       }
01401    }
01402    AST_LIST_TRAVERSE_SAFE_END
01403 
01404    return datastore;
01405 }

int ast_channel_datastore_free ( struct ast_datastore datastore  ) 

Free a channel datastore structure.

Definition at line 1316 of file channel.c.

References ast_datastore::data, ast_datastore_info::destroy, free, ast_datastore::info, and ast_datastore::uid.

Referenced by ast_channel_free(), chanspy_ds_free(), queue_transfer_fixup(), and try_calling().

01317 {
01318    int res = 0;
01319 
01320    /* Using the destroy function (if present) destroy the data */
01321    if (datastore->info->destroy != NULL && datastore->data != NULL) {
01322       datastore->info->destroy(datastore->data);
01323       datastore->data = NULL;
01324    }
01325 
01326    /* Free allocated UID memory */
01327    if (datastore->uid != NULL) {
01328       free(datastore->uid);
01329       datastore->uid = NULL;
01330    }
01331 
01332    /* Finally free memory used by ourselves */
01333    free(datastore);
01334 
01335    return res;
01336 }

int ast_channel_datastore_inherit ( struct ast_channel from,
struct ast_channel to 
)

Inherit datastores from a parent to a child.

Definition at line 1338 of file channel.c.

References ast_channel_datastore_alloc(), AST_LIST_INSERT_TAIL, AST_LIST_TRAVERSE, ast_datastore::data, DATASTORE_INHERIT_FOREVER, ast_datastore_info::duplicate, ast_datastore::info, ast_datastore::inheritance, and ast_datastore::uid.

Referenced by local_call(), and wait_for_answer().

01339 {
01340    struct ast_datastore *datastore = NULL, *datastore2;
01341 
01342    AST_LIST_TRAVERSE(&from->datastores, datastore, entry) {
01343       if (datastore->inheritance > 0) {
01344          datastore2 = ast_channel_datastore_alloc(datastore->info, datastore->uid);
01345          if (datastore2) {
01346             datastore2->data = datastore->info->duplicate(datastore->data);
01347             datastore2->inheritance = datastore->inheritance == DATASTORE_INHERIT_FOREVER ? DATASTORE_INHERIT_FOREVER : datastore->inheritance - 1;
01348             AST_LIST_INSERT_TAIL(&to->datastores, datastore2, entry);
01349          }
01350       }
01351    }
01352    return 0;
01353 }

int ast_channel_datastore_remove ( struct ast_channel chan,
struct ast_datastore datastore 
)

Remove a datastore from a channel.

Definition at line 1364 of file channel.c.

References AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, and AST_LIST_TRAVERSE_SAFE_END.

Referenced by chanspy_ds_free(), queue_transfer_fixup(), speech_background(), speech_destroy(), and try_calling().

01365 {
01366    struct ast_datastore *datastore2 = NULL;
01367    int res = -1;
01368 
01369    /* Find our position and remove ourselves */
01370    AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->datastores, datastore2, entry) {
01371       if (datastore2 == datastore) {
01372          AST_LIST_REMOVE_CURRENT(&chan->datastores, entry);
01373          res = 0;
01374          break;
01375       }
01376    }
01377    AST_LIST_TRAVERSE_SAFE_END
01378 
01379    return res;
01380 }

int ast_channel_defer_dtmf ( struct ast_channel chan  ) 

Set defer DTMF flag on channel.

Defer DTMF so that you only read things like hangups and audio. Returns non-zero if channel was already DTMF-deferred or 0 if channel is just now being DTMF-deferred

Definition at line 992 of file channel.c.

References AST_FLAG_DEFER_DTMF, ast_set_flag, and ast_test_flag.

Referenced by __adsi_transmit_messages(), and find_cache().

00993 {
00994    int pre = 0;
00995 
00996    if (chan) {
00997       pre = ast_test_flag(chan, AST_FLAG_DEFER_DTMF);
00998       ast_set_flag(chan, AST_FLAG_DEFER_DTMF);
00999    }
01000    return pre;
01001 }

void ast_channel_free ( struct ast_channel  ) 

Free a channel structure.

Definition at line 1199 of file channel.c.

References ast_channel::alertpipe, ast_app_group_discard(), ast_cdr_discard(), ast_channel_datastore_free(), ast_channel_lock, AST_CHANNEL_NAME, ast_channel_unlock, ast_device_state_changed_literal(), ast_frfree, ast_jb_destroy(), AST_LIST_LOCK, AST_LIST_REMOVE, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, ast_log(), ast_moh_cleanup(), ast_mutex_destroy(), ast_string_field_free_memory, ast_translator_free_path(), ast_var_delete(), ast_channel::cdr, channels, ast_channel::cid, f, free, free_cid(), ast_channel::lock, LOG_ERROR, LOG_WARNING, ast_channel::monitor, ast_channel::music_state, name, ast_channel::pbx, ast_channel::readtrans, ast_channel::sched, sched_context_destroy(), ast_channel_monitor::stop, ast_channel::tech_pvt, ast_channel::timingfd, ast_channel::varshead, and ast_channel::writetrans.

Referenced by acf_odbc_read(), acf_odbc_write(), agent_cleanup(), agent_new(), ast_do_masquerade(), ast_hangup(), ast_iax2_new(), ast_pbx_outgoing_cdr_failed(), gtalk_newcall(), local_new(), make_email_file(), pbx_substitute_variables_helper_full(), and sendpage().

01200 {
01201    int fd;
01202    struct ast_var_t *vardata;
01203    struct ast_frame *f;
01204    struct varshead *headp;
01205    struct ast_datastore *datastore = NULL;
01206    char name[AST_CHANNEL_NAME], *dashptr;
01207    
01208    headp=&chan->varshead;
01209    
01210    AST_LIST_LOCK(&channels);
01211    if (!AST_LIST_REMOVE(&channels, chan, chan_list)) {
01212       AST_LIST_UNLOCK(&channels);
01213       ast_log(LOG_ERROR, "Unable to find channel in list to free. Assuming it has already been done.\n");
01214    }
01215    /* Lock and unlock the channel just to be sure nobody has it locked still
01216       due to a reference retrieved from the channel list. */
01217    ast_channel_lock(chan);
01218    ast_channel_unlock(chan);
01219 
01220    /* Get rid of each of the data stores on the channel */
01221    while ((datastore = AST_LIST_REMOVE_HEAD(&chan->datastores, entry)))
01222       /* Free the data store */
01223       ast_channel_datastore_free(datastore);
01224 
01225    /* Lock and unlock the channel just to be sure nobody has it locked still
01226       due to a reference that was stored in a datastore. (i.e. app_chanspy) */
01227    ast_channel_lock(chan);
01228    ast_channel_unlock(chan);
01229 
01230    if (chan->tech_pvt) {
01231       ast_log(LOG_WARNING, "Channel '%s' may not have been hung up properly\n", chan->name);
01232       free(chan->tech_pvt);
01233    }
01234 
01235    if (chan->sched)
01236       sched_context_destroy(chan->sched);
01237 
01238    ast_copy_string(name, chan->name, sizeof(name));
01239    if ((dashptr = strrchr(name, '-'))) {
01240       *dashptr = '\0';
01241    }
01242 
01243    /* Stop monitoring */
01244    if (chan->monitor)
01245       chan->monitor->stop( chan, 0 );
01246 
01247    /* If there is native format music-on-hold state, free it */
01248    if (chan->music_state)
01249       ast_moh_cleanup(chan);
01250 
01251    /* Free translators */
01252    if (chan->readtrans)
01253       ast_translator_free_path(chan->readtrans);
01254    if (chan->writetrans)
01255       ast_translator_free_path(chan->writetrans);
01256    if (chan->pbx)
01257       ast_log(LOG_WARNING, "PBX may not have been terminated properly on '%s'\n", chan->name);
01258    free_cid(&chan->cid);
01259    /* Close pipes if appropriate */
01260    if ((fd = chan->alertpipe[0]) > -1)
01261       close(fd);
01262    if ((fd = chan->alertpipe[1]) > -1)
01263       close(fd);
01264    if ((fd = chan->timingfd) > -1)
01265       close(fd);
01266    while ((f = AST_LIST_REMOVE_HEAD(&chan->readq, frame_list)))
01267       ast_frfree(f);
01268    
01269    /* loop over the variables list, freeing all data and deleting list items */
01270    /* no need to lock the list, as the channel is already locked */
01271    
01272    while ((vardata = AST_LIST_REMOVE_HEAD(headp, entries)))
01273       ast_var_delete(vardata);
01274 
01275    ast_app_group_discard(chan);
01276 
01277    /* Destroy the jitterbuffer */
01278    ast_jb_destroy(chan);
01279 
01280    if (chan->cdr) {
01281       ast_cdr_discard(chan->cdr);
01282       chan->cdr = NULL;
01283    }
01284    
01285    ast_mutex_destroy(&chan->lock);
01286 
01287    ast_string_field_free_memory(chan);
01288    free(chan);
01289    AST_LIST_UNLOCK(&channels);
01290 
01291    ast_device_state_changed_literal(name);
01292 }

void ast_channel_inherit_variables ( const struct ast_channel parent,
struct ast_channel child 
)

Inherits channel variable from parent to child channel.

Parameters:
parent Parent channel
child Child channel
Scans all channel variables in the parent channel, looking for those that should be copied into the child channel. Variables whose names begin with a single '_' are copied into the child channel with the prefix removed. Variables whose names begin with '__' are copied into the child channel with their names unchanged.

Definition at line 3313 of file channel.c.

References AST_LIST_INSERT_TAIL, AST_LIST_TRAVERSE, ast_log(), ast_var_assign(), ast_var_full_name(), ast_var_name(), ast_var_value(), LOG_DEBUG, option_debug, and ast_channel::varshead.

Referenced by __ast_request_and_dial(), agent_call(), ast_feature_request_and_dial(), begin_dial(), findmeexec(), ring_entry(), and wait_for_answer().

03314 {
03315    struct ast_var_t *current, *newvar;
03316    const char *varname;
03317 
03318    AST_LIST_TRAVERSE(&parent->varshead, current, entries) {
03319       int vartype = 0;
03320 
03321       varname = ast_var_full_name(current);
03322       if (!varname)
03323          continue;
03324 
03325       if (varname[0] == '_') {
03326          vartype = 1;
03327          if (varname[1] == '_')
03328             vartype = 2;
03329       }
03330 
03331       switch (vartype) {
03332       case 1:
03333          newvar = ast_var_assign(&varname[1], ast_var_value(current));
03334          if (newvar) {
03335             AST_LIST_INSERT_TAIL(&child->varshead, newvar, entries);
03336             if (option_debug)
03337                ast_log(LOG_DEBUG, "Copying soft-transferable variable %s.\n", ast_var_name(newvar));
03338          }
03339          break;
03340       case 2:
03341          newvar = ast_var_assign(ast_var_full_name(current), ast_var_value(current));
03342          if (newvar) {
03343             AST_LIST_INSERT_TAIL(&child->varshead, newvar, entries);
03344             if (option_debug)
03345                ast_log(LOG_DEBUG, "Copying hard-transferable variable %s.\n", ast_var_name(newvar));
03346          }
03347          break;
03348       default:
03349          if (option_debug)
03350             ast_log(LOG_DEBUG, "Not copying variable %s.\n", ast_var_name(current));
03351          break;
03352       }
03353    }
03354 }

int ast_channel_make_compatible ( struct ast_channel c0,
struct ast_channel c1 
)

Makes two channel formats compatible.

Parameters:
c0 first channel to make compatible
c1 other channel to make compatible Set two channels to compatible formats -- call before ast_channel_bridge in general .
Returns:
Returns 0 on success and -1 if it could not be done

Definition at line 3166 of file channel.c.

References AST_FORMAT_SLINEAR, ast_log(), ast_opt_transcode_via_slin, ast_set_read_format(), ast_set_write_format(), ast_translate_path_steps(), ast_translator_best_choice(), LOG_WARNING, ast_channel::nativeformats, ast_channel::readformat, and ast_channel::writeformat.

Referenced by app_exec(), ast_channel_bridge(), check_compat(), park_exec(), try_calling(), and wait_for_answer().

03167 {
03168    int src;
03169    int dst;
03170 
03171    if (chan->readformat == peer->writeformat && chan->writeformat == peer->readformat) {
03172       /* Already compatible!  Moving on ... */
03173       return 0;
03174    }
03175 
03176    /* Set up translation from the chan to the peer */
03177    src = chan->nativeformats;
03178    dst = peer->nativeformats;
03179    if (ast_translator_best_choice(&dst, &src) < 0) {
03180       ast_log(LOG_WARNING, "No path to translate from %s(%d) to %s(%d)\n", chan->name, src, peer->name, dst);
03181       return -1;
03182    }
03183 
03184    /* if the best path is not 'pass through', then
03185       transcoding is needed; if desired, force transcode path
03186       to use SLINEAR between channels, but only if there is
03187       no direct conversion available */
03188    if ((src != dst) && ast_opt_transcode_via_slin &&
03189        (ast_translate_path_steps(dst, src) != 1))
03190       dst = AST_FORMAT_SLINEAR;
03191    if (ast_set_read_format(chan, dst) < 0) {
03192       ast_log(LOG_WARNING, "Unable to set read format on channel %s to %d\n", chan->name, dst);
03193       return -1;
03194    }
03195    if (ast_set_write_format(peer, dst) < 0) {
03196       ast_log(LOG_WARNING, "Unable to set write format on channel %s to %d\n", peer->name, dst);
03197       return -1;
03198    }
03199 
03200    /* Set up translation from the peer to the chan */
03201    src = peer->nativeformats;
03202    dst = chan->nativeformats;
03203    if (ast_translator_best_choice(&dst, &src) < 0) {
03204       ast_log(LOG_WARNING, "No path to translate from %s(%d) to %s(%d)\n", peer->name, src, chan->name, dst);
03205       return -1;
03206    }
03207 
03208    /* if the best path is not 'pass through', then
03209       transcoding is needed; if desired, force transcode path
03210       to use SLINEAR between channels, but only if there is
03211       no direct conversion available */
03212    if ((src != dst) && ast_opt_transcode_via_slin &&
03213        (ast_translate_path_steps(dst, src) != 1))
03214       dst = AST_FORMAT_SLINEAR;
03215    if (ast_set_read_format(peer, dst) < 0) {
03216       ast_log(LOG_WARNING, "Unable to set read format on channel %s to %d\n", peer->name, dst);
03217       return -1;
03218    }
03219    if (ast_set_write_format(chan, dst) < 0) {
03220       ast_log(LOG_WARNING, "Unable to set write format on channel %s to %d\n", chan->name, dst);
03221       return -1;
03222    }
03223    return 0;
03224 }

int ast_channel_masquerade ( struct ast_channel original,
struct ast_channel clone 
)

Weird function made for call transfers.

Parameters:
original channel to make a copy of
clone copy of the original channel This is a very strange and freaky function used primarily for transfer. Suppose that "original" and "clone" are two channels in random situations. This function takes the guts out of "clone" and puts them into the "original" channel, then alerts the channel driver of the change, asking it to fixup any private information (like the p->owner pointer) that is affected by the change. The physical layer of the original channel is hung up.

Definition at line 3226 of file channel.c.

References ast_channel::_bridge, ast_bridged_channel(), ast_channel_lock, ast_channel_trylock, ast_channel_unlock, ast_log(), ast_null_frame, ast_queue_frame(), ast_channel_tech::get_base_channel, LOG_DEBUG, LOG_WARNING, ast_channel::masq, ast_channel::masqr, option_debug, and ast_channel::tech.

Referenced by ast_async_goto(), ast_masq_park_call(), ast_pickup_call(), attempt_transfer(), check_availability(), check_bridge(), check_goto_on_transfer(), do_atxfer(), handle_invite_replaces(), iax_park(), misdn_transfer_bc(), pickup_do(), and sip_park().

03227 {
03228    int res = -1;
03229    struct ast_channel *final_orig, *final_clone, *base;
03230 
03231 retrymasq:
03232    final_orig = original;
03233    final_clone = clone;
03234 
03235    ast_channel_lock(original);
03236    while (ast_channel_trylock(clone)) {
03237       ast_channel_unlock(original);
03238       usleep(1);
03239       ast_channel_lock(original);
03240    }
03241 
03242    /* each of these channels may be sitting behind a channel proxy (i.e. chan_agent)
03243       and if so, we don't really want to masquerade it, but its proxy */
03244    if (original->_bridge && (original->_bridge != ast_bridged_channel(original)) && (original->_bridge->_bridge != original))
03245       final_orig = original->_bridge;
03246 
03247    if (clone->_bridge && (clone->_bridge != ast_bridged_channel(clone)) && (clone->_bridge->_bridge != clone))
03248       final_clone = clone->_bridge;
03249    
03250    if (final_clone->tech->get_base_channel && (base = final_clone->tech->get_base_channel(final_clone))) {
03251       final_clone = base;
03252    }
03253 
03254    if ((final_orig != original) || (final_clone != clone)) {
03255       /* Lots and lots of deadlock avoidance.  The main one we're competing with
03256        * is ast_write(), which locks channels recursively, when working with a
03257        * proxy channel. */
03258       if (ast_channel_trylock(final_orig)) {
03259          ast_channel_unlock(clone);
03260          ast_channel_unlock(original);
03261          goto retrymasq;
03262       }
03263       if (ast_channel_trylock(final_clone)) {
03264          ast_channel_unlock(final_orig);
03265          ast_channel_unlock(clone);
03266          ast_channel_unlock(original);
03267          goto retrymasq;
03268       }
03269       ast_channel_unlock(clone);
03270       ast_channel_unlock(original);
03271       original = final_orig;
03272       clone = final_clone;
03273    }
03274 
03275    if (original == clone) {
03276       ast_log(LOG_WARNING, "Can't masquerade channel '%s' into itself!\n", original->name);
03277       ast_channel_unlock(clone);
03278       ast_channel_unlock(original);
03279       return -1;
03280    }
03281 
03282    if (option_debug)
03283       ast_log(LOG_DEBUG, "Planning to masquerade channel %s into the structure of %s\n",
03284          clone->name, original->name);
03285    if (original->masq) {
03286       ast_log(LOG_WARNING, "%s is already going to masquerade as %s\n",
03287          original->masq->name, original->name);
03288    } else if (clone->masqr) {
03289       ast_log(LOG_WARNING, "%s is already going to masquerade as %s\n",
03290          clone->name, clone->masqr->name);
03291    } else {
03292       original->masq = clone;
03293       clone->masqr = original;
03294       ast_queue_frame(original, &ast_null_frame);
03295       ast_queue_frame(clone, &ast_null_frame);
03296       if (option_debug)
03297          ast_log(LOG_DEBUG, "Done planning to masquerade channel %s into the structure of %s\n", clone->name, original->name);
03298       res = 0;
03299    }
03300 
03301    ast_channel_unlock(clone);
03302    ast_channel_unlock(original);
03303 
03304    return res;
03305 }

struct ast_frame* ast_channel_queryoption ( struct ast_channel channel,
int  option,
void *  data,
int *  datalen,
int  block 
)

Query the value of an option, optionally blocking until a reply is received Works similarly to setoption except only reads the options.

char* ast_channel_reason2str ( int  reason  ) 

return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument

Parameters:
reason The integer argument, usually taken from AST_CONTROL_ macros
Returns:
char pointer explaining the code

Definition at line 2859 of file channel.c.

References AST_CONTROL_ANSWER, AST_CONTROL_BUSY, AST_CONTROL_CONGESTION, AST_CONTROL_HANGUP, AST_CONTROL_RING, and AST_CONTROL_RINGING.

Referenced by attempt_thread().

02860 {
02861    switch (reason) /* the following appear to be the only ones actually returned by request_and_dial */
02862    {
02863    case 0:
02864       return "Call Failure (not BUSY, and not NO_ANSWER, maybe Circuit busy or down?)";
02865    case AST_CONTROL_HANGUP:
02866       return "Hangup";
02867    case AST_CONTROL_RING:
02868       return "Local Ring";
02869    case AST_CONTROL_RINGING:
02870       return "Remote end Ringing";
02871    case AST_CONTROL_ANSWER:
02872       return "Remote end has Answered";
02873    case AST_CONTROL_BUSY:
02874       return "Remote end is Busy";
02875    case AST_CONTROL_CONGESTION:
02876       return "Congestion (circuits busy)";
02877    default:
02878       return "Unknown Reason!!";
02879    }
02880 }

int ast_channel_register ( const struct ast_channel_tech tech  ) 

Register a channel technology (a new channel driver) Called by a channel module to register the kind of channels it supports.

Parameters:
tech Structure defining channel technology or "type"
Returns:
Returns 0 on success, -1 on failure.

Definition at line 497 of file channel.c.

References ast_calloc, AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), ast_verbose(), channels, LOG_DEBUG, LOG_WARNING, option_debug, option_verbose, chanlist::tech, ast_channel_tech::type, and VERBOSE_PREFIX_2.

Referenced by load_module(), and unload_module().

00498 {
00499    struct chanlist *chan;
00500 
00501    AST_LIST_LOCK(&channels);
00502 
00503    AST_LIST_TRAVERSE(&backends, chan, list) {
00504       if (!strcasecmp(tech->type, chan->tech->type)) {
00505          ast_log(LOG_WARNING, "Already have a handler for type '%s'\n", tech->type);
00506          AST_LIST_UNLOCK(&channels);
00507          return -1;
00508       }
00509    }
00510    
00511    if (!(chan = ast_calloc(1, sizeof(*chan)))) {
00512       AST_LIST_UNLOCK(&channels);
00513       return -1;
00514    }
00515    chan->tech = tech;
00516    AST_LIST_INSERT_HEAD(&backends, chan, list);
00517 
00518    if (option_debug)
00519       ast_log(LOG_DEBUG, "Registered handler for '%s' (%s)\n", chan->tech->type, chan->tech->description);
00520 
00521    if (option_verbose > 1)
00522       ast_verbose(VERBOSE_PREFIX_2 "Registered channel type '%s' (%s)\n", chan->tech->type,
00523              chan->tech->description);
00524 
00525    AST_LIST_UNLOCK(&channels);
00526    return 0;
00527 }

int ast_channel_sendhtml ( struct ast_channel channel,
int  subclass,
const char *  data,
int  datalen 
)

Send HTML or URL on link. Returns 0 on success or -1 on failure

Definition at line 3154 of file channel.c.

References ast_channel_tech::send_html, and ast_channel::tech.

Referenced by agent_sendhtml(), ast_channel_sendurl(), and wait_for_answer().

03155 {
03156    if (chan->tech->send_html)
03157       return chan->tech->send_html(chan, subclass, data, datalen);
03158    return -1;
03159 }

int ast_channel_sendurl ( struct ast_channel channel,
const char *  url 
)

Send URL on link. Returns 0 on success or -1 on failure

Definition at line 3161 of file channel.c.

References ast_channel_sendhtml(), and AST_HTML_URL.

Referenced by sendurl_exec(), and try_calling().

03162 {
03163    return ast_channel_sendhtml(chan, AST_HTML_URL, url, strlen(url) + 1);
03164 }

int ast_channel_setoption ( struct ast_channel channel,
int  option,
void *  data,
int  datalen,
int  block 
)

Sets an option on a channel.

Parameters:
channel channel to set options on
option option to change
data data specific to option
datalen length of the data
block blocking or not Set an option on a channel (see frame.h), optionally blocking awaiting the reply Returns 0 on success and -1 on failure

Definition at line 4187 of file channel.c.

References ast_log(), errno, LOG_ERROR, ast_channel_tech::setoption, and ast_channel::tech.

Referenced by ast_bridge_call(), common_exec(), conf_run(), dahdi_hangup(), func_channel_write(), handle_tddmode(), play_record_review(), reset_volumes(), rpt(), set_listen_volume(), set_talk_volume(), try_calling(), and vm_forwardoptions().

04188 {
04189    int res;
04190 
04191    if (chan->tech->setoption) {
04192       res = chan->tech->setoption(chan, option, data, datalen);
04193       if (res < 0)
04194          return res;
04195    } else {
04196       errno = ENOSYS;
04197       return -1;
04198    }
04199    if (block) {
04200       /* XXX Implement blocking -- just wait for our option frame reply, discarding
04201          intermediate packets. XXX */
04202       ast_log(LOG_ERROR, "XXX Blocking not implemented yet XXX\n");
04203       return -1;
04204    }
04205    return 0;
04206 }

void ast_channel_setwhentohangup ( struct ast_channel chan,
time_t  offset 
)

Set when to hang a channel up.

Parameters:
chan channel on which to check for hang up
offset offset in seconds from current time of when to hang up This function sets the absolute time out on a channel (when to hang up).

Definition at line 467 of file channel.c.

References ast_null_frame, ast_queue_frame(), and ast_channel::whentohangup.

Referenced by action_timeout(), and timeout_write().

00468 {
00469    chan->whentohangup = offset ? time(NULL) + offset : 0;
00470    ast_queue_frame(chan, &ast_null_frame);
00471    return;
00472 }

struct ast_silence_generator* ast_channel_start_silence_generator ( struct ast_channel chan  ) 

Starts a silence generator on the given channel.

Parameters:
chan The channel to generate silence on
Returns:
An ast_silence_generator pointer, or NULL if an error occurs
This function will cause SLINEAR silence to be generated on the supplied channel until it is disabled; if the channel cannot be put into SLINEAR mode then the function will fail.

The pointer returned by this function must be preserved and passed to ast_channel_stop_silence_generator when you wish to stop the silence generation.

Definition at line 4515 of file channel.c.

References ast_activate_generator(), ast_calloc, AST_FORMAT_SLINEAR, ast_log(), ast_set_write_format(), free, LOG_DEBUG, LOG_ERROR, ast_silence_generator::old_write_format, option_debug, silence_generator, and ast_channel::writeformat.

Referenced by __ast_play_and_record(), ast_dtmf_stream(), and channel_spy().

04516 {
04517    struct ast_silence_generator *state;
04518 
04519    if (!(state = ast_calloc(1, sizeof(*state)))) {
04520       return NULL;
04521    }
04522 
04523    state->old_write_format = chan->writeformat;
04524 
04525    if (ast_set_write_format(chan, AST_FORMAT_SLINEAR) < 0) {
04526       ast_log(LOG_ERROR, "Could not set write format to SLINEAR\n");
04527       free(state);
04528       return NULL;
04529    }
04530 
04531    ast_activate_generator(chan, &silence_generator, state);
04532 
04533    if (option_debug)
04534       ast_log(LOG_DEBUG, "Started silence generator on '%s'\n", chan->name);
04535 
04536    return state;
04537 }

void ast_channel_stop_silence_generator ( struct ast_channel chan,
struct ast_silence_generator state 
)

Stops a previously-started silence generator on the given channel.

Parameters:
chan The channel to operate on
state The ast_silence_generator pointer return by a previous call to ast_channel_start_silence_generator.
Returns:
nothing
This function will stop the operating silence generator and return the channel to its previous write format.

Definition at line 4539 of file channel.c.

References ast_deactivate_generator(), ast_log(), ast_set_write_format(), free, LOG_DEBUG, LOG_ERROR, ast_silence_generator::old_write_format, and option_debug.

Referenced by __ast_play_and_record(), ast_dtmf_stream(), and channel_spy().

04540 {
04541    if (!state)
04542       return;
04543 
04544    ast_deactivate_generator(chan);
04545 
04546    if (option_debug)
04547       ast_log(LOG_DEBUG, "Stopped silence generator on '%s'\n", chan->name);
04548 
04549    if (ast_set_write_format(chan, state->old_write_format) < 0)
04550       ast_log(LOG_ERROR, "Could not return write format to its original state\n");
04551 
04552    free(state);
04553 }

int ast_channel_supports_html ( struct ast_channel channel  ) 

Returns 0 if channel does not support HTML or non-zero if it does

Definition at line 3149 of file channel.c.

References ast_channel_tech::send_html, and ast_channel::tech.

Referenced by sendurl_exec(), and try_calling().

03150 {
03151    return (chan->tech->send_html) ? 1 : 0;
03152 }

void ast_channel_undefer_dtmf ( struct ast_channel chan  ) 

Unset defer DTMF flag on channel.

Undo defer. ast_read will return any dtmf characters that were queued

Definition at line 1004 of file channel.c.

References ast_clear_flag, and AST_FLAG_DEFER_DTMF.

Referenced by __adsi_transmit_messages(), find_cache(), and rpt_call().

01005 {
01006    if (chan)
01007       ast_clear_flag(chan, AST_FLAG_DEFER_DTMF);
01008 }

void ast_channel_unregister ( const struct ast_channel_tech tech  ) 

Unregister a channel technology.

Parameters:
tech Structure defining channel technology or "type" that was previously registered
Returns:
No return value.

Definition at line 529 of file channel.c.

References AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_log(), ast_verbose(), channels, free, LOG_DEBUG, option_debug, option_verbose, chanlist::tech, ast_channel_tech::type, and VERBOSE_PREFIX_2.

Referenced by __unload_module(), and unload_module().

00530 {
00531    struct chanlist *chan;
00532 
00533    if (option_debug)
00534       ast_log(LOG_DEBUG, "Unregistering channel type '%s'\n", tech->type);
00535 
00536    AST_LIST_LOCK(&channels);
00537 
00538    AST_LIST_TRAVERSE_SAFE_BEGIN(&backends, chan, list) {
00539       if (chan->tech == tech) {
00540          AST_LIST_REMOVE_CURRENT(&backends, list);
00541          free(chan);
00542          if (option_verbose > 1)
00543             ast_verbose(VERBOSE_PREFIX_2 "Unregistered channel type '%s'\n", tech->type);
00544          break;   
00545       }
00546    }
00547    AST_LIST_TRAVERSE_SAFE_END
00548 
00549    AST_LIST_UNLOCK(&channels);
00550 }

struct ast_channel* ast_channel_walk_locked ( const struct ast_channel prev  ) 

Browse channels in use Browse the channels currently in use.

Parameters:
prev where you want to start in the channel list
Returns:
Returns the next channel in the list, NULL on end. If it returns a channel, that channel *has been locked*!

Definition at line 1120 of file channel.c.

References channel_find_locked().

Referenced by action_status(), ast_complete_channels(), ast_pickup_call(), complete_ch_helper(), conf_exec(), handle_chanlist(), handle_chanlist_deprecated(), handle_core_set_debug_channel(), handle_debugchan_deprecated(), handle_nodebugchan_deprecated(), next_channel(), pickup_by_exten(), pickup_by_mark(), and softhangup_exec().

01121 {
01122    return channel_find_locked(prev, NULL, 0, NULL, NULL);
01123 }

int ast_channel_whisper_feed ( struct ast_channel chan,
struct ast_frame f 
)

Feed an audio frame into the whisper buffer on a channel.

Parameters:
chan The channel to whisper onto
f The frame to to whisper onto chan
Returns:
0 for success, non-zero for failure

int ast_channel_whisper_start ( struct ast_channel chan  ) 

Begin 'whispering' onto a channel.

Parameters:
chan The channel to whisper onto
Returns:
0 for success, non-zero for failure
This function will add a whisper buffer onto a channel and set a flag causing writes to the channel to reduce the volume level of the written audio samples, and then to mix in audio from the whisper buffer if it is available.

Note: This function performs no locking; you must hold the channel's lock before calling this function.

void ast_channel_whisper_stop ( struct ast_channel chan  ) 

Stop 'whispering' onto a channel.

Parameters:
chan The channel to whisper onto
Returns:
0 for success, non-zero for failure
Note: This function performs no locking; you must hold the channel's lock before calling this function.

struct ast_variable* ast_channeltype_list ( void   ) 

return an ast_variable list of channeltypes

Definition at line 163 of file channel.c.

References AST_LIST_TRAVERSE, ast_variable_new(), ast_channel_tech::description, chanlist::tech, ast_channel_tech::type, and var.

00164 {
00165    struct chanlist *cl;
00166    struct ast_variable *var=NULL, *prev = NULL;
00167    AST_LIST_TRAVERSE(&backends, cl, list) {
00168       if (prev)  {
00169          if ((prev->next = ast_variable_new(cl->tech->type, cl->tech->description)))
00170             prev = prev->next;
00171       } else {
00172          var = ast_variable_new(cl->tech->type, cl->tech->description);
00173          prev = var;
00174       }
00175    }
00176    return var;
00177 }

int ast_check_hangup ( struct ast_channel chan  ) 

Check to see if a channel is needing hang up.

Parameters:
chan channel on which to check for hang up This function determines if the channel is being requested to be hung up.
Returns:
Returns 0 if not, or 1 if hang up is requested (including time-out).

Definition at line 385 of file channel.c.

References ast_channel::_softhangup, AST_SOFTHANGUP_TIMEOUT, ast_channel::tech_pvt, and ast_channel::whentohangup.

Referenced by __ast_read(), action_redirect(), agent_indicate(), app_exec(), ast_answer(), ast_bridge_call(), ast_call(), ast_channel_bridge(), ast_check_hangup_locked(), ast_feature_request_and_dial(), ast_indicate_data(), ast_readstring_full(), ast_recvtext(), ast_rtp_bridge(), ast_sendtext(), ast_transfer(), ast_udptl_bridge(), ast_waitfordigit_full(), ast_write(), bridge_native_loop(), channel_spy(), common_exec(), conf_run(), dahdi_sendtext(), dahdi_setoption(), deadagi_exec(), do_atxfer(), handle_request_invite(), handle_sendimage(), pbx_exec(), rpt(), and wait_for_answer().

00386 {
00387    if (chan->_softhangup)     /* yes if soft hangup flag set */
00388       return 1;
00389    if (!chan->tech_pvt)    /* yes if no technology private data */
00390       return 1;
00391    if (!chan->whentohangup)   /* no if no hangup scheduled */
00392       return 0;
00393    if (chan->whentohangup > time(NULL))   /* no if hangup time has not come yet. */
00394       return 0;
00395    chan->_softhangup |= AST_SOFTHANGUP_TIMEOUT; /* record event */
00396    return 1;
00397 }

void ast_deactivate_generator ( struct ast_channel chan  ) 

Deactive an active generator

Definition at line 1570 of file channel.c.

References ast_channel_lock, ast_channel_unlock, ast_clear_flag, AST_FLAG_WRITE_INT, AST_GENERATOR_FD, ast_settimeout(), ast_channel::fds, ast_channel::generator, ast_channel::generatordata, and ast_generator::release.

Referenced by __ast_read(), app_exec(), ast_channel_stop_silence_generator(), ast_openstream_full(), ast_playtones_stop(), ast_quiet_chan(), ast_read_generator_actions(), ast_tonepair_stop(), ast_write(), cb_events(), channel_spy(), generator_force(), local_ast_moh_stop(), old_milliwatt_exec(), and wait_for_answer().

01571 {
01572    ast_channel_lock(chan);
01573    if (chan->generatordata) {
01574       if (chan->generator && chan->generator->release)
01575          chan->generator->release(chan, chan->generatordata);
01576       chan->generatordata = NULL;
01577       chan->generator = NULL;
01578       chan->fds[AST_GENERATOR_FD] = -1;
01579       ast_clear_flag(chan, AST_FLAG_WRITE_INT);
01580       ast_settimeout(chan, 0, NULL, NULL);
01581    }
01582    ast_channel_unlock(chan);
01583 }

int ast_do_masquerade ( struct ast_channel original  ) 

Start masquerading a channel XXX This is a seriously wacked out operation. We're essentially putting the guts of the clone channel into the original channel. Start by killing off the original channel's backend. I'm not sure we're going to keep this function, because while the features are nice, the cost is very high in terms of pure nastiness. XXX.

Note:
Assumes channel will be locked when called

Definition at line 3387 of file channel.c.

References ast_channel::_softhangup, ast_channel::_state, ast_channel::adsicpe, ast_channel::alertpipe, ast_app_group_update(), ast_cause2str(), ast_channel_free(), ast_channel_lock, ast_channel_unlock, ast_copy_flags, AST_FLAG_BLOCKING, AST_FLAG_EXCEPTION, AST_FLAG_ZOMBIE, AST_GENERATOR_FD, ast_indicate(), AST_LIST_APPEND_LIST, AST_LIST_FIRST, AST_LIST_HEAD_NOLOCK, AST_LIST_HEAD_SET_NOLOCK, AST_LIST_INSERT_TAIL, AST_LIST_REMOVE_HEAD, AST_LIST_TRAVERSE, ast_log(), AST_MAX_FDS, ast_null_frame, ast_queue_frame(), ast_set_flag, ast_set_read_format(), ast_set_write_format(), AST_SOFTHANGUP_DEV, ast_string_field_set, ast_test_flag, AST_TIMING_FD, ast_channel::blocker, ast_channel::cdr, ast_datastore_info::chan_fixup, ast_channel::cid, clone_variables(), ast_datastore::data, EVENT_FLAG_CALL, ast_channel::fdno, ast_channel::fds, ast_channel_tech::fixup, free_translation(), ast_channel_tech::hangup, ast_datastore::info, language, ast_channel::lock, LOG_DEBUG, LOG_WARNING, manager_event(), ast_channel::masq, ast_channel::masqr, ast_channel::monitor, musicclass, name, ast_channel::nativeformats, option_debug, ast_channel::rawreadformat, ast_channel::rawwriteformat, ast_channel::readformat, t, ast_channel::tech, ast_channel::tech_pvt, ast_channel::timingfd, ast_channel_tech::type, ast_channel::visible_indication, and ast_channel::writeformat.

Referenced by __ast_read(), ast_async_goto(), ast_hangup(), ast_waitfor_nandfds(), ast_write(), iax_park(), sip_park(), and sip_park_thread().

03388 {
03389    int x,i;
03390    int res=0;
03391    int origstate;
03392    struct ast_frame *cur;
03393    const struct ast_channel_tech *t;
03394    void *t_pvt;
03395    struct ast_callerid tmpcid;
03396    struct ast_channel *clone = original->masq;
03397    struct ast_cdr *cdr;
03398    int rformat = original->readformat;
03399    int wformat = original->writeformat;
03400    char newn[100];
03401    char orig[100];
03402    char masqn[100];
03403    char zombn[100];
03404 
03405    if (option_debug > 3)
03406       ast_log(LOG_DEBUG, "Actually Masquerading %s(%d) into the structure of %s(%d)\n",
03407          clone->name, clone->_state, original->name, original->_state);
03408 
03409    /* XXX This is a seriously wacked out operation.  We're essentially putting the guts of
03410       the clone channel into the original channel.  Start by killing off the original
03411       channel's backend.   I'm not sure we're going to keep this function, because
03412       while the features are nice, the cost is very high in terms of pure nastiness. XXX */
03413 
03414    /* We need the clone's lock, too */
03415    ast_channel_lock(clone);
03416 
03417    if (option_debug > 1)
03418       ast_log(LOG_DEBUG, "Got clone lock for masquerade on '%s' at %p\n", clone->name, &clone->lock);
03419 
03420    /* Having remembered the original read/write formats, we turn off any translation on either
03421       one */
03422    free_translation(clone);
03423    free_translation(original);
03424 
03425 
03426    /* Unlink the masquerade */
03427    original->masq = NULL;
03428    clone->masqr = NULL;
03429    
03430    /* Save the original name */
03431    ast_copy_string(orig, original->name, sizeof(orig));
03432    /* Save the new name */
03433    ast_copy_string(newn, clone->name, sizeof(newn));
03434    /* Create the masq name */
03435    snprintf(masqn, sizeof(masqn), "%s<MASQ>", newn);
03436       
03437    /* Copy the name from the clone channel */
03438    ast_string_field_set(original, name, newn);
03439 
03440    /* Mangle the name of the clone channel */
03441    ast_string_field_set(clone, name, masqn);
03442    
03443    /* Notify any managers of the change, first the masq then the other */
03444    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", newn, masqn, clone->uniqueid);
03445    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", orig, newn, original->uniqueid);
03446 
03447    /* Swap the technologies */   
03448    t = original->tech;
03449    original->tech = clone->tech;
03450    clone->tech = t;
03451 
03452    /* Swap the cdrs */
03453    cdr = original->cdr;
03454    original->cdr = clone->cdr;
03455    clone->cdr = cdr;
03456 
03457    t_pvt = original->tech_pvt;
03458    original->tech_pvt = clone->tech_pvt;
03459    clone->tech_pvt = t_pvt;
03460 
03461    /* Swap the alertpipes */
03462    for (i = 0; i < 2; i++) {
03463       x = original->alertpipe[i];
03464       original->alertpipe[i] = clone->alertpipe[i];
03465       clone->alertpipe[i] = x;
03466    }
03467 
03468    /* 
03469     * Swap the readq's.  The end result should be this:
03470     *
03471     *  1) All frames should be on the new (original) channel.
03472     *  2) Any frames that were already on the new channel before this
03473     *     masquerade need to be at the end of the readq, after all of the
03474     *     frames on the old (clone) channel.
03475     *  3) The alertpipe needs to get poked for every frame that was already
03476     *     on the new channel, since we are now using the alert pipe from the
03477     *     old (clone) channel.
03478     */
03479    {
03480       AST_LIST_HEAD_NOLOCK(, ast_frame) tmp_readq;
03481       AST_LIST_HEAD_SET_NOLOCK(&tmp_readq, NULL);
03482 
03483       AST_LIST_APPEND_LIST(&tmp_readq, &original->readq, frame_list);
03484       AST_LIST_APPEND_LIST(&original->readq, &clone->readq, frame_list);
03485 
03486       while ((cur = AST_LIST_REMOVE_HEAD(&tmp_readq, frame_list))) {
03487          AST_LIST_INSERT_TAIL(&original->readq, cur, frame_list);
03488          if (original->alertpipe[1] > -1) {
03489             int poke = 0;
03490             write(original->alertpipe[1], &poke, sizeof(poke));
03491          }
03492       }
03493    }
03494 
03495    /* Swap the raw formats */
03496    x = original->rawreadformat;
03497    original->rawreadformat = clone->rawreadformat;
03498    clone->rawreadformat = x;
03499    x = original->rawwriteformat;
03500    original->rawwriteformat = clone->rawwriteformat;
03501    clone->rawwriteformat = x;
03502 
03503    clone->_softhangup = AST_SOFTHANGUP_DEV;
03504 
03505    /* And of course, so does our current state.  Note we need not
03506       call ast_setstate since the event manager doesn't really consider
03507       these separate.  We do this early so that the clone has the proper
03508       state of the original channel. */
03509    origstate = original->_state;
03510    original->_state = clone->_state;
03511    clone->_state = origstate;
03512 
03513    if (clone->tech->fixup){
03514       res = clone->tech->fixup(original, clone);
03515       if (res)
03516          ast_log(LOG_WARNING, "Fixup failed on channel %s, strange things may happen.\n", clone->name);
03517    }
03518 
03519    /* Start by disconnecting the original's physical side */
03520    if (clone->tech->hangup)
03521       res = clone->tech->hangup(clone);
03522    if (res) {
03523       ast_log(LOG_WARNING, "Hangup failed!  Strange things may happen!\n");
03524       ast_channel_unlock(clone);
03525       return -1;
03526    }
03527    
03528    snprintf(zombn, sizeof(zombn), "%s<ZOMBIE>", orig);
03529    /* Mangle the name of the clone channel */
03530    ast_string_field_set(clone, name, zombn);
03531    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", masqn, zombn, clone->uniqueid);
03532 
03533    /* Update the type. */
03534    t_pvt = original->monitor;
03535    original->monitor = clone->monitor;
03536    clone->monitor = t_pvt;
03537    
03538    /* Keep the same language.  */
03539    ast_string_field_set(original, language, clone->language);
03540    /* Copy the FD's other than the generator fd */
03541    for (x = 0; x < AST_MAX_FDS; x++) {
03542       if (x != AST_GENERATOR_FD)
03543          original->fds[x] = clone->fds[x];
03544    }
03545 
03546    ast_app_group_update(clone, original);
03547    /* Move data stores over */
03548    if (AST_LIST_FIRST(&clone->datastores)) {
03549       struct ast_datastore *ds;
03550       AST_LIST_APPEND_LIST(&original->datastores, &clone->datastores, entry);
03551       AST_LIST_TRAVERSE(&original->datastores, ds, entry) {
03552          if (ds->info->chan_fixup)
03553             ds->info->chan_fixup(ds->data, clone, original);
03554       }
03555    }
03556 
03557    clone_variables(original, clone);
03558    /* Presense of ADSI capable CPE follows clone */
03559    original->adsicpe = clone->adsicpe;
03560    /* Bridge remains the same */
03561    /* CDR fields remain the same */
03562    /* XXX What about blocking, softhangup, blocker, and lock and blockproc? XXX */
03563    /* Application and data remain the same */
03564    /* Clone exception  becomes real one, as with fdno */
03565    ast_copy_flags(original, clone, AST_FLAG_EXCEPTION);
03566    original->fdno = clone->fdno;
03567    /* Schedule context remains the same */
03568    /* Stream stuff stays the same */
03569    /* Keep the original state.  The fixup code will need to work with it most likely */
03570 
03571    /* Just swap the whole structures, nevermind the allocations, they'll work themselves
03572       out. */
03573    tmpcid = original->cid;
03574    original->cid = clone->cid;
03575    clone->cid = tmpcid;
03576    
03577    /* Restore original timing file descriptor */
03578    original->fds[AST_TIMING_FD] = original->timingfd;
03579    
03580    /* Our native formats are different now */
03581    original->nativeformats = clone->nativeformats;
03582    
03583    /* Context, extension, priority, app data, jump table,  remain the same */
03584    /* pvt switches.  pbx stays the same, as does next */
03585    
03586    /* Set the write format */
03587    ast_set_write_format(original, wformat);
03588 
03589    /* Set the read format */
03590    ast_set_read_format(original, rformat);
03591 
03592    /* Copy the music class */
03593    ast_string_field_set(original, musicclass, clone->musicclass);
03594 
03595    if (option_debug)
03596       ast_log(LOG_DEBUG, "Putting channel %s in %d/%d formats\n", original->name, wformat, rformat);
03597 
03598    /* Okay.  Last thing is to let the channel driver know about all this mess, so he
03599       can fix up everything as best as possible */
03600    if (original->tech->fixup) {
03601       res = original->tech->fixup(clone, original);
03602       if (res) {
03603          ast_log(LOG_WARNING, "Channel for type '%s' could not fixup channel %s\n",
03604             original->tech->type, original->name);
03605          ast_channel_unlock(clone);
03606          return -1;
03607       }
03608    } else
03609       ast_log(LOG_WARNING, "Channel type '%s' does not have a fixup routine (for %s)!  Bad things may happen.\n",
03610          original->tech->type, original->name);
03611 
03612    /* If an indication is currently playing maintain it on the channel that is taking the place of original */
03613    if (original->visible_indication)
03614       ast_indicate(original, original->visible_indication);
03615    
03616    /* Now, at this point, the "clone" channel is totally F'd up.  We mark it as
03617       a zombie so nothing tries to touch it.  If it's already been marked as a
03618       zombie, then free it now (since it already is considered invalid). */
03619    if (ast_test_flag(clone, AST_FLAG_ZOMBIE)) {
03620       if (option_debug)
03621          ast_log(LOG_DEBUG, "Destroying channel clone '%s'\n", clone->name);
03622       ast_channel_unlock(clone);
03623       manager_event(EVENT_FLAG_CALL, "Hangup",
03624          "Channel: %s\r\n"
03625          "Uniqueid: %s\r\n"
03626          "Cause: %d\r\n"
03627          "Cause-txt: %s\r\n",
03628          clone->name,
03629          clone->uniqueid,
03630          clone->hangupcause,
03631          ast_cause2str(clone->hangupcause)
03632          );
03633       ast_channel_free(clone);
03634    } else {
03635       if (option_debug)
03636          ast_log(LOG_DEBUG, "Released clone lock on '%s'\n", clone->name);
03637       ast_set_flag(clone, AST_FLAG_ZOMBIE);
03638       ast_queue_frame(clone, &ast_null_frame);
03639       ast_channel_unlock(clone);
03640    }
03641    
03642    /* Signal any blocker */
03643    if (ast_test_flag(original, AST_FLAG_BLOCKING))
03644       pthread_kill(original->blocker, SIGURG);
03645    if (option_debug)
03646       ast_log(LOG_DEBUG, "Done Masquerading %s (%d)\n", original->name, original->_state);
03647    return 0;
03648 }

static int ast_fdisset ( struct pollfd pfds,
int  fd,
int  max,
int *  start 
) [inline, static]

Helper function for migrating select to poll.

Definition at line 1276 of file channel.h.

References pollfd::revents.

01277 {
01278    int x;
01279    int dummy=0;
01280 
01281    if (fd < 0)
01282       return 0;
01283    if (!start)
01284       start = &dummy;
01285    for (x = *start; x<max; x++)
01286       if (pfds[x].fd == fd) {
01287          if (x == *start)
01288             (*start)++;
01289          return pfds[x].revents;
01290       }
01291    return 0;
01292 }

struct ast_channel* ast_get_channel_by_exten_locked ( const char *  exten,
const char *  context 
)

Get channel by exten (and optionally context) and lock it.

Definition at line 1145 of file channel.c.

References channel_find_locked().

01146 {
01147    return channel_find_locked(NULL, NULL, 0, context, exten);
01148 }

struct ast_channel* ast_get_channel_by_name_locked ( const char *  chan  ) 

Get channel by name (locks channel).

Definition at line 1126 of file channel.c.

References channel_find_locked().

Referenced by action_atxfer(), action_getvar(), action_hangup(), action_redirect(), action_setcdruserfield(), action_setvar(), action_status(), action_timeout(), ast_async_goto_by_name(), asyncgoto_exec(), change_monitor_action(), do_pause_or_unpause(), get_zap_channel_locked(), handle_channelstatus(), handle_core_set_debug_channel(), handle_debugchan_deprecated(), handle_getvariablefull(), handle_hangup(), handle_nodebugchan_deprecated(), handle_showchan(), handle_showchan_deprecated(), handle_softhangup(), manager_park(), manager_play_dtmf(), park_call_full(), pbx_builtin_importvar(), start_monitor_action(), and stop_monitor_action().

01127 {
01128    return channel_find_locked(NULL, name, 0, NULL, NULL);
01129 }

struct ast_channel* ast_get_channel_by_name_prefix_locked ( const char *  name,
const int  namelen 
)

Get channel by name prefix (locks channel).

Definition at line 1132 of file channel.c.

References channel_find_locked().

Referenced by ast_parse_device_state(), common_exec(), and mixmonitor_cli().

01133 {
01134    return channel_find_locked(NULL, name, namelen, NULL, NULL);
01135 }

struct ast_channel_tech* ast_get_channel_tech ( const char *  name  ) 

Get a channel technology structure by name.

Parameters:
name name of technology to find
Returns:
a pointer to the structure, or NULL if no matching technology found

Definition at line 552 of file channel.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), channels, LOG_WARNING, chanlist::tech, and ast_channel_tech::type.

Referenced by ast_device_state().

00553 {
00554    struct chanlist *chanls;
00555    const struct ast_channel_tech *ret = NULL;
00556 
00557    if (AST_LIST_LOCK(&channels)) {
00558       ast_log(LOG_WARNING, "Unable to lock channel tech list\n");
00559       return NULL;
00560    }
00561 
00562    AST_LIST_TRAVERSE(&backends, chanls, list) {
00563       if (!strcasecmp(name, chanls->tech->type)) {
00564          ret = chanls->tech;
00565          break;
00566       }
00567    }
00568 
00569    AST_LIST_UNLOCK(&channels);
00570    
00571    return ret;
00572 }

ast_group_t ast_get_group ( const char *  s  ) 

Definition at line 4360 of file channel.c.

References ast_log(), ast_strdupa, ast_strlen_zero(), group, LOG_ERROR, LOG_WARNING, and strsep().

Referenced by _parse(), build_device(), build_gateway(), build_peer(), build_user(), func_channel_write(), process_dahdi(), and read_agent_config().

04361 {
04362    char *piece;
04363    char *c;
04364    int start=0, finish=0, x;
04365    ast_group_t group = 0;
04366 
04367    if (ast_strlen_zero(s))
04368       return 0;
04369 
04370    c = ast_strdupa(s);
04371    
04372    while ((piece = strsep(&c, ","))) {
04373       if (sscanf(piece, "%d-%d", &start, &finish) == 2) {
04374          /* Range */
04375       } else if (sscanf(piece, "%d", &start)) {
04376          /* Just one */
04377          finish = start;
04378       } else {
04379          ast_log(LOG_ERROR, "Syntax error parsing group configuration '%s' at '%s'. Ignoring.\n", s, piece);
04380          continue;
04381       }
04382       for (x = start; x <= finish; x++) {
04383          if ((x > 63) || (x < 0)) {
04384             ast_log(LOG_WARNING, "Ignoring invalid group %d (maximum group is 63)\n", x);
04385          } else
04386             group |= ((ast_group_t) 1 << x);
04387       }
04388    }
04389    return group;
04390 }

int ast_hangup ( struct ast_channel chan  ) 

Hang up a channel.

Note:
This function performs a hard hangup on a channel. Unlike the soft-hangup, this function performs all stream stopping, etc, on the channel that needs to end. chan is no longer valid after this call.
Parameters:
chan channel to hang up
Returns:
Returns 0 on success, -1 on failure.

Definition at line 1444 of file channel.c.

References ast_assert, ast_audiohook_detach_list(), ast_autoservice_stop(), ast_cause2str(), ast_cdr_detach(), ast_cdr_end(), AST_CDR_FLAG_BRIDGED, AST_CDR_FLAG_DIALED, AST_CDR_FLAG_POST_DISABLED, AST_CDR_NULL, ast_channel_free(), ast_channel_lock, ast_channel_unlock, ast_closestream(), ast_do_masquerade(), AST_FLAG_BLOCKING, AST_FLAG_ZOMBIE, ast_log(), ast_set_flag, ast_test_flag, ast_channel::audiohooks, ast_channel::blocker, ast_channel::blockproc, ast_channel::cdr, ast_cdr::disposition, EVENT_FLAG_CALL, free_translation(), ast_channel::generator, ast_channel::generatordata, ast_channel_tech::hangup, ast_channel::hangupcause, LOG_DEBUG, LOG_WARNING, manager_event(), ast_channel::masq, ast_channel::masqr, option_debug, ast_generator::release, ast_channel::sched, sched_context_destroy(), ast_channel::stream, ast_channel::tech, and ast_channel::vstream.

Referenced by __ast_request_and_dial(), __oh323_new(), agent_hangup(), agent_read(), alsa_new(), answer_exec_run(), app_exec(), ast_async_goto(), ast_bridge_call_thread(), ast_dial_destroy(), ast_dial_hangup(), ast_feature_request_and_dial(), ast_iax2_new(), ast_masq_park_call(), ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_pbx_run_app(), async_wait(), begin_dial(), build_conf(), chanavail_exec(), check_compat(), check_goto_on_transfer(), clear_caller(), conf_free(), conf_run(), connect_link(), dahdi_handle_event(), dahdi_new(), do_atxfer(), do_hang(), do_parking_thread(), features_hangup(), findmeexec(), gtalk_new(), handle_enbloc_call_message(), handle_frame(), handle_frame_ownerless(), handle_hd_hf(), handle_init_event(), handle_invite_replaces(), handle_offhook_message(), handle_request_invite(), handle_soft_key_event_message(), handle_stimulus_message(), hangup_chan(), hangupcalls(), hanguptree(), iax2_request(), iax_park(), iax_park_thread(), local_attended_transfer(), local_hangup(), mgcp_new(), mgcp_ss(), monitor_dial(), nbs_new(), oss_new(), park_exec(), parkandannounce_exec(), phone_new(), rpt(), rpt_call(), rpt_tele_thread(), sip_new(), sip_park(), sip_park_thread(), skinny_new(), skinny_ss(), ss_thread(), try_calling(), wait_for_answer(), and wait_for_winner().

01445 {
01446    int res = 0;
01447 
01448    /* Don't actually hang up a channel that will masquerade as someone else, or
01449       if someone is going to masquerade as us */
01450    ast_channel_lock(chan);
01451 
01452    if (chan->audiohooks) {
01453       ast_audiohook_detach_list(chan->audiohooks);
01454       chan->audiohooks = NULL;
01455    }
01456 
01457    ast_autoservice_stop(chan);
01458 
01459    if (chan->masq) {
01460       if (ast_do_masquerade(chan))
01461          ast_log(LOG_WARNING, "Failed to perform masquerade\n");
01462    }
01463 
01464    if (chan->masq) {
01465       ast_log(LOG_WARNING, "%s getting hung up, but someone is trying to masq into us?!?\n", chan->name);
01466       ast_channel_unlock(chan);
01467       return 0;
01468    }
01469    /* If this channel is one which will be masqueraded into something,
01470       mark it as a zombie already, so we know to free it later */
01471    if (chan->masqr) {
01472       ast_set_flag(chan, AST_FLAG_ZOMBIE);
01473       ast_channel_unlock(chan);
01474       return 0;
01475    }
01476    free_translation(chan);
01477    /* Close audio stream */
01478    if (chan->stream) {
01479       ast_closestream(chan->stream);
01480       chan->stream = NULL;
01481    }
01482    /* Close video stream */
01483    if (chan->vstream) {
01484       ast_closestream(chan->vstream);
01485       chan->vstream = NULL;
01486    }
01487    if (chan->sched) {
01488       sched_context_destroy(chan->sched);
01489       chan->sched = NULL;
01490    }
01491    
01492    if (chan->generatordata)   /* Clear any tone stuff remaining */
01493       chan->generator->release(chan, chan->generatordata);
01494    chan->generatordata = NULL;
01495    chan->generator = NULL;
01496    if (ast_test_flag(chan, AST_FLAG_BLOCKING)) {
01497       ast_log(LOG_WARNING, "Hard hangup called by thread %ld on %s, while fd "
01498                "is blocked by thread %ld in procedure %s!  Expect a failure\n",
01499                (long)pthread_self(), chan->name, (long)chan->blocker, chan->blockproc);
01500       ast_assert(ast_test_flag(chan, AST_FLAG_BLOCKING) == 0);
01501    }
01502    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE)) {
01503       if (option_debug)
01504          ast_log(LOG_DEBUG, "Hanging up channel '%s'\n", chan->name);
01505       if (chan->tech->hangup)
01506          res = chan->tech->hangup(chan);
01507    } else {
01508       if (option_debug)
01509          ast_log(LOG_DEBUG, "Hanging up zombie '%s'\n", chan->name);
01510    }
01511          
01512    ast_channel_unlock(chan);
01513    manager_event(EVENT_FLAG_CALL, "Hangup",
01514          "Channel: %s\r\n"
01515          "Uniqueid: %s\r\n"
01516          "Cause: %d\r\n"
01517          "Cause-txt: %s\r\n",
01518          chan->name,
01519          chan->uniqueid,
01520          chan->hangupcause,
01521          ast_cause2str(chan->hangupcause)
01522          );
01523 
01524    if (chan->cdr && !ast_test_flag(chan->cdr, AST_CDR_FLAG_BRIDGED) && 
01525       !ast_test_flag(chan->cdr, AST_CDR_FLAG_POST_DISABLED) && 
01526        (chan->cdr->disposition != AST_CDR_NULL || ast_test_flag(chan->cdr, AST_CDR_FLAG_DIALED))) {
01527          
01528       ast_cdr_end(chan->cdr);
01529       ast_cdr_detach(chan->cdr);
01530       chan->cdr = NULL;
01531    }
01532    
01533    ast_channel_free(chan);
01534 
01535    return res;
01536 }

int ast_indicate ( struct ast_channel chan,
int  condition 
)

Indicates condition of channel.

Note:
Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
Parameters:
chan channel to change the indication
condition which condition to indicate on the channel
Returns:
Returns 0 on success, -1 on failure

Definition at line 2388 of file channel.c.

References ast_indicate_data().

Referenced by __ast_play_and_record(), agent_new(), ast_bridge_call(), ast_channel_bridge(), ast_do_masquerade(), ast_dtmf_stream(), ast_feature_request_and_dial(), attempt_transfer(), builtin_blindtransfer(), conf_run(), disa_exec(), do_atxfer(), do_parking_thread(), features_indicate(), finishup(), function_remote(), handle_frame(), handle_recordfile(), mgcp_ss(), monitor_dial(), park_exec(), pbx_builtin_busy(), pbx_builtin_congestion(), pbx_builtin_progress(), pbx_builtin_ringing(), pbx_builtin_waitexten(), queue_exec(), rpt(), send_waveform_to_channel(), skinny_ss(), sla_handle_hold_event(), sla_station_exec(), sla_trunk_exec(), and wait_for_answer().

02389 {
02390    return ast_indicate_data(chan, condition, NULL, 0);
02391 }

int ast_indicate_data ( struct ast_channel chan,
int  condition,
const void *  data,
size_t  datalen 
)

Indicates condition of channel, with payload.

Note:
Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
Parameters:
chan channel to change the indication
condition which condition to indicate on the channel
data pointer to payload data
datalen size of payload data
Returns:
Returns 0 on success, -1 on failure

Definition at line 2393 of file channel.c.

References ast_channel_lock, ast_channel_unlock, ast_check_hangup(), AST_CONTROL_BUSY, AST_CONTROL_CONGESTION, AST_CONTROL_HOLD, AST_CONTROL_PROCEEDING, AST_CONTROL_PROGRESS, AST_CONTROL_RINGING, AST_CONTROL_SRCUPDATE, AST_CONTROL_UNHOLD, AST_CONTROL_VIDUPDATE, AST_FLAG_ZOMBIE, ast_get_indication_tone(), ast_log(), ast_playtones_start(), ast_playtones_stop(), ast_test_flag, ind_tone_zone_sound::data, ast_channel_tech::indicate, LOG_DEBUG, LOG_WARNING, option_debug, ast_channel::tech, ast_channel::visible_indication, and ast_channel::zone.

Referenced by __login_exec(), agent_hangup(), ast_bridge_call(), ast_indicate(), bridge_native_loop(), do_parking_thread(), park_call_full(), pbx_builtin_waitexten(), and wait_for_answer().

02394 {
02395    int res = -1;
02396 
02397    ast_channel_lock(chan);
02398    /* Stop if we're a zombie or need a soft hangup */
02399    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
02400       ast_channel_unlock(chan);
02401       return -1;
02402    }
02403    if (chan->tech->indicate)
02404       res = chan->tech->indicate(chan, condition, data, datalen);
02405    ast_channel_unlock(chan);
02406    if (!chan->tech->indicate || res) {
02407       /*
02408        * Device does not support (that) indication, lets fake
02409        * it by doing our own tone generation. (PM2002)
02410        */
02411       if (condition < 0)
02412          ast_playtones_stop(chan);
02413       else {
02414          const struct ind_tone_zone_sound *ts = NULL;
02415          switch (condition) {
02416          case AST_CONTROL_RINGING:
02417             ts = ast_get_indication_tone(chan->zone, "ring");
02418             break;
02419          case AST_CONTROL_BUSY:
02420             ts = ast_get_indication_tone(chan->zone, "busy");
02421             break;
02422          case AST_CONTROL_CONGESTION:
02423             ts = ast_get_indication_tone(chan->zone, "congestion");
02424             break;
02425          }
02426          if (ts && ts->data[0]) {
02427             if (option_debug)
02428                ast_log(LOG_DEBUG, "Driver for channel '%s' does not support indication %d, emulating it\n", chan->name, condition);
02429             ast_playtones_start(chan,0,ts->data, 1);
02430             res = 0;
02431             chan->visible_indication = condition;
02432          } else if (condition == AST_CONTROL_PROGRESS) {
02433             /* ast_playtones_stop(chan); */
02434          } else if (condition == AST_CONTROL_PROCEEDING) {
02435             /* Do nothing, really */
02436          } else if (condition == AST_CONTROL_HOLD) {
02437             /* Do nothing.... */
02438          } else if (condition == AST_CONTROL_UNHOLD) {
02439             /* Do nothing.... */
02440          } else if (condition == AST_CONTROL_VIDUPDATE) {
02441             /* Do nothing.... */
02442          } else if (condition == AST_CONTROL_SRCUPDATE) {
02443             /* Do nothing... */
02444          } else {
02445             /* not handled */
02446             ast_log(LOG_WARNING, "Unable to handle indication %d for '%s'\n", condition, chan->name);
02447             res = -1;
02448          }
02449       }
02450    } else
02451       chan->visible_indication = condition;
02452 
02453    return res;
02454 }

int ast_internal_timing_enabled ( struct ast_channel chan  ) 

Check if the channel can run in internal timing mode.

Parameters:
chan The channel to check
Returns:
boolean
This function will return 1 if internal timing is enabled and the timing device is available.

Definition at line 2370 of file channel.c.

References ast_log(), ast_opt_internal_timing, LOG_DEBUG, option_debug, and ast_channel::timingfd.

Referenced by add_sdp(), and ast_read_generator_actions().

02371 {
02372    int ret = ast_opt_internal_timing && chan->timingfd > -1;
02373    if (option_debug > 4)
02374       ast_log(LOG_DEBUG, "Internal timing is %s (option_internal_timing=%d chan->timingfd=%d)\n", ret? "enabled": "disabled", ast_opt_internal_timing, chan->timingfd);
02375    return ret;
02376 }

char* ast_print_group ( char *  buf,
int  buflen,
ast_group_t  group 
)

print call- and pickup groups into buffer

Definition at line 4445 of file channel.c.

Referenced by _sip_show_peer(), func_channel_read(), misdn_cfg_get_config_string(), print_group(), read_config(), and serialize_showchan().

04446 {
04447    unsigned int i;
04448    int first=1;
04449    char num[3];
04450 
04451    buf[0] = '\0';
04452    
04453    if (!group) /* Return empty string if no group */
04454       return buf;
04455 
04456    for (i = 0; i <= 63; i++) {   /* Max group is 63 */
04457       if (group & ((ast_group_t) 1 << i)) {
04458             if (!first) {
04459             strncat(buf, ", ", buflen - strlen(buf) - 1);
04460          } else {
04461             first=0;
04462          }
04463          snprintf(num, sizeof(num), "%u", i);
04464          strncat(buf, num, buflen - strlen(buf) - 1);
04465       }
04466    }
04467    return buf;
04468 }

int ast_prod ( struct ast_channel chan  ) 

Send empty audio to prime a channel driver.

Definition at line 2576 of file channel.c.

References ast_channel::_state, AST_FRAME_VOICE, AST_FRIENDLY_OFFSET, ast_log(), AST_STATE_UP, ast_write(), ast_frame::data, LOG_DEBUG, LOG_WARNING, option_debug, ast_channel::rawwriteformat, ast_frame::src, and ast_frame::subclass.

Referenced by ast_activate_generator().

02577 {
02578    struct ast_frame a = { AST_FRAME_VOICE };
02579    char nothing[128];
02580 
02581    /* Send an empty audio frame to get things moving */
02582    if (chan->_state != AST_STATE_UP) {
02583       if (option_debug)
02584          ast_log(LOG_DEBUG, "Prodding channel '%s'\n", chan->name);
02585       a.subclass = chan->rawwriteformat;
02586       a.data = nothing + AST_FRIENDLY_OFFSET;
02587       a.src = "ast_prod";
02588       if (ast_write(chan, &a))
02589          ast_log(LOG_WARNING, "Prodding channel '%s' failed\n", chan->name);
02590    }
02591    return 0;
02592 }

int ast_queue_control ( struct ast_channel chan,
enum ast_control_frame_type  control 
)

Queue a control frame with payload.

Parameters:
chan channel to queue frame onto
control type of control frame
Returns:
zero on success, non-zero on failure

Definition at line 969 of file channel.c.

References AST_FRAME_CONTROL, ast_queue_frame(), and f.

Referenced by __dahdi_exception(), __oh323_update_info(), ast_pickup_call(), attempt_transfer(), auto_congest(), cb_events(), dahdi_handle_event(), dahdi_hangup(), gtalk_is_answered(), gtalk_ringing_ack(), handle_hd_hf(), handle_offhook_message(), handle_request(), handle_request_bye(), handle_request_info(), handle_request_refer(), handle_response(), handle_response_invite(), handle_response_refer(), handle_soft_key_event_message(), handle_stimulus_message(), mgcp_call(), nbs_call(), phone_call(), pickup_do(), process_sdp(), receive_digit(), send_cause2ast(), setup_rtp_connection(), skinny_call(), skinny_unhold(), ss_thread(), and update_state().

00970 {
00971    struct ast_frame f = { AST_FRAME_CONTROL, };
00972 
00973    f.subclass = control;
00974 
00975    return ast_queue_frame(chan, &f);
00976 }

int ast_queue_control_data ( struct ast_channel chan,
enum ast_control_frame_type  control,
const void *  data,
size_t  datalen 
)

Queue a control frame with payload.

Parameters:
chan channel to queue frame onto
control type of control frame
data pointer to payload data to be included in frame
datalen number of bytes of payload data
Returns:
zero on success, non-zero on failure
The supplied payload data is copied into the frame, so the caller's copy is not modified nor freed, and the resulting frame will retain a copy of the data even if the caller frees their local copy.

Note:
This method should be treated as a 'network transport'; in other words, your frames may be transferred across an IAX2 channel to another system, which may be a different endianness than yours. Because of this, you should ensure that either your frames will never be expected to work across systems, or that you always put your payload data into 'network byte order' before calling this function.

Definition at line 979 of file channel.c.

References AST_FRAME_CONTROL, ast_queue_frame(), and f.

Referenced by action_atxfer(), dahdi_handle_event(), dahdi_hangup(), iax2_queue_control_data(), process_sdp(), and skinny_hold().

00981 {
00982    struct ast_frame f = { AST_FRAME_CONTROL, };
00983 
00984    f.subclass = control;
00985    f.data = (void *) data;
00986    f.datalen = datalen;
00987 
00988    return ast_queue_frame(chan, &f);
00989 }

int ast_queue_frame ( struct ast_channel chan,
struct ast_frame f 
)

Queue an outgoing frame.

Definition at line 901 of file channel.c.

References ast_channel::alertpipe, ast_assert, ast_channel_lock, ast_channel_unlock, AST_CONTROL_HANGUP, AST_FLAG_BLOCKING, AST_FRAME_CONTROL, AST_FRAME_VOICE, ast_frdup(), ast_frfree, AST_LIST_INSERT_TAIL, AST_LIST_LAST, AST_LIST_TRAVERSE, ast_log(), ast_test_flag, ast_channel::blocker, errno, f, ast_frame::frametype, LOG_DEBUG, LOG_WARNING, option_debug, ast_frame::subclass, and ast_channel::timingfd.

Referenced by __oh323_rtp_create(), __oh323_update_info(), agent_new(), alsa_call(), ast_autoservice_stop(), ast_channel_masquerade(), ast_channel_setwhentohangup(), ast_do_masquerade(), ast_dsp_process(), ast_queue_control(), ast_queue_control_data(), ast_queue_hangup(), ast_softhangup_nolock(), cb_events(), console_answer(), console_answer_deprecated(), console_dial(), console_dial_deprecated(), console_flash(), console_flash_deprecated(), console_sendtext(), console_sendtext_deprecated(), dahdi_queue_frame(), dictate_exec(), do_immediate_setup(), gtalk_handle_dtmf(), handle_keypad_button_message(), handle_request_info(), handle_request_invite(), handle_response_invite(), iax2_queue_frame(), local_queue_frame(), mgcp_queue_frame(), oh323_simulate_dtmf_end(), oss_call(), process_sdp(), receive_digit(), receive_message(), rpt_call(), and wakeup_sub().

00902 {
00903    struct ast_frame *f;
00904    struct ast_frame *cur;
00905    int blah = 1;
00906    int qlen = 0;
00907 
00908    /* Build us a copy and free the original one */
00909    if (!(f = ast_frdup(fin))) {
00910       ast_log(LOG_WARNING, "Unable to duplicate frame\n");
00911       return -1;
00912    }
00913    ast_channel_lock(chan);
00914 
00915    /* See if the last frame on the queue is a hangup, if so don't queue anything */
00916    if ((cur = AST_LIST_LAST(&chan->readq)) && (cur->frametype == AST_FRAME_CONTROL) && (cur->subclass == AST_CONTROL_HANGUP)) {
00917       ast_frfree(f);
00918       ast_channel_unlock(chan);
00919       return 0;
00920    }
00921 
00922    /* Count how many frames exist on the queue */
00923    AST_LIST_TRAVERSE(&chan->readq, cur, frame_list) {
00924       qlen++;
00925    }
00926 
00927    /* Allow up to 96 voice frames outstanding, and up to 128 total frames */
00928    if (((fin->frametype == AST_FRAME_VOICE) && (qlen > 96)) || (qlen  > 128)) {
00929       if (fin->frametype != AST_FRAME_VOICE) {
00930          ast_log(LOG_WARNING, "Exceptionally long queue length queuing to %s\n", chan->name);
00931          ast_assert(fin->frametype == AST_FRAME_VOICE);
00932       } else {
00933          if (option_debug)
00934             ast_log(LOG_DEBUG, "Dropping voice to exceptionally long queue on %s\n", chan->name);
00935          ast_frfree(f);
00936          ast_channel_unlock(chan);
00937          return 0;
00938       }
00939    }
00940    AST_LIST_INSERT_TAIL(&chan->readq, f, frame_list);
00941    if (chan->alertpipe[1] > -1) {
00942       if (write(chan->alertpipe[1], &blah, sizeof(blah)) != sizeof(blah))
00943          ast_log(LOG_WARNING, "Unable to write to alert pipe on %s, frametype/subclass %d/%d (qlen = %d): %s!\n",
00944             chan->name, f->frametype, f->subclass, qlen, strerror(errno));
00945 #ifdef HAVE_DAHDI
00946    } else if (chan->timingfd > -1) {
00947       ioctl(chan->timingfd, DAHDI_TIMERPING, &blah);
00948 #endif            
00949    } else if (ast_test_flag(chan, AST_FLAG_BLOCKING)) {
00950       pthread_kill(chan->blocker, SIGURG);
00951    }
00952    ast_channel_unlock(chan);
00953    return 0;
00954 }

int ast_queue_hangup ( struct ast_channel chan  ) 

Queue a hangup frame.

Definition at line 957 of file channel.c.

References ast_channel::_softhangup, ast_channel_trylock, ast_channel_unlock, AST_CONTROL_HANGUP, AST_FRAME_CONTROL, ast_queue_frame(), AST_SOFTHANGUP_DEV, and f.

Referenced by __oh323_update_info(), __sip_autodestruct(), cleanup_connection(), console_hangup(), console_hangup_deprecated(), dahdi_handle_event(), gtalk_hangup_farend(), gtalk_is_answered(), handle_onhook_message(), handle_request_bye(), handle_request_cancel(), handle_response(), handle_response_invite(), handle_soft_key_event_message(), hangup_chan(), hangup_connection(), iax2_destroy(), iax2_queue_hangup(), local_hangup(), mgcp_queue_hangup(), misdn_answer(), and retrans_pkt().

00958 {
00959    struct ast_frame f = { AST_FRAME_CONTROL, AST_CONTROL_HANGUP };
00960    /* Yeah, let's not change a lock-critical value without locking */
00961    if (!ast_channel_trylock(chan)) {
00962       chan->_softhangup |= AST_SOFTHANGUP_DEV;
00963       ast_channel_unlock(chan);
00964    }
00965    return ast_queue_frame(chan, &f);
00966 }

struct ast_frame* ast_read ( struct ast_channel chan  ) 

Reads a frame.

Parameters:
chan channel to read a frame from Read a frame.
Returns:
Returns a frame, or NULL on error. If it returns NULL, you best just stop reading frames and assume the channel has been disconnected.

Definition at line 2378 of file channel.c.

References __ast_read().

Referenced by __adsi_transmit_messages(), __ast_play_and_record(), __ast_request_and_dial(), adsi_careful_send(), agent_ack_sleep(), agent_read(), app_exec(), ast_feature_request_and_dial(), ast_masq_park_call(), ast_recvtext(), ast_safe_sleep_conditional(), ast_tonepair(), ast_udptl_bridge(), ast_waitfordigit_full(), async_wait(), autoservice_run(), background_detect_exec(), bridge_native_loop(), bridge_p2p_loop(), channel_spy(), check_goto_on_transfer(), conf_exec(), conf_flush(), conf_run(), dahdi_bridge(), dictate_exec(), disa_exec(), do_atxfer(), do_parking_thread(), do_waiting(), echo_exec(), features_read(), find_cache(), handle_invite_replaces(), handle_recordfile(), iax_park_thread(), ices_exec(), isAnsweringMachine(), measurenoise(), misdn_bridge(), monitor_dial(), mp3_exec(), NBScat_exec(), receive_dtmf_digits(), recordthread(), rpt(), run_agi(), send_tone_burst(), send_waveform_to_channel(), sendurl_exec(), speech_background(), ss_thread(), wait_for_answer(), wait_for_hangup(), wait_for_winner(), waitforring_exec(), and waitstream_core().

02379 {
02380    return __ast_read(chan, 0);
02381 }

struct ast_frame* ast_read_noaudio ( struct ast_channel chan  ) 

Reads a frame, returning AST_FRAME_NULL frame if audio. Read a frame.

Parameters:
chan channel to read a frame from
Returns:
Returns a frame, or NULL on error. If it returns NULL, you best just stop reading frames and assume the channel has been disconnected.
Note:
Audio is replaced with AST_FRAME_NULL to avoid transcode when the resulting audio is not necessary.

Definition at line 2383 of file channel.c.

References __ast_read().

Referenced by conf_run().

02384 {
02385    return __ast_read(chan, 1);
02386 }

int ast_readstring ( struct ast_channel c,
char *  s,
int  len,
int  timeout,
int  rtimeout,
char *  enders 
)

Reads multiple digits

Parameters:
c channel to read from
s string to read in to. Must be at least the size of your length
len how many digits to read (maximum)
timeout how long to timeout between digits
rtimeout timeout to wait on the first digit
enders digits to end the string Read in a digit string "s", max length "len", maximum timeout between digits "timeout" (-1 for none), terminated by anything in "enders". Give them rtimeout for the first digit. Returns 0 on normal return, or 1 on a timeout. In the case of a timeout, any digits that were read before the timeout will still be available in s. RETURNS 2 in full version when ctrlfd is available, NOT 1

Definition at line 3101 of file channel.c.

References ast_readstring_full().

Referenced by __adsi_transmit_messages(), ast_adsi_begin_download(), ast_adsi_get_cpeinfo(), ast_adsi_load_session(), ast_app_getdata(), dialout(), do_directory(), forward_message(), privacy_exec(), vm_authenticate(), vm_newuser(), and vm_options().

03102 {
03103    return ast_readstring_full(c, s, len, timeout, ftimeout, enders, -1, -1);
03104 }

int ast_readstring_full ( struct ast_channel c,
char *  s,
int  len,
int  timeout,
int  rtimeout,
char *  enders,
int  audiofd,
int  ctrlfd 
)

Definition at line 3106 of file channel.c.

References ast_check_hangup(), AST_DIGIT_ANY, AST_FLAG_ZOMBIE, ast_stopstream(), ast_test_flag, ast_waitfordigit_full(), ast_waitstream_full(), and ast_channel::stream.

Referenced by ast_app_getdata_full(), and ast_readstring().

03107 {
03108    int pos = 0;   /* index in the buffer where we accumulate digits */
03109    int to = ftimeout;
03110 
03111    /* Stop if we're a zombie or need a soft hangup */
03112    if (ast_test_flag(c, AST_FLAG_ZOMBIE) || ast_check_hangup(c))
03113       return -1;
03114    if (!len)
03115       return -1;
03116    for (;;) {
03117       int d;
03118       if (c->stream) {
03119          d = ast_waitstream_full(c, AST_DIGIT_ANY, audiofd, ctrlfd);
03120          ast_stopstream(c);
03121          usleep(1000);
03122          if (!d)
03123             d = ast_waitfordigit_full(c, to, audiofd, ctrlfd);
03124       } else {
03125          d = ast_waitfordigit_full(c, to, audiofd, ctrlfd);
03126       }
03127       if (d < 0)
03128          return -1;
03129       if (d == 0) {
03130          s[pos]='\0';
03131          return 1;
03132       }
03133       if (d == 1) {
03134          s[pos]='\0';
03135          return 2;
03136       }
03137       if (!strchr(enders, d))
03138          s[pos++] = d;
03139       if (strchr(enders, d) || (pos >= len)) {
03140          s[pos]='\0';
03141          return 0;
03142       }
03143       to = timeout;
03144    }
03145    /* Never reached */
03146    return 0;
03147 }

int ast_recvchar ( struct ast_channel chan,
int  timeout 
)

Receives a text character from a channel.

Parameters:
chan channel to act upon
timeout timeout in milliseconds (0 for infinite wait) Read a char of text from a channel Returns 0 on success, -1 on failure

Definition at line 2456 of file channel.c.

References ast_recvtext(), and free.

Referenced by handle_recvchar().

02457 {
02458    int c;
02459    char *buf = ast_recvtext(chan, timeout);
02460    if (buf == NULL)
02461       return -1;  /* error or timeout */
02462    c = *(unsigned char *)buf;
02463    free(buf);
02464    return c;
02465 }

char* ast_recvtext ( struct ast_channel chan,
int  timeout 
)

Receives a text string from a channel Read a string of text from a channel.

Parameters:
chan channel to act upon
timeout timeout in milliseconds (0 for infinite wait)
Returns:
the received text, or NULL to signify failure.

Definition at line 2467 of file channel.c.

References ast_check_hangup(), AST_CONTROL_HANGUP, AST_FRAME_CONTROL, AST_FRAME_TEXT, ast_frfree, ast_read(), ast_strndup, ast_waitfor(), and f.

Referenced by ast_recvchar(), and handle_recvtext().

02468 {
02469    int res, done = 0;
02470    char *buf = NULL;
02471    
02472    while (!done) {
02473       struct ast_frame *f;
02474       if (ast_check_hangup(chan))
02475          break;
02476       res = ast_waitfor(chan, timeout);
02477       if (res <= 0) /* timeout or error */
02478          break;
02479       timeout = res; /* update timeout */
02480       f = ast_read(chan);
02481       if (f == NULL)
02482          break; /* no frame */
02483       if (f->frametype == AST_FRAME_CONTROL && f->subclass == AST_CONTROL_HANGUP)
02484          done = 1;   /* force a break */
02485       else if (f->frametype == AST_FRAME_TEXT) {      /* what we want */
02486          buf = ast_strndup((char *) f->data, f->datalen);   /* dup and break */
02487          done = 1;
02488       }
02489       ast_frfree(f);
02490    }
02491    return buf;
02492 }

struct ast_channel* ast_request ( const char *  type,
int  format,
void *  data,
int *  status 
)

Requests a channel.

Parameters:
type type of channel to request
format requested channel format (codec)
data data to pass to the channel requester
status status Request a channel of a given type, with data as optional information used by the low level module
Returns:
Returns an ast_channel on success, NULL on failure.

Definition at line 3007 of file channel.c.

References AST_CAUSE_BEARERCAPABILITY_NOTAVAIL, AST_CAUSE_NOSUCHDRIVER, AST_CAUSE_NOTDEFINED, AST_FORMAT_AUDIO_MASK, AST_FORMAT_VIDEO_MASK, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), ast_translator_best_choice(), ast_channel_tech::capabilities, capabilities, channels, fmt, LOG_WARNING, ast_channel_tech::requester, chanlist::tech, and ast_channel_tech::type.

Referenced by __ast_request_and_dial(), agent_request(), ast_feature_request_and_dial(), attempt_reconnect(), begin_dial(), build_conf(), chanavail_exec(), conf_run(), connect_link(), features_alloc(), findmeexec(), ring_entry(), rpt(), rpt_call(), rpt_tele_thread(), and wait_for_answer().

03008 {
03009    struct chanlist *chan;
03010    struct ast_channel *c;
03011    int capabilities;
03012    int fmt;
03013    int res;
03014    int foo;
03015    int videoformat = format & AST_FORMAT_VIDEO_MASK;
03016 
03017    if (!cause)
03018       cause = &foo;
03019    *cause = AST_CAUSE_NOTDEFINED;
03020 
03021    if (AST_LIST_LOCK(&channels)) {
03022       ast_log(LOG_WARNING, "Unable to lock channel list\n");
03023       return NULL;
03024    }
03025 
03026    AST_LIST_TRAVERSE(&backends, chan, list) {
03027       if (strcasecmp(type, chan->tech->type))
03028          continue;
03029 
03030       capabilities = chan->tech->capabilities;
03031       fmt = format & AST_FORMAT_AUDIO_MASK;
03032       res = ast_translator_best_choice(&fmt, &capabilities);
03033       if (res < 0) {
03034          ast_log(LOG_WARNING, "No translator path exists for channel type %s (native %d) to %d\n", type, chan->tech->capabilities, format);
03035          *cause = AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
03036          AST_LIST_UNLOCK(&channels);
03037          return NULL;
03038       }
03039       AST_LIST_UNLOCK(&channels);
03040       if (!chan->tech->requester)
03041          return NULL;
03042       
03043       if (!(c = chan->tech->requester(type, capabilities | videoformat, data, cause)))
03044          return NULL;
03045 
03046       /* no need to generate a Newchannel event here; it is done in the channel_alloc call */
03047       return c;
03048    }
03049 
03050    ast_log(LOG_WARNING, "No channel type registered for '%s'\n", type);
03051    *cause = AST_CAUSE_NOSUCHDRIVER;
03052    AST_LIST_UNLOCK(&channels);
03053 
03054    return NULL;
03055 }

struct ast_channel* ast_request_and_dial ( const char *  type,
int  format,
void *  data,
int  timeout,
int *  reason,
const char *  cidnum,
const char *  cidname 
)

Request a channel of a given type, with data as optional information used by the low level module and attempt to place a call on it.

Parameters:
type type of channel to request
format requested channel format
data data to pass to the channel requester
timeout maximum amount of time to wait for an answer
reason why unsuccessful (if unsuceessful)
cidnum Caller-ID Number
cidname Caller-ID Name
Returns:
Returns an ast_channel on success or no answer, NULL on failure. Check the value of chan->_state to know if the call was answered or not.

Definition at line 3002 of file channel.c.

References __ast_request_and_dial().

Referenced by ast_pbx_outgoing_exten().

03003 {
03004    return __ast_request_and_dial(type, format, data, timeout, outstate, cidnum, cidname, NULL);
03005 }

int ast_safe_sleep ( struct ast_channel chan,
int  ms 
)

Wait for a specied amount of time, looking for hangups.

Parameters:
chan channel to wait for
ms length of time in milliseconds to sleep Waits for a specified amount of time, servicing the channel as required.
Returns:
returns -1 on hangup, otherwise 0.

Definition at line 1179 of file channel.c.

References ast_safe_sleep_conditional().

Referenced by __login_exec(), alarmreceiver_exec(), ast_adsi_transmit_message_full(), ast_dtmf_stream(), ast_senddigit(), builtin_parkcall(), dictate_exec(), flash_exec(), function_ilink(), mgcp_ss(), milliwatt_exec(), moh0_exec(), moh1_exec(), old_milliwatt_exec(), park_call_exec(), pbx_builtin_answer(), pbx_builtin_wait(), play_tone_pair(), playtone(), privacy_exec(), receive_ademco_contact_id(), rpt_call(), rpt_exec(), rpt_tele_thread(), send_morse(), send_tone_telemetry(), skinny_ss(), ss_thread(), testclient_exec(), testserver_exec(), try_calling(), wait_for_hangup(), wait_interval(), and zapateller_exec().

01180 {
01181    return ast_safe_sleep_conditional(chan, ms, NULL, NULL);
01182 }

int ast_safe_sleep_conditional ( struct ast_channel chan,
int  ms,
int(*)(void *)  cond,
void *  data 
)

Wait for a specied amount of time, looking for hangups and a condition argument.

Parameters:
chan channel to wait for
ms length of time in milliseconds to sleep
cond a function pointer for testing continue condition
data argument to be passed to the condition test function
Returns:
returns -1 on hangup, otherwise 0. Waits for a specified amount of time, servicing the channel as required. If cond returns 0, this function returns.

Definition at line 1158 of file channel.c.

References ast_frfree, ast_read(), ast_waitfor(), and f.

Referenced by __login_exec(), and ast_safe_sleep().

01159 {
01160    struct ast_frame *f;
01161 
01162    while (ms > 0) {
01163       if (cond && ((*cond)(data) == 0))
01164          return 0;
01165       ms = ast_waitfor(chan, ms);
01166       if (ms < 0)
01167          return -1;
01168       if (ms > 0) {
01169          f = ast_read(chan);
01170          if (!f)
01171             return -1;
01172          ast_frfree(f);
01173       }
01174    }
01175    return 0;
01176 }

char* ast_safe_string_alloc ( const char *  fmt,
  ... 
)

printf the string into a correctly sized mallocd buffer, and return the buffer

return a mallocd string with the result of sprintf of the fmt and following args

Definition at line 409 of file channel.c.

References ast_malloc, and len.

Referenced by dahdi_new(), and features_new().

00410 {
00411    char *b2, buf[1];
00412    int len;
00413    va_list args;
00414 
00415    va_start(args, fmt);
00416    len = vsnprintf(buf, 1, fmt, args);
00417    va_end(args);
00418 
00419    if (!(b2 = ast_malloc(len + 1)))
00420       return NULL;
00421 
00422    va_start(args, fmt);
00423    vsnprintf(b2, len + 1,  fmt, args);
00424    va_end(args);
00425 
00426    return b2;
00427 }

static int ast_select ( int  nfds,
fd_set *  rfds,
fd_set *  wfds,
fd_set *  efds,
struct timeval *  tvp 
) [inline, static]

Waits for activity on a group of channels.

Parameters:
nfds the maximum number of file descriptors in the sets
rfds file descriptors to check for read availability
wfds file descriptors to check for write availability
efds file descriptors to check for exceptions (OOB data)
tvp timeout while waiting for events This is the same as a standard select(), except it guarantees the behaviour where the passed struct timeval is updated with how much time was not slept while waiting for the specified events

Definition at line 1317 of file channel.h.

Referenced by do_monitor(), do_parking_thread(), and sound_thread().

01318 {
01319 #ifdef __linux__
01320    return select(nfds, rfds, wfds, efds, tvp);
01321 #else
01322    if (tvp) {
01323       struct timeval tv, tvstart, tvend, tvlen;
01324       int res;
01325 
01326       tv = *tvp;
01327       gettimeofday(&tvstart, NULL);
01328       res = select(nfds, rfds, wfds, efds, tvp);
01329       gettimeofday(&tvend, NULL);
01330       timersub(&tvend, &tvstart, &tvlen);
01331       timersub(&tv, &tvlen, tvp);
01332       if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
01333          tvp->tv_sec = 0;
01334          tvp->tv_usec = 0;
01335       }
01336       return res;
01337    }
01338    else
01339       return select(nfds, rfds, wfds, efds, NULL);
01340 #endif
01341 }

int ast_senddigit ( struct ast_channel chan,
char  digit 
)

Send a DTMF digit to a channel Send a DTMF digit to a channel.

Parameters:
chan channel to act upon
digit the DTMF digit to send, encoded in ASCII
Returns:
Returns 0 on success, -1 on failure

Definition at line 2566 of file channel.c.

References AST_DEFAULT_EMULATE_DTMF_DURATION, ast_safe_sleep(), ast_senddigit_begin(), ast_senddigit_end(), ast_channel_tech::send_digit_begin, and ast_channel::tech.

Referenced by ast_dtmf_stream(), do_dtmf_phone(), manager_play_dtmf(), and rpt_call().

02567 {
02568    if (chan->tech->send_digit_begin) {
02569       ast_senddigit_begin(chan, digit);
02570       ast_safe_sleep(chan, AST_DEFAULT_EMULATE_DTMF_DURATION);
02571    }
02572    
02573    return ast_senddigit_end(chan, digit, AST_DEFAULT_EMULATE_DTMF_DURATION);
02574 }

int ast_senddigit_begin ( struct ast_channel chan,
char  digit 
)

Definition at line 2507 of file channel.c.

References ast_log(), ast_playtones_start(), LOG_DEBUG, option_debug, ast_channel_tech::send_digit_begin, and ast_channel::tech.

Referenced by agent_digit_begin(), ast_senddigit(), ast_write(), and features_digit_begin().

02508 {
02509    /* Device does not support DTMF tones, lets fake
02510     * it by doing our own generation. */
02511    static const char* dtmf_tones[] = {
02512       "941+1336", /* 0 */
02513       "697+1209", /* 1 */
02514       "697+1336", /* 2 */
02515       "697+1477", /* 3 */
02516       "770+1209", /* 4 */
02517       "770+1336", /* 5 */
02518       "770+1477", /* 6 */
02519       "852+1209", /* 7 */
02520       "852+1336", /* 8 */
02521       "852+1477", /* 9 */
02522       "697+1633", /* A */
02523       "770+1633", /* B */
02524       "852+1633", /* C */
02525       "941+1633", /* D */
02526       "941+1209", /* * */
02527       "941+1477"  /* # */
02528    };
02529 
02530    if (!chan->tech->send_digit_begin)
02531       return 0;
02532 
02533    if (!chan->tech->send_digit_begin(chan, digit))
02534       return 0;
02535 
02536    if (digit >= '0' && digit <='9')
02537       ast_playtones_start(chan, 0, dtmf_tones[digit-'0'], 0);
02538    else if (digit >= 'A' && digit <= 'D')
02539       ast_playtones_start(chan, 0, dtmf_tones[digit-'A'+10], 0);
02540    else if (digit == '*')
02541       ast_playtones_start(chan, 0, dtmf_tones[14], 0);
02542    else if (digit == '#')
02543       ast_playtones_start(chan, 0, dtmf_tones[15], 0);
02544    else {
02545       /* not handled */
02546       if (option_debug)
02547          ast_log(LOG_DEBUG, "Unable to generate DTMF tone '%c' for '%s'\n", digit, chan->name);
02548    }
02549 
02550    return 0;
02551 }

int ast_senddigit_end ( struct ast_channel chan,
char  digit,
unsigned int  duration 
)

Definition at line 2553 of file channel.c.

References ast_playtones_stop(), ast_channel::generator, ast_channel_tech::send_digit_end, and ast_channel::tech.

Referenced by agent_digit_end(), ast_senddigit(), ast_write(), and features_digit_end().

02554 {
02555    int res = -1;
02556 
02557    if (chan->tech->send_digit_end)
02558       res = chan->tech->send_digit_end(chan, digit, duration);
02559 
02560    if (res && chan->generator)
02561       ast_playtones_stop(chan);
02562    
02563    return 0;
02564 }

int ast_sendtext ( struct ast_channel chan,
const char *  text 
)

Sends text to a channel Write text to a display on a channel.

Parameters:
chan channel to act upon
text string of text to send on the channel
Returns:
Returns 0 on success, -1 on failure

Definition at line 2494 of file channel.c.

References ast_check_hangup(), ast_clear_flag, AST_FLAG_BLOCKING, AST_FLAG_ZOMBIE, ast_test_flag, CHECK_BLOCKING, ast_channel_tech::send_text, and ast_channel::tech.

Referenced by agent_sendtext(), handle_sendtext(), and sendtext_exec().

02495 {
02496    int res = 0;
02497    /* Stop if we're a zombie or need a soft hangup */
02498    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan))
02499       return -1;
02500    CHECK_BLOCKING(chan);
02501    if (chan->tech->send_text)
02502       res = chan->tech->send_text(chan, text);
02503    ast_clear_flag(chan, AST_FLAG_BLOCKING);
02504    return res;
02505 }

void ast_set_callerid ( struct ast_channel chan,
const char *  cidnum,
const char *  cidname,
const char *  ani 
)

Note:
The channel does not need to be locked before calling this function.

Definition at line 3650 of file channel.c.

References ast_channel_lock, ast_channel_unlock, ast_describe_caller_presentation(), ast_strdup, ast_channel::cid, ast_callerid::cid_ani, ast_callerid::cid_name, ast_callerid::cid_num, ast_callerid::cid_pres, EVENT_FLAG_CALL, free, manager_event(), and S_OR.

Referenced by __ast_request_and_dial(), agent_call(), ast_feature_request_and_dial(), callerid_write(), dahdi_read(), disa_exec(), findmeexec(), handle_setcallerid(), lookupcidname_exec(), mgcp_ss(), privacy_exec(), read_config(), setcallerid_exec(), skinny_newcall(), ss_thread(), and wait_for_answer().

03651 {
03652    ast_channel_lock(chan);
03653 
03654    if (callerid) {
03655       if (chan->cid.cid_num)
03656          free(chan->cid.cid_num);
03657       chan->cid.cid_num = ast_strdup(callerid);
03658    }
03659    if (calleridname) {
03660       if (chan->cid.cid_name)
03661          free(chan->cid.cid_name);
03662       chan->cid.cid_name = ast_strdup(calleridname);
03663    }
03664    if (ani) {
03665       if (chan->cid.cid_ani)
03666          free(chan->cid.cid_ani);
03667       chan->cid.cid_ani = ast_strdup(ani);
03668    }
03669    manager_event(EVENT_FLAG_CALL, "Newcallerid",
03670             "Channel: %s\r\n"
03671             "CallerID: %s\r\n"
03672             "CallerIDName: %s\r\n"
03673             "Uniqueid: %s\r\n"
03674             "CID-CallingPres: %d (%s)\r\n",
03675             chan->name,
03676             S_OR(chan->cid.cid_num, "<Unknown>"),
03677             S_OR(chan->cid.cid_name, "<Unknown>"),
03678             chan->uniqueid,
03679             chan->cid.cid_pres,
03680             ast_describe_caller_presentation(chan->cid.cid_pres)
03681             );
03682    
03683    ast_channel_unlock(chan);
03684 }

int ast_set_read_format ( struct ast_channel chan,
int  format 
)

Sets read format on channel chan Set read format for channel to whichever component of "format" is best.

Parameters:
chan channel to change
format format to change to
Returns:
Returns 0 on success, -1 on failure

Definition at line 2847 of file channel.c.

References ast_channel::rawreadformat, ast_channel::readformat, ast_channel::readtrans, and set_format().

Referenced by __ast_play_and_record(), __login_exec(), __oh323_update_info(), agent_call(), alarmreceiver_exec(), ast_adsi_transmit_message_full(), ast_channel_make_compatible(), ast_do_masquerade(), attempt_reconnect(), background_detect_exec(), build_conf(), conf_run(), connect_link(), dictate_exec(), disa_exec(), do_waiting(), eagi_exec(), echo_exec(), gtalk_rtp_read(), handle_recordfile(), ices_exec(), isAnsweringMachine(), measurenoise(), mgcp_rtp_read(), oh323_rtp_read(), old_milliwatt_exec(), process_sdp(), rpt(), setup_rtp_connection(), sip_rtp_read(), skinny_rtp_read(), socket_process(), speech_background(), and update_features().

02848 {
02849    return set_format(chan, fmt, &chan->rawreadformat, &chan->readformat,
02850            &chan->readtrans, 0);
02851 }

void ast_set_variables ( struct ast_channel chan,
struct ast_variable vars 
)

adds a list of channel variables to a channel

Parameters:
chan the channel
vars a linked list of variables
Variable names can be for a regular channel variable or a dialplan function that has the ability to be written to.

Definition at line 4470 of file channel.c.

References ast_variable::name, ast_variable::next, pbx_builtin_setvar_helper(), and ast_variable::value.

Referenced by __ast_request_and_dial(), ast_pbx_outgoing_app(), and ast_pbx_outgoing_exten().

04471 {
04472    struct ast_variable *cur;
04473 
04474    for (cur = vars; cur; cur = cur->next)
04475       pbx_builtin_setvar_helper(chan, cur->name, cur->value);  
04476 }

int ast_set_write_format ( struct ast_channel chan,
int  format 
)

Sets write format on channel chan Set write format for channel to whichever compoent of "format" is best.

Parameters:
chan channel to change
format new format for writing
Returns:
Returns 0 on success, -1 on failure

Definition at line 2853 of file channel.c.

References ast_channel::rawwriteformat, set_format(), ast_channel::writeformat, and ast_channel::writetrans.

Referenced by __login_exec(), __oh323_update_info(), agent_call(), alarmreceiver_exec(), ast_adsi_transmit_message_full(), ast_channel_make_compatible(), ast_channel_start_silence_generator(), ast_channel_stop_silence_generator(), ast_do_masquerade(), ast_openstream_full(), ast_stopstream(), attempt_reconnect(), build_conf(), chanspy_exec(), conf_run(), connect_link(), disa_exec(), echo_exec(), extenspy_exec(), gtalk_rtp_read(), linear_alloc(), linear_release(), mgcp_rtp_read(), moh_alloc(), moh_files_release(), moh_release(), mp3_exec(), NBScat_exec(), oh323_rtp_read(), old_milliwatt_exec(), playtones_alloc(), playtones_release(), process_sdp(), rpt(), send_waveform_to_channel(), setup_rtp_connection(), sip_rtp_read(), skinny_rtp_read(), socket_process(), tonepair_alloc(), tonepair_release(), and update_features().

02854 {
02855    return set_format(chan, fmt, &chan->rawwriteformat, &chan->writeformat,
02856            &chan->writetrans, 1);
02857 }

int ast_setstate ( struct ast_channel chan,
enum  ast_channel_state 
)

Change the state of a channel.

Definition at line 3686 of file channel.c.

References ast_channel::_state, AST_CHANNEL_NAME, ast_device_state_changed_literal(), ast_state2str(), ast_channel::cid, ast_callerid::cid_name, ast_callerid::cid_num, EVENT_FLAG_CALL, manager_event(), name, and S_OR.

Referenced by __ast_read(), __dahdi_exception(), __oh323_update_info(), agent_call(), alsa_answer(), ast_answer(), cb_events(), check_availability(), dahdi_answer(), dahdi_call(), dahdi_handle_event(), dahdi_indicate(), dahdi_read(), gtalk_call(), gtalk_newcall(), handle_invite_replaces(), handle_offhook_message(), handle_request_invite(), handle_response_invite(), handle_soft_key_event_message(), handle_stimulus_message(), iax2_call(), mgcp_answer(), mgcp_call(), mgcp_ss(), misdn_call(), misdn_indication(), nbs_call(), nbs_hangup(), oh323_answer(), oss_answer(), pbx_builtin_busy(), pbx_builtin_congestion(), phone_answer(), phone_call(), phone_exception(), phone_hangup(), phone_write(), release_chan(), sip_answer(), skinny_answer(), skinny_call(), skinny_newcall(), ss_thread(), and update_state().

03687 {
03688    char name[AST_CHANNEL_NAME], *dashptr;
03689    int oldstate = chan->_state;
03690 
03691    if (oldstate == state)
03692       return 0;
03693 
03694    ast_copy_string(name, chan->name, sizeof(name));
03695    if ((dashptr = strrchr(name, '-'))) {
03696       *dashptr = '\0';
03697    }
03698 
03699    chan->_state = state;
03700    ast_device_state_changed_literal(name);
03701    /* setstate used to conditionally report Newchannel; this is no more */
03702    manager_event(EVENT_FLAG_CALL,
03703             "Newstate",
03704             "Channel: %s\r\n"
03705             "State: %s\r\n"
03706             "CallerID: %s\r\n"
03707             "CallerIDName: %s\r\n"
03708             "Uniqueid: %s\r\n",
03709             chan->name, ast_state2str(chan->_state),
03710             S_OR(chan->cid.cid_num, "<unknown>"),
03711             S_OR(chan->cid.cid_name, "<unknown>"),
03712             chan->uniqueid);
03713 
03714    return 0;
03715 }

int ast_settimeout ( struct ast_channel c,
int  samples,
int(*)(const void *data)  func,
void *  data 
)

Definition at line 1821 of file channel.c.

References ast_log(), LOG_DEBUG, option_debug, ast_channel::timingdata, ast_channel::timingfd, and ast_channel::timingfunc.

Referenced by ast_activate_generator(), ast_closestream(), ast_deactivate_generator(), ast_read_generator_actions(), and ast_readaudio_callback().

01822 {
01823    int res = -1;
01824 #ifdef HAVE_DAHDI
01825    if (c->timingfd > -1) {
01826       if (!func) {
01827          samples = 0;
01828          data = 0;
01829       }
01830       if (option_debug)
01831          ast_log(LOG_DEBUG, "Scheduling timer at %d sample intervals\n", samples);
01832       res = ioctl(c->timingfd, DAHDI_TIMERCONFIG, &samples);
01833       c->timingfunc = func;
01834       c->timingdata = data;
01835    }
01836 #endif   
01837    return res;
01838 }

int ast_shutting_down ( void   ) 

Returns non-zero if Asterisk is being shut down.

Returns non-zero if Asterisk is being shut down

Definition at line 461 of file channel.c.

Referenced by handle_request_options().

00462 {
00463    return shutting_down;
00464 }

int ast_softhangup ( struct ast_channel chan,
int  cause 
)

Softly hangup up a channel.

Parameters:
chan channel to be soft-hung-up Call the protocol layer, but don't destroy the channel structure (use this if you are trying to safely hangup a channel managed by another thread.
cause Ast hangupcause for hangup
Returns:
Returns 0 regardless

Definition at line 1422 of file channel.c.

References ast_channel_lock, ast_channel_unlock, and ast_softhangup_nolock().

Referenced by __ast_module_user_hangup_all(), __login_exec(), __unload_module(), action_hangup(), agent_hangup(), agent_logoff(), ast_begin_shutdown(), ast_dial_join(), connect_link(), dahdi_handle_event(), function_ilink(), handle_hangup(), handle_link_data(), handle_softhangup(), manager_park(), read_agent_config(), rpt(), rpt_call(), rpt_do_restart(), sla_handle_hold_event(), softhangup_exec(), start_spying(), startmon(), and unload_module().

01423 {
01424    int res;
01425    ast_channel_lock(chan);
01426    res = ast_softhangup_nolock(chan, cause);
01427    ast_channel_unlock(chan);
01428    return res;
01429 }

int ast_softhangup_nolock ( struct ast_channel chan,
int  cause 
)

Softly hangup up a channel (no channel lock).

Parameters:
chan channel to be soft-hung-up
cause Ast hangupcause for hangup (see cause.h)

Definition at line 1408 of file channel.c.

References ast_channel::_softhangup, AST_FLAG_BLOCKING, ast_log(), ast_null_frame, ast_queue_frame(), ast_test_flag, ast_channel::blocker, LOG_DEBUG, and option_debug.

Referenced by ast_async_goto(), ast_softhangup(), attempt_transfer(), dahdi_softhangup_all(), do_monitor(), oh323_indicate(), sip_indicate(), and skinny_indicate().

01409 {
01410    if (option_debug)
01411       ast_log(LOG_DEBUG, "Soft-Hanging up channel '%s'\n", chan->name);
01412    /* Inform channel driver that we need to be hung up, if it cares */
01413    chan->_softhangup |= cause;
01414    ast_queue_frame(chan, &ast_null_frame);
01415    /* Interrupt any poll call or such */
01416    if (ast_test_flag(chan, AST_FLAG_BLOCKING))
01417       pthread_kill(chan->blocker, SIGURG);
01418    return 0;
01419 }

char* ast_state2str ( enum  ast_channel_state  ) 

Gives the string form of a given channel state.

Parameters:
ast_channel_state state to get the name of Give a name to a state Returns the text form of the binary state given

Definition at line 600 of file channel.c.

References AST_STATE_BUSY, AST_STATE_DIALING, AST_STATE_DIALING_OFFHOOK, AST_STATE_DOWN, AST_STATE_OFFHOOK, AST_STATE_PRERING, AST_STATE_RESERVED, AST_STATE_RING, AST_STATE_RINGING, AST_STATE_UP, and STATE2STR_BUFSIZE.

Referenced by action_status(), agent_hangup(), ast_channel_alloc(), ast_setstate(), attempt_transfer(), func_channel_read(), handle_chanlist(), handle_chanlist_deprecated(), handle_invite_replaces(), handle_showchan(), handle_showchan_deprecated(), local_attended_transfer(), mgcp_new(), serialize_showchan(), and sip_hangup().

00601 {
00602    char *buf;
00603 
00604    switch(state) {
00605    case AST_STATE_DOWN:
00606       return "Down";
00607    case AST_STATE_RESERVED:
00608       return "Rsrvd";
00609    case AST_STATE_OFFHOOK:
00610       return "OffHook";
00611    case AST_STATE_DIALING:
00612       return "Dialing";
00613    case AST_STATE_RING:
00614       return "Ring";
00615    case AST_STATE_RINGING:
00616       return "Ringing";
00617    case AST_STATE_UP:
00618       return "Up";
00619    case AST_STATE_BUSY:
00620       return "Busy";
00621    case AST_STATE_DIALING_OFFHOOK:
00622       return "Dialing Offhook";
00623    case AST_STATE_PRERING:
00624       return "Pre-ring";
00625    default:
00626       if (!(buf = ast_threadstorage_get(&state2str_threadbuf, STATE2STR_BUFSIZE)))
00627          return "Unknown";
00628       snprintf(buf, STATE2STR_BUFSIZE, "Unknown (%d)", state);
00629       return buf;
00630    }
00631 }

int ast_str2cause ( const char *  name  ) 

Convert a symbolic hangup cause to number.

Parameters:
name string form of the cause Returns the cause code

Definition at line 588 of file channel.c.

References causes.

Referenced by pbx_builtin_hangup().

00589 {
00590    int x;
00591 
00592    for (x = 0; x < sizeof(causes) / sizeof(causes[0]); x++)
00593       if (strncasecmp(causes[x].name, name, strlen(causes[x].name)) == 0)
00594          return causes[x].cause;
00595 
00596    return -1;
00597 }

int ast_tonepair ( struct ast_channel chan,
int  freq1,
int  freq2,
int  duration,
int  vol 
)

Play a tone pair for a given amount of time

Definition at line 4342 of file channel.c.

References ast_frfree, ast_read(), ast_tonepair_start(), ast_waitfor(), f, and ast_channel::generatordata.

Referenced by zapateller_exec().

04343 {
04344    int res;
04345 
04346    if ((res = ast_tonepair_start(chan, freq1, freq2, duration, vol)))
04347       return res;
04348 
04349    /* Give us some wiggle room */
04350    while (chan->generatordata && ast_waitfor(chan, 100) >= 0) {
04351       struct ast_frame *f = ast_read(chan);
04352       if (f)
04353          ast_frfree(f);
04354       else
04355          return -1;
04356    }
04357    return 0;
04358 }

int ast_tonepair_start ( struct ast_channel chan,
int  freq1,
int  freq2,
int  duration,
int  vol 
)

Start a tone going

Definition at line 4324 of file channel.c.

References ast_activate_generator(), tonepair_def::duration, tonepair_def::freq1, tonepair_def::freq2, tonepair, and tonepair_def::vol.

Referenced by ast_tonepair(), play_dialtone(), play_tone_pair(), rpt_tele_thread(), and sendnoise().

04325 {
04326    struct tonepair_def d = { 0, };
04327 
04328    d.freq1 = freq1;
04329    d.freq2 = freq2;
04330    d.duration = duration;
04331    d.vol = (vol < 1) ? 8192 : vol; /* force invalid to 8192 */
04332    if (ast_activate_generator(chan, &tonepair, &d))
04333       return -1;
04334    return 0;
04335 }

void ast_tonepair_stop ( struct ast_channel chan  ) 

Stop a tone from playing

Definition at line 4337 of file channel.c.

References ast_deactivate_generator().

Referenced by sendnoise().

04338 {
04339    ast_deactivate_generator(chan);
04340 }

int ast_transfer ( struct ast_channel chan,
char *  dest 
)

Transfer a channel (if supported). Returns -1 on error, 0 if not supported and 1 if supported and requested.

Called by:

Definition at line 3083 of file channel.c.

References ast_channel_lock, ast_channel_unlock, ast_check_hangup(), AST_FLAG_ZOMBIE, ast_test_flag, ast_channel::tech, and ast_channel_tech::transfer.

Referenced by transfer_exec().

03084 {
03085    int res = -1;
03086 
03087    /* Stop if we're a zombie or need a soft hangup */
03088    ast_channel_lock(chan);
03089    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
03090       if (chan->tech->transfer) {
03091          res = chan->tech->transfer(chan, dest);
03092          if (!res)
03093             res = 1;
03094       } else
03095          res = 0;
03096    }
03097    ast_channel_unlock(chan);
03098    return res;
03099 }

char* ast_transfercapability2str ( int  transfercapability  )  const

Gives the string form of a given transfer capability.

Parameters:
transfercapability transfercapabilty to get the name of Give a name to a transfercapbility See above Returns the text form of the binary transfer capbility

Definition at line 634 of file channel.c.

References AST_TRANS_CAP_3_1K_AUDIO, AST_TRANS_CAP_DIGITAL, AST_TRANS_CAP_DIGITAL_W_TONES, AST_TRANS_CAP_RESTRICTED_DIGITAL, AST_TRANS_CAP_SPEECH, and AST_TRANS_CAP_VIDEO.

Referenced by cb_events(), dahdi_call(), dahdi_new(), misdn_call(), and oh323_call().

00635 {
00636    switch(transfercapability) {
00637    case AST_TRANS_CAP_SPEECH:
00638       return "SPEECH";
00639    case AST_TRANS_CAP_DIGITAL:
00640       return "DIGITAL";
00641    case AST_TRANS_CAP_RESTRICTED_DIGITAL:
00642       return "RESTRICTED_DIGITAL";
00643    case AST_TRANS_CAP_3_1K_AUDIO:
00644       return "3K1AUDIO";
00645    case AST_TRANS_CAP_DIGITAL_W_TONES:
00646       return "DIGITAL_W_TONES";
00647    case AST_TRANS_CAP_VIDEO:
00648       return "VIDEO";
00649    default:
00650       return "UNKNOWN";
00651    }
00652 }

int ast_waitfor ( struct ast_channel chan,
int  ms 
)

Wait for input on a channel.

Parameters:
chan channel to wait on
ms length of time to wait on the channel Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
Returns:
Returns < 0 on failure, 0 if nothing ever arrived, and the # of ms remaining otherwise

Definition at line 1805 of file channel.c.

References ast_waitfor_nandfds().

Referenced by __adsi_transmit_messages(), __ast_play_and_record(), __ast_request_and_dial(), adsi_careful_send(), agent_ack_sleep(), ast_dtmf_stream(), ast_recvtext(), ast_safe_sleep_conditional(), ast_tonepair(), async_wait(), background_detect_exec(), channel_spy(), conf_exec(), conf_flush(), dictate_exec(), disa_exec(), do_waiting(), echo_exec(), handle_recordfile(), ices_exec(), isAnsweringMachine(), measurenoise(), mp3_exec(), NBScat_exec(), receive_dtmf_digits(), recordthread(), send_tone_burst(), send_waveform_to_channel(), sendurl_exec(), speech_background(), ss_thread(), wait_for_hangup(), waitforring_exec(), and waitstream_core().

01806 {
01807    int oldms = ms;   /* -1 if no timeout */
01808 
01809    ast_waitfor_nandfds(&c, 1, NULL, 0, NULL, NULL, &ms);
01810    if ((ms < 0) && (oldms < 0))
01811       ms = 0;
01812    return ms;
01813 }

struct ast_channel* ast_waitfor_n ( struct ast_channel **  chan,
int  n,
int *  ms 
)

Waits for input on a group of channels Wait for input on an array of channels for a given # of milliseconds.

Returns:
Return channel with activity, or NULL if none has activity.
Parameters:
chan an array of pointers to channels
n number of channels that are to be waited upon
ms time "ms" is modified in-place, if applicable

Definition at line 1800 of file channel.c.

References ast_waitfor_nandfds().

Referenced by ast_feature_request_and_dial(), ast_udptl_bridge(), autoservice_run(), bridge_native_loop(), dahdi_bridge(), misdn_bridge(), monitor_dial(), rpt(), wait_for_answer(), and wait_for_winner().

01801 {
01802    return ast_waitfor_nandfds(c, n, NULL, 0, NULL, NULL, ms);
01803 }

int ast_waitfor_n_fd ( int *  fds,
int  n,
int *  ms,
int *  exception 
)

Waits for input on an fd This version works on fd's only. Be careful with it.

Definition at line 1644 of file channel.c.

References ast_waitfor_nandfds().

Referenced by dundi_lookup_internal(), and dundi_precache_internal().

01645 {
01646    int winner = -1;
01647    ast_waitfor_nandfds(NULL, 0, fds, n, exception, &winner, ms);
01648    return winner;
01649 }

struct ast_channel* ast_waitfor_nandfds ( struct ast_channel **  chan,
int  n,
int *  fds,
int  nfds,
int *  exception,
int *  outfd,
int *  ms 
)

Waits for activity on a group of channels.

Parameters:
chan an array of pointers to channels
n number of channels that are to be waited upon
fds an array of fds to wait upon
nfds the number of fds to wait upon
exception exception flag
outfd fd that had activity on it
ms how long the wait was Big momma function here. Wait for activity on any of the n channels, or any of the nfds file descriptors.
Returns:
Returns the channel with activity, or NULL on error or if an FD came first. If the FD came first, it will be returned in outfd, otherwise, outfd will be -1

Definition at line 1652 of file channel.c.

References ast_channel::_softhangup, ast_add_fd(), ast_channel_lock, ast_channel_unlock, ast_clear_flag, ast_do_masquerade(), AST_FLAG_BLOCKING, AST_FLAG_EXCEPTION, ast_log(), AST_MAX_FDS, ast_set_flag, AST_SOFTHANGUP_TIMEOUT, CHECK_BLOCKING, errno, pollfd::fd, LOG_WARNING, poll(), POLLPRI, and ast_channel::whentohangup.

Referenced by app_exec(), ast_waitfor(), ast_waitfor_n(), ast_waitfor_n_fd(), ast_waitfordigit_full(), conf_run(), find_cache(), run_agi(), and waitstream_core().

01654 {
01655    struct timeval start = { 0 , 0 };
01656    struct pollfd *pfds = NULL;
01657    int res;
01658    long rms;
01659    int x, y, max;
01660    int sz;
01661    time_t now = 0;
01662    long whentohangup = 0, diff;
01663    struct ast_channel *winner = NULL;
01664    struct fdmap {
01665       int chan;
01666       int fdno;
01667    } *fdmap = NULL;
01668 
01669    if ((sz = n * AST_MAX_FDS + nfds)) {
01670       pfds = alloca(sizeof(*pfds) * sz);
01671       fdmap = alloca(sizeof(*fdmap) * sz);
01672    }
01673 
01674    if (outfd)
01675       *outfd = -99999;
01676    if (exception)
01677       *exception = 0;
01678    
01679    /* Perform any pending masquerades */
01680    for (x=0; x < n; x++) {
01681       ast_channel_lock(c[x]);
01682       if (c[x]->masq) {
01683          if (ast_do_masquerade(c[x])) {
01684             ast_log(LOG_WARNING, "Masquerade failed\n");
01685             *ms = -1;
01686             ast_channel_unlock(c[x]);
01687             return NULL;
01688          }
01689       }
01690       if (c[x]->whentohangup) {
01691          if (!whentohangup)
01692             time(&now);
01693          diff = c[x]->whentohangup - now;
01694          if (diff < 1) {
01695             /* Should already be hungup */
01696             c[x]->_softhangup |= AST_SOFTHANGUP_TIMEOUT;
01697             ast_channel_unlock(c[x]);
01698             return c[x];
01699          }
01700          if (!whentohangup || (diff < whentohangup))
01701             whentohangup = diff;
01702       }
01703       ast_channel_unlock(c[x]);
01704    }
01705    /* Wait full interval */
01706    rms = *ms;
01707    if (whentohangup) {
01708       rms = whentohangup * 1000;              /* timeout in milliseconds */
01709       if (*ms >= 0 && *ms < rms)    /* original *ms still smaller */
01710          rms =  *ms;
01711    }
01712    /*
01713     * Build the pollfd array, putting the channels' fds first,
01714     * followed by individual fds. Order is important because
01715     * individual fd's must have priority over channel fds.
01716     */
01717    max = 0;
01718    for (x=0; x<n; x++) {
01719       for (y=0; y<AST_MAX_FDS; y++) {
01720          fdmap[max].fdno = y;  /* fd y is linked to this pfds */
01721          fdmap[max].chan = x;  /* channel x is linked to this pfds */
01722          max += ast_add_fd(&pfds[max], c[x]->fds[y]);
01723       }
01724       CHECK_BLOCKING(c[x]);
01725    }
01726    /* Add the individual fds */
01727    for (x=0; x<nfds; x++) {
01728       fdmap[max].chan = -1;
01729       max += ast_add_fd(&pfds[max], fds[x]);
01730    }
01731 
01732    if (*ms > 0)
01733       start = ast_tvnow();
01734    
01735    if (sizeof(int) == 4) { /* XXX fix timeout > 600000 on linux x86-32 */
01736       do {
01737          int kbrms = rms;
01738          if (kbrms > 600000)
01739             kbrms = 600000;
01740          res = poll(pfds, max, kbrms);
01741          if (!res)
01742             rms -= kbrms;
01743       } while (!res && (rms > 0));
01744    } else {
01745       res = poll(pfds, max, rms);
01746    }
01747    for (x=0; x<n; x++)
01748       ast_clear_flag(c[x], AST_FLAG_BLOCKING);
01749    if (res < 0) { /* Simulate a timeout if we were interrupted */
01750       if (errno != EINTR)
01751          *ms = -1;
01752       return NULL;
01753    }
01754    if (whentohangup) {   /* if we have a timeout, check who expired */
01755       time(&now);
01756       for (x=0; x<n; x++) {
01757          if (c[x]->whentohangup && now >= c[x]->whentohangup) {
01758             c[x]->_softhangup |= AST_SOFTHANGUP_TIMEOUT;
01759             if (winner == NULL)
01760                winner = c[x];
01761          }
01762       }
01763    }
01764    if (res == 0) { /* no fd ready, reset timeout and done */
01765       *ms = 0; /* XXX use 0 since we may not have an exact timeout. */
01766       return winner;
01767    }
01768    /*
01769     * Then check if any channel or fd has a pending event.
01770     * Remember to check channels first and fds last, as they
01771     * must have priority on setting 'winner'
01772     */
01773    for (x = 0; x < max; x++) {
01774       res = pfds[x].revents;
01775       if (res == 0)
01776          continue;
01777       if (fdmap[x].chan >= 0) {  /* this is a channel */
01778          winner = c[fdmap[x].chan]; /* override previous winners */
01779          if (res & POLLPRI)
01780             ast_set_flag(winner, AST_FLAG_EXCEPTION);
01781          else
01782             ast_clear_flag(winner, AST_FLAG_EXCEPTION);
01783          winner->fdno = fdmap[x].fdno;
01784       } else {       /* this is an fd */
01785          if (outfd)
01786             *outfd = pfds[x].fd;
01787          if (exception)
01788             *exception = (res & POLLPRI) ? -1 : 0;
01789          winner = NULL;
01790       }
01791    }
01792    if (*ms > 0) {
01793       *ms -= ast_tvdiff_ms(ast_tvnow(), start);
01794       if (*ms < 0)
01795          *ms = 0;
01796    }
01797    return winner;
01798 }

int ast_waitfordigit ( struct ast_channel c,
int  ms 
)

Waits for a digit.

!

Parameters:
c channel to wait for a digit on
ms how many milliseconds to wait
Returns:
Returns <0 on error, 0 on no entry, and the digit on success.

Definition at line 1816 of file channel.c.

References ast_waitfordigit_full().

Referenced by _while_exec(), advanced_options(), ast_adsi_get_cpeid(), ast_adsi_get_cpeinfo(), ast_adsi_print(), ast_adsi_read_encoded_dtmf(), ast_adsi_transmit_message_full(), ast_app_dtget(), ast_control_streamfile(), ast_record_review(), collect_digits(), common_exec(), cpeid_exec(), dialout(), directory_exec(), do_atxfer(), forward_message(), get_folder(), ivr_dispatch(), mgcp_ss(), my_getsigstr(), pbx_builtin_waitexten(), play_mailbox_owner(), play_record_review(), read_exec(), read_newoption(), retrydial_exec(), sendnoise(), ss_thread(), testclient_exec(), testserver_exec(), vm_execmain(), vm_forwardoptions(), vm_instructions(), vm_options(), vm_tempgreeting(), wait_a_bit(), and wait_our_turn().

01817 {
01818    return ast_waitfordigit_full(c, ms, -1, -1);
01819 }

int ast_waitfordigit_full ( struct ast_channel c,
int  ms,
int  audiofd,
int  ctrlfd 
)

Wait for a digit Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.

Parameters:
c channel to wait for a digit on
ms how many milliseconds to wait
audiofd audio file descriptor to write to if audio frames are received
ctrlfd control file descriptor to monitor for reading
Returns:
Returns 1 if ctrlfd becomes available

Definition at line 1840 of file channel.c.

References ast_check_hangup(), ast_clear_flag, AST_CONTROL_ANSWER, AST_CONTROL_HANGUP, AST_CONTROL_RINGING, AST_CONTROL_SRCUPDATE, AST_FLAG_END_DTMF_ONLY, AST_FLAG_ZOMBIE, AST_FRAME_CONTROL, AST_FRAME_DTMF_BEGIN, AST_FRAME_DTMF_END, AST_FRAME_VOICE, ast_frfree, ast_log(), ast_read(), ast_set_flag, ast_test_flag, ast_waitfor_nandfds(), errno, f, and LOG_WARNING.

Referenced by ast_readstring_full(), ast_waitfordigit(), handle_getoption(), and handle_waitfordigit().

01841 {
01842    /* Stop if we're a zombie or need a soft hangup */
01843    if (ast_test_flag(c, AST_FLAG_ZOMBIE) || ast_check_hangup(c))
01844       return -1;
01845 
01846    /* Only look for the end of DTMF, don't bother with the beginning and don't emulate things */
01847    ast_set_flag(c, AST_FLAG_END_DTMF_ONLY);
01848 
01849    /* Wait for a digit, no more than ms milliseconds total. */
01850    while (ms) {
01851       struct ast_channel *rchan;
01852       int outfd;
01853 
01854       errno = 0;
01855       rchan = ast_waitfor_nandfds(&c, 1, &cmdfd, (cmdfd > -1) ? 1 : 0, NULL, &outfd, &ms);
01856       if (!rchan && outfd < 0 && ms) {
01857          if (errno == 0 || errno == EINTR)
01858             continue;
01859          ast_log(LOG_WARNING, "Wait failed (%s)\n", strerror(errno));
01860          ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01861          return -1;
01862       } else if (outfd > -1) {
01863          /* The FD we were watching has something waiting */
01864          ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01865          return 1;
01866       } else if (rchan) {
01867          int res;
01868          struct ast_frame *f = ast_read(c);
01869          if (!f)
01870             return -1;
01871 
01872          switch(f->frametype) {
01873          case AST_FRAME_DTMF_BEGIN:
01874             break;
01875          case AST_FRAME_DTMF_END:
01876             res = f->subclass;
01877             ast_frfree(f);
01878             ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01879             return res;
01880          case AST_FRAME_CONTROL:
01881             switch(f->subclass) {
01882             case AST_CONTROL_HANGUP:
01883                ast_frfree(f);
01884                ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01885                return -1;
01886             case AST_CONTROL_RINGING:
01887             case AST_CONTROL_ANSWER:
01888             case AST_CONTROL_SRCUPDATE:
01889                /* Unimportant */
01890                break;
01891             default:
01892                ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", f->subclass);
01893                break;
01894             }
01895             break;
01896          case AST_FRAME_VOICE:
01897             /* Write audio if appropriate */
01898             if (audiofd > -1)
01899                write(audiofd, f->data, f->datalen);
01900          default:
01901             /* Ignore */
01902             break;
01903          }
01904          ast_frfree(f);
01905       }
01906    }
01907 
01908    ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01909 
01910    return 0; /* Time is up */
01911 }

struct ast_channel* ast_walk_channel_by_exten_locked ( const struct ast_channel chan,
const char *  exten,
const char *  context 
)

Get next channel by exten (and optionally context) and lock it.

Definition at line 1151 of file channel.c.

References channel_find_locked().

Referenced by next_channel().

01153 {
01154    return channel_find_locked(chan, NULL, 0, context, exten);
01155 }

struct ast_channel* ast_walk_channel_by_name_prefix_locked ( const struct ast_channel chan,
const char *  name,
const int  namelen 
)

Get channel by name prefix (locks channel).

Definition at line 1138 of file channel.c.

References channel_find_locked().

Referenced by next_channel().

01140 {
01141    return channel_find_locked(chan, name, namelen, NULL, NULL);
01142 }

int ast_write ( struct ast_channel chan,
struct ast_frame frame 
)

Write a frame to a channel This function writes the given frame to the indicated channel.

Parameters:
chan destination channel of the frame
frame frame that will be written
Returns:
It returns 0 on success, -1 on failure.

Todo:
XXX should return 0 maybe ?

Definition at line 2605 of file channel.c.

References ast_channel::_softhangup, AST_AUDIOHOOK_DIRECTION_WRITE, ast_audiohook_write_list(), ast_channel_lock, ast_channel_trylock, ast_channel_unlock, ast_check_hangup(), ast_clear_flag, AST_CONTROL_UNHOLD, ast_deactivate_generator(), ast_do_masquerade(), AST_FLAG_BLOCKING, AST_FLAG_WRITE_INT, AST_FLAG_ZOMBIE, AST_FRAME_CONTROL, AST_FRAME_DTMF_BEGIN, AST_FRAME_DTMF_END, ast_frame_dump(), AST_FRAME_HTML, AST_FRAME_IAX, AST_FRAME_MODEM, AST_FRAME_NULL, AST_FRAME_TEXT, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_frfree, ast_log(), AST_MONITOR_RUNNING, ast_seekstream(), ast_senddigit_begin(), ast_senddigit_end(), AST_SOFTHANGUP_DEV, ast_test_flag, ast_translate(), ast_writestream(), ast_channel::audiohooks, CHECK_BLOCKING, ast_frame::data, ast_frame::datalen, DEBUGCHAN_FLAG, f, ast_channel::fout, FRAMECOUNT_INC, ast_frame::frametype, ast_channel::generatordata, ast_channel_tech::indicate, ast_channel::insmpl, ast_frame::len, LOG_DEBUG, LOG_WARNING, ast_channel::masq, ast_channel::masqr, ast_channel::monitor, MONITOR_DELAY, option_debug, ast_channel::outsmpl, ast_channel::rawwriteformat, SEEK_FORCECUR, ast_channel_tech::send_html, ast_channel_tech::send_text, ast_channel_monitor::state, ast_frame::subclass, ast_channel::tech, ast_channel_tech::write, ast_channel_monitor::write_stream, ast_channel_tech::write_video, and ast_channel::writetrans.

Referenced by adsi_careful_send(), agent_write(), ast_prod(), ast_readaudio_callback(), ast_readvideo_callback(), ast_udptl_bridge(), ast_write_video(), bridge_native_loop(), conf_queue_dtmf(), conf_run(), dahdi_bridge(), dictate_exec(), echo_exec(), features_write(), function_ilink(), gen_generate(), handle_link_data(), jb_get_and_deliver(), linear_generator(), milliwatt_generate(), misdn_bridge(), moh_files_generator(), moh_generate(), mp3_exec(), NBScat_exec(), rpt(), send_link_dtmf(), send_tone_burst(), send_waveform_to_channel(), silence_generator_generate(), spy_generate(), and wait_for_answer().

02606 {
02607    int res = -1;
02608    int count = 0;
02609    struct ast_frame *f = NULL, *f2 = NULL;
02610 
02611    /*Deadlock avoidance*/
02612    while(ast_channel_trylock(chan)) {
02613       /*cannot goto done since the channel is not locked*/
02614       if(count++ > 10) {
02615          if(option_debug)
02616             ast_log(LOG_DEBUG, "Deadlock avoided for write to channel '%s'\n", chan->name);
02617          return 0;
02618       }
02619       usleep(1);
02620    }
02621    /* Stop if we're a zombie or need a soft hangup */
02622    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan))
02623       goto done;
02624 
02625    /* Handle any pending masquerades */
02626    if (chan->masq && ast_do_masquerade(chan)) {
02627       ast_log(LOG_WARNING, "Failed to perform masquerade\n");
02628       goto done;
02629    }
02630    if (chan->masqr) {
02631       res = 0; /* XXX explain, why 0 ? */
02632       goto done;
02633    }
02634    if (chan->generatordata) {
02635       if (ast_test_flag(chan, AST_FLAG_WRITE_INT))
02636          ast_deactivate_generator(chan);
02637       else {
02638          if (fr->frametype == AST_FRAME_DTMF_END) {
02639             /* There is a generator running while we're in the middle of a digit.
02640              * It's probably inband DTMF, so go ahead and pass it so it can
02641              * stop the generator */
02642             ast_clear_flag(chan, AST_FLAG_BLOCKING);
02643             ast_channel_unlock(chan);
02644             res = ast_senddigit_end(chan, fr->subclass, fr->len);
02645             ast_channel_lock(chan);
02646             CHECK_BLOCKING(chan);
02647          } else if (fr->frametype == AST_FRAME_CONTROL && fr->subclass == AST_CONTROL_UNHOLD) {
02648             /* This is a side case where Echo is basically being called and the person put themselves on hold and took themselves off hold */
02649             res = (chan->tech->indicate == NULL) ? 0 :
02650                chan->tech->indicate(chan, fr->subclass, fr->data, fr->datalen);
02651          }
02652          res = 0; /* XXX explain, why 0 ? */
02653          goto done;
02654       }
02655    }
02656    /* High bit prints debugging */
02657    if (chan->fout & DEBUGCHAN_FLAG)
02658       ast_frame_dump(chan->name, fr, ">>");
02659    CHECK_BLOCKING(chan);
02660    switch(fr->frametype) {
02661    case AST_FRAME_CONTROL:
02662       res = (chan->tech->indicate == NULL) ? 0 :
02663          chan->tech->indicate(chan, fr->subclass, fr->data, fr->datalen);
02664       break;
02665    case AST_FRAME_DTMF_BEGIN:
02666       if (chan->audiohooks) {
02667          struct ast_frame *old_frame = fr;
02668          fr = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_WRITE, fr);
02669          if (old_frame != fr)
02670             f = fr;
02671       }
02672       ast_clear_flag(chan, AST_FLAG_BLOCKING);
02673       ast_channel_unlock(chan);
02674       res = ast_senddigit_begin(chan, fr->subclass);
02675       ast_channel_lock(chan);
02676       CHECK_BLOCKING(chan);
02677       break;
02678    case AST_FRAME_DTMF_END:
02679       if (chan->audiohooks) {
02680          struct ast_frame *old_frame = fr;
02681          fr = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_WRITE, fr);
02682          if (old_frame != fr)
02683             f = fr;
02684       }
02685       ast_clear_flag(chan, AST_FLAG_BLOCKING);
02686       ast_channel_unlock(chan);
02687       res = ast_senddigit_end(chan, fr->subclass, fr->len);
02688       ast_channel_lock(chan);
02689       CHECK_BLOCKING(chan);
02690       break;
02691    case AST_FRAME_TEXT:
02692       res = (chan->tech->send_text == NULL) ? 0 :
02693          chan->tech->send_text(chan, (char *) fr->data);
02694       break;
02695    case AST_FRAME_HTML:
02696       res = (chan->tech->send_html == NULL) ? 0 :
02697          chan->tech->send_html(chan, fr->subclass, (char *) fr->data, fr->datalen);
02698       break;
02699    case AST_FRAME_VIDEO:
02700       /* XXX Handle translation of video codecs one day XXX */
02701       res = (chan->tech->write_video == NULL) ? 0 :
02702          chan->tech->write_video(chan, fr);
02703       break;
02704    case AST_FRAME_MODEM:
02705       res = (chan->tech->write == NULL) ? 0 :
02706          chan->tech->write(chan, fr);
02707       break;
02708    case AST_FRAME_VOICE:
02709       if (chan->tech->write == NULL)
02710          break;   /*! \todo XXX should return 0 maybe ? */
02711 
02712       if (chan->audiohooks) {
02713          struct ast_frame *old_frame = fr;
02714          fr = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_WRITE, fr);
02715          if (old_frame != fr)
02716             f2 = fr;
02717       }
02718       
02719       /* If the frame is in the raw write format, then it's easy... just use the frame - otherwise we will have to translate */
02720       if (fr->subclass == chan->rawwriteformat)
02721          f = fr;
02722       else
02723          f = (chan->writetrans) ? ast_translate(chan->writetrans, fr, 0) : fr;
02724 
02725       /* If we have no frame of audio, then we have to bail out */
02726       if (!f) {
02727          res = 0;
02728          break;
02729       }
02730 
02731       /* If Monitor is running on this channel, then we have to write frames out there too */
02732       if (chan->monitor && chan->monitor->write_stream) {
02733          /* XXX must explain this code */
02734 #ifndef MONITOR_CONSTANT_DELAY
02735          int jump = chan->insmpl - chan->outsmpl - 4 * f->samples;
02736          if (jump >= 0) {
02737             jump = chan->insmpl - chan->outsmpl;
02738             if (ast_seekstream(chan->monitor->write_stream, jump, SEEK_FORCECUR) == -1)
02739                ast_log(LOG_WARNING, "Failed to perform seek in monitoring write stream, synchronization between the files may be broken\n");
02740             chan->outsmpl += jump + f->samples;
02741          } else
02742             chan->outsmpl += f->samples;
02743 #else
02744          int jump = chan->insmpl - chan->outsmpl;
02745          if (jump - MONITOR_DELAY >= 0) {
02746             if (ast_seekstream(chan->monitor->write_stream, jump - f->samples, SEEK_FORCECUR) == -1)
02747                ast_log(LOG_WARNING, "Failed to perform seek in monitoring write stream, synchronization between the files may be broken\n");
02748             chan->outsmpl += jump;
02749          } else
02750             chan->outsmpl += f->samples;
02751 #endif
02752          if (chan->monitor->state == AST_MONITOR_RUNNING) {
02753             if (ast_writestream(chan->monitor->write_stream, f) < 0)
02754                ast_log(LOG_WARNING, "Failed to write data to channel monitor write stream\n");
02755          }
02756       }
02757 
02758       if (f) 
02759          res = chan->tech->write(chan,f);
02760       else
02761          res = 0;
02762       break;
02763    case AST_FRAME_NULL:
02764    case AST_FRAME_IAX:
02765       /* Ignore these */
02766       res = 0;
02767       break;
02768    default:
02769       /* At this point, fr is the incoming frame and f is NULL.  Channels do
02770        * not expect to get NULL as a frame pointer and will segfault.  Hence,
02771        * we output the original frame passed in. */
02772       res = chan->tech->write(chan, fr);
02773       break;
02774    }
02775 
02776    if (f && f != fr)
02777       ast_frfree(f);
02778    if (f2)
02779       ast_frfree(f2);
02780    ast_clear_flag(chan, AST_FLAG_BLOCKING);
02781    /* Consider a write failure to force a soft hangup */
02782    if (res < 0)
02783       chan->_softhangup |= AST_SOFTHANGUP_DEV;
02784    else {
02785       chan->fout = FRAMECOUNT_INC(chan->fout);
02786    }
02787 done:
02788    ast_channel_unlock(chan);
02789    return res;
02790 }

int ast_write_video ( struct ast_channel chan,
struct ast_frame frame 
)

Write video frame to a channel This function writes the given frame to the indicated channel.

Parameters:
chan destination channel of the frame
frame frame that will be written
Returns:
It returns 1 on success, 0 if not implemented, and -1 on failure.

Definition at line 2594 of file channel.c.

References ast_write(), ast_channel::tech, and ast_channel_tech::write_video.

02595 {
02596    int res;
02597    if (!chan->tech->write_video)
02598       return 0;
02599    res = ast_write(chan, fr);
02600    if (!res)
02601       res = 1;
02602    return res;
02603 }

const char* channelreloadreason2txt ( enum channelreloadreason  reason  ) 

Convert enum channelreloadreason to text string for manager event.

\ brief Convert channel reloadreason (ENUM) to text string for manager event

Definition at line 4557 of file channel.c.

References CHANNEL_CLI_RELOAD, CHANNEL_MODULE_LOAD, and CHANNEL_MODULE_RELOAD.

04558 {
04559    switch (reason) {
04560    case CHANNEL_MODULE_LOAD:
04561       return "LOAD (Channel module load)";
04562 
04563    case CHANNEL_MODULE_RELOAD:
04564       return "RELOAD (Channel module reload)";
04565 
04566    case CHANNEL_CLI_RELOAD:
04567       return "CLIRELOAD (Channel module reload by CLI command)";
04568 
04569    default:
04570       return "MANAGERRELOAD (Channel module reload by manager)";
04571    }
04572 };


Generated on Mon Nov 24 15:34:36 2008 for Asterisk - the Open Source PBX by  doxygen 1.4.7