Wed Oct 28 11:46:05 2009

Asterisk developer's documentation


channel.h File Reference

General Asterisk PBX channel definitions. More...

#include "asterisk/abstract_jb.h"
#include "asterisk/poll-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 dependency graph for channel.h:

Go to the source code of this file.

Data Structures

struct  ast_bridge_config
 bridge configuration More...
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::datastores
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  ast_group_info
 channel group info More...
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_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, amaflag,...)
#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   10
#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 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_IN_DTMF = (1 << 12), AST_FLAG_EMULATE_DTMF = (1 << 13),
  AST_FLAG_END_DTMF_ONLY = (1 << 14), AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15), AST_FLAG_MASQ_NOSTREAM = (1 << 16), AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
  AST_FLAG_BRIDGE_HANGUP_DONT = (1 << 18), AST_FLAG_IN_CHANNEL_LIST = (1 << 19)
}
 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_FEATURE_AUTOMIXMON = (1 << 6), AST_FEATURE_NO_H_EXTEN = (1 << 7),
  AST_FEATURE_WARNING_ACTIVE = (1 << 8)
}
 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  ast_t38_state {
  T38_STATE_UNAVAILABLE, T38_STATE_UNKNOWN, T38_STATE_NEGOTIATING, T38_STATE_REJECTED,
  T38_STATE_NEGOTIATED
}
 Possible T38 states on channels. 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

int __ast_answer (struct ast_channel *chan, unsigned int delay, int cdr_answer)
 Answer a channel, with a selectable delay before returning.
struct ast_channel
*attribute_malloc 
__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 *file, int line, const char *function, const char *name_fmt,...)
 Create a channel structure.
struct ast_channel__ast_request_and_dial (const char *type, int format, void *data, int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh)
 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_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 channel.
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.
struct 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.
struct ast_channelast_call_forward (struct ast_channel *caller, struct ast_channel *orig, int *timeout, int format, struct outgoing_helper *oh, int *outstate)
 Forwards a call to a new channel specified by the original channel's call_forward str. If possible, the new forwarded channel is created and returned while the original one is terminated.
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.
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.
struct ast_datastoreast_channel_datastore_alloc (const struct ast_datastore_info *info, const char *uid)
 Create a channel datastore structure.
struct ast_datastoreast_channel_datastore_find (struct ast_channel *chan, const struct ast_datastore_info *info, const 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.
int ast_channel_early_bridge (struct ast_channel *c0, struct ast_channel *c1)
 Bridge two channels together (early).
void ast_channel_free (struct ast_channel *)
 Free a channel structure.
static enum ast_t38_state ast_channel_get_t38_state (struct ast_channel *chan)
 Retrieves the current T38 state of a channel.
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.
int ast_channel_queryoption (struct ast_channel *channel, int option, void *data, int *datalen, int block)
const 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)
void ast_channel_set_fd (struct ast_channel *chan, int which, int fd)
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.
struct 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.
struct ast_channelast_channel_walk_locked (const struct ast_channel *prev)
 Browse channels in use Browse the channels currently in use.
struct 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 whacked 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.
struct ast_channelast_get_channel_by_exten_locked (const char *exten, const char *context)
 Get channel by exten (and optionally context) and lock it.
struct ast_channelast_get_channel_by_name_locked (const char *chan)
 Get channel by name or uniqueid (locks channel).
struct ast_channelast_get_channel_by_name_prefix_locked (const char *name, const int namelen)
 Get channel by name or uniqueid prefix (locks channel).
struct 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.
void ast_poll_channel_add (struct ast_channel *chan0, struct ast_channel *chan1)
void ast_poll_channel_del (struct ast_channel *chan0, struct ast_channel *chan1)
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 one or more frames to a channel's frame queue.
int ast_queue_frame_head (struct ast_channel *chan, struct ast_frame *f)
 Queue one or more frames to the head of a channel's frame queue.
int ast_queue_hangup (struct ast_channel *chan)
 Queue a hangup frame.
int ast_raw_answer (struct ast_channel *chan, int cdr_answer)
 Answer a channel.
struct ast_frameast_read (struct ast_channel *chan)
 Reads a frame.
struct ast_frameast_read_noaudio (struct ast_channel *chan)
 Reads a frame, returning AST_FRAME_NULL frame if audio.
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.
struct ast_channelast_request (const char *type, int format, void *data, int *status)
 Requests a channel.
struct ast_channelast_request_and_dial (const char *type, int format, void *data, int timeout, int *reason, const char *cid_num, const char *cid_name)
 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 specified 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 specified amount of time, looking for hangups and a condition argument.
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, unsigned int duration)
 Send a DTMF digit to a channel Send a DTMF digit to a channel.
int ast_senddigit_begin (struct ast_channel *chan, char digit)
 Send a DTMF digit to a channel Send a DTMF digit to a channel.
int ast_senddigit_end (struct ast_channel *chan, char digit, unsigned int duration)
 Send a DTMF digit to a channel.
int ast_sendtext (struct ast_channel *chan, const char *text)
 Sends text to a channel.
void ast_set_callerid (struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani)
 Set caller ID number, name and 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 component 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 reason)
 Softly hangup up a channel.
int ast_softhangup_nolock (struct ast_channel *chan, int reason)
 Softly hangup up a channel (no channel lock).
const 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.
struct 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.
struct 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.
struct 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.
struct ast_channelast_walk_channel_by_name_prefix_locked (const struct ast_channel *chan, const char *name, const int namelen)
 Get channel by name or uniqueid 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_text (struct ast_channel *chan, struct ast_frame *frame)
 Write text 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.
static void timersub (struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)

Variables

unsigned long global_fin
unsigned long global_fout


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 159 of file channel.h.

Referenced by agent_read().

#define AST_ALERT_FD   (AST_MAX_FDS-1)

used for alertpipe

Definition at line 157 of file channel.h.

Referenced by __ast_channel_alloc_ap(), and restore_channel().

#define AST_BRIDGE_DTMF_CHANNEL_0   (1 << 0)

#define AST_BRIDGE_DTMF_CHANNEL_1   (1 << 1)

#define AST_BRIDGE_IGNORE_SIGS   (1 << 4)

Ignore all signal frames except NULL.

Definition at line 1334 of file channel.h.

Referenced by ast_generic_bridge(), bridge_native_loop(), bridge_p2p_loop(), and iax2_bridge().

#define AST_BRIDGE_REC_CHANNEL_0   (1 << 2)

Return all voice frames on channel 0.

Definition at line 1330 of file channel.h.

#define AST_BRIDGE_REC_CHANNEL_1   (1 << 3)

Return all voice frames on channel 1.

Definition at line 1332 of file channel.h.

#define ast_channel_alloc ( needqueue,
state,
cid_num,
cid_name,
acctcode,
exten,
context,
amaflag,
...   ) 

#define AST_CHANNEL_NAME   80

#define AST_GENERATOR_FD   (AST_MAX_FDS-4)

used by generator

Definition at line 160 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 135 of file channel.h.

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

#define AST_MAX_EXTENSION   80

#define AST_MAX_FDS   10

#define AST_TIMING_FD   (AST_MAX_FDS-2)

used for timingfd

Definition at line 158 of file channel.h.

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

#define CHECK_BLOCKING (  ) 

Definition at line 1709 of file channel.h.

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

#define DATASTORE_INHERIT_FOREVER   INT_MAX

#define DEBUGCHAN_FLAG   0x80000000

The high bit of the frame count is used as a debug marker, so increments of the counters must be done with care. Please use c->fin = FRAMECOUNT_INC(c->fin) and the same for c->fout.

Definition at line 364 of file channel.h.

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

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

Definition at line 367 of file channel.h.

Referenced by __ast_read(), and ast_write().

#define MAX_LANGUAGE   20

Max length of the language setting

Definition at line 137 of file channel.h.

#define MAX_MUSICCLASS   80

Max length of the music class setting

Definition at line 138 of file channel.h.


Typedef Documentation

typedef unsigned long long ast_group_t

Definition at line 169 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 540 of file channel.h.

00540      {
00541    /*! \brief Channels have this property if they can accept input with jitter; 
00542     *         i.e. most VoIP channels */
00543    AST_CHAN_TP_WANTSJITTER = (1 << 0),
00544    /*! \brief Channels have this property if they can create jitter; 
00545     *         i.e. most VoIP channels */
00546    AST_CHAN_TP_CREATESJITTER = (1 << 1),
00547 };

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_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_ANSWERED_ELSEWHERE  Flag to show channels that this call is hangup due to the fact that the call was indeed anwered, but in another channel
AST_FLAG_MASQ_NOSTREAM  This flag indicates that on a masquerade, an active stream should not be carried over
AST_FLAG_BRIDGE_HANGUP_RUN  This flag indicates that the hangup exten was run when the bridge terminated, a message aimed at preventing a subsequent hangup exten being run at the pbx_run level
AST_FLAG_BRIDGE_HANGUP_DONT  This flag indicates that the hangup exten should NOT be run when the bridge terminates, this will allow the hangup in the pbx loop to be run instead.
AST_FLAG_IN_CHANNEL_LIST  This flag indicates whether the channel is in the channel list or not.

Definition at line 550 of file channel.h.

00550      {
00551    /*! Queue incoming dtmf, to be released when this flag is turned off */
00552    AST_FLAG_DEFER_DTMF =    (1 << 1),
00553    /*! write should be interrupt generator */
00554    AST_FLAG_WRITE_INT =     (1 << 2),
00555    /*! a thread is blocking on this channel */
00556    AST_FLAG_BLOCKING =      (1 << 3),
00557    /*! This is a zombie channel */
00558    AST_FLAG_ZOMBIE =        (1 << 4),
00559    /*! There is an exception pending */
00560    AST_FLAG_EXCEPTION =     (1 << 5),
00561    /*! Listening to moh XXX anthm promises me this will disappear XXX */
00562    AST_FLAG_MOH =           (1 << 6),
00563    /*! This channel is spying on another channel */
00564    AST_FLAG_SPYING =        (1 << 7),
00565    /*! This channel is in a native bridge */
00566    AST_FLAG_NBRIDGE =       (1 << 8),
00567    /*! the channel is in an auto-incrementing dialplan processor,
00568     *  so when ->priority is set, it will get incremented before
00569     *  finding the next priority to run */
00570    AST_FLAG_IN_AUTOLOOP =   (1 << 9),
00571    /*! This is an outgoing call */
00572    AST_FLAG_OUTGOING =      (1 << 10),
00573    /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
00574    AST_FLAG_IN_DTMF =       (1 << 12),
00575    /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is 
00576     *  currently being emulated */
00577    AST_FLAG_EMULATE_DTMF =  (1 << 13),
00578    /*! This is set to tell the channel not to generate DTMF begin frames, and
00579     *  to instead only generate END frames. */
00580    AST_FLAG_END_DTMF_ONLY = (1 << 14),
00581    /*! Flag to show channels that this call is hangup due to the fact that the call
00582        was indeed anwered, but in another channel */
00583    AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15),
00584    /*! This flag indicates that on a masquerade, an active stream should not
00585     *  be carried over */
00586    AST_FLAG_MASQ_NOSTREAM = (1 << 16),
00587    /*! This flag indicates that the hangup exten was run when the bridge terminated,
00588     *  a message aimed at preventing a subsequent hangup exten being run at the pbx_run
00589     *  level */
00590    AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
00591    /*! This flag indicates that the hangup exten should NOT be run when the 
00592     *  bridge terminates, this will allow the hangup in the pbx loop to be run instead.
00593     *  */
00594    AST_FLAG_BRIDGE_HANGUP_DONT = (1 << 18),
00595    /*! This flag indicates whether the channel is in the channel list or not. */
00596    AST_FLAG_IN_CHANNEL_LIST = (1 << 19),
00597 };

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 
AST_FEATURE_AUTOMIXMON 
AST_FEATURE_NO_H_EXTEN 
AST_FEATURE_WARNING_ACTIVE 

Definition at line 600 of file channel.h.

00600      {
00601    AST_FEATURE_PLAY_WARNING = (1 << 0),
00602    AST_FEATURE_REDIRECT =     (1 << 1),
00603    AST_FEATURE_DISCONNECT =   (1 << 2),
00604    AST_FEATURE_ATXFER =       (1 << 3),
00605    AST_FEATURE_AUTOMON =      (1 << 4),
00606    AST_FEATURE_PARKCALL =     (1 << 5),
00607    AST_FEATURE_AUTOMIXMON =   (1 << 6),
00608    AST_FEATURE_NO_H_EXTEN =   (1 << 7),
00609    AST_FEATURE_WARNING_ACTIVE = (1 << 8),
00610 };

anonymous enum

Enumerator:
AST_CDR_TRANSFER 
AST_CDR_FORWARD 
AST_CDR_CALLWAIT 
AST_CDR_CONFERENCE 

Definition at line 649 of file channel.h.

00649      {
00650    AST_CDR_TRANSFER =   (1 << 0),
00651    AST_CDR_FORWARD =    (1 << 1),
00652    AST_CDR_CALLWAIT =   (1 << 2),
00653    AST_CDR_CONFERENCE = (1 << 3),
00654 };

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 656 of file channel.h.

00656      {
00657    /*! Soft hangup by device */
00658    AST_SOFTHANGUP_DEV =       (1 << 0),
00659    /*! Soft hangup for async goto */
00660    AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
00661    AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
00662    AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
00663    AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
00664    AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
00665    AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
00666 };

Enumerator:
AST_BRIDGE_COMPLETE 
AST_BRIDGE_FAILED 
AST_BRIDGE_FAILED_NOWARN 
AST_BRIDGE_RETRY 

Definition at line 162 of file channel.h.

00162                        {
00163    AST_BRIDGE_COMPLETE = 0,
00164    AST_BRIDGE_FAILED = -1,
00165    AST_BRIDGE_FAILED_NOWARN = -2,
00166    AST_BRIDGE_RETRY = -3,
00167 };

Enumerator:
AST_ADSI_UNKNOWN 
AST_ADSI_AVAILABLE 
AST_ADSI_UNAVAILABLE 
AST_ADSI_OFFHOOKONLY 

Definition at line 375 of file channel.h.

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 388 of file channel.h.

00388                        {
00389    AST_STATE_DOWN,         /*!< Channel is down and available */
00390    AST_STATE_RESERVED,     /*!< Channel is down, but reserved */
00391    AST_STATE_OFFHOOK,      /*!< Channel is off hook */
00392    AST_STATE_DIALING,      /*!< Digits (or equivalent) have been dialed */
00393    AST_STATE_RING,         /*!< Line is ringing */
00394    AST_STATE_RINGING,      /*!< Remote end is ringing */
00395    AST_STATE_UP,        /*!< Line is up */
00396    AST_STATE_BUSY,         /*!< Line is busy */
00397    AST_STATE_DIALING_OFFHOOK, /*!< Digits (or equivalent) have been dialed while offhook */
00398    AST_STATE_PRERING,      /*!< Channel has detected an incoming call and is waiting for ring */
00399 
00400    AST_STATE_MUTE = (1 << 16),   /*!< Do not transmit voice data */
00401 };

Possible T38 states on channels.

Enumerator:
T38_STATE_UNAVAILABLE  T38 is unavailable on this channel or disabled by configuration
T38_STATE_UNKNOWN  The channel supports T38 but the current status is unknown
T38_STATE_NEGOTIATING  T38 is being negotiated
T38_STATE_REJECTED  Remote side has rejected our offer
T38_STATE_NEGOTIATED  T38 established

Definition at line 406 of file channel.h.

00406                    {
00407    T38_STATE_UNAVAILABLE,  /*!< T38 is unavailable on this channel or disabled by configuration */
00408    T38_STATE_UNKNOWN,   /*!< The channel supports T38 but the current status is unknown */
00409    T38_STATE_NEGOTIATING,  /*!< T38 is being negotiated */
00410    T38_STATE_REJECTED,  /*!< Remote side has rejected our offer */
00411    T38_STATE_NEGOTIATED,   /*!< T38 established */
00412 };

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 670 of file channel.h.


Function Documentation

int __ast_answer ( struct ast_channel chan,
unsigned int  delay,
int  cdr_answer 
)

Answer a channel, with a selectable delay before returning.

Parameters:
chan channel to answer
delay maximum amount of time to wait for incoming media
cdr_answer flag to control whether any associated CDR should be marked as 'answered'
This function answers a channel and handles all necessary call setup functions.

Note:
The channel passed does not need to be locked, but is locked by the function when needed.

This function will wait up to 'delay' milliseconds for media to arrive on the channel before returning to the caller, so that the caller can properly assume the channel is 'ready' for media flow. If 'delay' is less than 500, the function will wait up to 500 milliseconds.

Return values:
0 on success
non-zero on failure

Definition at line 1810 of file channel.c.

References ast_channel::_state, ast_channel_lock, ast_channel_unlock, AST_CONTROL_HANGUP, ast_debug, AST_FRAME_CNG, AST_FRAME_CONTROL, AST_FRAME_DTMF_BEGIN, AST_FRAME_DTMF_END, AST_FRAME_HTML, AST_FRAME_IAX, AST_FRAME_IMAGE, AST_FRAME_MODEM, AST_FRAME_NULL, AST_FRAME_TEXT, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_frfree, ast_frisolate(), AST_LIST_HEAD_INIT_NOLOCK, AST_LIST_HEAD_NOLOCK, AST_LIST_INSERT_HEAD, AST_LIST_REMOVE_HEAD, ast_log(), ast_queue_frame_head(), ast_raw_answer(), ast_read(), AST_STATE_RING, AST_STATE_RINGING, ast_waitfor(), errno, ast_frame::frame_list, frames, ast_frame::frametype, LOG_WARNING, MAX, ast_channel::name, and ast_frame::subclass.

Referenced by ast_answer(), dial_exec_full(), and pbx_builtin_answer().

01811 {
01812    int res = 0;
01813    enum ast_channel_state old_state;
01814 
01815    old_state = chan->_state;
01816    if ((res = ast_raw_answer(chan, cdr_answer))) {
01817       return res;
01818    }
01819 
01820    switch (old_state) {
01821    case AST_STATE_RINGING:
01822    case AST_STATE_RING:
01823       /* wait for media to start flowing, but don't wait any longer
01824        * than 'delay' or 500 milliseconds, whichever is longer
01825        */
01826       do {
01827          AST_LIST_HEAD_NOLOCK(, ast_frame) frames;
01828          struct ast_frame *cur, *new;
01829          int ms = MAX(delay, 500);
01830          unsigned int done = 0;
01831 
01832          AST_LIST_HEAD_INIT_NOLOCK(&frames);
01833 
01834          for (;;) {
01835             ms = ast_waitfor(chan, ms);
01836             if (ms < 0) {
01837                ast_log(LOG_WARNING, "Error condition occurred when polling channel %s for a voice frame: %s\n", chan->name, strerror(errno));
01838                res = -1;
01839                break;
01840             }
01841             if (ms == 0) {
01842                ast_debug(2, "Didn't receive a media frame from %s within %d ms of answering. Continuing anyway\n", chan->name, MAX(delay, 500));
01843                break;
01844             }
01845             cur = ast_read(chan);
01846             if (!cur || ((cur->frametype == AST_FRAME_CONTROL) &&
01847                     (cur->subclass == AST_CONTROL_HANGUP))) {
01848                if (cur) {
01849                   ast_frfree(cur);
01850                }
01851                res = -1;
01852                ast_debug(2, "Hangup of channel %s detected in answer routine\n", chan->name);
01853                break;
01854             }
01855 
01856             if ((new = ast_frisolate(cur)) != cur) {
01857                ast_frfree(cur);
01858             }
01859 
01860             AST_LIST_INSERT_HEAD(&frames, new, frame_list);
01861 
01862             /* if a specific delay period was requested, continue
01863              * until that delay has passed. don't stop just because
01864              * incoming media has arrived.
01865              */
01866             if (delay) {
01867                continue;
01868             }
01869 
01870             switch (new->frametype) {
01871                /* all of these frametypes qualify as 'media' */
01872             case AST_FRAME_VOICE:
01873             case AST_FRAME_VIDEO:
01874             case AST_FRAME_TEXT:
01875             case AST_FRAME_DTMF_BEGIN:
01876             case AST_FRAME_DTMF_END:
01877             case AST_FRAME_IMAGE:
01878             case AST_FRAME_HTML:
01879             case AST_FRAME_MODEM:
01880                done = 1;
01881                break;
01882             case AST_FRAME_CONTROL:
01883             case AST_FRAME_IAX:
01884             case AST_FRAME_NULL:
01885             case AST_FRAME_CNG:
01886                break;
01887             }
01888 
01889             if (done) {
01890                break;
01891             }
01892          }
01893 
01894          if (res == 0) {
01895             ast_channel_lock(chan);
01896             while ((cur = AST_LIST_REMOVE_HEAD(&frames, frame_list))) {
01897                ast_queue_frame_head(chan, cur);
01898                ast_frfree(cur);
01899             }
01900             ast_channel_unlock(chan);
01901          }
01902       } while (0);
01903       break;
01904    default:
01905       break;
01906    }
01907 
01908    return res;
01909 }

struct ast_channel* attribute_malloc __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 *  file,
int  line,
const char *  function,
const char *  name_fmt,
  ... 
) [read]

Create a channel structure.

Return values:
NULL failure
non-NULL successfully allocated channel
Note:
By default, new channels are set to the "s" extension and "default" context.

Definition at line 967 of file channel.c.

References __ast_channel_alloc_ap().

00972 {
00973    va_list ap1, ap2;
00974    struct ast_channel *result;
00975 
00976    va_start(ap1, name_fmt);
00977    va_start(ap2, name_fmt);
00978    result = __ast_channel_alloc_ap(needqueue, state, cid_num, cid_name, acctcode, exten, context,
00979                amaflag, file, line, function, name_fmt, ap1, ap2);
00980    va_end(ap1);
00981    va_end(ap2);
00982 
00983    return result;
00984 }

struct ast_channel* __ast_request_and_dial ( const char *  type,
int  format,
void *  data,
int  timeout,
int *  reason,
const char *  cid_num,
const char *  cid_name,
struct outgoing_helper oh 
) [read]

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 unsuccessful)
cid_num Caller-ID Number
cid_name Caller-ID Name (ascii)
oh Outgoing helper
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 3777 of file channel.c.

