Tue Nov 4 13:20:36 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 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(), iax2_bridge(), misdn_bridge(), set_config_flags(), and zt_bridge().

#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(), iax2_bridge(), misdn_bridge(), set_config_flags(), and zt_bridge().

#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 ast_channel_free(), ast_parse_device_state(), create_jb(), fast_originate(), page_exec(), 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_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_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(), phone_read(), and zt_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 2847 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().

02848 {
02849    int dummy_outstate;
02850    int cause = 0;
02851    struct ast_channel *chan;
02852    int res = 0;
02853    int last_subclass = 0;
02854    
02855    if (outstate)
02856       *outstate = 0;
02857    else
02858       outstate = &dummy_outstate;   /* make outstate always a valid pointer */
02859 
02860    chan = ast_request(type, format, data, &cause);
02861    if (!chan) {
02862       ast_log(LOG_NOTICE, "Unable to request channel %s/%s\n", type, (char *)data);
02863       /* compute error and return */
02864       if (cause == AST_CAUSE_BUSY)
02865          *outstate = AST_CONTROL_BUSY;
02866       else if (cause == AST_CAUSE_CONGESTION)
02867          *outstate = AST_CONTROL_CONGESTION;
02868       return NULL;
02869    }
02870 
02871    if (oh) {
02872       if (oh->vars)  
02873          ast_set_variables(chan, oh->vars);
02874       /* XXX why is this necessary, for the parent_channel perhaps ? */
02875       if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name))
02876          ast_set_callerid(chan, oh->cid_num, oh->cid_name, oh->cid_num);
02877       if (oh->parent_channel)
02878          ast_channel_inherit_variables(oh->parent_channel, chan);
02879       if (oh->account)
02880          ast_cdr_setaccount(chan, oh->account); 
02881    }
02882    ast_set_callerid(chan, cid_num, cid_name, cid_num);
02883 
02884    
02885 
02886    if (!chan->cdr) { /* up till now, this insertion hasn't been done. Therefore,
02887             to keep from throwing off the basic order of the universe,
02888             we will try to keep this cdr from getting posted. */
02889       chan->cdr = ast_cdr_alloc();
02890       ast_cdr_init(chan->cdr, chan);
02891       ast_cdr_start(chan->cdr);
02892    }
02893    if (ast_call(chan, data, 0)) {   /* ast_call failed... */
02894       ast_log(LOG_NOTICE, "Unable to call channel %s/%s\n", type, (char *)data);
02895    } else {
02896       res = 1; /* mark success in case chan->_state is already AST_STATE_UP */
02897       while (timeout && chan->_state != AST_STATE_UP) {
02898          struct ast_frame *f;
02899          res = ast_waitfor(chan, timeout);
02900          if (res <= 0) /* error, timeout, or done */
02901             break;
02902          if (timeout > -1)
02903             timeout = res;
02904          f = ast_read(chan);
02905          if (!f) {
02906             *outstate = AST_CONTROL_HANGUP;
02907             res = 0;
02908             break;
02909          }
02910          if (f->frametype == AST_FRAME_CONTROL) {
02911             switch (f->subclass) {
02912             case AST_CONTROL_RINGING:  /* record but keep going */
02913                *outstate = f->subclass;
02914                break;
02915 
02916             case AST_CONTROL_BUSY:
02917             case AST_CONTROL_CONGESTION:
02918             case AST_CONTROL_ANSWER:
02919                *outstate = f->subclass;
02920                timeout = 0;      /* trick to force exit from the while() */
02921                break;
02922 
02923             /* Ignore these */
02924             case AST_CONTROL_PROGRESS:
02925             case AST_CONTROL_PROCEEDING:
02926             case AST_CONTROL_HOLD:
02927             case AST_CONTROL_UNHOLD:
02928             case AST_CONTROL_VIDUPDATE:
02929             case AST_CONTROL_SRCUPDATE:
02930             case -1:       /* Ignore -- just stopping indications */
02931                break;
02932 
02933             default:
02934                ast_log(LOG_NOTICE, "Don't know what to do with control frame %d\n", f->subclass);
02935             }
02936             last_subclass = f->subclass;
02937          }
02938          ast_frfree(f);
02939       }
02940    }
02941 
02942    /* Final fixups */
02943    if (oh) {
02944       if (!ast_strlen_zero(oh->context))
02945          ast_copy_string(chan->context, oh->context, sizeof(chan->context));
02946       if (!ast_strlen_zero(oh->exten))
02947          ast_copy_string(chan->exten, oh->exten, sizeof(chan->exten));
02948       if (oh->priority) 
02949          chan->priority = oh->priority;
02950    }
02951    if (chan->_state == AST_STATE_UP)
02952       *outstate = AST_CONTROL_ANSWER;
02953 
02954    if (res <= 0) {
02955       if ( AST_CONTROL_RINGING == last_subclass ) 
02956          chan->hangupcause = AST_CAUSE_NO_ANSWER;
02957       if (!chan->cdr && (chan->cdr = ast_cdr_alloc()))
02958          ast_cdr_init(chan->cdr, chan);
02959       if (chan->cdr) {
02960          char tmp[256];
02961          snprintf(tmp, sizeof(tmp), "%s/%s", type, (char *)data);
02962          ast_cdr_setapp(chan->cdr,"Dial",tmp);
02963          ast_cdr_update(chan);
02964          ast_cdr_start(chan->cdr);
02965          ast_cdr_end(chan->cdr);
02966          /* If the cause wasn't handled properly */
02967          if (ast_cdr_disposition(chan->cdr,chan->hangupcause))
02968             ast_cdr_failed(chan->cdr);
02969       }
02970       ast_hangup(chan);
02971       chan = NULL;
02972    }
02973    return chan;
02974 }

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

Activate a given generator

Definition at line 1588 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().

01589 {
01590    int res = 0;
01591 
01592    ast_channel_lock(chan);
01593 
01594    if (chan->generatordata) {
01595       if (chan->generator && chan->generator->release)
01596          chan->generator->release(chan, chan->generatordata);
01597       chan->generatordata = NULL;
01598    }
01599 
01600    ast_prod(chan);
01601    if (gen->alloc && !(chan->generatordata = gen->alloc(chan, params))) {
01602       res = -1;
01603    }
01604    
01605    if (!res) {
01606       ast_settimeout(chan, 160, generator_force, chan);
01607       chan->generator = gen;
01608    }
01609 
01610    ast_channel_unlock(chan);
01611 
01612    return res;
01613 }

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(), 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 1509 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(), 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(), zapateller_exec(), and zapras_exec().

01510 {
01511    int res = 0;
01512    ast_channel_lock(chan);
01513    /* You can't answer an outbound call */
01514    if (ast_test_flag(chan, AST_FLAG_OUTGOING)) {
01515       ast_channel_unlock(chan);
01516       return 0;
01517    }
01518    /* Stop if we're a zombie or need a soft hangup */
01519    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
01520       ast_channel_unlock(chan);
01521       return -1;
01522    }
01523    switch(chan->_state) {
01524    case AST_STATE_RINGING:
01525    case AST_STATE_RING:
01526       if (chan->tech->answer)
01527          res = chan->tech->answer(chan);
01528       ast_setstate(chan, AST_STATE_UP);
01529       ast_cdr_answer(chan->cdr);
01530       break;
01531    case AST_STATE_UP:
01532       ast_cdr_answer(chan->cdr);
01533       break;
01534    default:
01535       break;
01536    }
01537    chan->visible_indication = 0;
01538    ast_channel_unlock(chan);
01539    return res;
01540 }

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 3686 of file channel.c.

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

Referenced by __zt_exception(), action_agents(), agents_show(), agents_show_online(), ast_channel_masquerade(), attempt_transfer(), check_bridge(), common_exec(), console_transfer(), console_transfer_deprecated(), create_jb(), 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(), schedule_delivery(), sip_read(), socket_process(), ss_thread(), start_spying(), startmon(), zt_handle_event(), and zt_hangup().

03687 {
03688    struct ast_channel *bridged;
03689    bridged = chan->_bridge;
03690    if (bridged && bridged->tech->bridged_channel)
03691       bridged = bridged->tech->bridged_channel(chan, bridged);
03692    return bridged;
03693 }

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 3031 of file channel.c.

References 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, 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().

03032 {
03033    /* Place an outgoing call, but don't wait any longer than timeout ms before returning.
03034       If the remote end does not answer within the timeout, then do NOT hang up, but
03035       return anyway.  */
03036    int res = -1;
03037    /* Stop if we're a zombie or need a soft hangup */
03038    ast_channel_lock(chan);
03039    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
03040       if (chan->tech->call)
03041          res = chan->tech->call(chan, addr, timeout);
03042       ast_set_flag(chan, AST_FLAG_OUTGOING);
03043    }
03044    ast_channel_unlock(chan);
03045    return res;
03046 }

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 3279 of file channel.c.

References ast_string_field_set, manager_event(), and name.

03280 {
03281    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", chan->name, newname, chan->uniqueid);
03282    ast_string_field_set(chan, name, newname);
03283 }

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

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 3876 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, ast_channel::generator, LOG_DEBUG, 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().

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

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 1327 of file channel.c.

References AST_LIST_INSERT_HEAD.

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

01328 {
01329    int res = 0;
01330 
01331    AST_LIST_INSERT_HEAD(&chan->datastores, datastore, entry);
01332 
01333    return res;
01334 }

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

Create a channel datastore structure.

Definition at line 1266 of file channel.c.

References ast_calloc, ast_strdup, and ast_datastore::info.

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

01267 {
01268    struct ast_datastore *datastore = NULL;
01269 
01270    /* Make sure we at least have type so we can identify this */
01271    if (info == NULL) {
01272       return NULL;
01273    }
01274 
01275    /* Allocate memory for datastore and clear it */
01276    datastore = ast_calloc(1, sizeof(*datastore));
01277    if (datastore == NULL) {
01278       return NULL;
01279    }
01280 
01281    datastore->info = info;
01282 
01283    datastore->uid = ast_strdup(uid);
01284 
01285    return datastore;
01286 }

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 1354 of file channel.c.

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

Referenced by chanspy_ds_free(), find_speech(), smdi_msg_read(), speech_background(), speech_destroy(), and try_calling().

01355 {
01356    struct ast_datastore *datastore = NULL;
01357    
01358    if (info == NULL)
01359       return NULL;
01360 
01361    AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->datastores, datastore, entry) {
01362       if (datastore->info == info) {
01363          if (uid != NULL && datastore->uid != NULL) {
01364             if (!strcasecmp(uid, datastore->uid)) {
01365                /* Matched by type AND uid */
01366                break;
01367             }
01368          } else {
01369             /* Matched by type at least */
01370             break;
01371          }
01372       }
01373    }
01374    AST_LIST_TRAVERSE_SAFE_END
01375 
01376    return datastore;
01377 }

int ast_channel_datastore_free ( struct ast_datastore datastore  ) 

Free a channel datastore structure.

Definition at line 1288 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(), and try_calling().

01289 {
01290    int res = 0;
01291 
01292    /* Using the destroy function (if present) destroy the data */
01293    if (datastore->info->destroy != NULL && datastore->data != NULL) {
01294       datastore->info->destroy(datastore->data);
01295       datastore->data = NULL;
01296    }
01297 
01298    /* Free allocated UID memory */
01299    if (datastore->uid != NULL) {
01300       free(datastore->uid);
01301       datastore->uid = NULL;
01302    }
01303 
01304    /* Finally free memory used by ourselves */
01305    free(datastore);
01306 
01307    return res;
01308 }

int ast_channel_datastore_inherit ( struct ast_channel from,
struct ast_channel to 
)

Inherit datastores from a parent to a child.

Definition at line 1310 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().

01311 {
01312    struct ast_datastore *datastore = NULL, *datastore2;
01313 
01314    AST_LIST_TRAVERSE(&from->datastores, datastore, entry) {
01315       if (datastore->inheritance > 0) {
01316          datastore2 = ast_channel_datastore_alloc(datastore->info, datastore->uid);
01317          if (datastore2) {
01318             datastore2->data = datastore->info->duplicate(datastore->data);
01319             datastore2->inheritance = datastore->inheritance == DATASTORE_INHERIT_FOREVER ? DATASTORE_INHERIT_FOREVER : datastore->inheritance - 1;
01320             AST_LIST_INSERT_TAIL(&to->datastores, datastore2, entry);
01321          }
01322       }
01323    }
01324    return 0;
01325 }

int ast_channel_datastore_remove ( struct ast_channel chan,
struct ast_datastore datastore 
)

Remove a datastore from a channel.

Definition at line 1336 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(), speech_background(), speech_destroy(), and try_calling().

01337 {
01338    struct ast_datastore *datastore2 = NULL;
01339    int res = -1;
01340 
01341    /* Find our position and remove ourselves */
01342    AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->datastores, datastore2, entry) {
01343       if (datastore2 == datastore) {
01344          AST_LIST_REMOVE_CURRENT(&chan->datastores, entry);
01345          res = 0;
01346          break;
01347       }
01348    }
01349    AST_LIST_TRAVERSE_SAFE_END
01350 
01351    return res;
01352 }

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 975 of file channel.c.

References AST_FLAG_DEFER_DTMF, ast_set_flag, and ast_test_flag.

Referenced by __adsi_transmit_messages(), and find_cache().

00976 {
00977    int pre = 0;
00978 
00979    if (chan) {
00980       pre = ast_test_flag(chan, AST_FLAG_DEFER_DTMF);
00981       ast_set_flag(chan, AST_FLAG_DEFER_DTMF);
00982    }
00983    return pre;
00984 }

void ast_channel_free ( struct ast_channel  ) 

Free a channel structure.

Definition at line 1179 of file channel.c.

References ast_channel::alertpipe, ast_app_group_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(), channels, ast_channel::cid, f, free, free_cid(), ast_channel::lock, LOG_ERROR, 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().

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

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 3285 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().