References ast_channel::_state, outgoing_helper::account, ast_call(), ast_call_forward(), AST_CAUSE_NO_ANSWER, ast_cdr_alloc(), ast_cdr_disposition(), ast_cdr_end(), ast_cdr_failed(), AST_CDR_FLAG_ORIGINATED, ast_cdr_init(), ast_cdr_setaccount(), ast_cdr_setapp(), ast_cdr_start(), ast_cdr_update(), ast_channel_datastore_inherit(), 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_copy_string(), AST_FRAME_CONTROL, ast_frfree, ast_hangup(), ast_log(), ast_read(), ast_request(), ast_set_callerid(), ast_set_flag, ast_set_variables(), AST_STATE_UP, ast_strlen_zero(), ast_waitfor(), ast_channel::call_forward, 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_frame::frametype, handle_cause(), ast_channel::hangupcause, LOG_NOTICE, outgoing_helper::parent_channel, ast_channel::priority, outgoing_helper::priority, ast_frame::subclass, and outgoing_helper::vars.

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

03778 {
03779    int dummy_outstate;
03780    int cause = 0;
03781    struct ast_channel *chan;
03782    int res = 0;
03783    int last_subclass = 0;
03784    
03785    if (outstate)
03786       *outstate = 0;
03787    else
03788       outstate = &dummy_outstate;   /* make outstate always a valid pointer */
03789 
03790    chan = ast_request(type, format, data, &cause);
03791    if (!chan) {
03792       ast_log(LOG_NOTICE, "Unable to request channel %s/%s\n", type, (char *)data);
03793       handle_cause(cause, outstate);
03794       return NULL;
03795    }
03796 
03797    if (oh) {
03798       if (oh->vars)  
03799          ast_set_variables(chan, oh->vars);
03800       /* XXX why is this necessary, for the parent_channel perhaps ? */
03801       if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name))
03802          ast_set_callerid(chan, oh->cid_num, oh->cid_name, oh->cid_num);
03803       if (oh->parent_channel) {
03804          ast_channel_inherit_variables(oh->parent_channel, chan);
03805          ast_channel_datastore_inherit(oh->parent_channel, chan);
03806       }
03807       if (oh->account)
03808          ast_cdr_setaccount(chan, oh->account); 
03809    }
03810    ast_set_callerid(chan, cid_num, cid_name, cid_num);
03811    ast_set_flag(chan->cdr, AST_CDR_FLAG_ORIGINATED);
03812 
03813    if (ast_call(chan, data, 0)) {   /* ast_call failed... */
03814       ast_log(LOG_NOTICE, "Unable to call channel %s/%s\n", type, (char *)data);
03815    } else {
03816       res = 1; /* mark success in case chan->_state is already AST_STATE_UP */
03817       while (timeout && chan->_state != AST_STATE_UP) {
03818          struct ast_frame *f;
03819          res = ast_waitfor(chan, timeout);
03820          if (res == 0) { /* timeout, treat it like ringing */
03821             *outstate = AST_CONTROL_RINGING;
03822             break;
03823          }
03824          if (res < 0) /* error or done */
03825             break;
03826          if (timeout > -1)
03827             timeout = res;
03828          if (!ast_strlen_zero(chan->call_forward)) {
03829             if (!(chan = ast_call_forward(NULL, chan, &timeout, format, oh, outstate))) {
03830                return NULL;
03831             }
03832             continue;
03833          }
03834 
03835          f = ast_read(chan);
03836          if (!f) {
03837             *outstate = AST_CONTROL_HANGUP;
03838             res = 0;
03839             break;
03840          }
03841          if (f->frametype == AST_FRAME_CONTROL) {
03842             switch (f->subclass) {
03843             case AST_CONTROL_RINGING:  /* record but keep going */
03844                *outstate = f->subclass;
03845                break;
03846 
03847             case AST_CONTROL_BUSY:
03848             case AST_CONTROL_CONGESTION:
03849             case AST_CONTROL_ANSWER:
03850                *outstate = f->subclass;
03851                timeout = 0;      /* trick to force exit from the while() */
03852                break;
03853 
03854             /* Ignore these */
03855             case AST_CONTROL_PROGRESS:
03856             case AST_CONTROL_PROCEEDING:
03857             case AST_CONTROL_HOLD:
03858             case AST_CONTROL_UNHOLD:
03859             case AST_CONTROL_VIDUPDATE:
03860             case AST_CONTROL_SRCUPDATE:
03861             case -1:       /* Ignore -- just stopping indications */
03862                break;
03863 
03864             default:
03865                ast_log(LOG_NOTICE, "Don't know what to do with control frame %d\n", f->subclass);
03866             }
03867             last_subclass = f->subclass;
03868          }
03869          ast_frfree(f);
03870       }
03871    }
03872 
03873    /* Final fixups */
03874    if (oh) {
03875       if (!ast_strlen_zero(oh->context))
03876          ast_copy_string(chan->context, oh->context, sizeof(chan->context));
03877       if (!ast_strlen_zero(oh->exten))
03878          ast_copy_string(chan->exten, oh->exten, sizeof(chan->exten));
03879       if (oh->priority) 
03880          chan->priority = oh->priority;
03881    }
03882    if (chan->_state == AST_STATE_UP)
03883       *outstate = AST_CONTROL_ANSWER;
03884 
03885    if (res <= 0) {
03886       if ( AST_CONTROL_RINGING == last_subclass ) 
03887          chan->hangupcause = AST_CAUSE_NO_ANSWER;
03888       if (!chan->cdr && (chan->cdr = ast_cdr_alloc()))
03889          ast_cdr_init(chan->cdr, chan);
03890       if (chan->cdr) {
03891          char tmp[256];
03892          snprintf(tmp, sizeof(tmp), "%s/%s", type, (char *)data);
03893          ast_cdr_setapp(chan->cdr,"Dial",tmp);
03894          ast_cdr_update(chan);
03895          ast_cdr_start(chan->cdr);
03896          ast_cdr_end(chan->cdr);
03897          /* If the cause wasn't handled properly */
03898          if (ast_cdr_disposition(chan->cdr,chan->hangupcause))
03899             ast_cdr_failed(chan->cdr);
03900       }
03901       ast_hangup(chan);
03902       chan = NULL;
03903    }
03904    return chan;
03905 }

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

Activate a given generator

Definition at line 1961 of file channel.c.

References ast_generator::alloc, ast_channel_lock, ast_channel_unlock, ast_prod(), ast_settimeout(), 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(), old_milliwatt_exec(), and transmit_audio().

01962 {
01963    int res = 0;
01964 
01965    ast_channel_lock(chan);
01966 
01967    if (chan->generatordata) {
01968       if (chan->generator && chan->generator->release)
01969          chan->generator->release(chan, chan->generatordata);
01970       chan->generatordata = NULL;
01971    }
01972 
01973    ast_prod(chan);
01974    if (gen->alloc && !(chan->generatordata = gen->alloc(chan, params))) {
01975       res = -1;
01976    }
01977    
01978    if (!res) {
01979       ast_settimeout(chan, 160, generator_force, chan);
01980       chan->generator = gen;
01981    }
01982 
01983    ast_channel_unlock(chan);
01984 
01985    return res;
01986 }

int ast_active_channels ( void   ) 

returns number of active/allocated channels

Returns number of active/allocated channels

Definition at line 499 of file channel.c.

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, and AST_RWLIST_UNLOCK.

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

00500 {
00501    struct ast_channel *c;
00502    int cnt = 0;
00503    AST_RWLIST_RDLOCK(&channels);
00504    AST_RWLIST_TRAVERSE(&channels, c, chan_list)
00505       cnt++;
00506    AST_RWLIST_UNLOCK(&channels);
00507    return cnt;
00508 }

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 1623 of file channel.h.

Referenced by ast_waitfor_nandfds().

01624 {
01625    pfd->fd = fd;
01626    pfd->events = POLLIN | POLLPRI;
01627    return fd >= 0;
01628 }

int ast_answer ( struct ast_channel chan  ) 

Answer a channel.

Parameters:
chan channel to answer
This function answers a channel and handles all necessary call setup functions.

Note:
The channel passed does not need to be locked, but is locked by the function when needed.

This function will wait up to 500 milliseconds for media to arrive on the channel before returning to the caller, so that the caller can properly assume the channel is 'ready' for media flow.

Return values:
0 on success
non-zero on failure

Definition at line 1911 of file channel.c.

References __ast_answer().

Referenced by action_bridge(), agi_exec_full(), alarmreceiver_exec(), answer_trunk_chan(), app_exec(), ast_control_streamfile(), ast_pickup_call(), auth_exec(), background_detect_exec(), bridge_exec(), builtin_parkcall(), common_exec(), conf_exec(), count_exec(), dahdiras_exec(), dictate_exec(), directory_exec(), disa_exec(), features_answer(), handle_answer(), ices_exec(), login_exec(), minivm_accmess_exec(), minivm_greet_exec(), minivm_record_exec(), old_milliwatt_exec(), park_call_exec(), park_exec(), pbx_builtin_background(), pickup_do(), playback_exec(), privacy_exec(), read_exec(), readexten_exec(), record_exec(), rpt_exec(), sayunixtime_exec(), send_waveform_to_channel(), setup_privacy_args(), skel_exec(), sla_station_exec(), speech_background(), testclient_exec(), testserver_exec(), transmit(), vm_exec(), vm_execmain(), waitforsilence_exec(), and zapateller_exec().

01912 {
01913    return __ast_answer(chan, 0, 1);
01914 }

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 192 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, asent::list, LOG_WARNING, asent::orig_end_dtmf_flag, and asent::use_count.

Referenced by _macro_exec(), acf_curl_exec(), acf_odbc_read(), acf_odbc_write(), ast_dtmf_stream(), ast_get_enum(), ast_get_srv(), ast_get_txt(), bridge_playfile(), builtin_atxfer(), builtin_automixmonitor(), builtin_automonitor(), builtin_blindtransfer(), conf_play(), dial_exec_full(), feature_exec_app(), function_realtime_read(), function_realtime_readdestroy(), function_realtime_store(), function_realtime_write(), lock_read(), lua_autoservice_start(), lua_get_variable_value(), lua_pbx_exec(), lua_set_variable(), lua_set_variable_value(), osplookup_exec(), pbx_find_extension(), shell_helper(), sla_station_exec(), smdi_msg_retrieve_read(), system_exec_helper(), try_calling(), and trylock_read().

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

int ast_autoservice_stop ( struct ast_channel chan  ) 

Stop servicing a channel for us...

Note:
if chan is locked prior to calling ast_autoservice_stop, it is likely that there will be a deadlock between the thread that calls ast_autoservice_stop and the autoservice thread. It is important that chan is not locked prior to this call
Return values:
0 success
-1 error, or the channel has been hungup

Definition at line 251 of file autoservice.c.

References ast_channel::_softhangup, as_chan_list_state, ast_channel_lock, ast_channel_unlock, 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_head(), asthread, asent::chan, asent::deferred_frames, f, ast_frame::frame_list, free, asent::list, asent::orig_end_dtmf_flag, and asent::use_count.

Referenced by _macro_exec(), acf_curl_exec(), acf_odbc_read(), acf_odbc_write(), array(), ast_dtmf_stream(), ast_get_enum(), ast_get_srv(), ast_get_txt(), ast_hangup(), bridge_playfile(), builtin_atxfer(), builtin_automixmonitor(), builtin_automonitor(), conf_play(), dial_exec_full(), feature_exec_app(), finishup(), function_realtime_read(), function_realtime_readdestroy(), function_realtime_store(), function_realtime_write(), lock_read(), lua_autoservice_stop(), lua_get_variable_value(), lua_pbx_exec(), lua_set_variable(), lua_set_variable_value(), osplookup_exec(), pbx_find_extension(), shell_helper(), sla_station_exec(), smdi_msg_retrieve_read(), system_exec_helper(), try_calling(), and trylock_read().

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

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

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_softhangup(), and AST_SOFTHANGUP_SHUTDOWN.

Referenced by quit_handler().

00487 {
00488    struct ast_channel *c;
00489    shutting_down = 1;
00490    if (hangup) {
00491       AST_RWLIST_RDLOCK(&channels);
00492       AST_RWLIST_TRAVERSE(&channels, c, chan_list)
00493          ast_softhangup(c, AST_SOFTHANGUP_SHUTDOWN);
00494       AST_RWLIST_UNLOCK(&channels);
00495    }
00496 }

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

References ARRAY_LEN, 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_SLINEAR16, AST_FORMAT_SPEEX, AST_FORMAT_ULAW, ast_log(), LOG_WARNING, and prefs.

Referenced by __oh323_new(), agent_call(), ast_codec_choose(), ast_iax2_new(), ast_speech_new(), builtin_atxfer(), echo_exec(), findmeexec(), gtalk_new(), handle_open_receive_channel_ack_message(), iax2_request(), jingle_new(), local_new(), login_exec(), mgcp_new(), sip_new(), skinny_new(), skinny_set_rtp_peer(), socket_process(), start_rtp(), transmit_connect(), and unistim_new().

00707 {
00708    /* This just our opinion, expressed in code.  We are asked to choose
00709       the best codec to use, given no information */
00710    int x;
00711    static const int prefs[] =
00712    {
00713       /*! Okay, ulaw is used by all telephony equipment, so start with it */
00714       AST_FORMAT_ULAW,
00715       /*! Unless of course, you're a silly European, so then prefer ALAW */
00716       AST_FORMAT_ALAW,
00717       /*! G.722 is better then all below, but not as common as the above... so give ulaw and alaw priority */
00718       AST_FORMAT_G722,
00719       /*! Okay, well, signed linear is easy to translate into other stuff */
00720       AST_FORMAT_SLINEAR16,
00721       AST_FORMAT_SLINEAR,
00722       /*! G.726 is standard ADPCM, in RFC3551 packing order */
00723       AST_FORMAT_G726,
00724       /*! G.726 is standard ADPCM, in AAL2 packing order */
00725       AST_FORMAT_G726_AAL2,
00726       /*! ADPCM has great sound quality and is still pretty easy to translate */
00727       AST_FORMAT_ADPCM,
00728       /*! Okay, we're down to vocoders now, so pick GSM because it's small and easier to
00729           translate and sounds pretty good */
00730       AST_FORMAT_GSM,
00731       /*! iLBC is not too bad */
00732       AST_FORMAT_ILBC,
00733       /*! Speex is free, but computationally more expensive than GSM */
00734       AST_FORMAT_SPEEX,
00735       /*! Ick, LPC10 sounds terrible, but at least we have code for it, if you're tacky enough
00736           to use it */
00737       AST_FORMAT_LPC10,
00738       /*! G.729a is faster than 723 and slightly less expensive */
00739       AST_FORMAT_G729A,
00740       /*! Down to G.723.1 which is proprietary but at least designed for voice */
00741       AST_FORMAT_G723_1,
00742    };
00743 
00744    /* Strip out video */
00745    fmts &= AST_FORMAT_AUDIO_MASK;
00746    
00747    /* Find the first preferred codec in the format given */
00748    for (x = 0; x < ARRAY_LEN(prefs); x++) {
00749       if (fmts & prefs[x])
00750          return prefs[x];
00751    }
00752 
00753    ast_log(LOG_WARNING, "Don't know any of 0x%x formats\n", fmts);
00754 
00755    return 0;
00756 }

struct ast_channel* ast_bridged_channel ( struct ast_channel chan  )  [read]

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

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

Referenced by __ast_request_and_dial(), agent_call(), ast_call_forward(), ast_feature_request_and_dial(), attempt_reconnect(), begin_dial_channel(), dial_exec_full(), do_forward(), features_call(), findmeexec(), function_ilink(), ring_entry(), rpt(), rpt_exec(), and wait_for_answer().

03969 {
03970    /* Place an outgoing call, but don't wait any longer than timeout ms before returning.
03971       If the remote end does not answer within the timeout, then do NOT hang up, but
03972       return anyway.  */
03973    int res = -1;
03974    /* Stop if we're a zombie or need a soft hangup */
03975    ast_channel_lock(chan);
03976    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
03977       if (chan->cdr)
03978          ast_set_flag(chan->cdr, AST_CDR_FLAG_DIALED);
03979       if (chan->tech->call)
03980          res = chan->tech->call(chan, addr, timeout);
03981       ast_set_flag(chan, AST_FLAG_OUTGOING);
03982    }
03983    ast_channel_unlock(chan);
03984    return res;
03985 }

struct ast_channel* ast_call_forward ( struct ast_channel caller,
struct ast_channel orig,
int *  timeout,
int  format,
struct outgoing_helper oh,
int *  outstate 
) [read]

Forwards a call to a new channel specified by the original channel's call_forward str. If possible, the new forwarded channel is created and returned while the original one is terminated.

Parameters:
caller in channel that requested orig
orig channel being replaced by the call forward channel
timeout maximum amount of time to wait for setup of new forward channel
format requested channel format
oh outgoing helper used with original channel
outstate reason why unsuccessful (if uncuccessful)
Returns:
Returns the forwarded call's ast_channel on success or NULL on failure

Definition at line 3705 of file channel.c.

References outgoing_helper::account, ast_channel::accountcode, accountcode, ast_call(), AST_CDR_FLAG_ORIGINATED, ast_cdr_setaccount(), ast_channel_datastore_inherit(), ast_channel_inherit_variables(), ast_channel_lock, ast_channel_trylock, ast_channel_unlock, ast_copy_flags, ast_copy_string(), ast_hangup(), ast_log(), ast_request(), ast_set_callerid(), ast_set_variables(), ast_string_field_set, ast_strlen_zero(), ast_channel::call_forward, ast_channel::cdr, CHANNEL_DEADLOCK_AVOIDANCE, ast_channel::cid, ast_callerid::cid_name, outgoing_helper::cid_name, ast_callerid::cid_num, outgoing_helper::cid_num, ast_channel::context, handle_cause(), LOG_NOTICE, outgoing_helper::parent_channel, pbx_builtin_getvar_helper(), S_OR, type, and outgoing_helper::vars.

Referenced by __ast_request_and_dial(), and ast_feature_request_and_dial().

03706 {
03707    char tmpchan[256];
03708    struct ast_channel *new = NULL;
03709    char *data, *type;
03710    int cause = 0;
03711 
03712    /* gather data and request the new forward channel */
03713    ast_copy_string(tmpchan, orig->call_forward, sizeof(tmpchan));
03714    if ((data = strchr(tmpchan, '/'))) {
03715       *data++ = '\0';
03716       type = tmpchan;
03717    } else {
03718       const char *forward_context;
03719       ast_channel_lock(orig);
03720       forward_context = pbx_builtin_getvar_helper(orig, "FORWARD_CONTEXT");
03721       snprintf(tmpchan, sizeof(tmpchan), "%s@%s", orig->call_forward, S_OR(forward_context, orig->context));
03722       ast_channel_unlock(orig);
03723       data = tmpchan;
03724       type = "Local";
03725    }
03726    if (!(new = ast_request(type, format, data, &cause))) {
03727       ast_log(LOG_NOTICE, "Unable to create channel for call forward to '%s/%s' (cause = %d)\n", type, data, cause);
03728       handle_cause(cause, outstate);
03729       ast_hangup(orig);
03730       return NULL;
03731    }
03732 
03733    /* Copy/inherit important information into new channel */
03734    if (oh) {
03735       if (oh->vars) {
03736          ast_set_variables(new, oh->vars);
03737       }
03738       if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name)) {
03739          ast_set_callerid(new, oh->cid_num, oh->cid_name, oh->cid_num);
03740       }
03741       if (oh->parent_channel) {
03742          ast_channel_inherit_variables(oh->parent_channel, new);
03743          ast_channel_datastore_inherit(oh->parent_channel, new);
03744       }
03745       if (oh->account) {
03746          ast_cdr_setaccount(new, oh->account);
03747       }
03748    } else if (caller) { /* no outgoing helper so use caller if avaliable */
03749       ast_channel_inherit_variables(caller, new);
03750       ast_channel_datastore_inherit(caller, new);
03751    }
03752 
03753    ast_channel_lock(orig);
03754    while (ast_channel_trylock(new)) {
03755       CHANNEL_DEADLOCK_AVOIDANCE(orig);
03756    }
03757    ast_copy_flags(new->cdr, orig->cdr, AST_CDR_FLAG_ORIGINATED);
03758    ast_string_field_set(new, accountcode, orig->accountcode);
03759    if (!ast_strlen_zero(orig->cid.cid_num) && !ast_strlen_zero(new->cid.cid_name)) {
03760       ast_set_callerid(new, orig->cid.cid_num, orig->cid.cid_name, orig->cid.cid_num);
03761    }
03762    ast_channel_unlock(new);
03763    ast_channel_unlock(orig);
03764 
03765    /* call new channel */
03766    if ((*timeout = ast_call(new, data, 0))) {
03767       ast_log(LOG_NOTICE, "Unable to call forward to channel %s/%s\n", type, (char *)data);
03768       ast_hangup(orig);
03769       ast_hangup(new);
03770       return NULL;
03771    }
03772    ast_hangup(orig);
03773 
03774    return new;
03775 }

void ast_cancel_shutdown ( void   ) 

Cancel a shutdown in progress.

Cancels an existing shutdown and returns to normal operation

Definition at line 511 of file channel.c.

Referenced by handle_abort_shutdown().

00512 {
00513    shutting_down = 0;
00514 }

const char* ast_cause2str ( int  state  ) 

Gives the string form of a given hangup cause.

Gives the string form of a given cause code

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

References ARRAY_LEN, causes, and ast_cause::desc.

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

00625 {
00626    int x;
00627 
00628    for (x = 0; x < ARRAY_LEN(causes); x++) {
00629       if (causes[x].cause == cause)
00630          return causes[x].desc;
00631    }
00632 
00633    return "Unknown";
00634 }

void ast_change_name ( struct ast_channel chan,
char *  newname 
)

Change channel name.

Note:
The channel must be locked before calling this function.

Definition at line 4220 of file channel.c.

References ast_string_field_set, EVENT_FLAG_CALL, manager_event, name, ast_channel::name, and ast_channel::uniqueid.