03286 {
03287    struct ast_var_t *current, *newvar;
03288    const char *varname;
03289 
03290    AST_LIST_TRAVERSE(&parent->varshead, current, entries) {
03291       int vartype = 0;
03292 
03293       varname = ast_var_full_name(current);
03294       if (!varname)
03295          continue;
03296 
03297       if (varname[0] == '_') {
03298          vartype = 1;
03299          if (varname[1] == '_')
03300             vartype = 2;
03301       }
03302 
03303       switch (vartype) {
03304       case 1:
03305          newvar = ast_var_assign(&varname[1], ast_var_value(current));
03306          if (newvar) {
03307             AST_LIST_INSERT_TAIL(&child->varshead, newvar, entries);
03308             if (option_debug)
03309                ast_log(LOG_DEBUG, "Copying soft-transferable variable %s.\n", ast_var_name(newvar));
03310          }
03311          break;
03312       case 2:
03313          newvar = ast_var_assign(ast_var_full_name(current), ast_var_value(current));
03314          if (newvar) {
03315             AST_LIST_INSERT_TAIL(&child->varshead, newvar, entries);
03316             if (option_debug)
03317                ast_log(LOG_DEBUG, "Copying hard-transferable variable %s.\n", ast_var_name(newvar));
03318          }
03319          break;
03320       default:
03321          if (option_debug)
03322             ast_log(LOG_DEBUG, "Not copying variable %s.\n", ast_var_name(current));
03323          break;
03324       }
03325    }
03326 }

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 3138 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(), 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().

03139 {
03140    int src;
03141    int dst;
03142 
03143    if (chan->readformat == peer->writeformat && chan->writeformat == peer->readformat) {
03144       /* Already compatible!  Moving on ... */
03145       return 0;
03146    }
03147 
03148    /* Set up translation from the chan to the peer */
03149    src = chan->nativeformats;
03150    dst = peer->nativeformats;
03151    if (ast_translator_best_choice(&dst, &src) < 0) {
03152       ast_log(LOG_WARNING, "No path to translate from %s(%d) to %s(%d)\n", chan->name, src, peer->name, dst);
03153       return -1;
03154    }
03155 
03156    /* if the best path is not 'pass through', then
03157       transcoding is needed; if desired, force transcode path
03158       to use SLINEAR between channels, but only if there is
03159       no direct conversion available */
03160    if ((src != dst) && ast_opt_transcode_via_slin &&
03161        (ast_translate_path_steps(dst, src) != 1))
03162       dst = AST_FORMAT_SLINEAR;
03163    if (ast_set_read_format(chan, dst) < 0) {
03164       ast_log(LOG_WARNING, "Unable to set read format on channel %s to %d\n", chan->name, dst);
03165       return -1;
03166    }
03167    if (ast_set_write_format(peer, dst) < 0) {
03168       ast_log(LOG_WARNING, "Unable to set write format on channel %s to %d\n", peer->name, dst);
03169       return -1;
03170    }
03171 
03172    /* Set up translation from the peer to the chan */
03173    src = peer->nativeformats;
03174    dst = chan->nativeformats;
03175    if (ast_translator_best_choice(&dst, &src) < 0) {
03176       ast_log(LOG_WARNING, "No path to translate from %s(%d) to %s(%d)\n", peer->name, src, chan->name, dst);
03177       return -1;
03178    }
03179 
03180    /* if the best path is not 'pass through', then
03181       transcoding is needed; if desired, force transcode path
03182       to use SLINEAR between channels, but only if there is
03183       no direct conversion available */
03184    if ((src != dst) && ast_opt_transcode_via_slin &&
03185        (ast_translate_path_steps(dst, src) != 1))
03186       dst = AST_FORMAT_SLINEAR;
03187    if (ast_set_read_format(peer, dst) < 0) {
03188       ast_log(LOG_WARNING, "Unable to set read format on channel %s to %d\n", peer->name, dst);
03189       return -1;
03190    }
03191    if (ast_set_write_format(chan, dst) < 0) {
03192       ast_log(LOG_WARNING, "Unable to set write format on channel %s to %d\n", chan->name, dst);
03193       return -1;
03194    }
03195    return 0;
03196 }

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 3198 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, 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().

03199 {
03200    int res = -1;
03201    struct ast_channel *final_orig, *final_clone, *base;
03202 
03203 retrymasq:
03204    final_orig = original;
03205    final_clone = clone;
03206 
03207    ast_channel_lock(original);
03208    while (ast_channel_trylock(clone)) {
03209       ast_channel_unlock(original);
03210       usleep(1);
03211       ast_channel_lock(original);
03212    }
03213 
03214    /* each of these channels may be sitting behind a channel proxy (i.e. chan_agent)
03215       and if so, we don't really want to masquerade it, but its proxy */
03216    if (original->_bridge && (original->_bridge != ast_bridged_channel(original)) && (original->_bridge->_bridge != original))
03217       final_orig = original->_bridge;
03218 
03219    if (clone->_bridge && (clone->_bridge != ast_bridged_channel(clone)) && (clone->_bridge->_bridge != clone))
03220       final_clone = clone->_bridge;
03221    
03222    if (final_clone->tech->get_base_channel && (base = final_clone->tech->get_base_channel(final_clone))) {
03223       final_clone = base;
03224    }
03225 
03226    if ((final_orig != original) || (final_clone != clone)) {
03227       /* Lots and lots of deadlock avoidance.  The main one we're competing with
03228        * is ast_write(), which locks channels recursively, when working with a
03229        * proxy channel. */
03230       if (ast_channel_trylock(final_orig)) {
03231          ast_channel_unlock(clone);
03232          ast_channel_unlock(original);
03233          goto retrymasq;
03234       }
03235       if (ast_channel_trylock(final_clone)) {
03236          ast_channel_unlock(final_orig);
03237          ast_channel_unlock(clone);
03238          ast_channel_unlock(original);
03239          goto retrymasq;
03240       }
03241       ast_channel_unlock(clone);
03242       ast_channel_unlock(original);
03243       original = final_orig;
03244       clone = final_clone;
03245    }
03246 
03247    if (original == clone) {
03248       ast_log(LOG_WARNING, "Can't masquerade channel '%s' into itself!\n", original->name);
03249       ast_channel_unlock(clone);
03250       ast_channel_unlock(original);
03251       return -1;
03252    }
03253 
03254    if (option_debug)
03255       ast_log(LOG_DEBUG, "Planning to masquerade channel %s into the structure of %s\n",
03256          clone->name, original->name);
03257    if (original->masq) {
03258       ast_log(LOG_WARNING, "%s is already going to masquerade as %s\n",
03259          original->masq->name, original->name);
03260    } else if (clone->masqr) {
03261       ast_log(LOG_WARNING, "%s is already going to masquerade as %s\n",
03262          clone->name, clone->masqr->name);
03263    } else {
03264       original->masq = clone;
03265       clone->masqr = original;
03266       ast_queue_frame(original, &ast_null_frame);
03267       ast_queue_frame(clone, &ast_null_frame);
03268       if (option_debug)
03269          ast_log(LOG_DEBUG, "Done planning to masquerade channel %s into the structure of %s\n", clone->name, original->name);
03270       res = 0;
03271    }
03272 
03273    ast_channel_unlock(clone);
03274    ast_channel_unlock(original);
03275 
03276    return res;
03277 }

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 2824 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().

02825 {
02826    switch (reason) /* the following appear to be the only ones actually returned by request_and_dial */
02827    {
02828    case 0:
02829       return "Call Failure (not BUSY, and not NO_ANSWER, maybe Circuit busy or down?)";
02830    case AST_CONTROL_HANGUP:
02831       return "Hangup";
02832    case AST_CONTROL_RING:
02833       return "Local Ring";
02834    case AST_CONTROL_RINGING:
02835       return "Remote end Ringing";
02836    case AST_CONTROL_ANSWER:
02837       return "Remote end has Answered";
02838    case AST_CONTROL_BUSY:
02839       return "Remote end is Busy";
02840    case AST_CONTROL_CONGESTION:
02841       return "Congestion (circuits busy)";
02842    default:
02843       return "Unknown Reason!!";
02844    }
02845 }

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 3126 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().

03127 {
03128    if (chan->tech->send_html)
03129       return chan->tech->send_html(chan, subclass, data, datalen);
03130    return -1;
03131 }

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 3133 of file channel.c.

References ast_channel_sendhtml(), and AST_HTML_URL.

Referenced by sendurl_exec(), and try_calling().

03134 {
03135    return ast_channel_sendhtml(chan, AST_HTML_URL, url, strlen(url) + 1);
03136 }

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 4144 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(), func_channel_write(), handle_tddmode(), play_record_review(), reset_volumes(), rpt(), set_listen_volume(), set_talk_volume(), try_calling(), vm_forwardoptions(), and zt_hangup().

04145 {
04146    int res;
04147 
04148    if (chan->tech->setoption) {
04149       res = chan->tech->setoption(chan, option, data, datalen);
04150       if (res < 0)
04151          return res;
04152    } else {
04153       errno = ENOSYS;
04154       return -1;
04155    }
04156    if (block) {
04157       /* XXX Implement blocking -- just wait for our option frame reply, discarding
04158          intermediate packets. XXX */
04159       ast_log(LOG_ERROR, "XXX Blocking not implemented yet XXX\n");
04160       return -1;
04161    }
04162    return 0;
04163 }

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 4472 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().

04473 {
04474    struct ast_silence_generator *state;
04475 
04476    if (!(state = ast_calloc(1, sizeof(*state)))) {
04477       return NULL;
04478    }
04479 
04480    state->old_write_format = chan->writeformat;
04481 
04482    if (ast_set_write_format(chan, AST_FORMAT_SLINEAR) < 0) {
04483       ast_log(LOG_ERROR, "Could not set write format to SLINEAR\n");
04484       free(state);
04485       return NULL;
04486    }
04487 
04488    ast_activate_generator(chan, &silence_generator, state);
04489 
04490    if (option_debug)
04491       ast_log(LOG_DEBUG, "Started silence generator on '%s'\n", chan->name);
04492 
04493    return state;
04494 }

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 4496 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().

04497 {
04498    if (!state)
04499       return;
04500 
04501    ast_deactivate_generator(chan);
04502 
04503    if (option_debug)
04504       ast_log(LOG_DEBUG, "Stopped silence generator on '%s'\n", chan->name);
04505 
04506    if (ast_set_write_format(chan, state->old_write_format) < 0)
04507       ast_log(LOG_ERROR, "Could not return write format to its original state\n");
04508 
04509    free(state);
04510 }

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 3121 of file channel.c.

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

Referenced by sendurl_exec(), and try_calling().

03122 {
03123    return (chan->tech->send_html) ? 1 : 0;
03124 }

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 987 of file channel.c.

References ast_clear_flag, and AST_FLAG_DEFER_DTMF.

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

00988 {
00989    if (chan)
00990       ast_clear_flag(chan, AST_FLAG_DEFER_DTMF);
00991 }

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 1100 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().

01101 {
01102    return channel_find_locked(prev, NULL, 0, NULL, NULL);
01103 }

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(), 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(), deadagi_exec(), do_atxfer(), handle_request_invite(), handle_sendimage(), pbx_exec(), rpt(), wait_for_answer(), zt_sendtext(), and zt_setoption().

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 1542 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(), channel_spy(), generator_force(), local_ast_moh_stop(), old_milliwatt_exec(), and wait_for_answer().

01543 {
01544    ast_channel_lock(chan);
01545    if (chan->generatordata) {
01546       if (chan->generator && chan->generator->release)
01547          chan->generator->release(chan, chan->generatordata);
01548       chan->generatordata = NULL;
01549       chan->generator = NULL;
01550       chan->fds[AST_GENERATOR_FD] = -1;
01551       ast_clear_flag(chan, AST_FLAG_WRITE_INT);
01552       ast_settimeout(chan, 0, NULL, NULL);
01553    }
01554    ast_channel_unlock(chan);
01555 }

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 3359 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, 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, 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().

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

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 1125 of file channel.c.

References channel_find_locked().

01126 {
01127    return channel_find_locked(NULL, NULL, 0, context, exten);
01128 }

struct ast_channel* ast_get_channel_by_name_locked ( const char *  chan  ) 

Get channel by name (locks channel).

Definition at line 1106 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(), pbx_builtin_importvar(), start_monitor_action(), and stop_monitor_action().

01107 {
01108    return channel_find_locked(NULL, name, 0, NULL, NULL);
01109 }

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 1112 of file channel.c.

References channel_find_locked().

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

01113 {
01114    return channel_find_locked(NULL, name, namelen, NULL, NULL);
01115 }

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 4317 of file channel.c.

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

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

04318 {
04319    char *piece;
04320    char *c;
04321    int start=0, finish=0, x;
04322    ast_group_t group = 0;
04323 
04324    if (ast_strlen_zero(s))
04325       return 0;
04326 
04327    c = ast_strdupa(s);
04328    
04329    while ((piece = strsep(&c, ","))) {
04330       if (sscanf(piece, "%d-%d", &start, &finish) == 2) {
04331          /* Range */
04332       } else if (sscanf(piece, "%d", &start)) {
04333          /* Just one */
04334          finish = start;
04335       } else {
04336          ast_log(LOG_ERROR, "Syntax error parsing group configuration '%s' at '%s'. Ignoring.\n", s, piece);
04337          continue;
04338       }
04339       for (x = start; x <= finish; x++) {
04340          if ((x > 63) || (x < 0)) {
04341             ast_log(LOG_WARNING, "Ignoring invalid group %d (maximum group is 63)\n", x);
04342          } else
04343             group |= ((ast_group_t) 1 << x);
04344       }
04345    }
04346    return group;
04347 }

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 1416 of file channel.c.

References ast_assert, ast_audiohook_detach_list(), ast_autoservice_stop(), ast_cause2str(), ast_cdr_detach(), ast_cdr_end(), 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, free_translation(), ast_channel::generator, ast_channel::generatordata, ast_channel_tech::hangup, ast_channel::hangupcause, LOG_DEBUG, 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_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(), 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(), wait_for_winner(), zt_handle_event(), and zt_new().