04221 {
04222    manager_event(EVENT_FLAG_CALL, "Rename", "Channel: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", chan->name, newname, chan->uniqueid);
04223    ast_string_field_set(chan, name, newname);
04224 }

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 4947 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_debug, AST_FEATURE_PLAY_WARNING, AST_FEATURE_WARNING_ACTIVE, AST_FLAG_END_DTMF_ONLY, AST_FLAG_NBRIDGE, AST_FLAG_ZOMBIE, ast_generic_bridge(), ast_indicate(), ast_log(), ast_samp2tv(), ast_set_flag, AST_SOFTHANGUP_UNBRIDGE, ast_test_flag, ast_tvadd(), ast_tvdiff_ms(), ast_tvnow(), ast_tvsub(), ast_tvzero(), ast_verb, ast_channel::audiohooks, ast_channel_tech::bridge, bridge_playfile(), ast_channel::cid, ast_callerid::cid_num, ast_bridge_config::end_sound, EVENT_FLAG_CALL, ast_bridge_config::feature_timer, ast_bridge_config::features_callee, ast_bridge_config::features_caller, ast_bridge_config::firstpass, ast_bridge_config::flags, ast_channel::generator, LOG_WARNING, manager_bridge_event(), manager_event, ast_channel::masq, ast_channel::masqr, ast_channel::monitor, ast_channel::name, ast_channel::nativeformats, ast_bridge_config::nexteventts, ast_bridge_config::play_warning, ast_channel::readformat, ast_channel_tech::send_digit_begin, ast_bridge_config::start_sound, ast_bridge_config::start_time, ast_channel::tech, ast_bridge_config::timelimit, ast_channel::uniqueid, update_bridge_vars(), ast_bridge_config::warning_freq, ast_bridge_config::warning_sound, and ast_channel::writeformat.

Referenced by ast_bridge_call().

04949 {
04950    struct ast_channel *who = NULL;
04951    enum ast_bridge_result res = AST_BRIDGE_COMPLETE;
04952    int nativefailed=0;
04953    int firstpass;
04954    int o0nativeformats;
04955    int o1nativeformats;
04956    long time_left_ms=0;
04957    char caller_warning = 0;
04958    char callee_warning = 0;
04959 
04960    if (c0->_bridge) {
04961       ast_log(LOG_WARNING, "%s is already in a bridge with %s\n",
04962          c0->name, c0->_bridge->name);
04963       return -1;
04964    }
04965    if (c1->_bridge) {
04966       ast_log(LOG_WARNING, "%s is already in a bridge with %s\n",
04967          c1->name, c1->_bridge->name);
04968       return -1;
04969    }
04970    
04971    /* Stop if we're a zombie or need a soft hangup */
04972    if (ast_test_flag(c0, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c0) ||
04973        ast_test_flag(c1, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c1))
04974       return -1;
04975 
04976    *fo = NULL;
04977    firstpass = config->firstpass;
04978    config->firstpass = 0;
04979 
04980    if (ast_tvzero(config->start_time))
04981       config->start_time = ast_tvnow();
04982    time_left_ms = config->timelimit;
04983 
04984    caller_warning = ast_test_flag(&config->features_caller, AST_FEATURE_PLAY_WARNING);
04985    callee_warning = ast_test_flag(&config->features_callee, AST_FEATURE_PLAY_WARNING);
04986 
04987    if (config->start_sound && firstpass) {
04988       if (caller_warning)
04989          bridge_playfile(c0, c1, config->start_sound, time_left_ms / 1000);
04990       if (callee_warning)
04991          bridge_playfile(c1, c0, config->start_sound, time_left_ms / 1000);
04992    }
04993 
04994    /* Keep track of bridge */
04995    c0->_bridge = c1;
04996    c1->_bridge = c0;
04997 
04998 
04999    o0nativeformats = c0->nativeformats;
05000    o1nativeformats = c1->nativeformats;
05001 
05002    if (config->feature_timer && !ast_tvzero(config->nexteventts)) {
05003       config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->feature_timer, 1000));
05004    } else if (config->timelimit && firstpass) {
05005       config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->timelimit, 1000));
05006       if (caller_warning || callee_warning)
05007          config->nexteventts = ast_tvsub(config->nexteventts, ast_samp2tv(config->play_warning, 1000));
05008    }
05009 
05010    if (!c0->tech->send_digit_begin)
05011       ast_set_flag(c1, AST_FLAG_END_DTMF_ONLY);
05012    if (!c1->tech->send_digit_begin)
05013       ast_set_flag(c0, AST_FLAG_END_DTMF_ONLY);
05014    manager_bridge_event(1, 1, c0, c1);
05015 
05016    /* Before we enter in and bridge these two together tell them both the source of audio has changed */
05017    ast_indicate(c0, AST_CONTROL_SRCUPDATE);
05018    ast_indicate(c1, AST_CONTROL_SRCUPDATE);
05019 
05020    for (/* ever */;;) {
05021       struct timeval now = { 0, };
05022       int to;
05023 
05024       to = -1;
05025 
05026       if (!ast_tvzero(config->nexteventts)) {
05027          now = ast_tvnow();
05028          to = ast_tvdiff_ms(config->nexteventts, now);
05029          if (to <= 0) {
05030             if (!config->timelimit) {
05031                res = AST_BRIDGE_COMPLETE;
05032                break;
05033             }
05034             to = 0;
05035          }
05036       }
05037 
05038       if (config->timelimit) {
05039          time_left_ms = config->timelimit - ast_tvdiff_ms(now, config->start_time);
05040          if (time_left_ms < to)
05041             to = time_left_ms;
05042 
05043          if (time_left_ms <= 0) {
05044             if (caller_warning && config->end_sound)
05045                bridge_playfile(c0, c1, config->end_sound, 0);
05046             if (callee_warning && config->end_sound)
05047                bridge_playfile(c1, c0, config->end_sound, 0);
05048             *fo = NULL;
05049             if (who)
05050                *rc = who;
05051             res = 0;
05052             break;
05053          }
05054 
05055          if (!to) {
05056             if (time_left_ms >= 5000 && config->warning_sound && config->play_warning && ast_test_flag(config, AST_FEATURE_WARNING_ACTIVE)) {
05057                int t = (time_left_ms + 500) / 1000; /* round to nearest second */
05058                if (caller_warning)
05059                   bridge_playfile(c0, c1, config->warning_sound, t);
05060                if (callee_warning)
05061                   bridge_playfile(c1, c0, config->warning_sound, t);
05062             }
05063             if (config->warning_freq && (time_left_ms > (config->warning_freq + 5000)))
05064                config->nexteventts = ast_tvadd(config->nexteventts, ast_samp2tv(config->warning_freq, 1000));
05065             else
05066                config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->timelimit, 1000));
05067          }
05068          ast_clear_flag(config, AST_FEATURE_WARNING_ACTIVE);
05069       }
05070 
05071       if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE || c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE) {
05072          if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
05073             c0->_softhangup = 0;
05074          if (c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
05075             c1->_softhangup = 0;
05076          c0->_bridge = c1;
05077          c1->_bridge = c0;
05078          ast_debug(1, "Unbridge signal received. Ending native bridge.\n");
05079          continue;
05080       }
05081 
05082       /* Stop if we're a zombie or need a soft hangup */
05083       if (ast_test_flag(c0, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c0) ||
05084           ast_test_flag(c1, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c1)) {
05085          *fo = NULL;
05086          if (who)
05087             *rc = who;
05088          res = 0;
05089          ast_debug(1, "Bridge stops because we're zombie or need a soft hangup: c0=%s, c1=%s, flags: %s,%s,%s,%s\n",
05090             c0->name, c1->name,
05091             ast_test_flag(c0, AST_FLAG_ZOMBIE) ? "Yes" : "No",
05092             ast_check_hangup(c0) ? "Yes" : "No",
05093             ast_test_flag(c1, AST_FLAG_ZOMBIE) ? "Yes" : "No",
05094             ast_check_hangup(c1) ? "Yes" : "No");
05095          break;
05096       }
05097 
05098       update_bridge_vars(c0, c1);
05099 
05100       if (c0->tech->bridge &&
05101           (c0->tech->bridge == c1->tech->bridge) &&
05102           !nativefailed && !c0->monitor && !c1->monitor &&
05103           !c0->audiohooks && !c1->audiohooks && 
05104           !c0->masq && !c0->masqr && !c1->masq && !c1->masqr) {
05105          /* Looks like they share a bridge method and nothing else is in the way */
05106          ast_set_flag(c0, AST_FLAG_NBRIDGE);
05107          ast_set_flag(c1, AST_FLAG_NBRIDGE);
05108          if ((res = c0->tech->bridge(c0, c1, config->flags, fo, rc, to)) == AST_BRIDGE_COMPLETE) {
05109             /* \todo  XXX here should check that cid_num is not NULL */
05110             manager_event(EVENT_FLAG_CALL, "Unlink",
05111                      "Channel1: %s\r\n"
05112                      "Channel2: %s\r\n"
05113                      "Uniqueid1: %s\r\n"
05114                      "Uniqueid2: %s\r\n"
05115                      "CallerID1: %s\r\n"
05116                      "CallerID2: %s\r\n",
05117                      c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
05118             ast_debug(1, "Returning from native bridge, channels: %s, %s\n", c0->name, c1->name);
05119 
05120             ast_clear_flag(c0, AST_FLAG_NBRIDGE);
05121             ast_clear_flag(c1, AST_FLAG_NBRIDGE);
05122 
05123             if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE || c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
05124                continue;
05125 
05126             c0->_bridge = NULL;
05127             c1->_bridge = NULL;
05128 
05129             return res;
05130          } else {
05131             ast_clear_flag(c0, AST_FLAG_NBRIDGE);
05132             ast_clear_flag(c1, AST_FLAG_NBRIDGE);
05133          }
05134          switch (res) {
05135          case AST_BRIDGE_RETRY:
05136             if (config->play_warning) {
05137                ast_set_flag(config, AST_FEATURE_WARNING_ACTIVE);
05138             }
05139             continue;
05140          default:
05141             ast_verb(3, "Native bridging %s and %s ended\n", c0->name, c1->name);
05142             /* fallthrough */
05143          case AST_BRIDGE_FAILED_NOWARN:
05144             nativefailed++;
05145             break;
05146          }
05147       }
05148 
05149       if (((c0->writeformat != c1->readformat) || (c0->readformat != c1->writeformat) ||
05150           (c0->nativeformats != o0nativeformats) || (c1->nativeformats != o1nativeformats)) &&
05151           !(c0->generator || c1->generator)) {
05152          if (ast_channel_make_compatible(c0, c1)) {
05153             ast_log(LOG_WARNING, "Can't make %s and %s compatible\n", c0->name, c1->name);
05154             manager_bridge_event(0, 1, c0, c1);
05155             return AST_BRIDGE_FAILED;
05156          }
05157          o0nativeformats = c0->nativeformats;
05158          o1nativeformats = c1->nativeformats;
05159       }
05160 
05161       update_bridge_vars(c0, c1);
05162 
05163       res = ast_generic_bridge(c0, c1, config, fo, rc, config->nexteventts);
05164       if (res != AST_BRIDGE_RETRY) {
05165          break;
05166       } else if (config->feature_timer) {
05167          /* feature timer expired but has not been updated, sending to ast_bridge_call to do so */
05168          break;
05169       }
05170    }
05171 
05172    ast_clear_flag(c0, AST_FLAG_END_DTMF_ONLY);
05173    ast_clear_flag(c1, AST_FLAG_END_DTMF_ONLY);
05174 
05175    /* Now that we have broken the bridge the source will change yet again */
05176    ast_indicate(c0, AST_CONTROL_SRCUPDATE);
05177    ast_indicate(c1, AST_CONTROL_SRCUPDATE);
05178 
05179    c0->_bridge = NULL;
05180    c1->_bridge = NULL;
05181 
05182    /* \todo  XXX here should check that cid_num is not NULL */
05183    manager_event(EVENT_FLAG_CALL, "Unlink",
05184             "Channel1: %s\r\n"
05185             "Channel2: %s\r\n"
05186             "Uniqueid1: %s\r\n"
05187             "Uniqueid2: %s\r\n"
05188             "CallerID1: %s\r\n"
05189             "CallerID2: %s\r\n",
05190             c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
05191    ast_debug(1, "Bridge stops bridging channels %s and %s\n", c0->name, c1->name);
05192 
05193    return res;
05194 }

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 return -1.

Definition at line 531 of file channel.c.

References ast_channel::whentohangup.

00532 {
00533    time_t whentohangup;
00534 
00535    if (!chan->whentohangup)
00536       return (offset == 0) ? 0 : -1;
00537 
00538    if (!offset) /* XXX why is this special? */
00539       return 1;
00540 
00541    whentohangup = offset + time(NULL);
00542 
00543    if (chan->whentohangup < whentohangup)
00544       return 1;
00545    else if (chan->whentohangup == whentohangup)
00546       return 0;
00547    else
00548       return -1;
00549 }

int ast_channel_datastore_add ( struct ast_channel chan,
struct ast_datastore datastore 
)

Add a datastore to a channel.

Note:
The channel should be locked before calling this function.
Return values:
0 success
non-zero failure

Definition at line 1498 of file channel.c.

References AST_LIST_INSERT_HEAD, and ast_channel::datastores.

Referenced by _macro_exec(), acf_iaxvar_write(), acf_odbc_read(), add_features_datastores(), add_to_agi(), ast_iax2_new(), authenticate_reply(), dial_exec_full(), dundi_query_read(), enable_jack_hook(), enum_query_read(), get_lock(), gosub_exec(), lua_get_state(), pbx_builtin_raise_exception(), setup_chanspy_ds(), setup_inheritance_datastore(), setup_mixmonitor_ds(), setup_transfer_datastore(), shared_write(), smdi_msg_retrieve_read(), socket_process(), speech_create(), try_calling(), and volume_write().

01499 {
01500    int res = 0;
01501 
01502    AST_LIST_INSERT_HEAD(&chan->datastores, datastore, entry);
01503 
01504    return res;
01505 }

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

Create a channel datastore structure.

Note:
None of the datastore API calls lock the ast_channel they are using. So, the channel should be locked before calling the functions that take a channel argument.

Definition at line 1437 of file channel.c.

References ast_calloc, ast_strdup, ast_datastore::info, and ast_datastore::uid.

Referenced by _macro_exec(), acf_iaxvar_write(), acf_odbc_read(), add_features_datastores(), add_to_agi(), ast_channel_datastore_inherit(), ast_iax2_new(), authenticate_reply(), dial_exec_full(), dundi_query_read(), enable_jack_hook(), enum_query_read(), get_lock(), gosub_exec(), lua_get_state(), pbx_builtin_raise_exception(), setup_chanspy_ds(), setup_inheritance_datastore(), setup_mixmonitor_ds(), setup_transfer_datastore(), shared_write(), smdi_msg_retrieve_read(), socket_process(), speech_create(), try_calling(), and volume_write().

01438 {
01439    struct ast_datastore *datastore = NULL;
01440 
01441    /* Make sure we at least have type so we can identify this */
01442    if (!info) {
01443       return NULL;
01444    }
01445 
01446    /* Allocate memory for datastore and clear it */
01447    datastore = ast_calloc(1, sizeof(*datastore));
01448    if (!datastore) {
01449       return NULL;
01450    }
01451 
01452    datastore->info = info;
01453 
01454    datastore->uid = ast_strdup(uid);
01455 
01456    return datastore;
01457 }

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

Find a datastore on a channel.

Note:
The channel should be locked before calling this function.

The datastore returned from this function must not be used if the reference to the channel is released.

Definition at line 1512 of file channel.c.

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

Referenced by _macro_exec(), acf_exception_read(), acf_fetch(), acf_iaxvar_read(), acf_iaxvar_write(), add_agi_cmd(), add_features_datastores(), add_to_agi(), attended_transfer_occurred(), builtin_atxfer(), chanspy_ds_free(), dial_exec_full(), disable_jack_hook(), do_parking_thread(), dundi_result_read(), enable_jack_hook(), enum_result_read(), exec_odbcfinish(), find_speech(), func_inheritance_write(), get_agi_cmd(), get_lock(), gosub_exec(), iax2_call(), jack_hook_callback(), local_read(), local_write(), lock_fixup(), lua_get_state(), park_exec(), pbx_builtin_raise_exception(), pop_exec(), queue_transfer_fixup(), return_exec(), shared_read(), shared_write(), smdi_msg_read(), speech_background(), speech_destroy(), stop_mixmonitor_exec(), try_calling(), unlock_read(), volume_callback(), and volume_write().

01513 {
01514    struct ast_datastore *datastore = NULL;
01515    
01516    if (info == NULL)
01517       return NULL;
01518 
01519    AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->datastores, datastore, entry) {
01520       if (datastore->info == info) {
01521          if (uid != NULL && datastore->uid != NULL) {
01522             if (!strcasecmp(uid, datastore->uid)) {
01523                /* Matched by type AND uid */
01524                break;
01525             }
01526          } else {
01527             /* Matched by type at least */
01528             break;
01529          }
01530       }
01531    }
01532    AST_LIST_TRAVERSE_SAFE_END
01533 
01534    return datastore;
01535 }

int ast_channel_datastore_free ( struct ast_datastore datastore  ) 

Free a channel datastore structure.

Definition at line 1459 of file channel.c.

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

Referenced by acf_fetch(), add_features_datastores(), add_to_agi(), ast_channel_free(), ast_iax2_new(), authenticate_reply(), chanspy_ds_free(), dial_exec_full(), disable_jack_hook(), exec_odbcfinish(), get_lock(), gosub_exec(), lua_get_state(), pbx_builtin_raise_exception(), setup_inheritance_datastore(), shared_write(), socket_process(), try_calling(), and volume_write().

01460 {
01461    int res = 0;
01462 
01463    /* Using the destroy function (if present) destroy the data */
01464    if (datastore->info->destroy != NULL && datastore->data != NULL) {
01465       datastore->info->destroy(datastore->data);
01466       datastore->data = NULL;
01467    }
01468 
01469    /* Free allocated UID memory */
01470    if (datastore->uid != NULL) {
01471       ast_free((void *) datastore->uid);
01472       datastore->uid = NULL;
01473    }
01474 
01475    /* Finally free memory used by ourselves */
01476    ast_free(datastore);
01477 
01478    return res;
01479 }

int ast_channel_datastore_inherit ( struct ast_channel from,
struct ast_channel to 
)

Inherit datastores from a parent to a child.

Definition at line 1481 of file channel.c.

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

Referenced by __ast_request_and_dial(), ast_call_forward(), dial_exec_full(), do_forward(), findmeexec(), local_call(), ring_entry(), and wait_for_answer().

01482 {
01483    struct ast_datastore *datastore = NULL, *datastore2;
01484 
01485    AST_LIST_TRAVERSE(&from->datastores, datastore, entry) {
01486       if (datastore->inheritance > 0) {
01487          datastore2 = ast_channel_datastore_alloc(datastore->info, datastore->uid);
01488          if (datastore2) {
01489             datastore2->data = datastore->info->duplicate ? datastore->info->duplicate(datastore->data) : NULL;
01490             datastore2->inheritance = datastore->inheritance == DATASTORE_INHERIT_FOREVER ? DATASTORE_INHERIT_FOREVER : datastore->inheritance - 1;
01491             AST_LIST_INSERT_TAIL(&to->datastores, datastore2, entry);
01492          }
01493       }
01494    }
01495    return 0;
01496 }

int ast_channel_datastore_remove ( struct ast_channel chan,
struct ast_datastore datastore 
)

Remove a datastore from a channel.

Note:
The channel should be locked before calling this function.
Return values:
0 success
non-zero failure

Definition at line 1507 of file channel.c.

References AST_LIST_REMOVE, and ast_channel::datastores.

Referenced by acf_fetch(), chanspy_ds_free(), dial_exec_full(), disable_jack_hook(), exec_odbcfinish(), lua_get_state(), queue_transfer_fixup(), speech_background(), speech_destroy(), and try_calling().

01508 {
01509    return AST_LIST_REMOVE(&chan->datastores, datastore, entry) ? 0 : -1;
01510 }

int ast_channel_defer_dtmf ( struct ast_channel chan  ) 

Set defer DTMF flag on channel.

Defers DTMF

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

References AST_FLAG_DEFER_DTMF, ast_set_flag, and ast_test_flag.

Referenced by __adsi_transmit_messages(), and find_cache().

01123 {
01124    int pre = 0;
01125 
01126    if (chan) {
01127       pre = ast_test_flag(chan, AST_FLAG_DEFER_DTMF);
01128       ast_set_flag(chan, AST_FLAG_DEFER_DTMF);
01129    }
01130    return pre;
01131 }

int ast_channel_early_bridge ( struct ast_channel c0,
struct ast_channel c1 
)

Bridge two channels together (early).

Bridge two channels together (early)

Parameters:
c0 first channel to bridge
c1 second channel to bridge Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
Returns:
Returns 0 on success and -1 if it could not be done

Definition at line 4876 of file channel.c.

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

Referenced by dial_exec_full(), and wait_for_answer().

04877 {
04878    /* Make sure we can early bridge, if not error out */
04879    if (!c0->tech->early_bridge || (c1 && (!c1->tech->early_bridge || c0->tech->early_bridge != c1->tech->early_bridge)))
04880       return -1;
04881 
04882    return c0->tech->early_bridge(c0, c1);
04883 }

void ast_channel_free ( struct ast_channel  ) 

Free a channel structure.

Definition at line 1328 of file channel.c.

References ast_channel::alertpipe, ast_app_group_discard(), ast_cdr_discard(), ast_channel_datastore_free(), ast_channel_lock, AST_CHANNEL_NAME, ast_channel_unlock, ast_copy_string(), ast_debug, ast_device_state_changed_literal(), AST_FLAG_IN_CHANNEL_LIST, ast_free, ast_frfree, ast_jb_destroy(), AST_LIST_REMOVE_HEAD, ast_log(), AST_MAX_FDS, ast_moh_cleanup(), ast_mutex_destroy(), AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_string_field_free_memory, ast_test_flag, ast_translator_free_path(), ast_var_delete(), ast_channel::cdr, ast_channel::cid, ast_channel::datastores, f, free, free_cid(), ast_channel::lock_dont_use, LOG_WARNING, ast_channel::monitor, ast_channel::music_state, ast_channel::name, name, ast_channel::pbx, ast_channel::readq, 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(), action_getvar(), 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(), rotate_file(), sendmail(), and sendpage().