01417 {
01418    int res = 0;
01419    struct ast_cdr *cdr = NULL;
01420 
01421    /* Don't actually hang up a channel that will masquerade as someone else, or
01422       if someone is going to masquerade as us */
01423    ast_channel_lock(chan);
01424 
01425    if (chan->audiohooks) {
01426       ast_audiohook_detach_list(chan->audiohooks);
01427       chan->audiohooks = NULL;
01428    }
01429 
01430    ast_autoservice_stop(chan);
01431 
01432    if (chan->masq) {
01433       if (ast_do_masquerade(chan))
01434          ast_log(LOG_WARNING, "Failed to perform masquerade\n");
01435    }
01436 
01437    if (chan->masq) {
01438       ast_log(LOG_WARNING, "%s getting hung up, but someone is trying to masq into us?!?\n", chan->name);
01439       ast_channel_unlock(chan);
01440       return 0;
01441    }
01442    /* If this channel is one which will be masqueraded into something,
01443       mark it as a zombie already, so we know to free it later */
01444    if (chan->masqr) {
01445       ast_set_flag(chan, AST_FLAG_ZOMBIE);
01446       ast_channel_unlock(chan);
01447       return 0;
01448    }
01449    free_translation(chan);
01450    /* Close audio stream */
01451    if (chan->stream) {
01452       ast_closestream(chan->stream);
01453       chan->stream = NULL;
01454    }
01455    /* Close video stream */
01456    if (chan->vstream) {
01457       ast_closestream(chan->vstream);
01458       chan->vstream = NULL;
01459    }
01460    if (chan->sched) {
01461       sched_context_destroy(chan->sched);
01462       chan->sched = NULL;
01463    }
01464    
01465    if (chan->generatordata)   /* Clear any tone stuff remaining */
01466       chan->generator->release(chan, chan->generatordata);
01467    chan->generatordata = NULL;
01468    chan->generator = NULL;
01469    if (chan->cdr) {     /* End the CDR if it hasn't already */
01470       ast_cdr_end(chan->cdr);
01471       cdr = chan->cdr;
01472       chan->cdr = NULL;
01473    }
01474    if (ast_test_flag(chan, AST_FLAG_BLOCKING)) {
01475       ast_log(LOG_WARNING, "Hard hangup called by thread %ld on %s, while fd "
01476                "is blocked by thread %ld in procedure %s!  Expect a failure\n",
01477                (long)pthread_self(), chan->name, (long)chan->blocker, chan->blockproc);
01478       ast_assert(0);
01479    }
01480    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE)) {
01481       if (option_debug)
01482          ast_log(LOG_DEBUG, "Hanging up channel '%s'\n", chan->name);
01483       if (chan->tech->hangup)
01484          res = chan->tech->hangup(chan);
01485    } else {
01486       if (option_debug)
01487          ast_log(LOG_DEBUG, "Hanging up zombie '%s'\n", chan->name);
01488    }
01489          
01490    ast_channel_unlock(chan);
01491    manager_event(EVENT_FLAG_CALL, "Hangup",
01492          "Channel: %s\r\n"
01493          "Uniqueid: %s\r\n"
01494          "Cause: %d\r\n"
01495          "Cause-txt: %s\r\n",
01496          chan->name,
01497          chan->uniqueid,
01498          chan->hangupcause,
01499          ast_cause2str(chan->hangupcause)
01500          );
01501    ast_channel_free(chan);
01502 
01503    if (cdr)
01504       ast_cdr_detach(cdr);
01505 
01506    return res;
01507 }

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 2355 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().

02356 {
02357    return ast_indicate_data(chan, condition, NULL, 0);
02358 }

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 2360 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, tone_zone_sound::data, ast_channel_tech::indicate, LOG_DEBUG, 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().

02361 {
02362    int res = -1;
02363 
02364    ast_channel_lock(chan);
02365    /* Stop if we're a zombie or need a soft hangup */
02366    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
02367       ast_channel_unlock(chan);
02368       return -1;
02369    }
02370    if (chan->tech->indicate)
02371       res = chan->tech->indicate(chan, condition, data, datalen);
02372    ast_channel_unlock(chan);
02373    if (!chan->tech->indicate || res) {
02374       /*
02375        * Device does not support (that) indication, lets fake
02376        * it by doing our own tone generation. (PM2002)
02377        */
02378       if (condition < 0)
02379          ast_playtones_stop(chan);
02380       else {
02381          const struct tone_zone_sound *ts = NULL;
02382          switch (condition) {
02383          case AST_CONTROL_RINGING:
02384             ts = ast_get_indication_tone(chan->zone, "ring");
02385             break;
02386          case AST_CONTROL_BUSY:
02387             ts = ast_get_indication_tone(chan->zone, "busy");
02388             break;
02389          case AST_CONTROL_CONGESTION:
02390             ts = ast_get_indication_tone(chan->zone, "congestion");
02391             break;
02392          }
02393          if (ts && ts->data[0]) {
02394             if (option_debug)
02395                ast_log(LOG_DEBUG, "Driver for channel '%s' does not support indication %d, emulating it\n", chan->name, condition);
02396             ast_playtones_start(chan,0,ts->data, 1);
02397             res = 0;
02398             chan->visible_indication = condition;
02399          } else if (condition == AST_CONTROL_PROGRESS) {
02400             /* ast_playtones_stop(chan); */
02401          } else if (condition == AST_CONTROL_PROCEEDING) {
02402             /* Do nothing, really */
02403          } else if (condition == AST_CONTROL_HOLD) {
02404             /* Do nothing.... */
02405          } else if (condition == AST_CONTROL_UNHOLD) {
02406             /* Do nothing.... */
02407          } else if (condition == AST_CONTROL_VIDUPDATE) {
02408             /* Do nothing.... */
02409          } else if (condition == AST_CONTROL_SRCUPDATE) {
02410             /* Do nothing... */
02411          } else {
02412             /* not handled */
02413             ast_log(LOG_WARNING, "Unable to handle indication %d for '%s'\n", condition, chan->name);
02414             res = -1;
02415          }
02416       }
02417    } else
02418       chan->visible_indication = condition;
02419 
02420    return res;
02421 }

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 2337 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().

02338 {
02339    int ret = ast_opt_internal_timing && chan->timingfd > -1;
02340    if (option_debug > 4)
02341       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);
02342    return ret;
02343 }

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

print call- and pickup groups into buffer

Definition at line 4402 of file channel.c.

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

04403 {
04404    unsigned int i;
04405    int first=1;
04406    char num[3];
04407 
04408    buf[0] = '\0';
04409    
04410    if (!group) /* Return empty string if no group */
04411       return buf;
04412 
04413    for (i = 0; i <= 63; i++) {   /* Max group is 63 */
04414       if (group & ((ast_group_t) 1 << i)) {
04415             if (!first) {
04416             strncat(buf, ", ", buflen - strlen(buf) - 1);
04417          } else {
04418             first=0;
04419          }
04420          snprintf(num, sizeof(num), "%u", i);
04421          strncat(buf, num, buflen - strlen(buf) - 1);
04422       }
04423    }
04424    return buf;
04425 }

int ast_prod ( struct ast_channel chan  ) 

Send empty audio to prime a channel driver.

Definition at line 2543 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, option_debug, ast_channel::rawwriteformat, ast_frame::src, and ast_frame::subclass.

Referenced by ast_activate_generator().

02544 {
02545    struct ast_frame a = { AST_FRAME_VOICE };
02546    char nothing[128];
02547 
02548    /* Send an empty audio frame to get things moving */
02549    if (chan->_state != AST_STATE_UP) {
02550       if (option_debug)
02551          ast_log(LOG_DEBUG, "Prodding channel '%s'\n", chan->name);
02552       a.subclass = chan->rawwriteformat;
02553       a.data = nothing + AST_FRIENDLY_OFFSET;
02554       a.src = "ast_prod";
02555       if (ast_write(chan, &a))
02556          ast_log(LOG_WARNING, "Prodding channel '%s' failed\n", chan->name);
02557    }
02558    return 0;
02559 }

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 952 of file channel.c.

References AST_FRAME_CONTROL, ast_queue_frame(), and f.

Referenced by __oh323_update_info(), __zt_exception(), ast_pickup_call(), attempt_transfer(), auto_congest(), 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(), update_state(), zt_handle_event(), and zt_hangup().