01329 {
01330    int fd;
01331 #ifdef HAVE_EPOLL
01332    int i;
01333 #endif
01334    struct ast_var_t *vardata;
01335    struct ast_frame *f;
01336    struct varshead *headp;
01337    struct ast_datastore *datastore = NULL;
01338    char name[AST_CHANNEL_NAME], *dashptr;
01339    int inlist;
01340    
01341    headp=&chan->varshead;
01342    
01343    inlist = ast_test_flag(chan, AST_FLAG_IN_CHANNEL_LIST);
01344    if (inlist) {
01345       AST_RWLIST_WRLOCK(&channels);
01346       if (!AST_RWLIST_REMOVE(&channels, chan, chan_list)) {
01347          ast_debug(1, "Unable to find channel in list to free. Assuming it has already been done.\n");
01348       }
01349       /* Lock and unlock the channel just to be sure nobody has it locked still
01350          due to a reference retrieved from the channel list. */
01351       ast_channel_lock(chan);
01352       ast_channel_unlock(chan);
01353    }
01354 
01355    /* Get rid of each of the data stores on the channel */
01356    while ((datastore = AST_LIST_REMOVE_HEAD(&chan->datastores, entry)))
01357       /* Free the data store */
01358       ast_channel_datastore_free(datastore);
01359 
01360    /* Lock and unlock the channel just to be sure nobody has it locked still
01361       due to a reference that was stored in a datastore. (i.e. app_chanspy) */
01362    ast_channel_lock(chan);
01363    ast_channel_unlock(chan);
01364 
01365    if (chan->tech_pvt) {
01366       ast_log(LOG_WARNING, "Channel '%s' may not have been hung up properly\n", chan->name);
01367       ast_free(chan->tech_pvt);
01368    }
01369 
01370    if (chan->sched)
01371       sched_context_destroy(chan->sched);
01372 
01373    ast_copy_string(name, chan->name, sizeof(name));
01374    if ((dashptr = strrchr(name, '-'))) {
01375       *dashptr = '\0';
01376    }
01377 
01378    /* Stop monitoring */
01379    if (chan->monitor)
01380       chan->monitor->stop( chan, 0 );
01381 
01382    /* If there is native format music-on-hold state, free it */
01383    if (chan->music_state)
01384       ast_moh_cleanup(chan);
01385 
01386    /* Free translators */
01387    if (chan->readtrans)
01388       ast_translator_free_path(chan->readtrans);
01389    if (chan->writetrans)
01390       ast_translator_free_path(chan->writetrans);
01391    if (chan->pbx)
01392       ast_log(LOG_WARNING, "PBX may not have been terminated properly on '%s'\n", chan->name);
01393    free_cid(&chan->cid);
01394    /* Close pipes if appropriate */
01395    if ((fd = chan->alertpipe[0]) > -1)
01396       close(fd);
01397    if ((fd = chan->alertpipe[1]) > -1)
01398       close(fd);
01399    if ((fd = chan->timingfd) > -1)
01400       close(fd);
01401 #ifdef HAVE_EPOLL
01402    for (i = 0; i < AST_MAX_FDS; i++) {
01403       if (chan->epfd_data[i])
01404          free(chan->epfd_data[i]);
01405    }
01406    close(chan->epfd);
01407 #endif
01408    while ((f = AST_LIST_REMOVE_HEAD(&chan->readq, frame_list)))
01409       ast_frfree(f);
01410    
01411    /* loop over the variables list, freeing all data and deleting list items */
01412    /* no need to lock the list, as the channel is already locked */
01413    
01414    while ((vardata = AST_LIST_REMOVE_HEAD(headp, entries)))
01415       ast_var_delete(vardata);
01416 
01417    ast_app_group_discard(chan);
01418 
01419    /* Destroy the jitterbuffer */
01420    ast_jb_destroy(chan);
01421 
01422    if (chan->cdr) {
01423       ast_cdr_discard(chan->cdr);
01424       chan->cdr = NULL;
01425    }
01426    
01427    ast_mutex_destroy(&chan->lock_dont_use);
01428 
01429    ast_string_field_free_memory(chan);
01430    ast_free(chan);
01431    if (inlist)
01432       AST_RWLIST_UNLOCK(&channels);
01433 
01434    ast_device_state_changed_literal(name);
01435 }

static enum ast_t38_state ast_channel_get_t38_state ( struct ast_channel chan  )  [inline, static]

Retrieves the current T38 state of a channel.

Definition at line 1699 of file channel.h.

References ast_channel_queryoption(), AST_OPTION_T38_STATE, and T38_STATE_UNAVAILABLE.

Referenced by transmit(), transmit_audio(), and transmit_t38().

01700 {
01701    enum ast_t38_state state = T38_STATE_UNAVAILABLE;
01702    int datalen = sizeof(state);
01703 
01704    ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
01705 
01706    return state;
01707 }

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

References ast_debug, AST_LIST_INSERT_TAIL, AST_LIST_TRAVERSE, ast_var_assign(), ast_var_full_name(), ast_var_name(), ast_var_value(), ast_var_t::entries, and ast_channel::varshead.

Referenced by __ast_request_and_dial(), agent_call(), ast_call_forward(), ast_feature_request_and_dial(), begin_dial_channel(), dial_exec_full(), do_forward(), findmeexec(), ring_entry(), and wait_for_answer().

04227 {
04228    struct ast_var_t *current, *newvar;
04229    const char *varname;
04230 
04231    AST_LIST_TRAVERSE(&parent->varshead, current, entries) {
04232       int vartype = 0;
04233 
04234       varname = ast_var_full_name(current);
04235       if (!varname)
04236          continue;
04237 
04238       if (varname[0] == '_') {
04239          vartype = 1;
04240          if (varname[1] == '_')
04241             vartype = 2;
04242       }
04243 
04244       switch (vartype) {
04245       case 1:
04246          newvar = ast_var_assign(&varname[1], ast_var_value(current));
04247          if (newvar) {
04248             AST_LIST_INSERT_TAIL(&child->varshead, newvar, entries);
04249             ast_debug(1, "Copying soft-transferable variable %s.\n", ast_var_name(newvar));
04250          }
04251          break;
04252       case 2:
04253          newvar = ast_var_assign(varname, ast_var_value(current));
04254          if (newvar) {
04255             AST_LIST_INSERT_TAIL(&child->varshead, newvar, entries);
04256             ast_debug(1, "Copying hard-transferable variable %s.\n", ast_var_name(newvar));
04257          }
04258          break;
04259       default:
04260          ast_debug(1, "Not copying variable %s.\n", ast_var_name(current));
04261          break;
04262       }
04263    }
04264 }

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

References ast_channel_make_compatible_helper().

Referenced by action_bridge(), app_exec(), ast_channel_bridge(), bridge_exec(), check_compat(), dial_exec_full(), do_forward(), park_exec(), try_calling(), and wait_for_answer().

04125 {
04126    /* Some callers do not check return code, and we must try to set all call legs correctly */
04127    int rc = 0;
04128 
04129    /* Set up translation from the chan to the peer */
04130    rc = ast_channel_make_compatible_helper(chan, peer);
04131 
04132    if (rc < 0)
04133       return rc;
04134 
04135    /* Set up translation from the peer to the chan */
04136    rc = ast_channel_make_compatible_helper(peer, chan);
04137 
04138    return rc;
04139 }

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.

Note:
Neither channel passed here needs to be locked before calling this function.

Definition at line 4141 of file channel.c.

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

Referenced by ast_async_goto(), ast_pickup_call(), attempt_transfer(), builtin_atxfer(), check_availability(), check_bridge(), check_goto_on_transfer(), do_bridge_masquerade(), handle_invite_replaces(), iax_park(), masq_park_call(), misdn_attempt_transfer(), pickup_do(), and sip_park().

04142 {
04143    int res = -1;
04144    struct ast_channel *final_orig, *final_clone, *base;
04145 
04146 retrymasq:
04147    final_orig = original;
04148    final_clone = clone;
04149 
04150    ast_channel_lock(original);
04151    while (ast_channel_trylock(clone)) {
04152       ast_channel_unlock(original);
04153       usleep(1);
04154       ast_channel_lock(original);
04155    }
04156 
04157    /* each of these channels may be sitting behind a channel proxy (i.e. chan_agent)
04158       and if so, we don't really want to masquerade it, but its proxy */
04159    if (original->_bridge && (original->_bridge != ast_bridged_channel(original)) && (original->_bridge->_bridge != original))
04160       final_orig = original->_bridge;
04161 
04162    if (clone->_bridge && (clone->_bridge != ast_bridged_channel(clone)) && (clone->_bridge->_bridge != clone))
04163       final_clone = clone->_bridge;
04164    
04165    if (final_clone->tech->get_base_channel && (base = final_clone->tech->get_base_channel(final_clone))) {
04166       final_clone = base;
04167    }
04168 
04169    if ((final_orig != original) || (final_clone != clone)) {
04170       /* Lots and lots of deadlock avoidance.  The main one we're competing with
04171        * is ast_write(), which locks channels recursively, when working with a
04172        * proxy channel. */
04173       if (ast_channel_trylock(final_orig)) {
04174          ast_channel_unlock(clone);
04175          ast_channel_unlock(original);
04176          goto retrymasq;
04177       }
04178       if (ast_channel_trylock(final_clone)) {
04179          ast_channel_unlock(final_orig);
04180          ast_channel_unlock(clone);
04181          ast_channel_unlock(original);
04182          goto retrymasq;
04183       }
04184       ast_channel_unlock(clone);
04185       ast_channel_unlock(original);
04186       original = final_orig;
04187       clone = final_clone;
04188    }
04189 
04190    if (original == clone) {
04191       ast_log(LOG_WARNING, "Can't masquerade channel '%s' into itself!\n", original->name);
04192       ast_channel_unlock(clone);
04193       ast_channel_unlock(original);
04194       return -1;
04195    }
04196 
04197    ast_debug(1, "Planning to masquerade channel %s into the structure of %s\n",
04198       clone->name, original->name);
04199    if (original->masq) {
04200       ast_log(LOG_WARNING, "%s is already going to masquerade as %s\n",
04201          original->masq->name, original->name);
04202    } else if (clone->masqr) {
04203       ast_log(LOG_WARNING, "%s is already going to masquerade as %s\n",
04204          clone->name, clone->masqr->name);
04205    } else {
04206       original->masq = clone;
04207       clone->masqr = original;
04208       ast_queue_frame(original, &ast_null_frame);
04209       ast_queue_frame(clone, &ast_null_frame);
04210       ast_debug(1, "Done planning to masquerade channel %s into the structure of %s\n", clone->name, original->name);
04211       res = 0;
04212    }
04213 
04214    ast_channel_unlock(clone);
04215    ast_channel_unlock(original);
04216 
04217    return res;
04218 }

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

Checks the value of an option

Query the value of an option Works similarly to setoption except only reads the options.

Definition at line 5210 of file channel.c.

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

Referenced by ast_channel_get_t38_state().

05211 {
05212    if (!chan->tech->queryoption) {
05213       errno = ENOSYS;
05214       return -1;
05215    }
05216 
05217    if (block)
05218       ast_log(LOG_ERROR, "XXX Blocking not implemented yet XXX\n");
05219 
05220    return chan->tech->queryoption(chan, option, data, datalen);
05221 }

const 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 3669 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().

03670 {
03671    switch (reason) /* the following appear to be the only ones actually returned by request_and_dial */
03672    {
03673    case 0:
03674       return "Call Failure (not BUSY, and not NO_ANSWER, maybe Circuit busy or down?)";
03675    case AST_CONTROL_HANGUP:
03676       return "Hangup";
03677    case AST_CONTROL_RING:
03678       return "Local Ring";
03679    case AST_CONTROL_RINGING:
03680       return "Remote end Ringing";
03681    case AST_CONTROL_ANSWER:
03682       return "Remote end has Answered";
03683    case AST_CONTROL_BUSY:
03684       return "Remote end is Busy";
03685    case AST_CONTROL_CONGESTION:
03686       return "Congestion (circuits busy)";
03687    default:
03688       return "Unknown Reason!!";
03689    }
03690 }

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

References ast_calloc, ast_debug, AST_LIST_INSERT_HEAD, AST_LIST_TRAVERSE, ast_log(), AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, ast_channel_tech::description, LOG_WARNING, chanlist::tech, and ast_channel_tech::type.

Referenced by load_module(), and unload_module().

00553 {
00554    struct chanlist *chan;
00555 
00556    AST_RWLIST_WRLOCK(&channels);
00557 
00558    AST_LIST_TRAVERSE(&backends, chan, list) {
00559       if (!strcasecmp(tech->type, chan->tech->type)) {
00560          ast_log(LOG_WARNING, "Already have a handler for type '%s'\n", tech->type);
00561          AST_RWLIST_UNLOCK(&channels);
00562          return -1;
00563       }
00564    }
00565    
00566    if (!(chan = ast_calloc(1, sizeof(*chan)))) {
00567       AST_RWLIST_UNLOCK(&channels);
00568       return -1;
00569    }
00570    chan->tech = tech;
00571    AST_LIST_INSERT_HEAD(&backends, chan, list);
00572 
00573    ast_debug(1, "Registered handler for '%s' (%s)\n", chan->tech->type, chan->tech->description);
00574 
00575    ast_verb(2, "Registered channel type '%s' (%s)\n", chan->tech->type, chan->tech->description);
00576 
00577    AST_RWLIST_UNLOCK(&channels);
00578    return 0;
00579 }

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

Sends HTML on given channel

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

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

04071 {
04072    if (chan->tech->send_html)
04073       return chan->tech->send_html(chan, subclass, data, datalen);
04074    return -1;
04075 }

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

Sends a URL on a given link

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

Definition at line 4077 of file channel.c.

References ast_channel_sendhtml(), and AST_HTML_URL.

Referenced by dial_exec_full(), sendurl_exec(), and try_calling().

04078 {
04079    return ast_channel_sendhtml(chan, AST_HTML_URL, url, strlen(url) + 1);
04080 }

void ast_channel_set_fd ( struct ast_channel chan,
int  which,
int  fd 
)

Set the file descriptor on the channel

Definition at line 1538 of file channel.c.

References ast_calloc, ast_epoll_data::chan, ast_channel::fds, free, and ast_epoll_data::which.

Referenced by __ast_channel_alloc_ap(), __oh323_new(), __oh323_rtp_create(), __oh323_update_info(), alsa_new(), ast_deactivate_generator(), ast_do_masquerade(), dahdi_new(), gtalk_new(), jingle_new(), mgcp_new(), misdn_new(), nbs_new(), oss_new(), phone_new(), restore_channel(), setformat(), sip_new(), skinny_new(), start_rtp(), swap_subs(), and update_features().

01539 {
01540 #ifdef HAVE_EPOLL
01541    struct epoll_event ev;
01542    struct ast_epoll_data *aed = NULL;
01543 
01544    if (chan->fds[which] > -1) {
01545       epoll_ctl(chan->epfd, EPOLL_CTL_DEL, chan->fds[which], &ev);
01546       aed = chan->epfd_data[which];
01547    }
01548 
01549    /* If this new fd is valid, add it to the epoll */
01550    if (fd > -1) {
01551       if (!aed && (!(aed = ast_calloc(1, sizeof(*aed)))))
01552          return;
01553       
01554       chan->epfd_data[which] = aed;
01555       aed->chan = chan;
01556       aed->which = which;
01557       
01558       ev.events = EPOLLIN | EPOLLPRI | EPOLLERR | EPOLLHUP;
01559       ev.data.ptr = aed;
01560       epoll_ctl(chan->epfd, EPOLL_CTL_ADD, fd, &ev);
01561    } else if (aed) {
01562       /* We don't have to keep around this epoll data structure now */
01563       free(aed);
01564       chan->epfd_data[which] = NULL;
01565    }
01566 #endif
01567    chan->fds[which] = fd;
01568    return;
01569 }

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

Sets an option on a channel.

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

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

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

05198 {
05199    if (!chan->tech->setoption) {
05200       errno = ENOSYS;
05201       return -1;
05202    }
05203 
05204    if (block)
05205       ast_log(LOG_ERROR, "XXX Blocking not implemented yet XXX\n");
05206 
05207    return chan->tech->setoption(chan, option, data, datalen);
05208 }

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

Note:
This function does not require that the channel is locked before calling it.
Returns:
Nothing

Definition at line 523 of file channel.c.

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

Referenced by action_timeout(), and timeout_write().

00524 {
00525    chan->whentohangup = offset ? time(NULL) + offset : 0;
00526    ast_queue_frame(chan, &ast_null_frame);
00527    return;
00528 }

struct ast_silence_generator* ast_channel_start_silence_generator ( struct ast_channel chan  )  [read]

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

References ast_activate_generator(), ast_calloc, ast_debug, AST_FORMAT_SLINEAR, ast_free, ast_log(), ast_set_write_format(), LOG_ERROR, ast_channel::name, ast_silence_generator::old_write_format, and ast_channel::writeformat.

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

05531 {
05532    struct ast_silence_generator *state;
05533 
05534    if (!(state = ast_calloc(1, sizeof(*state)))) {
05535       return NULL;
05536    }
05537 
05538    state->old_write_format = chan->writeformat;
05539 
05540    if (ast_set_write_format(chan, AST_FORMAT_SLINEAR) < 0) {
05541       ast_log(LOG_ERROR, "Could not set write format to SLINEAR\n");
05542       ast_free(state);
05543       return NULL;
05544    }
05545 
05546    ast_activate_generator(chan, &silence_generator, state);
05547 
05548    ast_debug(1, "Started silence generator on '%s'\n", chan->name);
05549 
05550    return state;
05551 }

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

References ast_deactivate_generator(), ast_debug, ast_free, ast_log(), ast_set_write_format(), LOG_ERROR, ast_channel::name, and ast_silence_generator::old_write_format.

Referenced by __ast_play_and_record(), ast_dtmf_stream(), channel_spy(), HandleCallOutgoing(), key_dial_page(), record_exec(), and unistim_hangup().

05554 {
05555    if (!state)
05556       return;
05557 
05558    ast_deactivate_generator(chan);
05559 
05560    ast_debug(1, "Stopped silence generator on '%s'\n", chan->name);
05561 
05562    if (ast_set_write_format(chan, state->old_write_format) < 0)
05563       ast_log(LOG_ERROR, "Could not return write format to its original state\n");
05564 
05565    ast_free(state);
05566 }

int ast_channel_supports_html ( struct ast_channel channel  ) 

Checks for HTML support on a channel

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

Definition at line 4065 of file channel.c.

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

Referenced by dial_exec_full(), sendurl_exec(), and try_calling().

04066 {
04067    return (chan->tech->send_html) ? 1 : 0;
04068 }

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

References ast_clear_flag, and AST_FLAG_DEFER_DTMF.

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

01135 {
01136    if (chan)
01137       ast_clear_flag(chan, AST_FLAG_DEFER_DTMF);
01138 }

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

References ast_debug, ast_free, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, chanlist::tech, and ast_channel_tech::type.

Referenced by __unload_module(), load_module(), and unload_module().

00583 {
00584    struct chanlist *chan;
00585 
00586    ast_debug(1, "Unregistering channel type '%s'\n", tech->type);
00587 
00588    AST_RWLIST_WRLOCK(&channels);
00589 
00590    AST_LIST_TRAVERSE_SAFE_BEGIN(&backends, chan, list) {
00591       if (chan->tech == tech) {
00592          AST_LIST_REMOVE_CURRENT(list);
00593          ast_free(chan);
00594          ast_verb(2, "Unregistered channel type '%s'\n", tech->type);
00595          break;   
00596       }
00597    }
00598    AST_LIST_TRAVERSE_SAFE_END;
00599 
00600    AST_RWLIST_UNLOCK(&channels);
00601 }

struct ast_channel* ast_channel_walk_locked ( const struct ast_channel prev  )  [read]

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

References channel_find_locked().

Referenced by action_coreshowchannels(), action_status(), ast_complete_channels(), ast_pickup_call(), conf_exec(), handle_chanlist(), handle_core_set_debug_channel(), next_channel(), pickup_by_exten(), and pickup_by_mark().

01249 {
01250    return channel_find_locked(prev, NULL, 0, NULL, NULL);
01251 }

struct ast_variable* ast_channeltype_list ( void   )  [read]

return an ast_variable list of channeltypes

Definition at line 188 of file channel.c.

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

00189 {
00190    struct chanlist *cl;
00191    struct ast_variable *var=NULL, *prev = NULL;
00192    AST_LIST_TRAVERSE(&backends, cl, list) {
00193       if (prev)  {
00194          if ((prev->next = ast_variable_new(cl->tech->type, cl->tech->description, "")))
00195             prev = prev->next;
00196       } else {
00197          var = ast_variable_new(cl->tech->type, cl->tech->description, "");
00198          prev = var;
00199       }
00200    }
00201    return var;
00202 }

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

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

Referenced by __ast_pbx_run(), __ast_read(), _macro_exec(), action_redirect(), agent_indicate(), agi_exec(), agi_handle_command(), announce_thread(), ast_bridge_call(), ast_bridge_call_thread(), ast_call(), ast_channel_bridge(), ast_check_hangup_locked(), ast_feature_request_and_dial(), ast_indicate_data(), ast_raw_answer(), ast_readstring_full(), ast_recvtext(), ast_rtp_bridge(), ast_sendtext(), ast_transfer(), ast_udptl_bridge(), ast_waitfordigit_full(), ast_write(), autoservice_run(), bridge_exec(), bridge_native_loop(), bridge_p2p_loop(), builtin_atxfer(), channel_spy(), check_bridge(), common_exec(), conf_play(), conf_run(), dahdi_sendtext(), dahdi_setoption(), dial_exec_full(), dundi_lookup_internal(), eagi_exec(), eivr_comm(), findmeexec(), handle_sendimage(), iax2_bridge(), launch_asyncagi(), lua_check_hangup(), ospfinished_exec(), pbx_exec(), read_exec(), readexten_exec(), rpt(), rpt_exec(), run_ras(), try_calling(), and wait_for_answer().

00465 {
00466    if (chan->_softhangup)     /* yes if soft hangup flag set */
00467       return 1;
00468    if (!chan->whentohangup)   /* no if no hangup scheduled */
00469       return 0;
00470    if (chan->whentohangup > time(NULL))   /* no if hangup time has not come yet. */
00471       return 0;
00472    chan->_softhangup |= AST_SOFTHANGUP_TIMEOUT; /* record event */
00473    return 1;
00474 }

void ast_deactivate_generator ( struct ast_channel chan  ) 

int ast_do_masquerade ( struct ast_channel original  ) 

Start masquerading a channel XXX This is a seriously whacked 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.

Parameters:
chan Channel to masquerade
Start masquerading a channel XXX This is a seriously whacked 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 4317 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_NAME, ast_channel_set_fd(), ast_channel_unlock, ast_copy_string(), ast_debug, AST_FLAG_BLOCKING, AST_FLAG_EXCEPTION, AST_FLAG_OUTGOING, 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_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, 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_state2str(), 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::datastores, errno, EVENT_FLAG_CALL, ast_channel::fdno, ast_channel::fds, ast_channel_tech::fixup, free_translation(), ast_channel_tech::hangup, ast_channel::hangupcause, ast_datastore::info, ast_channel::language, language, ast_channel::lock_dont_use, LOG_WARNING, manager_event, ast_channel::masq, ast_channel::masqr, ast_channel::monitor, ast_channel::musicclass, musicclass, name, ast_channel::name, ast_channel::nativeformats, ast_channel::rawreadformat, ast_channel::rawwriteformat, ast_channel::readformat, ast_channel::readq, report_new_callerid(), ast_channel::tech, ast_channel::tech_pvt, ast_channel::timingfd, ast_channel_tech::type, ast_channel::uniqueid, ast_channel::visible_indication, and ast_channel::writeformat.

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

04318 {
04319    int x,i;
04320    int res=0;
04321    int origstate;
04322    struct ast_frame *cur;
04323    const struct ast_channel_tech *t;
04324    void *t_pvt;
04325    struct ast_callerid tmpcid;
04326    struct ast_channel *clone = original->masq;
04327    struct ast_cdr *cdr;
04328    int rformat = original->readformat;
04329    int wformat = original->writeformat;
04330    char newn[AST_CHANNEL_NAME];
04331    char orig[AST_CHANNEL_NAME];
04332    char masqn[AST_CHANNEL_NAME];
04333    char zombn[AST_CHANNEL_NAME];
04334 
04335    ast_debug(4, "Actually Masquerading %s(%d) into the structure of %s(%d)\n",
04336       clone->name, clone->_state, original->name, original->_state);
04337 
04338    manager_event(EVENT_FLAG_CALL, "Masquerade", "Clone: %s\r\nCloneState: %s\r\nOriginal: %s\r\nOriginalState: %s\r\n",
04339             clone->name, ast_state2str(clone->_state), original->name, ast_state2str(original->_state));
04340 
04341    /* XXX This operation is a bit odd.  We're essentially putting the guts of
04342     * the clone channel into the original channel.  Start by killing off the
04343     * original channel's backend.  While the features are nice, which is the
04344     * reason we're keeping it, it's still awesomely weird. XXX */
04345 
04346    /* We need the clone's lock, too */
04347    ast_channel_lock(clone);
04348 
04349    ast_debug(2, "Got clone lock for masquerade on '%s' at %p\n", clone->name, &clone->lock_dont_use);
04350 
04351    /* Having remembered the original read/write formats, we turn off any translation on either
04352       one */
04353    free_translation(clone);
04354    free_translation(original);
04355 
04356 
04357    /* Unlink the masquerade */
04358    original->masq = NULL;
04359    clone->masqr = NULL;
04360    
04361    /* Save the original name */
04362    ast_copy_string(orig, original->name, sizeof(orig));
04363    /* Save the new name */
04364    ast_copy_string(newn, clone->name, sizeof(newn));
04365    /* Create the masq name */
04366    snprintf(masqn, sizeof(masqn), "%s<MASQ>", newn);
04367       
04368    /* Copy the name from the clone channel */
04369    ast_string_field_set(original, name, newn);
04370 
04371    /* Mangle the name of the clone channel */
04372    ast_string_field_set(clone, name, masqn);
04373    
04374    /* Notify any managers of the change, first the masq then the other */
04375    manager_event(EVENT_FLAG_CALL, "Rename", "Channel: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", newn, masqn, clone->uniqueid);
04376    manager_event(EVENT_FLAG_CALL, "Rename", "Channel: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", orig, newn, original->uniqueid);
04377 
04378    /* Swap the technologies */   
04379    t = original->tech;
04380    original->tech = clone->tech;
04381    clone->tech = t;
04382 
04383    /* Swap the cdrs */
04384    cdr = original->cdr;
04385    original->cdr = clone->cdr;
04386    clone->cdr = cdr;
04387 
04388    t_pvt = original->tech_pvt;
04389    original->tech_pvt = clone->tech_pvt;
04390    clone->tech_pvt = t_pvt;
04391 
04392    /* Swap the alertpipes */
04393    for (i = 0; i < 2; i++) {
04394       x = original->alertpipe[i];
04395       original->alertpipe[i] = clone->alertpipe[i];
04396       clone->alertpipe[i] = x;
04397    }
04398 
04399    /* 
04400     * Swap the readq's.  The end result should be this:
04401     *
04402     *  1) All frames should be on the new (original) channel.
04403     *  2) Any frames that were already on the new channel before this
04404     *     masquerade need to be at the end of the readq, after all of the
04405     *     frames on the old (clone) channel.
04406     *  3) The alertpipe needs to get poked for every frame that was already
04407     *     on the new channel, since we are now using the alert pipe from the
04408     *     old (clone) channel.
04409     */
04410    {
04411       AST_LIST_HEAD_NOLOCK(, ast_frame) tmp_readq;
04412       AST_LIST_HEAD_SET_NOLOCK(&tmp_readq, NULL);
04413 
04414       AST_LIST_APPEND_LIST(&tmp_readq, &original->readq, frame_list);
04415       AST_LIST_APPEND_LIST(&original->readq, &clone->readq, frame_list);
04416 
04417       while ((cur = AST_LIST_REMOVE_HEAD(&tmp_readq, frame_list))) {
04418          AST_LIST_INSERT_TAIL(&original->readq, cur, frame_list);
04419          if (original->alertpipe[1] > -1) {
04420             int poke = 0;
04421 
04422             if (write(original->alertpipe[1], &poke, sizeof(poke)) < 0) {
04423                ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
04424             }
04425          }
04426       }
04427    }
04428 
04429    /* Swap the raw formats */
04430    x = original->rawreadformat;
04431    original->rawreadformat = clone->rawreadformat;
04432    clone->rawreadformat = x;
04433    x = original->rawwriteformat;
04434    original->rawwriteformat = clone->rawwriteformat;
04435    clone->rawwriteformat = x;
04436 
04437    clone->_softhangup = AST_SOFTHANGUP_DEV;
04438 
04439    /* And of course, so does our current state.  Note we need not
04440       call ast_setstate since the event manager doesn't really consider
04441       these separate.  We do this early so that the clone has the proper
04442       state of the original channel. */
04443    origstate = original->_state;
04444    original->_state = clone->_state;
04445    clone->_state = origstate;
04446 
04447    if (clone->tech->fixup){
04448       res = clone->tech->fixup(original, clone);
04449       if (res)
04450          ast_log(LOG_WARNING, "Fixup failed on channel %s, strange things may happen.\n", clone->name);
04451    }
04452 
04453    /* Start by disconnecting the original's physical side */
04454    if (clone->tech->hangup)
04455       res = clone->tech->hangup(clone);
04456    if (res) {
04457       ast_log(LOG_WARNING, "Hangup failed!  Strange things may happen!\n");
04458       ast_channel_unlock(clone);
04459       return -1;
04460    }
04461 
04462    snprintf(zombn, sizeof(zombn), "%s<ZOMBIE>", orig);
04463    /* Mangle the name of the clone channel */
04464    ast_string_field_set(clone, name, zombn);
04465    manager_event(EVENT_FLAG_CALL, "Rename", "Channel: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", masqn, zombn, clone->uniqueid);
04466 
04467    /* Update the type. */
04468    t_pvt = original->monitor;
04469    original->monitor = clone->monitor;
04470    clone->monitor = t_pvt;
04471 
04472    /* Keep the same language.  */
04473    ast_string_field_set(original, language, clone->language);
04474    /* Copy the FD's other than the generator fd */
04475    for (x = 0; x < AST_MAX_FDS; x++) {
04476       if (x != AST_GENERATOR_FD)
04477          ast_channel_set_fd(original, x, clone->fds[x]);
04478    }
04479 
04480    ast_app_group_update(clone, original);
04481 
04482    /* Move data stores over */
04483    if (AST_LIST_FIRST(&clone->datastores)) {
04484       struct ast_datastore *ds;
04485       /* We use a safe traversal here because some fixup routines actually
04486        * remove the datastore from the list and free them.
04487        */
04488       AST_LIST_TRAVERSE_SAFE_BEGIN(&clone->datastores, ds, entry) {
04489          if (ds->info->chan_fixup)
04490             ds->info->chan_fixup(ds->data, clone, original);
04491       }
04492       AST_LIST_TRAVERSE_SAFE_END;
04493       AST_LIST_APPEND_LIST(&original->datastores, &clone->datastores, entry);
04494    }
04495 
04496    clone_variables(original, clone);
04497    /* Presense of ADSI capable CPE follows clone */
04498    original->adsicpe = clone->adsicpe;
04499    /* Bridge remains the same */
04500    /* CDR fields remain the same */
04501    /* XXX What about blocking, softhangup, blocker, and lock and blockproc? XXX */
04502    /* Application and data remain the same */
04503    /* Clone exception  becomes real one, as with fdno */
04504    ast_set_flag(original, ast_test_flag(clone, AST_FLAG_OUTGOING | AST_FLAG_EXCEPTION));
04505    original->fdno = clone->fdno;
04506    /* Schedule context remains the same */
04507    /* Stream stuff stays the same */
04508    /* Keep the original state.  The fixup code will need to work with it most likely */
04509 
04510    /* Just swap the whole structures, nevermind the allocations, they'll work themselves
04511       out. */
04512    tmpcid = original->cid;
04513    original->cid = clone->cid;
04514    clone->cid = tmpcid;
04515    report_new_callerid(original);
04516 
04517    /* Restore original timing file descriptor */
04518    ast_channel_set_fd(original, AST_TIMING_FD, original->timingfd);
04519 
04520    /* Our native formats are different now */
04521    original->nativeformats = clone->nativeformats;
04522 
04523    /* Context, extension, priority, app data, jump table,  remain the same */
04524    /* pvt switches.  pbx stays the same, as does next */
04525 
04526    /* Set the write format */
04527    ast_set_write_format(original, wformat);
04528 
04529    /* Set the read format */
04530    ast_set_read_format(original, rformat);
04531 
04532    /* Copy the music class */
04533    ast_string_field_set(original, musicclass, clone->musicclass);
04534 
04535    ast_debug(1, "Putting channel %s in %d/%d formats\n", original->name, wformat, rformat);
04536 
04537    /* Okay.  Last thing is to let the channel driver know about all this mess, so he
04538       can fix up everything as best as possible */
04539    if (original->tech->fixup) {
04540       res = original->tech->fixup(clone, original);
04541       if (res) {
04542          ast_log(LOG_WARNING, "Channel for type '%s' could not fixup channel %s\n",
04543             original->tech->type, original->name);
04544          ast_channel_unlock(clone);
04545          return -1;
04546       }
04547    } else
04548       ast_log(LOG_WARNING, "Channel type '%s' does not have a fixup routine (for %s)!  Bad things may happen.\n",
04549          original->tech->type, original->name);
04550 
04551    /* 
04552     * If an indication is currently playing, maintain it on the channel 
04553     * that is taking the place of original 
04554     *
04555     * This is needed because the masquerade is swapping out in the internals
04556     * of this channel, and the new channel private data needs to be made
04557     * aware of the current visible indication (RINGING, CONGESTION, etc.)
04558     */
04559    if (original->visible_indication) {
04560       ast_indicate(original, original->visible_indication);
04561    }
04562    
04563    /* Now, at this point, the "clone" channel is totally F'd up.  We mark it as
04564       a zombie so nothing tries to touch it.  If it's already been marked as a
04565       zombie, then free it now (since it already is considered invalid). */
04566    if (ast_test_flag(clone, AST_FLAG_ZOMBIE)) {
04567       ast_debug(1, "Destroying channel clone '%s'\n", clone->name);
04568       ast_channel_unlock(clone);
04569       manager_event(EVENT_FLAG_CALL, "Hangup",
04570          "Channel: %s\r\n"
04571          "Uniqueid: %s\r\n"
04572          "Cause: %d\r\n"
04573          "Cause-txt: %s\r\n",
04574          clone->name,
04575          clone->uniqueid,
04576          clone->hangupcause,
04577          ast_cause2str(clone->hangupcause)
04578          );
04579       ast_channel_free(clone);
04580    } else {
04581       ast_debug(1, "Released clone lock on '%s'\n", clone->name);
04582       ast_set_flag(clone, AST_FLAG_ZOMBIE);
04583       ast_queue_frame(clone, &ast_null_frame);
04584       ast_channel_unlock(clone);
04585    }
04586 
04587    /* Signal any blocker */
04588    if (ast_test_flag(original, AST_FLAG_BLOCKING))
04589       pthread_kill(original->blocker, SIGURG);
04590    ast_debug(1, "Done Masquerading %s (%d)\n", original->name, original->_state);
04591    return 0;
04592 }

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 1631 of file channel.h.

References dummy().

Referenced by do_monitor().

01632 {
01633    int x;
01634    int dummy=0;
01635 
01636    if (fd < 0)
01637       return 0;
01638    if (!start)
01639       start = &dummy;
01640    for (x = *start; x<max; x++)
01641       if (pfds[x].fd == fd) {
01642          if (x == *start)
01643             (*start)++;
01644          return pfds[x].revents;
01645       }
01646    return 0;
01647 }

struct ast_channel* ast_get_channel_by_exten_locked ( const char *  exten,
const char *  context 
) [read]

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

Definition at line 1273 of file channel.c.

References channel_find_locked().

01274 {
01275    return channel_find_locked(NULL, NULL, 0, context, exten);
01276 }

struct ast_channel* ast_get_channel_by_name_locked ( const char *  name  )  [read]

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

Get channel by name or uniqueid prefix (locks channel).

Definition at line 1260 of file channel.c.

References channel_find_locked().

Referenced by action_bridge(), ast_parse_device_state(), bridge_exec(), common_exec(), handle_cli_mixmonitor(), shared_read(), and shared_write().

01261 {
01262    return channel_find_locked(NULL, name, namelen, NULL, NULL);
01263 }

struct ast_channel_tech* ast_get_channel_tech ( const char *  name  )  [read]

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

References AST_LIST_TRAVERSE, AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, chanlist::tech, and ast_channel_tech::type.

Referenced by _ast_device_state().

00605 {
00606    struct chanlist *chanls;
00607    const struct ast_channel_tech *ret = NULL;
00608 
00609    AST_RWLIST_RDLOCK(&channels);
00610 
00611    AST_LIST_TRAVERSE(&backends, chanls, list) {
00612       if (!strcasecmp(name, chanls->tech->type)) {
00613          ret = chanls->tech;
00614          break;
00615       }
00616    }
00617 
00618    AST_RWLIST_UNLOCK(&channels);
00619    
00620    return ret;
00621 }

ast_group_t ast_get_group ( const char *  s  ) 

Definition at line 5375 of file channel.c.

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

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

05376 {
05377    char *piece;
05378    char *c;
05379    int start=0, finish=0, x;
05380    ast_group_t group = 0;
05381 
05382    if (ast_strlen_zero(s))
05383       return 0;
05384 
05385    c = ast_strdupa(s);
05386    
05387    while ((piece = strsep(&c, ","))) {
05388       if (sscanf(piece, "%30d-%30d", &start, &finish) == 2) {
05389          /* Range */
05390       } else if (sscanf(piece, "%30d", &start)) {
05391          /* Just one */
05392          finish = start;
05393       } else {
05394          ast_log(LOG_ERROR, "Syntax error parsing group configuration '%s' at '%s'. Ignoring.\n", s, piece);
05395          continue;
05396       }
05397       for (x = start; x <= finish; x++) {
05398          if ((x > 63) || (x < 0)) {
05399             ast_log(LOG_WARNING, "Ignoring invalid group %d (maximum group is 63)\n", x);
05400          } else
05401             group |= ((ast_group_t) 1 << x);
05402       }
05403    }
05404    return group;
05405 }

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

References ast_assert, ast_audiohook_detach_list(), ast_autoservice_stop(), ast_cause2str(), ast_cdr_detach(), ast_cdr_end(), AST_CDR_FLAG_BRIDGED, AST_CDR_FLAG_DIALED, AST_CDR_FLAG_POST_DISABLED, AST_CDR_NULL, ast_channel_free(), ast_channel_lock, ast_channel_unlock, ast_clear_flag, ast_closestream(), ast_debug, ast_do_masquerade(), AST_FLAG_BLOCKING, AST_FLAG_IN_CHANNEL_LIST, AST_FLAG_ZOMBIE, ast_log(), AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_set_flag, ast_test_flag, ast_channel::audiohooks, ast_channel::blocker, ast_channel::blockproc, ast_channel::cdr, ast_channel::cid, ast_callerid::cid_name, ast_callerid::cid_num, ast_cdr::disposition, EVENT_FLAG_CALL, free_translation(), ast_channel::generator, ast_channel::generatordata, ast_channel_tech::hangup, ast_channel::hangupcause, LOG_ERROR, LOG_WARNING, manager_event, ast_channel::masq, ast_channel::masqr, ast_channel::name, ast_generator::release, S_OR, ast_channel::sched, sched_context_destroy(), ast_channel::stream, ast_channel::tech, ast_channel::uniqueid, and ast_channel::vstream.

Referenced by __ast_pbx_run(), __ast_request_and_dial(), __oh323_new(), action_bridge(), agent_hangup(), agent_read(), alsa_new(), answer_exec_run(), app_exec(), ast_async_goto(), ast_bridge_call_thread(), ast_call_forward(), 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_channel(), bridge_exec(), build_conf(), builtin_atxfer(), chanavail_exec(), check_compat(), check_goto_on_transfer(), clear_caller(), conf_free(), conf_run(), console_new(), dahdi_handle_event(), dahdi_new(), dial_exec_full(), do_forward(), do_hang(), do_parking_thread(), features_hangup(), findmeexec(), function_ilink(), gtalk_new(), handle_call_forward(), handle_callforward_button(), 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(), handle_timeout_trip(), HandleCallOutgoing(), hangup_chan(), hangupcalls(), hanguptree(), iax2_request(), iax_park(), iax_park_thread(), jingle_new(), local_hangup(), masq_park_call(), mgcp_new(), mgcp_ss(), monitor_dial(), mwi_thread(), nbs_new(), oss_new(), park_exec(), parkandannounce_exec(), phone_new(), rpt(), rpt_call(), rpt_exec(), rpt_tele_thread(), sip_new(), sip_park(), sip_park_thread(), skinny_new(), skinny_ss(), ss_thread(), try_calling(), unistim_new(), usbradio_new(), wait_for_answer(), and wait_for_winner().

01651 {
01652    int res = 0;
01653 
01654    /* Don't actually hang up a channel that will masquerade as someone else, or
01655       if someone is going to masquerade as us */
01656    ast_channel_lock(chan);
01657 
01658    if (chan->audiohooks) {
01659       ast_audiohook_detach_list(chan->audiohooks);
01660       chan->audiohooks = NULL;
01661    }
01662 
01663    ast_autoservice_stop(chan);
01664 
01665    if (chan->masq) {
01666       if (ast_do_masquerade(chan))
01667          ast_log(LOG_WARNING, "Failed to perform masquerade\n");
01668    }
01669 
01670    if (chan->masq) {
01671       ast_log(LOG_WARNING, "%s getting hung up, but someone is trying to masq into us?!?\n", chan->name);
01672       ast_channel_unlock(chan);
01673       return 0;
01674    }
01675    /* If this channel is one which will be masqueraded into something,
01676       mark it as a zombie already, so we know to free it later */
01677    if (chan->masqr) {
01678       ast_set_flag(chan, AST_FLAG_ZOMBIE);
01679       ast_channel_unlock(chan);
01680       return 0;
01681    }
01682    ast_channel_unlock(chan);
01683 
01684    AST_RWLIST_WRLOCK(&channels);
01685    if (!AST_RWLIST_REMOVE(&channels, chan, chan_list)) {
01686       ast_log(LOG_ERROR, "Unable to find channel in list to free. Assuming it has already been done.\n");
01687    }
01688    ast_clear_flag(chan, AST_FLAG_IN_CHANNEL_LIST);
01689    AST_RWLIST_UNLOCK(&channels);
01690 
01691    ast_channel_lock(chan);
01692    free_translation(chan);
01693    /* Close audio stream */
01694    if (chan->stream) {
01695       ast_closestream(chan->stream);
01696       chan->stream = NULL;
01697    }
01698    /* Close video stream */
01699    if (chan->vstream) {
01700       ast_closestream(chan->vstream);
01701       chan->vstream = NULL;
01702    }
01703    if (chan->sched) {
01704       sched_context_destroy(chan->sched);
01705       chan->sched = NULL;
01706    }
01707    
01708    if (chan->generatordata)   /* Clear any tone stuff remaining */
01709       if (chan->generator && chan->generator->release)
01710          chan->generator->release(chan, chan->generatordata);
01711    chan->generatordata = NULL;
01712    chan->generator = NULL;
01713    if (ast_test_flag(chan, AST_FLAG_BLOCKING)) {
01714       ast_log(LOG_WARNING, "Hard hangup called by thread %ld on %s, while fd "
01715                "is blocked by thread %ld in procedure %s!  Expect a failure\n",
01716                (long)pthread_self(), chan->name, (long)chan->blocker, chan->blockproc);
01717       ast_assert(ast_test_flag(chan, AST_FLAG_BLOCKING) == 0);
01718    }
01719    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE)) {
01720       ast_debug(1, "Hanging up channel '%s'\n", chan->name);
01721       if (chan->tech->hangup)
01722          res = chan->tech->hangup(chan);
01723    } else {
01724       ast_debug(1, "Hanging up zombie '%s'\n", chan->name);
01725    }
01726          
01727    ast_channel_unlock(chan);
01728    manager_event(EVENT_FLAG_CALL, "Hangup",
01729          "Channel: %s\r\n"
01730          "Uniqueid: %s\r\n"
01731          "CallerIDNum: %s\r\n"
01732          "CallerIDName: %s\r\n"
01733          "Cause: %d\r\n"
01734          "Cause-txt: %s\r\n",
01735          chan->name,
01736          chan->uniqueid,
01737          S_OR(chan->cid.cid_num, "<unknown>"),
01738          S_OR(chan->cid.cid_name, "<unknown>"),
01739          chan->hangupcause,
01740          ast_cause2str(chan->hangupcause)
01741          );
01742 
01743    if (chan->cdr && !ast_test_flag(chan->cdr, AST_CDR_FLAG_BRIDGED) && 
01744       !ast_test_flag(chan->cdr, AST_CDR_FLAG_POST_DISABLED) && 
01745        (chan->cdr->disposition != AST_CDR_NULL || ast_test_flag(chan->cdr, AST_CDR_FLAG_DIALED))) {
01746       ast_channel_lock(chan);
01747          
01748       ast_cdr_end(chan->cdr);
01749       ast_cdr_detach(chan->cdr);
01750       chan->cdr = NULL;
01751       ast_channel_unlock(chan);
01752    }
01753    
01754    ast_channel_free(chan);
01755 
01756    return res;
01757 }