00953 {
00954    struct ast_frame f = { AST_FRAME_CONTROL, };
00955 
00956    f.subclass = control;
00957 
00958    return ast_queue_frame(chan, &f);
00959 }

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 962 of file channel.c.

References AST_FRAME_CONTROL, ast_queue_frame(), and f.

Referenced by action_atxfer(), iax2_queue_control_data(), process_sdp(), skinny_hold(), zt_handle_event(), and zt_hangup().

00964 {
00965    struct ast_frame f = { AST_FRAME_CONTROL, };
00966 
00967    f.subclass = control;
00968    f.data = (void *) data;
00969    f.datalen = datalen;
00970 
00971    return ast_queue_frame(chan, &f);
00972 }

int ast_queue_frame ( struct ast_channel chan,
struct ast_frame f 
)

Queue an outgoing frame.

Definition at line 884 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, 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(), 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(), wakeup_sub(), and zap_queue_frame().

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

int ast_queue_hangup ( struct ast_channel chan  ) 

Queue a hangup frame.

Definition at line 940 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(), 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(), mgcp_queue_hangup(), misdn_answer(), retrans_pkt(), and zt_handle_event().

00941 {
00942    struct ast_frame f = { AST_FRAME_CONTROL, AST_CONTROL_HANGUP };
00943    /* Yeah, let's not change a lock-critical value without locking */
00944    if (!ast_channel_trylock(chan)) {
00945       chan->_softhangup |= AST_SOFTHANGUP_DEV;
00946       ast_channel_unlock(chan);
00947    }
00948    return ast_queue_frame(chan, &f);
00949 }

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 2345 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(), 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(), waitstream_core(), and zt_bridge().

02346 {
02347    return __ast_read(chan, 0);
02348 }

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 2350 of file channel.c.

References __ast_read().

Referenced by conf_run().

02351 {
02352    return __ast_read(chan, 1);
02353 }

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 3073 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().

03074 {
03075    return ast_readstring_full(c, s, len, timeout, ftimeout, enders, -1, -1);
03076 }

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 3078 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().

03079 {
03080    int pos = 0;   /* index in the buffer where we accumulate digits */
03081    int to = ftimeout;
03082 
03083    /* Stop if we're a zombie or need a soft hangup */
03084    if (ast_test_flag(c, AST_FLAG_ZOMBIE) || ast_check_hangup(c))
03085       return -1;
03086    if (!len)
03087       return -1;
03088    for (;;) {
03089       int d;
03090       if (c->stream) {
03091          d = ast_waitstream_full(c, AST_DIGIT_ANY, audiofd, ctrlfd);
03092          ast_stopstream(c);
03093          usleep(1000);
03094          if (!d)
03095             d = ast_waitfordigit_full(c, to, audiofd, ctrlfd);
03096       } else {
03097          d = ast_waitfordigit_full(c, to, audiofd, ctrlfd);
03098       }
03099       if (d < 0)
03100          return -1;
03101       if (d == 0) {
03102          s[pos]='\0';
03103          return 1;
03104       }
03105       if (d == 1) {
03106          s[pos]='\0';
03107          return 2;
03108       }
03109       if (!strchr(enders, d))
03110          s[pos++] = d;
03111       if (strchr(enders, d) || (pos >= len)) {
03112          s[pos]='\0';
03113          return 0;
03114       }
03115       to = timeout;
03116    }
03117    /* Never reached */
03118    return 0;
03119 }

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 2423 of file channel.c.

References ast_recvtext(), and free.

Referenced by handle_recvchar().

02424 {
02425    int c;
02426    char *buf = ast_recvtext(chan, timeout);
02427    if (buf == NULL)
02428       return -1;  /* error or timeout */
02429    c = *(unsigned char *)buf;
02430    free(buf);
02431    return c;
02432 }

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 2434 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().

02435 {
02436    int res, done = 0;
02437    char *buf = NULL;
02438    
02439    while (!done) {
02440       struct ast_frame *f;
02441       if (ast_check_hangup(chan))
02442          break;
02443       res = ast_waitfor(chan, timeout);
02444       if (res <= 0) /* timeout or error */
02445          break;
02446       timeout = res; /* update timeout */
02447       f = ast_read(chan);
02448       if (f == NULL)
02449          break; /* no frame */
02450       if (f->frametype == AST_FRAME_CONTROL && f->subclass == AST_CONTROL_HANGUP)
02451          done = 1;   /* force a break */
02452       else if (f->frametype == AST_FRAME_TEXT) {      /* what we want */
02453          buf = ast_strndup((char *) f->data, f->datalen);   /* dup and break */
02454          done = 1;
02455       }
02456       ast_frfree(f);
02457    }
02458    return buf;
02459 }

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 2981 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, 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().

02982 {
02983    struct chanlist *chan;
02984    struct ast_channel *c;
02985    int capabilities;
02986    int fmt;
02987    int res;
02988    int foo;
02989    int videoformat = format & AST_FORMAT_VIDEO_MASK;
02990 
02991    if (!cause)
02992       cause = &foo;
02993    *cause = AST_CAUSE_NOTDEFINED;
02994 
02995    if (AST_LIST_LOCK(&channels)) {
02996       ast_log(LOG_WARNING, "Unable to lock channel list\n");
02997       return NULL;
02998    }
02999 
03000    AST_LIST_TRAVERSE(&backends, chan, list) {
03001       if (strcasecmp(type, chan->tech->type))
03002          continue;
03003 
03004       capabilities = chan->tech->capabilities;
03005       fmt = format & AST_FORMAT_AUDIO_MASK;
03006       res = ast_translator_best_choice(&fmt, &capabilities);
03007       if (res < 0) {
03008          ast_log(LOG_WARNING, "No translator path exists for channel type %s (native %d) to %d\n", type, chan->tech->capabilities, format);
03009          *cause = AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
03010          AST_LIST_UNLOCK(&channels);
03011          return NULL;
03012       }
03013       AST_LIST_UNLOCK(&channels);
03014       if (!chan->tech->requester)
03015          return NULL;
03016       
03017       if (!(c = chan->tech->requester(type, capabilities | videoformat, data, cause)))
03018          return NULL;
03019 
03020       /* no need to generate a Newchannel event here; it is done in the channel_alloc call */
03021       return c;
03022    }
03023 
03024    ast_log(LOG_WARNING, "No channel type registered for '%s'\n", type);
03025    *cause = AST_CAUSE_NOSUCHDRIVER;
03026    AST_LIST_UNLOCK(&channels);
03027 
03028    return NULL;
03029 }

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 2976 of file channel.c.

References __ast_request_and_dial().

Referenced by ast_pbx_outgoing_exten().

02977 {
02978    return __ast_request_and_dial(type, format, data, timeout, outstate, cidnum, cidname, NULL);
02979 }

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 1159 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().

01160 {
01161    return ast_safe_sleep_conditional(chan, ms, NULL, NULL);
01162 }

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 1138 of file channel.c.

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

Referenced by __login_exec(), and ast_safe_sleep().

01139 {
01140    struct ast_frame *f;
01141 
01142    while (ms > 0) {
01143       if (cond && ((*cond)(data) == 0))
01144          return 0;
01145       ms = ast_waitfor(chan, ms);
01146       if (ms < 0)
01147          return -1;
01148       if (ms > 0) {
01149          f = ast_read(chan);
01150          if (!f)
01151             return -1;
01152          ast_frfree(f);
01153       }
01154    }
01155    return 0;
01156 }

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 features_new(), and zt_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 2533 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().