int ast_indicate ( struct ast_channel chan,
int  condition 
)

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_HOLD with payload being music on hold class
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

Note:
If we compare the enumeration type, which does not have any negative constants, the compiler may optimize this code away. Therefore, we must perform an integer comparison here.

Definition at line 3085 of file channel.c.

References ast_channel::_state, _XXX_AST_CONTROL_T38, ast_channel_lock, ast_channel_unlock, ast_check_hangup(), AST_CONTROL_ANSWER, AST_CONTROL_BUSY, AST_CONTROL_CONGESTION, AST_CONTROL_FLASH, AST_CONTROL_HANGUP, AST_CONTROL_HOLD, AST_CONTROL_OFFHOOK, AST_CONTROL_OPTION, AST_CONTROL_PROCEEDING, AST_CONTROL_PROGRESS, AST_CONTROL_RADIO_KEY, AST_CONTROL_RADIO_UNKEY, AST_CONTROL_RING, AST_CONTROL_RINGING, AST_CONTROL_SRCUPDATE, AST_CONTROL_T38_PARAMETERS, AST_CONTROL_TAKEOFFHOOK, AST_CONTROL_UNHOLD, AST_CONTROL_VIDUPDATE, AST_CONTROL_WINK, ast_debug, AST_FLAG_ZOMBIE, ast_get_indication_tone(), ast_log(), ast_playtones_start(), ast_playtones_stop(), AST_STATE_UP, ast_test_flag, tone_zone_sound::data, ast_channel_tech::indicate, is_visible_indication(), LOG_WARNING, ast_channel::name, ast_channel::tech, ast_channel::visible_indication, and ast_channel::zone.

Referenced by agent_hangup(), ast_bridge_call(), ast_generic_bridge(), ast_indicate(), bridge_native_loop(), bridge_p2p_loop(), do_parking_thread(), login_exec(), park_call_full(), pbx_builtin_waitexten(), transmit_audio(), transmit_t38(), and wait_for_answer().

03087 {
03088    /* By using an enum, we'll get compiler warnings for values not handled 
03089     * in switch statements. */
03090    enum ast_control_frame_type condition = _condition;
03091    const struct tone_zone_sound *ts = NULL;
03092    int res = -1;
03093 
03094    ast_channel_lock(chan);
03095 
03096    /* Don't bother if the channel is about to go away, anyway. */
03097    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
03098       ast_channel_unlock(chan);
03099       return -1;
03100    }
03101 
03102    if (chan->tech->indicate) {
03103       /* See if the channel driver can handle this condition. */
03104       res = chan->tech->indicate(chan, condition, data, datalen);
03105    }
03106 
03107    ast_channel_unlock(chan);
03108 
03109    if (!res) {
03110       /* The channel driver successfully handled this indication */
03111       if (is_visible_indication(condition)) {
03112          chan->visible_indication = condition;
03113       }
03114       return 0;
03115    }
03116 
03117    /* The channel driver does not support this indication, let's fake
03118     * it by doing our own tone generation if applicable. */
03119 
03120    /*!\note If we compare the enumeration type, which does not have any
03121     * negative constants, the compiler may optimize this code away.
03122     * Therefore, we must perform an integer comparison here. */
03123    if (_condition < 0) {
03124       /* Stop any tones that are playing */
03125       ast_playtones_stop(chan);
03126       return 0;
03127    }
03128 
03129    /* Handle conditions that we have tones for. */
03130    switch (condition) {
03131    case _XXX_AST_CONTROL_T38:
03132       /* deprecated T.38 control frame */
03133       return -1;
03134    case AST_CONTROL_T38_PARAMETERS:
03135       /* there is no way to provide 'default' behavior for these
03136        * control frames, so we need to return failure, but there
03137        * is also no value in the log message below being emitted
03138        * since failure to handle these frames is not an 'error'
03139        * so just return right now.
03140        */
03141       return -1;
03142    case AST_CONTROL_RINGING:
03143       ts = ast_get_indication_tone(chan->zone, "ring");
03144       /* It is common practice for channel drivers to return -1 if trying
03145        * to indicate ringing on a channel which is up. The idea is to let the
03146        * core generate the ringing inband. However, we don't want the
03147        * warning message about not being able to handle the specific indication
03148        * to print nor do we want ast_indicate_data to return an "error" for this
03149        * condition
03150        */
03151       if (chan->_state == AST_STATE_UP) {
03152          res = 0;
03153       }
03154       break;
03155    case AST_CONTROL_BUSY:
03156       ts = ast_get_indication_tone(chan->zone, "busy");
03157       break;
03158    case AST_CONTROL_CONGESTION:
03159       ts = ast_get_indication_tone(chan->zone, "congestion");
03160       break;
03161    case AST_CONTROL_PROGRESS:
03162    case AST_CONTROL_PROCEEDING:
03163    case AST_CONTROL_VIDUPDATE:
03164    case AST_CONTROL_SRCUPDATE:
03165    case AST_CONTROL_RADIO_KEY:
03166    case AST_CONTROL_RADIO_UNKEY:
03167    case AST_CONTROL_OPTION:
03168    case AST_CONTROL_WINK:
03169    case AST_CONTROL_FLASH:
03170    case AST_CONTROL_OFFHOOK:
03171    case AST_CONTROL_TAKEOFFHOOK:
03172    case AST_CONTROL_ANSWER:
03173    case AST_CONTROL_HANGUP:
03174    case AST_CONTROL_RING:
03175    case AST_CONTROL_HOLD:
03176    case AST_CONTROL_UNHOLD:
03177       /* Nothing left to do for these. */
03178       res = 0;
03179       break;
03180    }
03181 
03182    if (ts && ts->data[0]) {
03183       /* We have a tone to play, yay. */
03184       ast_debug(1, "Driver for channel '%s' does not support indication %d, emulating it\n", chan->name, condition);
03185       ast_playtones_start(chan, 0, ts->data, 1);
03186       res = 0;
03187       chan->visible_indication = condition;
03188    }
03189 
03190    if (res) {
03191       /* not handled */
03192       ast_log(LOG_WARNING, "Unable to handle indication %d for '%s'\n", condition, chan->name);
03193    }
03194 
03195    return res;
03196 }

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

References ast_debug, ast_opt_internal_timing, and ast_channel::timingfd.

Referenced by add_sdp(), and ast_read_generator_actions().

03029 {
03030    int ret = ast_opt_internal_timing && chan->timingfd > -1;
03031    ast_debug(5, "Internal timing is %s (option_internal_timing=%d chan->timingfd=%d)\n", ret? "enabled": "disabled", ast_opt_internal_timing, chan->timingfd);
03032    return ret;
03033 }

void ast_poll_channel_add ( struct ast_channel chan0,
struct ast_channel chan1 
)

Add a channel to an optimized waitfor

Definition at line 1572 of file channel.c.

References AST_MAX_FDS, and ast_channel::fds.

Referenced by ast_feature_request_and_dial(), ast_generic_bridge(), begin_dial_channel(), bridge_native_loop(), bridge_p2p_loop(), and wait_for_answer().

01573 {
01574 #ifdef HAVE_EPOLL
01575    struct epoll_event ev;
01576    int i = 0;
01577 
01578    if (chan0->epfd == -1)
01579       return;
01580 
01581    /* Iterate through the file descriptors on chan1, adding them to chan0 */
01582    for (i = 0; i < AST_MAX_FDS; i++) {
01583       if (chan1->fds[i] == -1)
01584          continue;
01585       ev.events = EPOLLIN | EPOLLPRI | EPOLLERR | EPOLLHUP;
01586       ev.data.ptr = chan1->epfd_data[i];
01587       epoll_ctl(chan0->epfd, EPOLL_CTL_ADD, chan1->fds[i], &ev);
01588    }
01589 
01590 #endif
01591    return;
01592 }

void ast_poll_channel_del ( struct ast_channel chan0,
struct ast_channel chan1 
)

Delete a channel from an optimized waitfor

Definition at line 1595 of file channel.c.

References AST_MAX_FDS, and ast_channel::fds.

Referenced by ast_feature_request_and_dial(), ast_generic_bridge(), bridge_native_loop(), bridge_p2p_loop(), monitor_dial(), and wait_for_answer().

01596 {
01597 #ifdef HAVE_EPOLL
01598    struct epoll_event ev;
01599    int i = 0;
01600 
01601    if (chan0->epfd == -1)
01602       return;
01603 
01604    for (i = 0; i < AST_MAX_FDS; i++) {
01605       if (chan1->fds[i] == -1)
01606          continue;
01607       epoll_ctl(chan0->epfd, EPOLL_CTL_DEL, chan1->fds[i], &ev);
01608    }
01609 
01610 #endif
01611    return;
01612 }

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

print call- and pickup groups into buffer

Definition at line 5457 of file channel.c.

References first, and num.

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

05458 {
05459    unsigned int i;
05460    int first = 1;
05461    char num[3];
05462 
05463    buf[0] = '\0';
05464    
05465    if (!group) /* Return empty string if no group */
05466       return buf;
05467 
05468    for (i = 0; i <= 63; i++) {   /* Max group is 63 */
05469       if (group & ((ast_group_t) 1 << i)) {
05470             if (!first) {
05471             strncat(buf, ", ", buflen - strlen(buf) - 1);
05472          } else {
05473             first = 0;
05474          }
05475          snprintf(num, sizeof(num), "%u", i);
05476          strncat(buf, num, buflen - strlen(buf) - 1);
05477       }
05478    }
05479    return buf;
05480 }

int ast_prod ( struct ast_channel chan  ) 

Send empty audio to prime a channel driver.

Definition at line 3317 of file channel.c.

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

Referenced by ast_activate_generator().

03318 {
03319    struct ast_frame a = { AST_FRAME_VOICE };
03320    char nothing[128];
03321 
03322    /* Send an empty audio frame to get things moving */
03323    if (chan->_state != AST_STATE_UP) {
03324       ast_debug(1, "Prodding channel '%s'\n", chan->name);
03325       a.subclass = chan->rawwriteformat;
03326       a.data = nothing + AST_FRIENDLY_OFFSET;
03327       a.src = "ast_prod";
03328       if (ast_write(chan, &a))
03329          ast_log(LOG_WARNING, "Prodding channel '%s' failed\n", chan->name);
03330    }
03331    return 0;
03332 }

int ast_queue_control ( struct ast_channel chan,
enum ast_control_frame_type  control 
)

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
Return values:
0 success
non-zero 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.

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

Definition at line 1109 of file channel.c.

References AST_FRAME_CONTROL, ast_queue_frame(), ast_frame::data, ast_frame::datalen, and ast_frame::subclass.

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

01111 {
01112    struct ast_frame f = { AST_FRAME_CONTROL, };
01113 
01114    f.subclass = control;
01115    f.data = (void *) data;
01116    f.datalen = datalen;
01117 
01118    return ast_queue_frame(chan, &f);
01119 }

int ast_queue_frame ( struct ast_channel chan,
struct ast_frame f 
)

int ast_queue_frame_head ( struct ast_channel chan,
struct ast_frame f 
)

Queue one or more frames to the head of a channel's frame queue.

Parameters:
chan the channel to queue the frame(s) on
f the frame(s) to queue. Note that the frame(s) will be duplicated by this function. It is the responsibility of the caller to handle freeing the memory associated with the frame(s) being passed if necessary.
Return values:
0 success
non-zero failure

Definition at line 1081 of file channel.c.

References __ast_queue_frame().

Referenced by __ast_answer(), __ast_read(), and ast_autoservice_stop().

01082 {
01083    return __ast_queue_frame(chan, fin, 1, NULL);
01084 }

int ast_queue_hangup ( struct ast_channel chan  ) 

int ast_raw_answer ( struct ast_channel chan,
int  cdr_answer 
)

Answer a channel.

Parameters:
chan channel to answer
cdr_answer flag to control whether any associated CDR should be marked as 'answered'
This function answers a channel and handles all necessary call setup functions.

Note:
The channel passed does not need to be locked, but is locked by the function when needed.

Unlike ast_answer(), this function will not wait for media flow to begin. The caller should be careful before sending media to the channel before incoming media arrives, as the outgoing media may be lost.

Return values:
0 on success
non-zero on failure

Definition at line 1759 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_indicate(), 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 __ast_answer(), and ast_bridge_call().

01760 {
01761    int res = 0;
01762 
01763    ast_channel_lock(chan);
01764 
01765    /* You can't answer an outbound call */
01766    if (ast_test_flag(chan, AST_FLAG_OUTGOING)) {
01767       ast_channel_unlock(chan);
01768       return 0;
01769    }
01770 
01771    /* Stop if we're a zombie or need a soft hangup */
01772    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
01773       ast_channel_unlock(chan);
01774       return -1;
01775    }
01776 
01777    ast_channel_unlock(chan);
01778 
01779    switch (chan->_state) {
01780    case AST_STATE_RINGING:
01781    case AST_STATE_RING:
01782       ast_channel_lock(chan);
01783       if (chan->tech->answer) {
01784          res = chan->tech->answer(chan);
01785       }
01786       ast_setstate(chan, AST_STATE_UP);
01787       if (cdr_answer) {
01788          ast_cdr_answer(chan->cdr);
01789       }
01790       ast_channel_unlock(chan);
01791       break;
01792    case AST_STATE_UP:
01793       /* Calling ast_cdr_answer when it it has previously been called
01794        * is essentially a no-op, so it is safe.
01795        */
01796       if (cdr_answer) {
01797          ast_cdr_answer(chan->cdr);
01798       }
01799       break;
01800    default:
01801       break;
01802    }
01803 
01804    ast_indicate(chan, -1);
01805    chan->visible_indication = 0;
01806 
01807    return res;
01808 }

struct ast_frame* ast_read ( struct ast_channel chan  )  [read]

Reads 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.

Definition at line 3035 of file channel.c.

References __ast_read().

Referenced by __adsi_transmit_messages(), __ast_answer(), __ast_play_and_record(), __ast_request_and_dial(), adsi_careful_send(), agent_ack_sleep(), agent_read(), ast_feature_request_and_dial(), ast_generic_bridge(), 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(), builtin_atxfer(), channel_spy(), check_goto_on_transfer(), conf_exec(), conf_flush(), conf_run(), dahdi_bridge(), dictate_exec(), disa_exec(), do_parking_thread(), do_waiting(), echo_exec(), eivr_comm(), features_read(), find_cache(), handle_recordfile(), handle_speechrecognize(), iax2_bridge(), iax_park_thread(), ices_exec(), isAnsweringMachine(), jack_exec(), launch_asyncagi(), masq_park_call(), measurenoise(), misdn_bridge(), monitor_dial(), mp3_exec(), NBScat_exec(), receive_dtmf_digits(), record_exec(), recordthread(), rpt(), rpt_exec(), run_agi(), send_tone_burst(), send_waveform_to_channel(), sendurl_exec(), speech_background(), ss_thread(), transmit_audio(), transmit_t38(), wait_for_answer(), wait_for_hangup(), wait_for_winner(), waitforring_exec(), and waitstream_core().

03036 {
03037    return __ast_read(chan, 0);
03038 }

struct ast_frame* ast_read_noaudio ( struct ast_channel chan  )  [read]

Reads a frame, returning AST_FRAME_NULL frame if audio.

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

References __ast_read().

Referenced by conf_run().

03041 {
03042    return __ast_read(chan, 1);
03043 }

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

04013 {
04014    return ast_readstring_full(c, s, len, timeout, ftimeout, enders, -1, -1);
04015 }

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

References ast_check_hangup(), AST_DIGIT_ANY, AST_FLAG_ZOMBIE, AST_GETDATA_COMPLETE, AST_GETDATA_EMPTY_END_TERMINATED, AST_GETDATA_FAILED, AST_GETDATA_INTERRUPTED, AST_GETDATA_TIMEOUT, ast_stopstream(), ast_test_flag, ast_waitfordigit_full(), ast_waitstream_full(), and ast_channel::stream.

Referenced by ast_app_getdata_full(), and ast_readstring().

04018 {
04019    int pos = 0;   /* index in the buffer where we accumulate digits */
04020    int to = ftimeout;
04021 
04022    /* Stop if we're a zombie or need a soft hangup */
04023    if (ast_test_flag(c, AST_FLAG_ZOMBIE) || ast_check_hangup(c))
04024       return -1;
04025    if (!len)
04026       return -1;
04027    for (;;) {
04028       int d;
04029       if (c->stream) {
04030          d = ast_waitstream_full(c, AST_DIGIT_ANY, audiofd, ctrlfd);
04031          ast_stopstream(c);
04032          usleep(1000);
04033          if (!d)
04034             d = ast_waitfordigit_full(c, to, audiofd, ctrlfd);
04035       } else {
04036          d = ast_waitfordigit_full(c, to, audiofd, ctrlfd);
04037       }
04038       if (d < 0)
04039          return AST_GETDATA_FAILED;
04040       if (d == 0) {
04041          s[pos] = '\0';
04042          return AST_GETDATA_TIMEOUT;
04043       }
04044       if (d == 1) {
04045          s[pos] = '\0';
04046          return AST_GETDATA_INTERRUPTED;
04047       }
04048       if (strchr(enders, d) && (pos == 0)) {
04049          s[pos] = '\0';
04050          return AST_GETDATA_EMPTY_END_TERMINATED;
04051       }
04052       if (!strchr(enders, d)) {
04053          s[pos++] = d;
04054       }
04055       if (strchr(enders, d) || (pos >= len)) {
04056          s[pos] = '\0';
04057          return AST_GETDATA_COMPLETE;
04058       }
04059       to = timeout;
04060    }
04061    /* Never reached */
04062    return 0;
04063 }

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

References ast_free, and ast_recvtext().

Referenced by handle_recvchar().

03199 {
03200    int c;
03201    char *buf = ast_recvtext(chan, timeout);
03202    if (buf == NULL)
03203       return -1;  /* error or timeout */
03204    c = *(unsigned char *)buf;
03205    ast_free(buf);
03206    return c;
03207 }

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 3209 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(), ast_frame::data, ast_frame::datalen, f, ast_frame::frametype, and ast_frame::subclass.

Referenced by ast_recvchar(), and handle_recvtext().

03210 {
03211    int res, done = 0;
03212    char *buf = NULL;
03213    
03214    while (!done) {
03215       struct ast_frame *f;
03216       if (ast_check_hangup(chan))
03217          break;
03218       res = ast_waitfor(chan, timeout);
03219       if (res <= 0) /* timeout or error */
03220          break;
03221       timeout = res; /* update timeout */
03222       f = ast_read(chan);
03223       if (f == NULL)
03224          break; /* no frame */
03225       if (f->frametype == AST_FRAME_CONTROL && f->subclass == AST_CONTROL_HANGUP)
03226          done = 1;   /* force a break */
03227       else if (f->frametype == AST_FRAME_TEXT) {      /* what we want */
03228          buf = ast_strndup((char *) f->data, f->datalen);   /* dup and break */
03229          done = 1;
03230       }
03231       ast_frfree(f);
03232    }
03233    return buf;
03234 }

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

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

Return values:
NULL failure
non-NULL channel on success

Definition at line 3912 of file channel.c.

References AST_CAUSE_BEARERCAPABILITY_NOTAVAIL, AST_CAUSE_NOSUCHDRIVER, AST_CAUSE_NOTDEFINED, AST_FORMAT_AUDIO_MASK, AST_FORMAT_TEXT_MASK, AST_FORMAT_VIDEO_MASK, AST_LIST_TRAVERSE, ast_log(), AST_RWLIST_RDLOCK, AST_RWLIST_UNLOCK, ast_translator_best_choice(), ast_channel_tech::capabilities, capabilities, LOG_WARNING, ast_channel_tech::requester, chanlist::tech, and ast_channel_tech::type.

Referenced by __ast_request_and_dial(), agent_request(), ast_call_forward(), ast_feature_request_and_dial(), attempt_reconnect(), begin_dial_channel(), build_conf(), chanavail_exec(), conf_run(), dial_exec_full(), do_forward(), features_alloc(), findmeexec(), function_ilink(), ring_entry(), rpt(), rpt_call(), rpt_exec(), rpt_tele_thread(), and wait_for_answer().

03913 {
03914    struct chanlist *chan;
03915    struct ast_channel *c;
03916    int capabilities;
03917    int fmt;
03918    int res;
03919    int foo;
03920    int videoformat = format & AST_FORMAT_VIDEO_MASK;
03921    int textformat = format & AST_FORMAT_TEXT_MASK;
03922 
03923    if (!cause)
03924       cause = &foo;
03925    *cause = AST_CAUSE_NOTDEFINED;
03926 
03927    if (AST_RWLIST_RDLOCK(&channels)) {
03928       ast_log(LOG_WARNING, "Unable to lock channel list\n");
03929       return NULL;
03930    }
03931 
03932    AST_LIST_TRAVERSE(&backends, chan, list) {
03933       if (strcasecmp(type, chan->tech->type))
03934          continue;
03935 
03936       capabilities = chan->tech->capabilities;
03937       fmt = format & AST_FORMAT_AUDIO_MASK;
03938       if (fmt) {
03939          /* We have audio - is it possible to connect the various calls to each other? 
03940             (Avoid this check for calls without audio, like text+video calls)
03941          */
03942          res = ast_translator_best_choice(&fmt, &capabilities);
03943          if (res < 0) {
03944             ast_log(LOG_WARNING, "No translator path exists for channel type %s (native 0x%x) to 0x%x\n", type, chan->tech->capabilities, format);
03945             *cause = AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
03946             AST_RWLIST_UNLOCK(&channels);
03947             return NULL;
03948          }
03949       }
03950       AST_RWLIST_UNLOCK(&channels);
03951       if (!chan->tech->requester)
03952          return NULL;
03953       
03954       if (!(c = chan->tech->requester(type, capabilities | videoformat | textformat, data, cause)))
03955          return NULL;
03956       
03957       /* no need to generate a Newchannel event here; it is done in the channel_alloc call */
03958       return c;
03959    }
03960 
03961    ast_log(LOG_WARNING, "No channel type registered for '%s'\n", type);
03962    *cause = AST_CAUSE_NOSUCHDRIVER;
03963    AST_RWLIST_UNLOCK(&channels);
03964 
03965    return NULL;
03966 }

struct ast_channel* ast_request_and_dial ( const char *  type,
int  format,
void *  data,
int  timeout,
int *  reason,
const char *  cid_num,
const char *  cid_name 
) [read]

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 unsuccessful)
cid_num Caller-ID Number
cid_name Caller-ID Name (ascii)
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 3907 of file channel.c.

References __ast_request_and_dial().

Referenced by ast_pbx_outgoing_exten().

03908 {
03909    return __ast_request_and_dial(type, format, data, timeout, outstate, cidnum, cidname, NULL);
03910 }

int ast_safe_sleep ( struct ast_channel chan,
int  ms 
)

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

Wait for a specified 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 1286 of file channel.c.

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

Referenced by ast_safe_sleep(), and login_exec().

01287 {
01288    struct ast_frame *f;
01289 
01290    while (ms > 0) {
01291       if (cond && ((*cond)(data) == 0))
01292          return 0;
01293       ms = ast_waitfor(chan, ms);
01294       if (ms < 0)
01295          return -1;
01296       if (ms > 0) {
01297          f = ast_read(chan);
01298          if (!f)
01299             return -1;
01300          ast_frfree(f);
01301       }
01302    }
01303    return 0;
01304 }

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 1672 of file channel.h.

References timersub().

Referenced by aji_io_recv(), ast_stun_request(), do_monitor(), and do_parking_thread().

01673 {
01674 #ifdef __linux__
01675    return select(nfds, rfds, wfds, efds, tvp);
01676 #else
01677    if (tvp) {
01678       struct timeval tv, tvstart, tvend, tvlen;
01679       int res;
01680 
01681       tv = *tvp;
01682       gettimeofday(&tvstart, NULL);
01683       res = select(nfds, rfds, wfds, efds, tvp);
01684       gettimeofday(&tvend, NULL);
01685       timersub(&tvend, &tvstart, &tvlen);
01686       timersub(&tv, &tvlen, tvp);
01687       if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
01688          tvp->tv_sec = 0;
01689          tvp->tv_usec = 0;
01690       }
01691       return res;
01692    }
01693    else
01694       return select(nfds, rfds, wfds, efds, NULL);
01695 #endif
01696 }

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

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
duration the duration of the digit ending in ms
Returns:
Returns 0 on success, -1 on failure

Definition at line 3307 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(), dial_exec_full(), and manager_play_dtmf().

03308 {
03309    if (chan->tech->send_digit_begin) {
03310       ast_senddigit_begin(chan, digit);
03311       ast_safe_sleep(chan, (duration >= AST_DEFAULT_EMULATE_DTMF_DURATION ? duration : AST_DEFAULT_EMULATE_DTMF_DURATION));
03312    }
03313    
03314    return ast_senddigit_end(chan, digit, (duration >= AST_DEFAULT_EMULATE_DTMF_DURATION ? duration : AST_DEFAULT_EMULATE_DTMF_DURATION));
03315 }

int ast_senddigit_begin ( 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 3249 of file channel.c.

References ast_debug, ast_playtones_start(), ast_channel::name, ast_channel_tech::send_digit_begin, and ast_channel::tech.

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

03250 {
03251    /* Device does not support DTMF tones, lets fake
03252     * it by doing our own generation. */
03253    static const char* dtmf_tones[] = {
03254       "941+1336", /* 0 */
03255       "697+1209", /* 1 */
03256       "697+1336", /* 2 */
03257       "697+1477", /* 3 */
03258       "770+1209", /* 4 */
03259       "770+1336", /* 5 */
03260       "770+1477", /* 6 */
03261       "852+1209", /* 7 */
03262       "852+1336", /* 8 */
03263       "852+1477", /* 9 */
03264       "697+1633", /* A */
03265       "770+1633", /* B */
03266       "852+1633", /* C */
03267       "941+1633", /* D */
03268       "941+1209", /* * */
03269       "941+1477"  /* # */
03270    };
03271 
03272    if (!chan->tech->send_digit_begin)
03273       return 0;
03274 
03275    if (!chan->tech->send_digit_begin(chan, digit))
03276       return 0;
03277 
03278    if (digit >= '0' && digit <='9')
03279       ast_playtones_start(chan, 0, dtmf_tones[digit-'0'], 0);
03280    else if (digit >= 'A' && digit <= 'D')
03281       ast_playtones_start(chan, 0, dtmf_tones[digit-'A'+10], 0);
03282    else if (digit == '*')
03283       ast_playtones_start(chan, 0, dtmf_tones[14], 0);
03284    else if (digit == '#')
03285       ast_playtones_start(chan, 0, dtmf_tones[15], 0);
03286    else {
03287       /* not handled */
03288       ast_debug(1, "Unable to generate DTMF tone '%c' for '%s'\n", digit, chan->name);
03289    }
03290 
03291    return 0;
03292 }

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

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
duration the duration of the digit ending in ms
Returns:
Returns 0 on success, -1 on failure

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

03295 {
03296    int res = -1;
03297 
03298    if (chan->tech->send_digit_end)
03299       res = chan->tech->send_digit_end(chan, digit, duration);
03300 
03301    if (res && chan->generator)
03302       ast_playtones_stop(chan);
03303    
03304    return 0;
03305 }

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

Sends text to a channel.

Parameters:
chan channel to act upon
text string of text to send on the channel
Write text to a display on a channel

Note:
The channel does not need to be locked before calling this function.
Return values:
0 on success
-1 on failure

Definition at line 3236 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 action_sendtext(), agent_sendtext(), handle_sendtext(), and sendtext_exec().

03237 {
03238    int res = 0;
03239    /* Stop if we're a zombie or need a soft hangup */
03240    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan))
03241       return -1;
03242    CHECK_BLOCKING(chan);
03243    if (chan->tech->send_text)
03244       res = chan->tech->send_text(chan, text);
03245    ast_clear_flag(chan, AST_FLAG_BLOCKING);
03246    return res;
03247 }

void ast_set_callerid ( struct ast_channel chan,
const char *  cid_num,
const char *  cid_name,
const char *  cid_ani 
)

Set caller ID number, name and ANI.

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

Definition at line 4594 of file channel.c.

References ast_channel_lock, ast_channel_unlock, ast_free, ast_strdup, ast_channel::cid, ast_callerid::cid_ani, ast_callerid::cid_name, ast_callerid::cid_num, and report_new_callerid().

Referenced by __ast_request_and_dial(), agent_call(), ast_call_forward(), ast_feature_request_and_dial(), callerid_write(), dahdi_read(), dial_exec_full(), disa_exec(), do_forward(), findmeexec(), handle_setcallerid(), mgcp_ss(), privacy_exec(), read_config(), rpt_exec(), skinny_newcall(), and ss_thread().

04595 {
04596    ast_channel_lock(chan);
04597 
04598    if (cid_num) {
04599       if (chan->cid.cid_num)
04600          ast_free(chan->cid.cid_num);
04601       chan->cid.cid_num = ast_strdup(cid_num);
04602    }
04603    if (cid_name) {
04604       if (chan->cid.cid_name)
04605          ast_free(chan->cid.cid_name);
04606       chan->cid.cid_name = ast_strdup(cid_name);
04607    }
04608    if (cid_ani) {
04609       if (chan->cid.cid_ani)
04610          ast_free(chan->cid.cid_ani);
04611       chan->cid.cid_ani = ast_strdup(cid_ani);
04612    }
04613 
04614    report_new_callerid(chan);
04615 
04616    ast_channel_unlock(chan);
04617 }

int ast_set_read_format ( struct ast_channel chan,
int  format 
)

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 5482 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_call_forward(), ast_pbx_outgoing_app(), and ast_pbx_outgoing_exten().

05483 {
05484    struct ast_variable *cur;
05485 
05486    for (cur = vars; cur; cur = cur->next)
05487       pbx_builtin_setvar_helper(chan, cur->name, cur->value);  
05488 }

int ast_set_write_format ( struct ast_channel chan,
int  format 
)

int ast_setstate ( struct ast_channel chan,
enum  ast_channel_state 
)

Change the state of a channel.

Definition at line 4619 of file channel.c.

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

Referenced by __ast_read(), __dahdi_exception(), __oh323_update_info(), agent_call(), alsa_answer(), ast_raw_answer(), cb_events(), check_availability(), console_answer(), dahdi_answer(), dahdi_call(), dahdi_handle_event(), dahdi_indicate(), dahdi_read(), do_bridge_masquerade(), 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(), jingle_call(), jingle_newcall(), 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(), release_chan_early(), sip_answer(), skinny_answer(), skinny_call(), skinny_newcall(), ss_thread(), unistim_answer(), unistim_call(), unistim_new(), unistim_ss(), update_state(), usbradio_answer(), and usbradio_call().

04620 {
04621    int oldstate = chan->_state;
04622    char name[AST_CHANNEL_NAME], *dashptr;
04623 
04624    if (oldstate == state)
04625       return 0;
04626 
04627    ast_copy_string(name, chan->name, sizeof(name));
04628    if ((dashptr = strrchr(name, '-'))) {
04629       *dashptr = '\0';
04630    }
04631 
04632    chan->_state = state;
04633    ast_device_state_changed_literal(name);
04634    /* setstate used to conditionally report Newchannel; this is no more */
04635    manager_event(EVENT_FLAG_CALL,
04636             "Newstate",
04637             "Channel: %s\r\n"
04638             "ChannelState: %d\r\n"
04639             "ChannelStateDesc: %s\r\n"
04640             "CallerIDNum: %s\r\n"
04641             "CallerIDName: %s\r\n"
04642             "Uniqueid: %s\r\n",
04643             chan->name, chan->_state, ast_state2str(chan->_state),
04644             S_OR(chan->cid.cid_num, ""),
04645             S_OR(chan->cid.cid_name, ""),
04646             chan->uniqueid);
04647 
04648    return 0;
04649 }

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

Definition at line 2369 of file channel.c.

References ast_channel_lock, ast_channel_unlock, ast_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(), ast_readaudio_callback(), and filestream_destructor().

02370 {
02371    int res = -1;
02372 #ifdef HAVE_DAHDI
02373    ast_channel_lock(c);
02374    if (c->timingfd > -1) {
02375       if (!func) {
02376          samples = 0;
02377          data = 0;
02378       }
02379       ast_debug(1, "Scheduling timer at %d sample intervals\n", samples);
02380       res = ioctl(c->timingfd, DAHDI_TIMERCONFIG, &samples);
02381       c->timingfunc = func;
02382       c->timingdata = data;
02383    }
02384    ast_channel_unlock(c);
02385 #endif
02386    return res;
02387 }

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

Referenced by handle_request_options().

00518 {
00519    return shutting_down;
00520 }

int ast_softhangup ( struct ast_channel chan,
int  cause 
)

Softly hangup up a channel.

Parameters:
chan channel to be soft-hung-up
reason an AST_SOFTHANGUP_* reason code
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.

Note:
The channel passed to this function does not need to be locked.
Returns:
Returns 0 regardless

Definition at line 1628 of file channel.c.

References ast_channel_lock, ast_channel_unlock, and ast_softhangup_nolock().

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

01629 {
01630    int res;
01631    ast_channel_lock(chan);
01632    res = ast_softhangup_nolock(chan, cause);
01633    ast_channel_unlock(chan);
01634    return res;
01635 }

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
reason an AST_SOFTHANGUP_* reason code

Definition at line 1615 of file channel.c.

References ast_channel::_softhangup, ast_debug, AST_FLAG_BLOCKING, ast_null_frame, ast_queue_frame(), ast_test_flag, ast_channel::blocker, and ast_channel::name.

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

01616 {
01617    ast_debug(1, "Soft-Hanging up channel '%s'\n", chan->name);
01618    /* Inform channel driver that we need to be hung up, if it cares */
01619    chan->_softhangup |= cause;
01620    ast_queue_frame(chan, &ast_null_frame);
01621    /* Interrupt any poll call or such */
01622    if (ast_test_flag(chan, AST_FLAG_BLOCKING))
01623       pthread_kill(chan->blocker, SIGURG);
01624    return 0;
01625 }

const char* ast_state2str ( enum ast_channel_state  state  ) 

Gives the string form of a given 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
Note:
This function is not reentrant.

Definition at line 651 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, ast_threadstorage_get(), STATE2STR_BUFSIZE, and state2str_threadbuf.

Referenced by __ast_channel_alloc_ap(), action_coreshowchannels(), action_status(), agent_hangup(), ast_do_masquerade(), ast_setstate(), attempt_transfer(), can_pickup(), func_channel_read(), handle_chanlist(), handle_invite_replaces(), handle_showchan(), local_attended_transfer(), mgcp_new(), serialize_showchan(), and sip_hangup().

00652 {
00653    char *buf;
00654 
00655    switch (state) {
00656    case AST_STATE_DOWN:
00657       return "Down";
00658    case AST_STATE_RESERVED:
00659       return "Rsrvd";
00660    case AST_STATE_OFFHOOK:
00661       return "OffHook";
00662    case AST_STATE_DIALING:
00663       return "Dialing";
00664    case AST_STATE_RING:
00665       return "Ring";
00666    case AST_STATE_RINGING:
00667       return "Ringing";
00668    case AST_STATE_UP:
00669       return "Up";
00670    case AST_STATE_BUSY:
00671       return "Busy";
00672    case AST_STATE_DIALING_OFFHOOK:
00673       return "Dialing Offhook";
00674    case AST_STATE_PRERING:
00675       return "Pre-ring";
00676    default:
00677       if (!(buf = ast_threadstorage_get(&state2str_threadbuf, STATE2STR_BUFSIZE)))
00678          return "Unknown";
00679       snprintf(buf, STATE2STR_BUFSIZE, "Unknown (%d)", state);
00680       return buf;
00681    }
00682 }

int ast_str2cause ( const char *  name  ) 

Convert a symbolic hangup cause to number.

Convert the string form of a cause code to a number

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

Definition at line 637 of file channel.c.

References ARRAY_LEN, and causes.

Referenced by pbx_builtin_hangup().

00638 {
00639    int x;
00640 
00641    for (x = 0; x < ARRAY_LEN(causes); x++)
00642       if (!strncasecmp(causes[x].name, name, strlen(causes[x].name)))
00643          return causes[x].cause;
00644 
00645    return -1;
00646 }

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

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

Referenced by zapateller_exec().

05358 {
05359    int res;
05360 
05361    if ((res = ast_tonepair_start(chan, freq1, freq2, duration, vol)))
05362       return res;
05363 
05364    /* Give us some wiggle room */
05365    while (chan->generatordata && ast_waitfor(chan, 100) >= 0) {
05366       struct ast_frame *f = ast_read(chan);
05367       if (f)
05368          ast_frfree(f);
05369       else
05370          return -1;
05371    }
05372    return 0;
05373 }

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

Start a tone going

Definition at line 5339 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(), pbx_builtin_waitexten(), play_dialtone(), play_tone_pair(), rpt_tele_thread(), and sendnoise().

05340 {
05341    struct tonepair_def d = { 0, };
05342 
05343    d.freq1 = freq1;
05344    d.freq2 = freq2;
05345    d.duration = duration;
05346    d.vol = (vol < 1) ? 8192 : vol; /* force invalid to 8192 */
05347    if (ast_activate_generator(chan, &tonepair, &d))
05348       return -1;
05349    return 0;
05350 }

void ast_tonepair_stop ( struct ast_channel chan  ) 

Stop a tone from playing

Definition at line 5352 of file channel.c.

References ast_deactivate_generator().

Referenced by sendnoise().

05353 {
05354    ast_deactivate_generator(chan);
05355 }

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.

Parameters:
chan current channel
dest destination extension for transfer
Transfer a channel (if supported). Returns -1 on error, 0 if not supported and 1 if supported and requested.

Called by:

  • app_transfer
  • the manager interface

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

03995 {
03996    int res = -1;
03997 
03998    /* Stop if we're a zombie or need a soft hangup */
03999    ast_channel_lock(chan);
04000    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
04001       if (chan->tech->transfer) {
04002          res = chan->tech->transfer(chan, dest);
04003          if (!res)
04004             res = 1;
04005       } else
04006          res = 0;
04007    }
04008    ast_channel_unlock(chan);
04009    return res;
04010 }

char* ast_transfercapability2str ( int  transfercapability  )  const

Gives the string form of a given transfer capability.

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 capability

Definition at line 685 of file channel.c.

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

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

00686 {
00687    switch (transfercapability) {
00688    case AST_TRANS_CAP_SPEECH:
00689       return "SPEECH";
00690    case AST_TRANS_CAP_DIGITAL:
00691       return "DIGITAL";
00692    case AST_TRANS_CAP_RESTRICTED_DIGITAL:
00693       return "RESTRICTED_DIGITAL";
00694    case AST_TRANS_CAP_3_1K_AUDIO:
00695       return "3K1AUDIO";
00696    case AST_TRANS_CAP_DIGITAL_W_TONES:
00697       return "DIGITAL_W_TONES";
00698    case AST_TRANS_CAP_VIDEO:
00699       return "VIDEO";
00700    default:
00701       return "UNKNOWN";
00702    }
00703 }

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

References ast_waitfor_nandfds().

Referenced by __adsi_transmit_messages(), __ast_answer(), __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(), handle_speechrecognize(), ices_exec(), isAnsweringMachine(), jack_exec(), launch_asyncagi(), measurenoise(), mp3_exec(), NBScat_exec(), receive_dtmf_digits(), record_exec(), recordthread(), send_tone_burst(), send_waveform_to_channel(), sendurl_exec(), speech_background(), ss_thread(), transmit_audio(), transmit_t38(), wait_for_hangup(), waitforring_exec(), and waitstream_core().

02354 {
02355    int oldms = ms;   /* -1 if no timeout */
02356 
02357    ast_waitfor_nandfds(&c, 1, NULL, 0, NULL, NULL, &ms);
02358    if ((ms < 0) && (oldms < 0))
02359       ms = 0;
02360    return ms;
02361 }

struct ast_channel* ast_waitfor_n ( struct ast_channel **  chan,
int  n,
int *  ms 
) [read]

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

References ast_waitfor_nandfds().

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

02349 {
02350    return ast_waitfor_nandfds(c, n, NULL, 0, NULL, NULL, ms);
02351 }

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

References ast_waitfor_nandfds().

Referenced by dundi_lookup_internal(), and dundi_precache_internal().

01990 {
01991    int winner = -1;
01992    ast_waitfor_nandfds(NULL, 0, fds, n, exception, &winner, ms);
01993    return winner;
01994 }

struct ast_channel* ast_waitfor_nandfds ( struct ast_channel **  c,
int  n,
int *  fds,
int  nfds,
int *  exception,
int *  outfd,
int *  ms 
) [read]

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 2001 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_poll, ast_set_flag, AST_SOFTHANGUP_TIMEOUT, ast_tvdiff_ms(), ast_tvnow(), CHECK_BLOCKING, errno, ast_channel::fdno, LOG_WARNING, and ast_channel::whentohangup.

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