02534 {
02535    if (chan->tech->send_digit_begin) {
02536       ast_senddigit_begin(chan, digit);
02537       ast_safe_sleep(chan, AST_DEFAULT_EMULATE_DTMF_DURATION);
02538    }
02539    
02540    return ast_senddigit_end(chan, digit, AST_DEFAULT_EMULATE_DTMF_DURATION);
02541 }

int ast_senddigit_begin ( struct ast_channel chan,
char  digit 
)

Definition at line 2474 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().

02475 {
02476    /* Device does not support DTMF tones, lets fake
02477     * it by doing our own generation. */
02478    static const char* dtmf_tones[] = {
02479       "941+1336", /* 0 */
02480       "697+1209", /* 1 */
02481       "697+1336", /* 2 */
02482       "697+1477", /* 3 */
02483       "770+1209", /* 4 */
02484       "770+1336", /* 5 */
02485       "770+1477", /* 6 */
02486       "852+1209", /* 7 */
02487       "852+1336", /* 8 */
02488       "852+1477", /* 9 */
02489       "697+1633", /* A */
02490       "770+1633", /* B */
02491       "852+1633", /* C */
02492       "941+1633", /* D */
02493       "941+1209", /* * */
02494       "941+1477"  /* # */
02495    };
02496 
02497    if (!chan->tech->send_digit_begin)
02498       return 0;
02499 
02500    if (!chan->tech->send_digit_begin(chan, digit))
02501       return 0;
02502 
02503    if (digit >= '0' && digit <='9')
02504       ast_playtones_start(chan, 0, dtmf_tones[digit-'0'], 0);
02505    else if (digit >= 'A' && digit <= 'D')
02506       ast_playtones_start(chan, 0, dtmf_tones[digit-'A'+10], 0);
02507    else if (digit == '*')
02508       ast_playtones_start(chan, 0, dtmf_tones[14], 0);
02509    else if (digit == '#')
02510       ast_playtones_start(chan, 0, dtmf_tones[15], 0);
02511    else {
02512       /* not handled */
02513       if (option_debug)
02514          ast_log(LOG_DEBUG, "Unable to generate DTMF tone '%c' for '%s'\n", digit, chan->name);
02515    }
02516 
02517    return 0;
02518 }

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

Definition at line 2520 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().

02521 {
02522    int res = -1;
02523 
02524    if (chan->tech->send_digit_end)
02525       res = chan->tech->send_digit_end(chan, digit, duration);
02526 
02527    if (res && chan->generator)
02528       ast_playtones_stop(chan);
02529    
02530    return 0;
02531 }

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 2461 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().

02462 {
02463    int res = 0;
02464    /* Stop if we're a zombie or need a soft hangup */
02465    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan))
02466       return -1;
02467    CHECK_BLOCKING(chan);
02468    if (chan->tech->send_text)
02469       res = chan->tech->send_text(chan, text);
02470    ast_clear_flag(chan, AST_FLAG_BLOCKING);
02471    return res;
02472 }

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 3622 of file channel.c.

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

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

03623 {
03624    ast_channel_lock(chan);
03625 
03626    if (callerid) {
03627       if (chan->cid.cid_num)
03628          free(chan->cid.cid_num);
03629       chan->cid.cid_num = ast_strdup(callerid);
03630    }
03631    if (calleridname) {
03632       if (chan->cid.cid_name)
03633          free(chan->cid.cid_name);
03634       chan->cid.cid_name = ast_strdup(calleridname);
03635    }
03636    if (ani) {
03637       if (chan->cid.cid_ani)
03638          free(chan->cid.cid_ani);
03639       chan->cid.cid_ani = ast_strdup(ani);
03640    }
03641    if (chan->cdr)
03642       ast_cdr_setcid(chan->cdr, chan);
03643    manager_event(EVENT_FLAG_CALL, "Newcallerid",
03644             "Channel: %s\r\n"
03645             "CallerID: %s\r\n"
03646             "CallerIDName: %s\r\n"
03647             "Uniqueid: %s\r\n"
03648             "CID-CallingPres: %d (%s)\r\n",
03649             chan->name,
03650             S_OR(chan->cid.cid_num, "<Unknown>"),
03651             S_OR(chan->cid.cid_name, "<Unknown>"),
03652             chan->uniqueid,
03653             chan->cid.cid_pres,
03654             ast_describe_caller_presentation(chan->cid.cid_pres)
03655             );
03656    
03657    ast_channel_unlock(chan);
03658 }

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 2812 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().

02813 {
02814    return set_format(chan, fmt, &chan->rawreadformat, &chan->readformat,
02815            &chan->readtrans, 0);
02816 }

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 4427 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().

04428 {
04429    struct ast_variable *cur;
04430 
04431    for (cur = vars; cur; cur = cur->next)
04432       pbx_builtin_setvar_helper(chan, cur->name, cur->value);  
04433 }

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 2818 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().

02819 {
02820    return set_format(chan, fmt, &chan->rawwriteformat, &chan->writeformat,
02821            &chan->writetrans, 1);
02822 }

int ast_setstate ( struct ast_channel chan,
enum  ast_channel_state 
)

Change the state of a channel.

Definition at line 3660 of file channel.c.

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

Referenced by __ast_read(), __oh323_update_info(), __zt_exception(), agent_call(), alsa_answer(), ast_answer(), cb_events(), check_availability(), 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(), update_state(), zt_answer(), zt_call(), zt_handle_event(), zt_indicate(), and zt_read().

03661 {
03662    int oldstate = chan->_state;
03663 
03664    if (oldstate == state)
03665       return 0;
03666 
03667    chan->_state = state;
03668    ast_device_state_changed_literal(chan->name);
03669    /* setstate used to conditionally report Newchannel; this is no more */
03670    manager_event(EVENT_FLAG_CALL,
03671             "Newstate",
03672             "Channel: %s\r\n"
03673             "State: %s\r\n"
03674             "CallerID: %s\r\n"
03675             "CallerIDName: %s\r\n"
03676             "Uniqueid: %s\r\n",
03677             chan->name, ast_state2str(chan->_state),
03678             S_OR(chan->cid.cid_num, "<unknown>"),
03679             S_OR(chan->cid.cid_name, "<unknown>"),
03680             chan->uniqueid);
03681 
03682    return 0;
03683 }

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

Definition at line 1793 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().

01794 {
01795    int res = -1;
01796 #ifdef HAVE_ZAPTEL
01797    if (c->timingfd > -1) {
01798       if (!func) {
01799          samples = 0;
01800          data = 0;
01801       }
01802       if (option_debug)
01803          ast_log(LOG_DEBUG, "Scheduling timer at %d sample intervals\n", samples);
01804       res = ioctl(c->timingfd, ZT_TIMERCONFIG, &samples);
01805       c->timingfunc = func;
01806       c->timingdata = data;
01807    }
01808 #endif   
01809    return res;
01810 }

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 1394 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(), 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(), unload_module(), and zt_handle_event().

01395 {
01396    int res;
01397    ast_channel_lock(chan);
01398    res = ast_softhangup_nolock(chan, cause);
01399    ast_channel_unlock(chan);
01400    return res;
01401 }

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 1380 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(), do_monitor(), oh323_indicate(), sip_indicate(), and skinny_indicate().