02004 {
02005    struct timeval start = { 0 , 0 };
02006    struct pollfd *pfds = NULL;
02007    int res;
02008    long rms;
02009    int x, y, max;
02010    int sz;
02011    time_t now = 0;
02012    long whentohangup = 0, diff;
02013    struct ast_channel *winner = NULL;
02014    struct fdmap {
02015       int chan;
02016       int fdno;
02017    } *fdmap = NULL;
02018 
02019    if ((sz = n * AST_MAX_FDS + nfds)) {
02020       pfds = alloca(sizeof(*pfds) * sz);
02021       fdmap = alloca(sizeof(*fdmap) * sz);
02022    }
02023 
02024    if (outfd)
02025       *outfd = -99999;
02026    if (exception)
02027       *exception = 0;
02028    
02029    /* Perform any pending masquerades */
02030    for (x = 0; x < n; x++) {
02031       ast_channel_lock(c[x]);
02032       if (c[x]->masq && ast_do_masquerade(c[x])) {
02033          ast_log(LOG_WARNING, "Masquerade failed\n");
02034          *ms = -1;
02035          ast_channel_unlock(c[x]);
02036          return NULL;
02037       }
02038       if (c[x]->whentohangup) {
02039          if (!whentohangup)
02040             time(&now);
02041          diff = c[x]->whentohangup - now;
02042          if (diff < 1) {
02043             /* Should already be hungup */
02044             c[x]->_softhangup |= AST_SOFTHANGUP_TIMEOUT;
02045             ast_channel_unlock(c[x]);
02046             return c[x];
02047          }
02048          if (!whentohangup || (diff < whentohangup))
02049             whentohangup = diff;
02050       }
02051       ast_channel_unlock(c[x]);
02052    }
02053    /* Wait full interval */
02054    rms = *ms;
02055    if (whentohangup) {
02056       rms = whentohangup * 1000;              /* timeout in milliseconds */
02057       if (*ms >= 0 && *ms < rms)    /* original *ms still smaller */
02058          rms =  *ms;
02059    }
02060    /*
02061     * Build the pollfd array, putting the channels' fds first,
02062     * followed by individual fds. Order is important because
02063     * individual fd's must have priority over channel fds.
02064     */
02065    max = 0;
02066    for (x = 0; x < n; x++) {
02067       for (y = 0; y < AST_MAX_FDS; y++) {
02068          fdmap[max].fdno = y;  /* fd y is linked to this pfds */
02069          fdmap[max].chan = x;  /* channel x is linked to this pfds */
02070          max += ast_add_fd(&pfds[max], c[x]->fds[y]);
02071       }
02072       CHECK_BLOCKING(c[x]);
02073    }
02074    /* Add the individual fds */
02075    for (x = 0; x < nfds; x++) {
02076       fdmap[max].chan = -1;
02077       max += ast_add_fd(&pfds[max], fds[x]);
02078    }
02079 
02080    if (*ms > 0)
02081       start = ast_tvnow();
02082    
02083    if (sizeof(int) == 4) { /* XXX fix timeout > 600000 on linux x86-32 */
02084       do {
02085          int kbrms = rms;
02086          if (kbrms > 600000)
02087             kbrms = 600000;
02088          res = ast_poll(pfds, max, kbrms);
02089          if (!res)
02090             rms -= kbrms;
02091       } while (!res && (rms > 0));
02092    } else {
02093       res = ast_poll(pfds, max, rms);
02094    }
02095    for (x = 0; x < n; x++)
02096       ast_clear_flag(c[x], AST_FLAG_BLOCKING);
02097    if (res < 0) { /* Simulate a timeout if we were interrupted */
02098       if (errno != EINTR)
02099          *ms = -1;
02100       return NULL;
02101    }
02102    if (whentohangup) {   /* if we have a timeout, check who expired */
02103       time(&now);
02104       for (x = 0; x < n; x++) {
02105          if (c[x]->whentohangup && now >= c[x]->whentohangup) {
02106             c[x]->_softhangup |= AST_SOFTHANGUP_TIMEOUT;
02107             if (winner == NULL)
02108                winner = c[x];
02109          }
02110       }
02111    }
02112    if (res == 0) { /* no fd ready, reset timeout and done */
02113       *ms = 0; /* XXX use 0 since we may not have an exact timeout. */
02114       return winner;
02115    }
02116    /*
02117     * Then check if any channel or fd has a pending event.
02118     * Remember to check channels first and fds last, as they
02119     * must have priority on setting 'winner'
02120     */
02121    for (x = 0; x < max; x++) {
02122       res = pfds[x].revents;
02123       if (res == 0)
02124          continue;
02125       if (fdmap[x].chan >= 0) {  /* this is a channel */
02126          winner = c[fdmap[x].chan]; /* override previous winners */
02127          if (res & POLLPRI)
02128             ast_set_flag(winner, AST_FLAG_EXCEPTION);
02129          else
02130             ast_clear_flag(winner, AST_FLAG_EXCEPTION);
02131          winner->fdno = fdmap[x].fdno;
02132       } else {       /* this is an fd */
02133          if (outfd)
02134             *outfd = pfds[x].fd;
02135          if (exception)
02136             *exception = (res & POLLPRI) ? -1 : 0;
02137          winner = NULL;
02138       }
02139    }
02140    if (*ms > 0) {
02141       *ms -= ast_tvdiff_ms(ast_tvnow(), start);
02142       if (*ms < 0)
02143          *ms = 0;
02144    }
02145    return winner;
02146 }

int ast_waitfordigit ( struct ast_channel c,
int  ms 
)

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 2389 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(), ast_frame::data, ast_frame::datalen, errno, f, ast_frame::frametype, LOG_WARNING, and ast_frame::subclass.

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

02390 {
02391    /* Stop if we're a zombie or need a soft hangup */
02392    if (ast_test_flag(c, AST_FLAG_ZOMBIE) || ast_check_hangup(c))
02393       return -1;
02394 
02395    /* Only look for the end of DTMF, don't bother with the beginning and don't emulate things */
02396    ast_set_flag(c, AST_FLAG_END_DTMF_ONLY);
02397 
02398    /* Wait for a digit, no more than ms milliseconds total. */
02399    
02400    while (ms) {
02401       struct ast_channel *rchan;
02402       int outfd=-1;
02403 
02404       errno = 0;
02405       rchan = ast_waitfor_nandfds(&c, 1, &cmdfd, (cmdfd > -1) ? 1 : 0, NULL, &outfd, &ms);
02406       
02407       if (!rchan && outfd < 0 && ms) {
02408          if (errno == 0 || errno == EINTR)
02409             continue;
02410          ast_log(LOG_WARNING, "Wait failed (%s)\n", strerror(errno));
02411          ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
02412          return -1;
02413       } else if (outfd > -1) {
02414          /* The FD we were watching has something waiting */
02415          ast_log(LOG_WARNING, "The FD we were waiting for has something waiting. Waitfordigit returning numeric 1\n");
02416          ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
02417          return 1;
02418       } else if (rchan) {
02419          int res;
02420          struct ast_frame *f = ast_read(c);
02421          if (!f)
02422             return -1;
02423 
02424          switch (f->frametype) {
02425          case AST_FRAME_DTMF_BEGIN:
02426             break;
02427          case AST_FRAME_DTMF_END:
02428             res = f->subclass;
02429             ast_frfree(f);
02430             ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
02431             return res;
02432          case AST_FRAME_CONTROL:
02433             switch (f->subclass) {
02434             case AST_CONTROL_HANGUP:
02435                ast_frfree(f);
02436                ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
02437                return -1;
02438             case AST_CONTROL_RINGING:
02439             case AST_CONTROL_ANSWER:
02440             case AST_CONTROL_SRCUPDATE:
02441                /* Unimportant */
02442                break;
02443             default:
02444                ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", f->subclass);
02445                break;
02446             }
02447             break;
02448          case AST_FRAME_VOICE:
02449             /* Write audio if appropriate */
02450             if (audiofd > -1) {
02451                if (write(audiofd, f->data, f->datalen) < 0) {
02452                   ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
02453                }
02454             }
02455          default:
02456             /* Ignore */
02457             break;
02458          }
02459          ast_frfree(f);
02460       }
02461    }
02462 
02463    ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
02464 
02465    return 0; /* Time is up */
02466 }

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

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

Definition at line 1279 of file channel.c.

References channel_find_locked().

Referenced by next_channel().

01281 {
01282    return channel_find_locked(chan, NULL, 0, context, exten);
01283 }

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

Get channel by name or uniqueid prefix (locks channel).

Definition at line 1266 of file channel.c.

References channel_find_locked().

Referenced by my_ast_get_channel_by_name_locked(), next_channel(), and softhangup_exec().

01268 {
01269    return channel_find_locked(chan, name, namelen, NULL, NULL);
01270 }

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 3345 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_debug, ast_do_masquerade(), AST_FLAG_BLOCKING, AST_FLAG_WRITE_INT, AST_FLAG_ZOMBIE, AST_FORMAT_T140, 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_frisolate(), AST_LIST_NEXT, 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, ast_frame::frame_list, FRAMECOUNT_INC, ast_frame::frametype, ast_channel::generatordata, ast_channel_tech::indicate, ast_channel::insmpl, ast_frame::len, LOG_WARNING, ast_channel::masq, ast_channel::masqr, ast_channel::monitor, ast_channel::name, chanlist::next, ast_channel::outsmpl, ast_channel::rawwriteformat, ast_frame::samples, SEEK_FORCECUR, send_dtmf_event(), 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_text, ast_channel_tech::write_video, and ast_channel::writetrans.

Referenced by adsi_careful_send(), agent_write(), ast_feature_request_and_dial(), ast_generic_bridge(), ast_prod(), ast_readaudio_callback(), ast_readvideo_callback(), ast_udptl_bridge(), ast_write_video(), bridge_native_loop(), bridge_p2p_loop(), conf_queue_dtmf(), conf_run(), dahdi_bridge(), dictate_exec(), echo_exec(), fax_generator_generate(), features_write(), function_ilink(), gen_generate(), handle_jack_audio(), handle_link_data(), iax2_bridge(), jb_get_and_deliver(), linear_generator(), milliwatt_generate(), misdn_bridge(), moh_files_generator(), moh_generate(), mp3_exec(), NBScat_exec(), playtones_generator(), rpt(), rpt_call(), rpt_exec(), send_link_dtmf(), send_tone_burst(), send_waveform_to_channel(), silence_generator_generate(), sms_generate(), spy_generate(), t38_tx_packet_handler(), tonepair_generator(), and wait_for_answer().

03346 {
03347    int res = -1;
03348    struct ast_frame *f = NULL;
03349    int count = 0;
03350 
03351    /*Deadlock avoidance*/
03352    while(ast_channel_trylock(chan)) {
03353       /*cannot goto done since the channel is not locked*/
03354       if(count++ > 10) {
03355          ast_debug(1, "Deadlock avoided for write to channel '%s'\n", chan->name);
03356          return 0;
03357       }
03358       usleep(1);
03359    }
03360    /* Stop if we're a zombie or need a soft hangup */
03361    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan))
03362       goto done;
03363 
03364    /* Handle any pending masquerades */
03365    if (chan->masq && ast_do_masquerade(chan)) {
03366       ast_log(LOG_WARNING, "Failed to perform masquerade\n");
03367       goto done;
03368    }
03369    if (chan->masqr) {
03370       res = 0; /* XXX explain, why 0 ? */
03371       goto done;
03372    }
03373    if (chan->generatordata) {
03374       if (ast_test_flag(chan, AST_FLAG_WRITE_INT))
03375          ast_deactivate_generator(chan);
03376       else {
03377          if (fr->frametype == AST_FRAME_DTMF_END) {
03378             /* There is a generator running while we're in the middle of a digit.
03379              * It's probably inband DTMF, so go ahead and pass it so it can
03380              * stop the generator */
03381             ast_clear_flag(chan, AST_FLAG_BLOCKING);
03382             ast_channel_unlock(chan);
03383             res = ast_senddigit_end(chan, fr->subclass, fr->len);
03384             ast_channel_lock(chan);
03385             CHECK_BLOCKING(chan);
03386          } else if (fr->frametype == AST_FRAME_CONTROL && fr->subclass == AST_CONTROL_UNHOLD) {
03387             /* This is a side case where Echo is basically being called and the person put themselves on hold and took themselves off hold */
03388             res = (chan->tech->indicate == NULL) ? 0 :
03389                chan->tech->indicate(chan, fr->subclass, fr->data, fr->datalen);
03390          }
03391          res = 0; /* XXX explain, why 0 ? */
03392          goto done;
03393       }
03394    }
03395    /* High bit prints debugging */
03396    if (chan->fout & DEBUGCHAN_FLAG)
03397       ast_frame_dump(chan->name, fr, ">>");
03398    CHECK_BLOCKING(chan);
03399    switch (fr->frametype) {
03400    case AST_FRAME_CONTROL:
03401       res = (chan->tech->indicate == NULL) ? 0 :
03402          chan->tech->indicate(chan, fr->subclass, fr->data, fr->datalen);
03403       break;
03404    case AST_FRAME_DTMF_BEGIN:
03405       if (chan->audiohooks) {
03406          struct ast_frame *old_frame = fr;
03407          fr = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_WRITE, fr);
03408          if (old_frame != fr)
03409             f = fr;
03410       }
03411       send_dtmf_event(chan, "Sent", fr->subclass, "Yes", "No");
03412       ast_clear_flag(chan, AST_FLAG_BLOCKING);
03413       ast_channel_unlock(chan);
03414       res = ast_senddigit_begin(chan, fr->subclass);
03415       ast_channel_lock(chan);
03416       CHECK_BLOCKING(chan);
03417       break;
03418    case AST_FRAME_DTMF_END:
03419       if (chan->audiohooks) {
03420          struct ast_frame *new_frame = fr;
03421 
03422          new_frame = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_WRITE, fr);
03423          if (new_frame != fr) {
03424             ast_frfree(new_frame);
03425          }
03426       }
03427       send_dtmf_event(chan, "Sent", fr->subclass, "No", "Yes");
03428       ast_clear_flag(chan, AST_FLAG_BLOCKING);
03429       ast_channel_unlock(chan);
03430       res = ast_senddigit_end(chan, fr->subclass, fr->len);
03431       ast_channel_lock(chan);
03432       CHECK_BLOCKING(chan);
03433       break;
03434    case AST_FRAME_TEXT:
03435       if (fr->subclass == AST_FORMAT_T140) {
03436          res = (chan->tech->write_text == NULL) ? 0 :
03437             chan->tech->write_text(chan, fr);
03438       } else {
03439          res = (chan->tech->send_text == NULL) ? 0 :
03440             chan->tech->send_text(chan, (char *) fr->data);
03441       }
03442       break;
03443    case AST_FRAME_HTML:
03444       res = (chan->tech->send_html == NULL) ? 0 :
03445          chan->tech->send_html(chan, fr->subclass, (char *) fr->data, fr->datalen);
03446       break;
03447    case AST_FRAME_VIDEO:
03448       /* XXX Handle translation of video codecs one day XXX */
03449       res = (chan->tech->write_video == NULL) ? 0 :
03450          chan->tech->write_video(chan, fr);
03451       break;
03452    case AST_FRAME_MODEM:
03453       res = (chan->tech->write == NULL) ? 0 :
03454          chan->tech->write(chan, fr);
03455       break;
03456    case AST_FRAME_VOICE:
03457       if (chan->tech->write == NULL)
03458          break;   /*! \todo XXX should return 0 maybe ? */
03459 
03460       /* If the frame is in the raw write format, then it's easy... just use the frame - otherwise we will have to translate */
03461       if (fr->subclass == chan->rawwriteformat)
03462          f = fr;
03463       else
03464          f = (chan->writetrans) ? ast_translate(chan->writetrans, fr, 0) : fr;
03465 
03466       if (!f) {
03467          res = 0;
03468          break;
03469       }
03470 
03471       if (chan->audiohooks) {
03472          struct ast_frame *prev = NULL, *new_frame, *cur, *dup;
03473 
03474          /* Since ast_audiohook_write may return a new frame, and the cur frame is
03475           * an item in a list of frames, create a new list adding each cur frame back to it
03476           * regardless if the cur frame changes or not. */
03477          for (cur = f; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
03478             new_frame = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_WRITE, cur);
03479 
03480             /* if this frame is different than cur, preserve the end of the list,
03481              * free the old frames, and set cur to be the new frame */
03482             if (new_frame != cur) {
03483                /* doing an ast_frisolate here seems silly, but we are not guaranteed the new_frame
03484                 * isn't part of local storage, meaning if ast_audiohook_write is called multiple
03485                 * times it may override the previous frame we got from it unless we dup it */
03486                if ((dup = ast_frisolate(new_frame))) {
03487                   AST_LIST_NEXT(dup, frame_list) = AST_LIST_NEXT(cur, frame_list);
03488                   ast_frfree(new_frame);
03489                   ast_frfree(cur);
03490                   cur = dup;
03491                }
03492             }
03493 
03494             /* now, regardless if cur is new or not, add it to the new list,
03495              * if the new list has not started, cur will become the first item. */
03496             if (prev) {
03497                AST_LIST_NEXT(prev, frame_list) = cur;
03498             } else {
03499                f = cur; /* set f to be the beginning of our new list */
03500             }
03501             prev = cur;
03502          }
03503       }
03504       
03505       /* If Monitor is running on this channel, then we have to write frames out there too */
03506       /* the translator on chan->writetrans may have returned multiple frames
03507          from the single frame we passed in; if so, feed each one of them to the
03508          monitor */
03509       if (chan->monitor && chan->monitor->write_stream) {
03510          struct ast_frame *cur;
03511 
03512          for (cur = f; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
03513          /* XXX must explain this code */
03514 #ifndef MONITOR_CONSTANT_DELAY
03515             int jump = chan->insmpl - chan->outsmpl - 4 * cur->samples;
03516             if (jump >= 0) {
03517                jump = chan->insmpl - chan->outsmpl;
03518                if (ast_seekstream(chan->monitor->write_stream, jump, SEEK_FORCECUR) == -1)
03519                   ast_log(LOG_WARNING, "Failed to perform seek in monitoring write stream, synchronization between the files may be broken\n");
03520                chan->outsmpl += jump + cur->samples;
03521             } else {
03522                chan->outsmpl += cur->samples;
03523             }
03524 #else
03525             int jump = chan->insmpl - chan->outsmpl;
03526             if (jump - MONITOR_DELAY >= 0) {
03527                if (ast_seekstream(chan->monitor->write_stream, jump - cur->samples, SEEK_FORCECUR) == -1)
03528                   ast_log(LOG_WARNING, "Failed to perform seek in monitoring write stream, synchronization between the files may be broken\n");
03529                chan->outsmpl += jump;
03530             } else {
03531                chan->outsmpl += cur->samples;
03532             }
03533 #endif
03534             if (chan->monitor->state == AST_MONITOR_RUNNING) {
03535                if (ast_writestream(chan->monitor->write_stream, cur) < 0)
03536                   ast_log(LOG_WARNING, "Failed to write data to channel monitor write stream\n");
03537             }
03538          }
03539       }
03540 
03541       /* the translator on chan->writetrans may have returned multiple frames
03542          from the single frame we passed in; if so, feed each one of them to the
03543          channel, freeing each one after it has been written */
03544       if ((f != fr) && AST_LIST_NEXT(f, frame_list)) {
03545          struct ast_frame *cur, *next;
03546          unsigned int skip = 0;
03547 
03548          for (cur = f, next = AST_LIST_NEXT(cur, frame_list);
03549               cur;
03550               cur = next, next = cur ? AST_LIST_NEXT(cur, frame_list) : NULL) {
03551             if (!skip) {
03552                if ((res = chan->tech->write(chan, cur)) < 0) {
03553                   chan->_softhangup |= AST_SOFTHANGUP_DEV;
03554                   skip = 1;
03555                } else if (next) {
03556                   /* don't do this for the last frame in the list,
03557                      as the code outside the loop will do it once
03558                   */
03559                   chan->fout = FRAMECOUNT_INC(chan->fout);
03560                }
03561             }
03562             ast_frfree(cur);
03563          }
03564 
03565          /* reset f so the code below doesn't attempt to free it */
03566          f = NULL;
03567       } else {
03568          res = chan->tech->write(chan, f);
03569       }
03570       break;
03571    case AST_FRAME_NULL:
03572    case AST_FRAME_IAX:
03573       /* Ignore these */
03574       res = 0;
03575       break;
03576    default:
03577       /* At this point, fr is the incoming frame and f is NULL.  Channels do
03578        * not expect to get NULL as a frame pointer and will segfault.  Hence,
03579        * we output the original frame passed in. */
03580       res = chan->tech->write(chan, fr);
03581       break;
03582    }
03583 
03584    if (f && f != fr)
03585       ast_frfree(f);
03586    ast_clear_flag(chan, AST_FLAG_BLOCKING);
03587 
03588    /* Consider a write failure to force a soft hangup */
03589    if (res < 0) {
03590       chan->_softhangup |= AST_SOFTHANGUP_DEV;
03591    } else {
03592       chan->fout = FRAMECOUNT_INC(chan->fout);
03593    }
03594 done:
03595    ast_channel_unlock(chan);
03596    return res;
03597 }

int ast_write_text ( struct ast_channel chan,
struct ast_frame frame 
)

Write text 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.

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

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

03335 {
03336    int res;
03337    if (!chan->tech->write_video)
03338       return 0;
03339    res = ast_write(chan, fr);
03340    if (!res)
03341       res = 1;
03342    return res;
03343 }

const char* channelreloadreason2txt ( enum channelreloadreason  reason  ) 

Convert enum channelreloadreason to text string for manager event.

Parameters:
reason Enum channelreloadreason - reason for reload (manager, cli, start etc)
\ brief Convert channel reloadreason (ENUM) to text string for manager event

Definition at line 5570 of file channel.c.

References CHANNEL_CLI_RELOAD, CHANNEL_MODULE_LOAD, and CHANNEL_MODULE_RELOAD.

Referenced by reload_config().

05571 {
05572    switch (reason) {
05573    case CHANNEL_MODULE_LOAD:
05574       return "LOAD (Channel module load)";
05575 
05576    case CHANNEL_MODULE_RELOAD:
05577       return "RELOAD (Channel module reload)";
05578 
05579    case CHANNEL_CLI_RELOAD:
05580       return "CLIRELOAD (Channel module reload by CLI command)";
05581 
05582    default:
05583       return "MANAGERRELOAD (Channel module reload by manager)";
05584    }
05585 };

static void timersub ( struct timeval *  tvend,
struct timeval *  tvstart,
struct timeval *  tvdiff 
) [inline, static]

Definition at line 1650 of file channel.h.

Referenced by ast_rtcp_write_rr(), ast_rtcp_write_sr(), and ast_select().

01651 {
01652    tvdiff->tv_sec = tvend->tv_sec - tvstart->tv_sec;
01653    tvdiff->tv_usec = tvend->tv_usec - tvstart->tv_usec;
01654    if (tvdiff->tv_usec < 0) {
01655       tvdiff->tv_sec --;
01656       tvdiff->tv_usec += 1000000;
01657    }
01658 
01659 }


Variable Documentation

unsigned long global_fin

The current value of the debug flags is stored in the two variables global_fin and global_fout (declared in main/channel.c)

Definition at line 88 of file channel.c.

Referenced by handle_core_set_debug_channel().

unsigned long global_fout

Definition at line 88 of file channel.c.

Referenced by handle_core_set_debug_channel().


Generated on Wed Oct 28 11:46:06 2009 for Asterisk - the Open Source PBX by  doxygen 1.5.6