01381 {
01382    if (option_debug)
01383       ast_log(LOG_DEBUG, "Soft-Hanging up channel '%s'\n", chan->name);
01384    /* Inform channel driver that we need to be hung up, if it cares */
01385    chan->_softhangup |= cause;
01386    ast_queue_frame(chan, &ast_null_frame);
01387    /* Interrupt any poll call or such */
01388    if (ast_test_flag(chan, AST_FLAG_BLOCKING))
01389       pthread_kill(chan->blocker, SIGURG);
01390    return 0;
01391 }

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_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 4299 of file channel.c.

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

Referenced by zapateller_exec().

04300 {
04301    int res;
04302 
04303    if ((res = ast_tonepair_start(chan, freq1, freq2, duration, vol)))
04304       return res;
04305 
04306    /* Give us some wiggle room */
04307    while (chan->generatordata && ast_waitfor(chan, 100) >= 0) {
04308       struct ast_frame *f = ast_read(chan);
04309       if (f)
04310          ast_frfree(f);
04311       else
04312          return -1;
04313    }
04314    return 0;
04315 }

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

Start a tone going

Definition at line 4281 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().

04282 {
04283    struct tonepair_def d = { 0, };
04284 
04285    d.freq1 = freq1;
04286    d.freq2 = freq2;
04287    d.duration = duration;
04288    d.vol = (vol < 1) ? 8192 : vol; /* force invalid to 8192 */
04289    if (ast_activate_generator(chan, &tonepair, &d))
04290       return -1;
04291    return 0;
04292 }

void ast_tonepair_stop ( struct ast_channel chan  ) 

Stop a tone from playing

Definition at line 4294 of file channel.c.

References ast_deactivate_generator().

Referenced by sendnoise().

04295 {
04296    ast_deactivate_generator(chan);
04297 }

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 3055 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().

03056 {
03057    int res = -1;
03058 
03059    /* Stop if we're a zombie or need a soft hangup */
03060    ast_channel_lock(chan);
03061    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
03062       if (chan->tech->transfer) {
03063          res = chan->tech->transfer(chan, dest);
03064          if (!res)
03065             res = 1;
03066       } else
03067          res = 0;
03068    }
03069    ast_channel_unlock(chan);
03070    return res;
03071 }

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(), misdn_call(), oh323_call(), zt_call(), and zt_new().

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 1777 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().

01778 {
01779    int oldms = ms;   /* -1 if no timeout */
01780 
01781    ast_waitfor_nandfds(&c, 1, NULL, 0, NULL, NULL, &ms);
01782    if ((ms < 0) && (oldms < 0))
01783       ms = 0;
01784    return ms;
01785 }

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 1772 of file channel.c.

References ast_waitfor_nandfds().

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

01773 {
01774    return ast_waitfor_nandfds(c, n, NULL, 0, NULL, NULL, ms);
01775 }

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 1616 of file channel.c.

References ast_waitfor_nandfds().

Referenced by dundi_lookup_internal(), and dundi_precache_internal().

01617 {
01618    int winner = -1;
01619    ast_waitfor_nandfds(NULL, 0, fds, n, exception, &winner, ms);
01620    return winner;
01621 }

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 1624 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, 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().

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

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 1788 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().

01789 {
01790    return ast_waitfordigit_full(c, ms, -1, -1);
01791 }

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 1812 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, and f.

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

01813 {
01814    /* Stop if we're a zombie or need a soft hangup */
01815    if (ast_test_flag(c, AST_FLAG_ZOMBIE) || ast_check_hangup(c))
01816       return -1;
01817 
01818    /* Only look for the end of DTMF, don't bother with the beginning and don't emulate things */
01819    ast_set_flag(c, AST_FLAG_END_DTMF_ONLY);
01820 
01821    /* Wait for a digit, no more than ms milliseconds total. */
01822    while (ms) {
01823       struct ast_channel *rchan;
01824       int outfd;
01825 
01826       errno = 0;
01827       rchan = ast_waitfor_nandfds(&c, 1, &cmdfd, (cmdfd > -1) ? 1 : 0, NULL, &outfd, &ms);
01828       if (!rchan && outfd < 0 && ms) {
01829          if (errno == 0 || errno == EINTR)
01830             continue;
01831          ast_log(LOG_WARNING, "Wait failed (%s)\n", strerror(errno));
01832          ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01833          return -1;
01834       } else if (outfd > -1) {
01835          /* The FD we were watching has something waiting */
01836          ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01837          return 1;
01838       } else if (rchan) {
01839          int res;
01840          struct ast_frame *f = ast_read(c);
01841          if (!f)
01842             return -1;
01843 
01844          switch(f->frametype) {
01845          case AST_FRAME_DTMF_BEGIN:
01846             break;
01847          case AST_FRAME_DTMF_END:
01848             res = f->subclass;
01849             ast_frfree(f);
01850             ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01851             return res;
01852          case AST_FRAME_CONTROL:
01853             switch(f->subclass) {
01854             case AST_CONTROL_HANGUP:
01855                ast_frfree(f);
01856                ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01857                return -1;
01858             case AST_CONTROL_RINGING:
01859             case AST_CONTROL_ANSWER:
01860             case AST_CONTROL_SRCUPDATE:
01861                /* Unimportant */
01862                break;
01863             default:
01864                ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", f->subclass);
01865                break;
01866             }
01867             break;
01868          case AST_FRAME_VOICE:
01869             /* Write audio if appropriate */
01870             if (audiofd > -1)
01871                write(audiofd, f->data, f->datalen);
01872          default:
01873             /* Ignore */
01874             break;
01875          }
01876          ast_frfree(f);
01877       }
01878    }
01879 
01880    ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01881 
01882    return 0; /* Time is up */
01883 }

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 1131 of file channel.c.

References channel_find_locked().

Referenced by next_channel().

01133 {
01134    return channel_find_locked(chan, NULL, 0, context, exten);
01135 }

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 1118 of file channel.c.

References channel_find_locked().

Referenced by next_channel().

01120 {
01121    return channel_find_locked(chan, name, namelen, NULL, NULL);
01122 }

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 2572 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, 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(), 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(), wait_for_answer(), and zt_bridge().

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

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 2561 of file channel.c.

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

02562 {
02563    int res;
02564    if (!chan->tech->write_video)
02565       return 0;
02566    res = ast_write(chan, fr);
02567    if (!res)
02568       res = 1;
02569    return res;
02570 }

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 4514 of file channel.c.

References CHANNEL_CLI_RELOAD, CHANNEL_MODULE_LOAD, and CHANNEL_MODULE_RELOAD.

04515 {
04516    switch (reason) {
04517    case CHANNEL_MODULE_LOAD:
04518       return "LOAD (Channel module load)";
04519 
04520    case CHANNEL_MODULE_RELOAD:
04521       return "RELOAD (Channel module reload)";
04522 
04523    case CHANNEL_CLI_RELOAD:
04524       return "CLIRELOAD (Channel module reload by CLI command)";
04525 
04526    default:
04527       return "MANAGERRELOAD (Channel module reload by manager)";
04528    }
04529 };


Generated on Tue Nov 4 13:20:36 2008 for Asterisk - the Open Source PBX by  doxygen 1.4.7