Thu Oct 1 13:09:53 2009

Asterisk developer's documentation


channel.h File Reference

General Asterisk PBX channel definitions. More...

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

Go to the source code of this file.

Data Structures

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

Defines

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

Typedefs

typedef unsigned long long ast_group_t

Enumerations

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

Functions

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


Detailed Description

General Asterisk PBX channel definitions.

See also:

Definition in file channel.h.


Define Documentation

#define AST_AGENT_FD   (AST_MAX_FDS-3)

used by agents for pass through

Definition at line 127 of file channel.h.

Referenced by agent_read().

#define AST_ALERT_FD   (AST_MAX_FDS-1)

used for alertpipe

Definition at line 125 of file channel.h.

Referenced by restore_channel().

#define AST_BRIDGE_DTMF_CHANNEL_0   (1 << 0)

Report DTMF on channel 0.

Definition at line 1046 of file channel.h.

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

#define AST_BRIDGE_DTMF_CHANNEL_1   (1 << 1)

Report DTMF on channel 1.

Definition at line 1048 of file channel.h.

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

#define AST_BRIDGE_IGNORE_SIGS   (1 << 4)

Ignore all signal frames except NULL.

Definition at line 1054 of file channel.h.

Referenced by bridge_native_loop().

#define AST_BRIDGE_REC_CHANNEL_0   (1 << 2)

Return all voice frames on channel 0.

Definition at line 1050 of file channel.h.

#define AST_BRIDGE_REC_CHANNEL_1   (1 << 3)

Return all voice frames on channel 1.

Definition at line 1052 of file channel.h.

#define AST_CHANNEL_NAME   80

Max length of an ast_channel name

Definition at line 102 of file channel.h.

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

#define AST_GENERATOR_FD   (AST_MAX_FDS-4)

used by generator

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

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

#define AST_MAX_EXTENSION   80

Max length of an extension

Definition at line 100 of file channel.h.

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

#define AST_MAX_FDS   8

Definition at line 120 of file channel.h.

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

#define AST_TIMING_FD   (AST_MAX_FDS-2)

used for timingfd

Definition at line 126 of file channel.h.

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

#define CHECK_BLOCKING (  ) 

Definition at line 1399 of file channel.h.

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

#define DATASTORE_INHERIT_FOREVER   INT_MAX

Definition at line 118 of file channel.h.

Referenced by _macro_exec(), add_features_datastores(), ast_channel_datastore_inherit(), and try_calling().

#define DEBUGCHAN_FLAG   0x80000000

Definition at line 294 of file channel.h.

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

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

Definition at line 295 of file channel.h.

Referenced by __ast_read(), and ast_write().

#define LOAD_OH ( oh   ) 

Definition at line 557 of file channel.h.

Referenced by ast_pbx_outgoing_exten().

#define MAX_LANGUAGE   20

Max length of the language setting

Definition at line 103 of file channel.h.

#define MAX_MUSICCLASS   80

Max length of the music class setting

Definition at line 104 of file channel.h.


Typedef Documentation

typedef unsigned long long ast_group_t

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

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

anonymous enum

ast_channel flags

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

Definition at line 474 of file channel.h.

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

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_NO_H_EXTEN 
AST_FEATURE_WARNING_ACTIVE 

Definition at line 521 of file channel.h.

00521      {
00522    AST_FEATURE_PLAY_WARNING = (1 << 0),
00523    AST_FEATURE_REDIRECT =     (1 << 1),
00524    AST_FEATURE_DISCONNECT =   (1 << 2),
00525    AST_FEATURE_ATXFER =       (1 << 3),
00526    AST_FEATURE_AUTOMON =      (1 << 4),
00527    AST_FEATURE_PARKCALL =     (1 << 5),
00528    AST_FEATURE_NO_H_EXTEN =   (1 << 6),
00529    AST_FEATURE_WARNING_ACTIVE = (1 << 7),
00530 };

anonymous enum

Enumerator:
AST_CDR_TRANSFER 
AST_CDR_FORWARD 
AST_CDR_CALLWAIT 
AST_CDR_CONFERENCE 

Definition at line 579 of file channel.h.

00579      {
00580    AST_CDR_TRANSFER =   (1 << 0),
00581    AST_CDR_FORWARD =    (1 << 1),
00582    AST_CDR_CALLWAIT =   (1 << 2),
00583    AST_CDR_CONFERENCE = (1 << 3),
00584 };

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

00586      {
00587    /*! Soft hangup by device */
00588    AST_SOFTHANGUP_DEV =       (1 << 0),
00589    /*! Soft hangup for async goto */
00590    AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
00591    AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
00592    AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
00593    AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
00594    AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
00595    AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
00596 };

enum ast_bridge_result

Enumerator:
AST_BRIDGE_COMPLETE 
AST_BRIDGE_FAILED 
AST_BRIDGE_FAILED_NOWARN 
AST_BRIDGE_RETRY 

Definition at line 130 of file channel.h.

00130                        {
00131    AST_BRIDGE_COMPLETE = 0,
00132    AST_BRIDGE_FAILED = -1,
00133    AST_BRIDGE_FAILED_NOWARN = -2,
00134    AST_BRIDGE_RETRY = -3,
00135 };

enum ast_channel_adsicpe

Enumerator:
AST_ADSI_UNKNOWN 
AST_ADSI_AVAILABLE 
AST_ADSI_UNAVAILABLE 
AST_ADSI_OFFHOOKONLY 

Definition at line 297 of file channel.h.

enum ast_channel_state

ast_channel states

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

Definition at line 310 of file channel.h.

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

enum channelreloadreason

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

Enumerator:
CHANNEL_MODULE_LOAD 
CHANNEL_MODULE_RELOAD 
CHANNEL_CLI_RELOAD 
CHANNEL_MANAGER_RELOAD 

Definition at line 600 of file channel.h.


Function Documentation

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

Definition at line 3204 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_answer(), ast_cdr_busy(), 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_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, handle_cause(), ast_channel::hangupcause, LOG_NOTICE, outgoing_helper::parent_channel, ast_channel::priority, outgoing_helper::priority, and outgoing_helper::vars.

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

03205 {
03206    int dummy_outstate;
03207    int cause = 0;
03208    struct ast_channel *chan;
03209    int res = 0;
03210    int last_subclass = 0;
03211    
03212    if (outstate)
03213       *outstate = 0;
03214    else
03215       outstate = &dummy_outstate;   /* make outstate always a valid pointer */
03216 
03217    chan = ast_request(type, format, data, &cause);
03218    if (!chan) {
03219       ast_log(LOG_NOTICE, "Unable to request channel %s/%s\n", type, (char *)data);
03220       handle_cause(cause, outstate);
03221       return NULL;
03222    }
03223 
03224    if (oh) {
03225       if (oh->vars)  
03226          ast_set_variables(chan, oh->vars);
03227       /* XXX why is this necessary, for the parent_channel perhaps ? */
03228       if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name))
03229          ast_set_callerid(chan, oh->cid_num, oh->cid_name, oh->cid_num);
03230       if (oh->parent_channel)
03231          ast_channel_inherit_variables(oh->parent_channel, chan);
03232       if (oh->account)
03233          ast_cdr_setaccount(chan, oh->account); 
03234    }
03235    ast_set_callerid(chan, cid_num, cid_name, cid_num);
03236    ast_set_flag(chan->cdr, AST_CDR_FLAG_ORIGINATED);
03237 
03238    if (ast_call(chan, data, 0)) {   /* ast_call failed... */
03239       ast_log(LOG_NOTICE, "Unable to call channel %s/%s\n", type, (char *)data);
03240    } else {
03241       res = 1; /* mark success in case chan->_state is already AST_STATE_UP */
03242       while (timeout && chan->_state != AST_STATE_UP) {
03243          struct ast_frame *f;
03244          res = ast_waitfor(chan, timeout);
03245          if (res <= 0) /* error, timeout, or done */
03246             break;
03247          if (timeout > -1)
03248             timeout = res;
03249          if (!ast_strlen_zero(chan->call_forward)) {
03250             if (!(chan = ast_call_forward(NULL, chan, &timeout, format, oh, outstate))) {
03251                return NULL;
03252             }
03253             continue;
03254          }
03255 
03256          f = ast_read(chan);
03257          if (!f) {
03258             *outstate = AST_CONTROL_HANGUP;
03259             res = 0;
03260             break;
03261          }
03262          if (f->frametype == AST_FRAME_CONTROL) {
03263             switch (f->subclass) {
03264             case AST_CONTROL_RINGING:  /* record but keep going */
03265                *outstate = f->subclass;
03266                break;
03267 
03268             case AST_CONTROL_BUSY:
03269                ast_cdr_busy(chan->cdr);
03270                *outstate = f->subclass;
03271                timeout = 0;
03272                break;
03273 
03274             case AST_CONTROL_CONGESTION:
03275                ast_cdr_failed(chan->cdr);
03276                *outstate = f->subclass;
03277                timeout = 0;
03278                break;
03279 
03280             case AST_CONTROL_ANSWER:
03281                ast_cdr_answer(chan->cdr);
03282                *outstate = f->subclass;
03283                timeout = 0;      /* trick to force exit from the while() */
03284                break;
03285 
03286             /* Ignore these */
03287             case AST_CONTROL_PROGRESS:
03288             case AST_CONTROL_PROCEEDING:
03289             case AST_CONTROL_HOLD:
03290             case AST_CONTROL_UNHOLD:
03291             case AST_CONTROL_VIDUPDATE:
03292             case AST_CONTROL_SRCUPDATE:
03293             case -1:       /* Ignore -- just stopping indications */
03294                break;
03295 
03296             default:
03297                ast_log(LOG_NOTICE, "Don't know what to do with control frame %d\n", f->subclass);
03298             }
03299             last_subclass = f->subclass;
03300          }
03301          ast_frfree(f);
03302       }
03303    }
03304 
03305    /* Final fixups */
03306    if (oh) {
03307       if (!ast_strlen_zero(oh->context))
03308          ast_copy_string(chan->context, oh->context, sizeof(chan->context));
03309       if (!ast_strlen_zero(oh->exten))
03310          ast_copy_string(chan->exten, oh->exten, sizeof(chan->exten));
03311       if (oh->priority) 
03312          chan->priority = oh->priority;
03313    }
03314    if (chan->_state == AST_STATE_UP)
03315       *outstate = AST_CONTROL_ANSWER;
03316 
03317    if (res <= 0) {
03318       if ( AST_CONTROL_RINGING == last_subclass ) 
03319          chan->hangupcause = AST_CAUSE_NO_ANSWER;
03320       if (!chan->cdr && (chan->cdr = ast_cdr_alloc()))
03321          ast_cdr_init(chan->cdr, chan);
03322       if (chan->cdr) {
03323          char tmp[256];
03324          snprintf(tmp, sizeof(tmp), "%s/%s", type, (char *)data);
03325          ast_cdr_setapp(chan->cdr,"Dial",tmp);
03326          ast_cdr_update(chan);
03327          ast_cdr_start(chan->cdr);
03328          ast_cdr_end(chan->cdr);
03329          /* If the cause wasn't handled properly */
03330          if (ast_cdr_disposition(chan->cdr,chan->hangupcause))
03331             ast_cdr_failed(chan->cdr);
03332       }
03333       ast_hangup(chan);
03334       chan = NULL;
03335    }
03336    return chan;
03337 }

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

Activate a given generator

Definition at line 1658 of file channel.c.

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

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

01659 {
01660    int res = 0;
01661 
01662    ast_channel_lock(chan);
01663 
01664    if (chan->generatordata) {
01665       if (chan->generator && chan->generator->release)
01666          chan->generator->release(chan, chan->generatordata);
01667       chan->generatordata = NULL;
01668    }
01669 
01670    ast_prod(chan);
01671    if (gen->alloc && !(chan->generatordata = gen->alloc(chan, params))) {
01672       res = -1;
01673    }
01674    
01675    if (!res) {
01676       ast_settimeout(chan, 160, generator_force, chan);
01677       chan->generator = gen;
01678    }
01679 
01680    ast_channel_unlock(chan);
01681 
01682    return res;
01683 }

int ast_active_channels ( void   ) 

returns number of active/allocated channels

Returns number of active/allocated channels

Definition at line 443 of file channel.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, and AST_LIST_UNLOCK.

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

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

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

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

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

Definition at line 1324 of file channel.h.

Referenced by ast_waitfor_nandfds().

01325 {
01326    pfd->fd = fd;
01327    pfd->events = POLLIN | POLLPRI;
01328    return fd >= 0;
01329 }

int ast_answer ( struct ast_channel chan  ) 

Answer a ringing call.

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

Definition at line 1579 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 __login_exec(), agi_exec_full(), alarmreceiver_exec(), answer_trunk_chan(), app_exec(), ast_bridge_call(), ast_control_streamfile(), ast_pickup_call(), auth_exec(), background_detect_exec(), builtin_parkcall(), common_exec(), conf_exec(), count_exec(), dictate_exec(), directory_exec(), disa_exec(), exec(), features_answer(), handle_answer(), ices_exec(), old_milliwatt_exec(), park_call_exec(), park_exec(), pbx_builtin_answer(), pbx_builtin_background(), pickup_do(), playback_exec(), privacy_exec(), read_exec(), sayunixtime_exec(), send_waveform_to_channel(), skel_exec(), sla_station_exec(), speech_background(), testclient_exec(), testserver_exec(), vm_exec(), vm_execmain(), waitforsilence_exec(), and zapateller_exec().

01580 {
01581    int res = 0;
01582    ast_channel_lock(chan);
01583    /* You can't answer an outbound call */
01584    if (ast_test_flag(chan, AST_FLAG_OUTGOING)) {
01585       ast_channel_unlock(chan);
01586       return 0;
01587    }
01588    /* Stop if we're a zombie or need a soft hangup */
01589    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
01590       ast_channel_unlock(chan);
01591       return -1;
01592    }
01593    switch(chan->_state) {
01594    case AST_STATE_RINGING:
01595    case AST_STATE_RING:
01596       if (chan->tech->answer)
01597          res = chan->tech->answer(chan);
01598       ast_setstate(chan, AST_STATE_UP);
01599       ast_cdr_answer(chan->cdr);
01600       break;
01601    case AST_STATE_UP:
01602       break;
01603    default:
01604       break;
01605    }
01606    ast_indicate(chan, -1);
01607    chan->visible_indication = 0;
01608    ast_channel_unlock(chan);
01609    return res;
01610 }

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 196 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, 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_automonitor(), builtin_blindtransfer(), conf_play(), do_atxfer(), feature_exec_app(), function_realtime_read(), function_realtime_write(), osplookup_exec(), sla_station_exec(), smdi_msg_retrieve_read(), and system_exec_helper().

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

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 256 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(), ast_dtmf_stream(), ast_get_srv(), ast_get_txt(), ast_hangup(), bridge_playfile(), builtin_automonitor(), conf_play(), do_atxfer(), feature_exec_app(), finishup(), function_realtime_read(), function_realtime_write(), osplookup_exec(), sla_station_exec(), smdi_msg_retrieve_read(), and system_exec_helper().

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

void ast_begin_shutdown ( int  hangup  ) 

Initiate system shutdown.

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

Definition at line 430 of file channel.c.

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

Referenced by quit_handler().

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

int ast_best_codec ( int  fmts  ) 

Pick the best audio codec.

Pick the best codec

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

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

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

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

G.726 is standard ADPCM, in RFC3551 packing order

G.726 is standard ADPCM, in AAL2 packing order

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

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

iLBC is not too bad

Speex is free, but computationally more expensive than GSM

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

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

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

Definition at line 655 of file channel.c.

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

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

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

struct ast_channel* ast_bridged_channel ( struct ast_channel chan  ) 

Find bridged channel.

Parameters:
chan Current channel

Definition at line 4082 of file channel.c.

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

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

04083 {
04084    struct ast_channel *bridged;
04085    bridged = chan->_bridge;
04086    if (bridged && bridged->tech->bridged_channel)
04087       bridged = bridged->tech->bridged_channel(chan, bridged);
04088    return bridged;
04089 }

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 3394 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(), connect_link(), do_idle_thread(), features_call(), findmeexec(), ring_entry(), rpt(), and wait_for_answer().

03395 {
03396    /* Place an outgoing call, but don't wait any longer than timeout ms before returning.
03397       If the remote end does not answer within the timeout, then do NOT hang up, but
03398       return anyway.  */
03399    int res = -1;
03400    /* Stop if we're a zombie or need a soft hangup */
03401    ast_channel_lock(chan);
03402    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
03403       if (chan->cdr)
03404          ast_set_flag(chan->cdr, AST_CDR_FLAG_DIALED);
03405       if (chan->tech->call)
03406          res = chan->tech->call(chan, addr, timeout);
03407       ast_set_flag(chan, AST_FLAG_OUTGOING);
03408    }
03409    ast_channel_unlock(chan);
03410    return res;
03411 }

struct ast_channel* ast_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.

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

References outgoing_helper::account, ast_channel::accountcode, accountcode, ast_call(), ast_cdr_setaccount(), ast_channel_datastore_inherit(), ast_channel_inherit_variables(), ast_channel_lock, ast_channel_unlock, 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::cid, ast_callerid::cid_name, outgoing_helper::cid_name, ast_callerid::cid_num, outgoing_helper::cid_num, ast_channel::context, ast_channel::data, 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().

03138 {
03139    char tmpchan[256];
03140    struct ast_channel *new = NULL;
03141    char *data, *type;
03142    int cause = 0;
03143 
03144    /* gather data and request the new forward channel */
03145    ast_copy_string(tmpchan, orig->call_forward, sizeof(tmpchan));
03146    if ((data = strchr(tmpchan, '/'))) {
03147       *data++ = '\0';
03148       type = tmpchan;
03149    } else {
03150       const char *forward_context;
03151       ast_channel_lock(orig);
03152       forward_context = pbx_builtin_getvar_helper(orig, "FORWARD_CONTEXT");
03153       snprintf(tmpchan, sizeof(tmpchan), "%s@%s", orig->call_forward, S_OR(forward_context, orig->context));
03154       ast_channel_unlock(orig);
03155       data = tmpchan;
03156       type = "Local";
03157    }
03158    if (!(new = ast_request(type, format, data, &cause))) {
03159       ast_log(LOG_NOTICE, "Unable to create channel for call forward to '%s/%s' (cause = %d)\n", type, data, cause);
03160       handle_cause(cause, outstate);
03161       ast_hangup(orig);
03162       return NULL;
03163    }
03164 
03165    /* Copy/inherit important information into new channel */
03166    if (oh) {
03167       if (oh->vars) {
03168          ast_set_variables(new, oh->vars);
03169       }
03170       if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name)) {
03171          ast_set_callerid(new, oh->cid_num, oh->cid_name, oh->cid_num);
03172       }
03173       if (oh->parent_channel) {
03174          ast_channel_inherit_variables(oh->parent_channel, new);
03175          ast_channel_datastore_inherit(oh->parent_channel, new);
03176       }
03177       if (oh->account) {
03178          ast_cdr_setaccount(new, oh->account);
03179       }
03180    } else if (caller) { /* no outgoing helper so use caller if avaliable */
03181       ast_channel_inherit_variables(caller, new);
03182       ast_channel_datastore_inherit(caller, new);
03183    }
03184 
03185    ast_channel_lock(orig);
03186    ast_string_field_set(new, accountcode, orig->accountcode);
03187    if (!ast_strlen_zero(orig->cid.cid_num) && !ast_strlen_zero(new->cid.cid_name)) {
03188       ast_set_callerid(new, orig->cid.cid_num, orig->cid.cid_name, orig->cid.cid_num);
03189    }
03190    ast_channel_unlock(orig);
03191 
03192    /* call new channel */
03193    if ((*timeout = ast_call(new, data, 0))) {
03194       ast_log(LOG_NOTICE, "Unable to call forward to channel %s/%s\n", type, (char *)data);
03195       ast_hangup(orig);
03196       ast_hangup(new);
03197       return NULL;
03198    }
03199    ast_hangup(orig);
03200 
03201    return new;
03202 }

void ast_cancel_shutdown ( void   ) 

Cancel a shutdown in progress.

Cancels an existing shutdown and returns to normal operation

Definition at line 455 of file channel.c.

Referenced by handle_abort_halt().

00456 {
00457    shutting_down = 0;
00458 }

const char* ast_cause2str ( int  state  ) 

Gives the string form of a given hangup cause.

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

Definition at line 575 of file channel.c.

References causes, and desc.

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

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

void ast_change_name ( struct ast_channel chan,
char *  newname 
)

Change channel name.

Definition at line 3644 of file channel.c.

References ast_string_field_set, manager_event(), name, ast_channel::name, and ast_channel::uniqueid.

03645 {
03646    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", chan->name, newname, chan->uniqueid);
03647    ast_string_field_set(chan, name, newname);
03648 }

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

Create a channel structure.

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

Definition at line 709 of file channel.c.

References ast_calloc, ast_log(), AST_MAX_FDS, ast_string_field_init, DAHDI_FILE_TIMER, ast_channel::flags, free, HAVE_DAHDI, LOG_WARNING, sched_context_create(), and sched_context_destroy().

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

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

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

References ast_channel::_bridge, ast_channel::_softhangup, AST_BRIDGE_COMPLETE, AST_BRIDGE_FAILED, AST_BRIDGE_FAILED_NOWARN, AST_BRIDGE_RETRY, ast_channel_make_compatible(), ast_check_hangup(), ast_check_hangup_locked(), ast_clear_flag, AST_CONTROL_SRCUPDATE, AST_FEATURE_PLAY_WARNING, AST_FEATURE_REDIRECT, AST_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_verbose(), ast_channel::audiohooks, ast_channel_tech::bridge, bridge_playfile(), ast_channel::cid, ast_callerid::cid_num, config, ast_channel::generator, LOG_DEBUG, manager_event(), ast_channel::masq, ast_channel::masqr, ast_channel::monitor, ast_channel::name, ast_channel::nativeformats, option_debug, option_verbose, ast_channel::readformat, ast_channel_tech::send_digit_begin, t, ast_channel::tech, ast_channel::uniqueid, update_bridgepeer(), VERBOSE_PREFIX_3, and ast_channel::writeformat.

Referenced by ast_bridge_call().

04326 {
04327    struct ast_channel *who = NULL;
04328    enum ast_bridge_result res = AST_BRIDGE_COMPLETE;
04329    int nativefailed=0;
04330    int firstpass;
04331    int o0nativeformats;
04332    int o1nativeformats;
04333    long time_left_ms=0;
04334    char caller_warning = 0;
04335    char callee_warning = 0;
04336 
04337    if (c0->_bridge) {
04338       ast_log(LOG_WARNING, "%s is already in a bridge with %s\n",
04339          c0->name, c0->_bridge->name);
04340       return -1;
04341    }
04342    if (c1->_bridge) {
04343       ast_log(LOG_WARNING, "%s is already in a bridge with %s\n",
04344          c1->name, c1->_bridge->name);
04345       return -1;
04346    }
04347    
04348    /* Stop if we're a zombie or need a soft hangup */
04349    if (ast_test_flag(c0, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c0) ||
04350        ast_test_flag(c1, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c1))
04351       return -1;
04352 
04353    *fo = NULL;
04354    firstpass = config->firstpass;
04355    config->firstpass = 0;
04356 
04357    if (ast_tvzero(config->start_time))
04358       config->start_time = ast_tvnow();
04359    time_left_ms = config->timelimit;
04360 
04361    caller_warning = ast_test_flag(&config->features_caller, AST_FEATURE_PLAY_WARNING);
04362    callee_warning = ast_test_flag(&config->features_callee, AST_FEATURE_PLAY_WARNING);
04363 
04364    if (config->start_sound && firstpass) {
04365       if (caller_warning)
04366          bridge_playfile(c0, c1, config->start_sound, time_left_ms / 1000);
04367       if (callee_warning)
04368          bridge_playfile(c1, c0, config->start_sound, time_left_ms / 1000);
04369    }
04370 
04371    /* Keep track of bridge */
04372    c0->_bridge = c1;
04373    c1->_bridge = c0;
04374 
04375    /* \todo  XXX here should check that cid_num is not NULL */
04376    manager_event(EVENT_FLAG_CALL, "Link",
04377             "Channel1: %s\r\n"
04378             "Channel2: %s\r\n"
04379             "Uniqueid1: %s\r\n"
04380             "Uniqueid2: %s\r\n"
04381             "CallerID1: %s\r\n"
04382             "CallerID2: %s\r\n",
04383             c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
04384 
04385    o0nativeformats = c0->nativeformats;
04386    o1nativeformats = c1->nativeformats;
04387 
04388    if (config->feature_timer && !ast_tvzero(config->nexteventts)) {
04389       config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->feature_timer, 1000));
04390    } else if (config->timelimit && firstpass) {
04391       config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->timelimit, 1000));
04392       if (caller_warning || callee_warning)
04393          config->nexteventts = ast_tvsub(config->nexteventts, ast_samp2tv(config->play_warning, 1000));
04394    }
04395 
04396    if (!c0->tech->send_digit_begin)
04397       ast_set_flag(c1, AST_FLAG_END_DTMF_ONLY);
04398    if (!c1->tech->send_digit_begin)
04399       ast_set_flag(c0, AST_FLAG_END_DTMF_ONLY);
04400 
04401    /* Before we enter in and bridge these two together tell them both the source of audio has changed */
04402    ast_indicate(c0, AST_CONTROL_SRCUPDATE);
04403    ast_indicate(c1, AST_CONTROL_SRCUPDATE);
04404 
04405    for (/* ever */;;) {
04406       struct timeval now = { 0, };
04407       int to;
04408 
04409       to = -1;
04410 
04411       if (!ast_tvzero(config->nexteventts)) {
04412          now = ast_tvnow();
04413          to = ast_tvdiff_ms(config->nexteventts, now);
04414          if (to <= 0) {
04415             if (!config->timelimit) {
04416                res = AST_BRIDGE_COMPLETE;
04417                break;
04418             }
04419             to = 0;
04420          }
04421       }
04422 
04423       if (config->timelimit) {
04424          time_left_ms = config->timelimit - ast_tvdiff_ms(now, config->start_time);
04425          if (time_left_ms < to)
04426             to = time_left_ms;
04427 
04428          if (time_left_ms <= 0) {
04429             if (caller_warning && config->end_sound)
04430                bridge_playfile(c0, c1, config->end_sound, 0);
04431             if (callee_warning && config->end_sound)
04432                bridge_playfile(c1, c0, config->end_sound, 0);
04433             *fo = NULL;
04434             if (who)
04435                *rc = who;
04436             res = 0;
04437             break;
04438          }
04439 
04440          if (!to) {
04441             if (time_left_ms >= 5000 && config->warning_sound && config->play_warning && ast_test_flag(config, AST_FEATURE_WARNING_ACTIVE)) {
04442                int t = (time_left_ms + 500) / 1000; /* round to nearest second */
04443                if (caller_warning)
04444                   bridge_playfile(c0, c1, config->warning_sound, t);
04445                if (callee_warning)
04446                   bridge_playfile(c1, c0, config->warning_sound, t);
04447             }
04448             if (config->warning_freq && (time_left_ms > (config->warning_freq + 5000)))
04449                config->nexteventts = ast_tvadd(config->nexteventts, ast_samp2tv(config->warning_freq, 1000));
04450             else
04451                config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->timelimit, 1000));
04452          }
04453          ast_clear_flag(config, AST_FEATURE_WARNING_ACTIVE);
04454       }
04455 
04456       if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE || c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE) {
04457          if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
04458             c0->_softhangup = 0;
04459          if (c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
04460             c1->_softhangup = 0;
04461          c0->_bridge = c1;
04462          c1->_bridge = c0;
04463          if (option_debug)
04464             ast_log(LOG_DEBUG, "Unbridge signal received. Ending native bridge.\n");
04465          continue;
04466       }
04467 
04468       /* Stop if we're a zombie or need a soft hangup */
04469       if (ast_test_flag(c0, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c0) ||
04470           ast_test_flag(c1, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c1)) {
04471          *fo = NULL;
04472          if (who)
04473             *rc = who;
04474          res = 0;
04475          if (option_debug)
04476             ast_log(LOG_DEBUG, "Bridge stops because we're zombie or need a soft hangup: c0=%s, c1=%s, flags: %s,%s,%s,%s\n",
04477                c0->name, c1->name,
04478                ast_test_flag(c0, AST_FLAG_ZOMBIE) ? "Yes" : "No",
04479                ast_check_hangup(c0) ? "Yes" : "No",
04480                ast_test_flag(c1, AST_FLAG_ZOMBIE) ? "Yes" : "No",
04481                ast_check_hangup(c1) ? "Yes" : "No");
04482          break;
04483       }
04484 
04485       update_bridgepeer(c0, c1);
04486 
04487       if (c0->tech->bridge &&
04488           (config->timelimit == 0) &&
04489           (c0->tech->bridge == c1->tech->bridge) &&
04490           !nativefailed && !c0->monitor && !c1->monitor &&
04491           !c0->audiohooks && !c1->audiohooks && !ast_test_flag(&(config->features_callee),AST_FEATURE_REDIRECT) &&
04492           !ast_test_flag(&(config->features_caller),AST_FEATURE_REDIRECT) &&
04493           !c0->masq && !c0->masqr && !c1->masq && !c1->masqr) {
04494          /* Looks like they share a bridge method and nothing else is in the way */
04495          ast_set_flag(c0, AST_FLAG_NBRIDGE);
04496          ast_set_flag(c1, AST_FLAG_NBRIDGE);
04497          if ((res = c0->tech->bridge(c0, c1, config->flags, fo, rc, to)) == AST_BRIDGE_COMPLETE) {
04498             /* \todo  XXX here should check that cid_num is not NULL */
04499             manager_event(EVENT_FLAG_CALL, "Unlink",
04500                      "Channel1: %s\r\n"
04501                      "Channel2: %s\r\n"
04502                      "Uniqueid1: %s\r\n"
04503                      "Uniqueid2: %s\r\n"
04504                      "CallerID1: %s\r\n"
04505                      "CallerID2: %s\r\n",
04506                      c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
04507             if (option_debug)
04508                ast_log(LOG_DEBUG, "Returning from native bridge, channels: %s, %s\n", c0->name, c1->name);
04509 
04510             ast_clear_flag(c0, AST_FLAG_NBRIDGE);
04511             ast_clear_flag(c1, AST_FLAG_NBRIDGE);
04512 
04513             if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE || c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
04514                continue;
04515 
04516             c0->_bridge = NULL;
04517             c1->_bridge = NULL;
04518 
04519             return res;
04520          } else {
04521             ast_clear_flag(c0, AST_FLAG_NBRIDGE);
04522             ast_clear_flag(c1, AST_FLAG_NBRIDGE);
04523          }
04524          switch (res) {
04525          case AST_BRIDGE_RETRY:
04526             if (config->play_warning) {
04527                ast_set_flag(config, AST_FEATURE_WARNING_ACTIVE);
04528             }
04529             continue;
04530          default:
04531             if (option_verbose > 2)
04532                ast_verbose(VERBOSE_PREFIX_3 "Native bridging %s and %s ended\n",
04533                       c0->name, c1->name);
04534             /* fallthrough */
04535          case AST_BRIDGE_FAILED_NOWARN:
04536             nativefailed++;
04537             break;
04538          }
04539       }
04540 
04541       if (((c0->writeformat != c1->readformat) || (c0->readformat != c1->writeformat) ||
04542           (c0->nativeformats != o0nativeformats) || (c1->nativeformats != o1nativeformats)) &&
04543           !(c0->generator || c1->generator)) {
04544          if (ast_channel_make_compatible(c0, c1)) {
04545             ast_log(LOG_WARNING, "Can't make %s and %s compatible\n", c0->name, c1->name);
04546             /* \todo  XXX here should check that cid_num is not NULL */
04547                                 manager_event(EVENT_FLAG_CALL, "Unlink",
04548                      "Channel1: %s\r\n"
04549                      "Channel2: %s\r\n"
04550                      "Uniqueid1: %s\r\n"
04551                      "Uniqueid2: %s\r\n"
04552                      "CallerID1: %s\r\n"
04553                      "CallerID2: %s\r\n",
04554                      c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
04555             return AST_BRIDGE_FAILED;
04556          }
04557          o0nativeformats = c0->nativeformats;
04558          o1nativeformats = c1->nativeformats;
04559       }
04560 
04561       update_bridgepeer(c0, c1);
04562 
04563       res = ast_generic_bridge(c0, c1, config, fo, rc, config->nexteventts);
04564       if (res != AST_BRIDGE_RETRY) {
04565          break;
04566       } else if (config->feature_timer) {
04567          /* feature timer expired but has not been updated, sending to ast_bridge_call to do so */
04568          break;
04569       }
04570    }
04571 
04572    ast_clear_flag(c0, AST_FLAG_END_DTMF_ONLY);
04573    ast_clear_flag(c1, AST_FLAG_END_DTMF_ONLY);
04574 
04575    /* Now that we have broken the bridge the source will change yet again */
04576    ast_indicate(c0, AST_CONTROL_SRCUPDATE);
04577    ast_indicate(c1, AST_CONTROL_SRCUPDATE);
04578 
04579    c0->_bridge = NULL;
04580    c1->_bridge = NULL;
04581 
04582    /* \todo  XXX here should check that cid_num is not NULL */
04583    manager_event(EVENT_FLAG_CALL, "Unlink",
04584             "Channel1: %s\r\n"
04585             "Channel2: %s\r\n"
04586             "Uniqueid1: %s\r\n"
04587             "Uniqueid2: %s\r\n"
04588             "CallerID1: %s\r\n"
04589             "CallerID2: %s\r\n",
04590             c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
04591    if (option_debug)
04592       ast_log(LOG_DEBUG, "Bridge stops bridging channels %s and %s\n", c0->name, c1->name);
04593 
04594    return res;
04595 }

int ast_channel_cmpwhentohangup ( struct ast_channel chan,
time_t  offset 
)

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

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

Definition at line 475 of file channel.c.

References ast_channel::whentohangup.

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

int ast_channel_datastore_add ( struct ast_channel chan,
struct ast_datastore datastore 
)

Add a datastore to a channel.

Definition at line 1396 of file channel.c.

References AST_LIST_INSERT_HEAD, ast_channel::datastores, and ast_datastore::entry.

Referenced by _macro_exec(), add_features_datastores(), setup_chanspy_ds(), setup_inheritance_datastore(), setup_mixmonitor_ds(), setup_transfer_datastore(), smdi_msg_retrieve_read(), speech_create(), and try_calling().

01397 {
01398    int res = 0;
01399 
01400    AST_LIST_INSERT_HEAD(&chan->datastores, datastore, entry);
01401 
01402    return res;
01403 }

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

Create a channel datastore structure.

Definition at line 1335 of file channel.c.

References ast_calloc, ast_strdup, and ast_datastore::info.

Referenced by _macro_exec(), add_features_datastores(), ast_channel_datastore_inherit(), setup_chanspy_ds(), setup_inheritance_datastore(), setup_mixmonitor_ds(), setup_transfer_datastore(), smdi_msg_retrieve_read(), speech_create(), and try_calling().

01336 {
01337    struct ast_datastore *datastore = NULL;
01338 
01339    /* Make sure we at least have type so we can identify this */
01340    if (info == NULL) {
01341       return NULL;
01342    }
01343 
01344    /* Allocate memory for datastore and clear it */
01345    datastore = ast_calloc(1, sizeof(*datastore));
01346    if (datastore == NULL) {
01347       return NULL;
01348    }
01349 
01350    datastore->info = info;
01351 
01352    datastore->uid = ast_strdup(uid);
01353 
01354    return datastore;
01355 }

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

Find a datastore on a channel.

Definition at line 1423 of file channel.c.

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

Referenced by _macro_exec(), add_features_datastores(), attended_transfer_occurred(), chanspy_ds_free(), do_atxfer(), do_parking_thread(), find_speech(), func_inheritance_write(), park_exec(), queue_transfer_fixup(), smdi_msg_read(), speech_background(), speech_destroy(), stop_mixmonitor_exec(), and try_calling().

01424 {
01425    struct ast_datastore *datastore = NULL;
01426    
01427    if (info == NULL)
01428       return NULL;
01429 
01430    AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->datastores, datastore, entry) {
01431       if (datastore->info == info) {
01432          if (uid != NULL && datastore->uid != NULL) {
01433             if (!strcasecmp(uid, datastore->uid)) {
01434                /* Matched by type AND uid */
01435                break;
01436             }
01437          } else {
01438             /* Matched by type at least */
01439             break;
01440          }
01441       }
01442    }
01443    AST_LIST_TRAVERSE_SAFE_END
01444 
01445    return datastore;
01446 }

int ast_channel_datastore_free ( struct ast_datastore datastore  ) 

Free a channel datastore structure.

Definition at line 1357 of file channel.c.

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

Referenced by add_features_datastores(), ast_channel_free(), chanspy_ds_free(), setup_inheritance_datastore(), and try_calling().

01358 {
01359    int res = 0;
01360 
01361    /* Using the destroy function (if present) destroy the data */
01362    if (datastore->info->destroy != NULL && datastore->data != NULL) {
01363       datastore->info->destroy(datastore->data);
01364       datastore->data = NULL;
01365    }
01366 
01367    /* Free allocated UID memory */
01368    if (datastore->uid != NULL) {
01369       free(datastore->uid);
01370       datastore->uid = NULL;
01371    }
01372 
01373    /* Finally free memory used by ourselves */
01374    free(datastore);
01375 
01376    return res;
01377 }

int ast_channel_datastore_inherit ( struct ast_channel from,
struct ast_channel to 
)

Inherit datastores from a parent to a child.

Definition at line 1379 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::entry, ast_datastore::info, ast_datastore::inheritance, and ast_datastore::uid.

Referenced by ast_call_forward(), local_call(), and wait_for_answer().

01380 {
01381    struct ast_datastore *datastore = NULL, *datastore2;
01382 
01383    AST_LIST_TRAVERSE(&from->datastores, datastore, entry) {
01384       if (datastore->inheritance > 0) {
01385          datastore2 = ast_channel_datastore_alloc(datastore->info, datastore->uid);
01386          if (datastore2) {
01387             datastore2->data = datastore->info->duplicate ? datastore->info->duplicate(datastore->data) : NULL;
01388             datastore2->inheritance = datastore->inheritance == DATASTORE_INHERIT_FOREVER ? DATASTORE_INHERIT_FOREVER : datastore->inheritance - 1;
01389             AST_LIST_INSERT_TAIL(&to->datastores, datastore2, entry);
01390          }
01391       }
01392    }
01393    return 0;
01394 }

int ast_channel_datastore_remove ( struct ast_channel chan,
struct ast_datastore datastore 
)

Remove a datastore from a channel.

Definition at line 1405 of file channel.c.

References AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_channel::datastores, and ast_datastore::entry.

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

01406 {
01407    struct ast_datastore *datastore2 = NULL;
01408    int res = -1;
01409 
01410    /* Find our position and remove ourselves */
01411    AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->datastores, datastore2, entry) {
01412       if (datastore2 == datastore) {
01413          AST_LIST_REMOVE_CURRENT(&chan->datastores, entry);
01414          res = 0;
01415          break;
01416       }
01417    }
01418    AST_LIST_TRAVERSE_SAFE_END
01419 
01420    return res;
01421 }

int ast_channel_defer_dtmf ( struct ast_channel chan  ) 

Set defer DTMF flag on channel.

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

Definition at line 1034 of file channel.c.

References AST_FLAG_DEFER_DTMF, ast_set_flag, and ast_test_flag.

Referenced by __adsi_transmit_messages(), and find_cache().

01035 {
01036    int pre = 0;
01037 
01038    if (chan) {
01039       pre = ast_test_flag(chan, AST_FLAG_DEFER_DTMF);
01040       ast_set_flag(chan, AST_FLAG_DEFER_DTMF);
01041    }
01042    return pre;
01043 }

void ast_channel_free ( struct ast_channel  ) 

Free a channel structure.

Definition at line 1241 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_device_state_changed_literal(), ast_frfree, ast_jb_destroy(), AST_LIST_LOCK, AST_LIST_REMOVE, AST_LIST_REMOVE_HEAD, AST_LIST_UNLOCK, ast_log(), ast_moh_cleanup(), ast_mutex_destroy, ast_string_field_free_memory, ast_translator_free_path(), ast_var_delete(), ast_channel::cdr, ast_channel::cid, ast_channel::datastores, ast_datastore::entry, f, free, free_cid(), ast_channel::lock, LOG_ERROR, 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(), and sendpage().

01242 {
01243    int fd;
01244    struct ast_var_t *vardata;
01245    struct ast_frame *f;
01246    struct varshead *headp;
01247    struct ast_datastore *datastore = NULL;
01248    char name[AST_CHANNEL_NAME], *dashptr;
01249    
01250    headp=&chan->varshead;
01251    
01252    AST_LIST_LOCK(&channels);
01253    if (!AST_LIST_REMOVE(&channels, chan, chan_list)) {
01254       ast_log(LOG_ERROR, "Unable to find channel in list to free. Assuming it has already been done.\n");
01255    }
01256    /* Lock and unlock the channel just to be sure nobody has it locked still
01257       due to a reference retrieved from the channel list. */
01258    ast_channel_lock(chan);
01259    ast_channel_unlock(chan);
01260 
01261    /* Get rid of each of the data stores on the channel */
01262    while ((datastore = AST_LIST_REMOVE_HEAD(&chan->datastores, entry)))
01263       /* Free the data store */
01264       ast_channel_datastore_free(datastore);
01265 
01266    /* Lock and unlock the channel just to be sure nobody has it locked still
01267       due to a reference that was stored in a datastore. (i.e. app_chanspy) */
01268    ast_channel_lock(chan);
01269    ast_channel_unlock(chan);
01270 
01271    if (chan->tech_pvt) {
01272       ast_log(LOG_WARNING, "Channel '%s' may not have been hung up properly\n", chan->name);
01273       free(chan->tech_pvt);
01274    }
01275 
01276    if (chan->sched)
01277       sched_context_destroy(chan->sched);
01278 
01279    ast_copy_string(name, chan->name, sizeof(name));
01280    if ((dashptr = strrchr(name, '-'))) {
01281       *dashptr = '\0';
01282    }
01283 
01284    /* Stop monitoring */
01285    if (chan->monitor)
01286       chan->monitor->stop( chan, 0 );
01287 
01288    /* If there is native format music-on-hold state, free it */
01289    if (chan->music_state)
01290       ast_moh_cleanup(chan);
01291 
01292    /* Free translators */
01293    if (chan->readtrans)
01294       ast_translator_free_path(chan->readtrans);
01295    if (chan->writetrans)
01296       ast_translator_free_path(chan->writetrans);
01297    if (chan->pbx)
01298       ast_log(LOG_WARNING, "PBX may not have been terminated properly on '%s'\n", chan->name);
01299    free_cid(&chan->cid);
01300    /* Close pipes if appropriate */
01301    if ((fd = chan->alertpipe[0]) > -1)
01302       close(fd);
01303    if ((fd = chan->alertpipe[1]) > -1)
01304       close(fd);
01305    if ((fd = chan->timingfd) > -1)
01306       close(fd);
01307    while ((f = AST_LIST_REMOVE_HEAD(&chan->readq, frame_list)))
01308       ast_frfree(f);
01309    
01310    /* loop over the variables list, freeing all data and deleting list items */
01311    /* no need to lock the list, as the channel is already locked */
01312    
01313    while ((vardata = AST_LIST_REMOVE_HEAD(headp, entries)))
01314       ast_var_delete(vardata);
01315 
01316    ast_app_group_discard(chan);
01317 
01318    /* Destroy the jitterbuffer */
01319    ast_jb_destroy(chan);
01320 
01321    if (chan->cdr) {
01322       ast_cdr_discard(chan->cdr);
01323       chan->cdr = NULL;
01324    }
01325    
01326    ast_mutex_destroy(&chan->lock);
01327 
01328    ast_string_field_free_memory(chan);
01329    free(chan);
01330    AST_LIST_UNLOCK(&channels);
01331 
01332    ast_device_state_changed_literal(name);
01333 }

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

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

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

03651 {
03652    struct ast_var_t *current, *newvar;
03653    const char *varname;
03654 
03655    AST_LIST_TRAVERSE(&parent->varshead, current, entries) {
03656       int vartype = 0;
03657 
03658       varname = ast_var_full_name(current);
03659       if (!varname)
03660          continue;
03661 
03662       if (varname[0] == '_') {
03663          vartype = 1;
03664          if (varname[1] == '_')
03665             vartype = 2;
03666       }
03667 
03668       switch (vartype) {
03669       case 1:
03670          newvar = ast_var_assign(&varname[1], ast_var_value(current));
03671          if (newvar) {
03672             AST_LIST_INSERT_TAIL(&child->varshead, newvar, entries);
03673             if (option_debug)
03674                ast_log(LOG_DEBUG, "Copying soft-transferable variable %s.\n", ast_var_name(newvar));
03675          }
03676          break;
03677       case 2:
03678          newvar = ast_var_assign(ast_var_full_name(current), ast_var_value(current));
03679          if (newvar) {
03680             AST_LIST_INSERT_TAIL(&child->varshead, newvar, entries);
03681             if (option_debug)
03682                ast_log(LOG_DEBUG, "Copying hard-transferable variable %s.\n", ast_var_name(newvar));
03683          }
03684          break;
03685       default:
03686          if (option_debug)
03687             ast_log(LOG_DEBUG, "Not copying variable %s.\n", ast_var_name(current));
03688          break;
03689       }
03690    }
03691 }

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

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

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

03504 {
03505    int src;
03506    int dst;
03507 
03508    if (chan->readformat == peer->writeformat && chan->writeformat == peer->readformat) {
03509       /* Already compatible!  Moving on ... */
03510       return 0;
03511    }
03512 
03513    /* Set up translation from the chan to the peer */
03514    src = chan->nativeformats;
03515    dst = peer->nativeformats;
03516    if (ast_translator_best_choice(&dst, &src) < 0) {
03517       ast_log(LOG_WARNING, "No path to translate from %s(%d) to %s(%d)\n", chan->name, src, peer->name, dst);
03518       return -1;
03519    }
03520 
03521    /* if the best path is not 'pass through', then
03522       transcoding is needed; if desired, force transcode path
03523       to use SLINEAR between channels, but only if there is
03524       no direct conversion available */
03525    if ((src != dst) && ast_opt_transcode_via_slin &&
03526        (ast_translate_path_steps(dst, src) != 1))
03527       dst = AST_FORMAT_SLINEAR;
03528    if (ast_set_read_format(chan, dst) < 0) {
03529       ast_log(LOG_WARNING, "Unable to set read format on channel %s to %d\n", chan->name, dst);
03530       return -1;
03531    }
03532    if (ast_set_write_format(peer, dst) < 0) {
03533       ast_log(LOG_WARNING, "Unable to set write format on channel %s to %d\n", peer->name, dst);
03534       return -1;
03535    }
03536 
03537    /* Set up translation from the peer to the chan */
03538    src = peer->nativeformats;
03539    dst = chan->nativeformats;
03540    if (ast_translator_best_choice(&dst, &src) < 0) {
03541       ast_log(LOG_WARNING, "No path to translate from %s(%d) to %s(%d)\n", peer->name, src, chan->name, dst);
03542       return -1;
03543    }
03544 
03545    /* if the best path is not 'pass through', then
03546       transcoding is needed; if desired, force transcode path
03547       to use SLINEAR between channels, but only if there is
03548       no direct conversion available */
03549    if ((src != dst) && ast_opt_transcode_via_slin &&
03550        (ast_translate_path_steps(dst, src) != 1))
03551       dst = AST_FORMAT_SLINEAR;
03552    if (ast_set_read_format(peer, dst) < 0) {
03553       ast_log(LOG_WARNING, "Unable to set read format on channel %s to %d\n", peer->name, dst);
03554       return -1;
03555    }
03556    if (ast_set_write_format(chan, dst) < 0) {
03557       ast_log(LOG_WARNING, "Unable to set write format on channel %s to %d\n", chan->name, dst);
03558       return -1;
03559    }
03560    return 0;
03561 }

int ast_channel_masquerade ( struct ast_channel original,
struct ast_channel clone 
)

Weird function made for call transfers.

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

Definition at line 3563 of file channel.c.

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

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

03564 {
03565    int res = -1;
03566    struct ast_channel *final_orig, *final_clone, *base;
03567 
03568 retrymasq:
03569    final_orig = original;
03570    final_clone = clone;
03571 
03572    ast_channel_lock(original);
03573    while (ast_channel_trylock(clone)) {
03574       ast_channel_unlock(original);
03575       usleep(1);
03576       ast_channel_lock(original);
03577    }
03578 
03579    /* each of these channels may be sitting behind a channel proxy (i.e. chan_agent)
03580       and if so, we don't really want to masquerade it, but its proxy */
03581    if (original->_bridge && (original->_bridge != ast_bridged_channel(original)) && (original->_bridge->_bridge != original))
03582       final_orig = original->_bridge;
03583 
03584    if (clone->_bridge && (clone->_bridge != ast_bridged_channel(clone)) && (clone->_bridge->_bridge != clone))
03585       final_clone = clone->_bridge;
03586    
03587    if (final_clone->tech->get_base_channel && (base = final_clone->tech->get_base_channel(final_clone))) {
03588       final_clone = base;
03589    }
03590 
03591    if ((final_orig != original) || (final_clone != clone)) {
03592       /* Lots and lots of deadlock avoidance.  The main one we're competing with
03593        * is ast_write(), which locks channels recursively, when working with a
03594        * proxy channel. */
03595       if (ast_channel_trylock(final_orig)) {
03596          ast_channel_unlock(clone);
03597          ast_channel_unlock(original);
03598          goto retrymasq;
03599       }
03600       if (ast_channel_trylock(final_clone)) {
03601          ast_channel_unlock(final_orig);
03602          ast_channel_unlock(clone);
03603          ast_channel_unlock(original);
03604          goto retrymasq;
03605       }
03606       ast_channel_unlock(clone);
03607       ast_channel_unlock(original);
03608       original = final_orig;
03609       clone = final_clone;
03610    }
03611 
03612    if (original == clone) {
03613       ast_log(LOG_WARNING, "Can't masquerade channel '%s' into itself!\n", original->name);
03614       ast_channel_unlock(clone);
03615       ast_channel_unlock(original);
03616       return -1;
03617    }
03618 
03619    if (option_debug)
03620       ast_log(LOG_DEBUG, "Planning to masquerade channel %s into the structure of %s\n",
03621          clone->name, original->name);
03622    if (original->masq) {
03623       ast_log(LOG_WARNING, "%s is already going to masquerade as %s\n",
03624          original->masq->name, original->name);
03625    } else if (clone->masqr) {
03626       ast_log(LOG_WARNING, "%s is already going to masquerade as %s\n",
03627          clone->name, clone->masqr->name);
03628    } else {
03629       original->masq = clone;
03630       clone->masqr = original;
03631       ast_queue_frame(original, &ast_null_frame);
03632       ast_queue_frame(clone, &ast_null_frame);
03633       if (option_debug)
03634          ast_log(LOG_DEBUG, "Done planning to masquerade channel %s into the structure of %s\n", clone->name, original->name);
03635       res = 0;
03636    }
03637 
03638    ast_channel_unlock(clone);
03639    ast_channel_unlock(original);
03640 
03641    return res;
03642 }

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

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

char* ast_channel_reason2str ( int  reason  ) 

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

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

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

03102 {
03103    switch (reason) /* the following appear to be the only ones actually returned by request_and_dial */
03104    {
03105    case 0:
03106       return "Call Failure (not BUSY, and not NO_ANSWER, maybe Circuit busy or down?)";
03107    case AST_CONTROL_HANGUP:
03108       return "Hangup";
03109    case AST_CONTROL_RING:
03110       return "Local Ring";
03111    case AST_CONTROL_RINGING:
03112       return "Remote end Ringing";
03113    case AST_CONTROL_ANSWER:
03114       return "Remote end has Answered";
03115    case AST_CONTROL_BUSY:
03116       return "Remote end is Busy";
03117    case AST_CONTROL_CONGESTION:
03118       return "Congestion (circuits busy)";
03119    default:
03120       return "Unknown Reason!!";
03121    }
03122 }

int ast_channel_register ( const struct ast_channel_tech tech  ) 

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

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

Definition at line 497 of file channel.c.

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

Referenced by load_module(), and unload_module().

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

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

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

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

03492 {
03493    if (chan->tech->send_html)
03494       return chan->tech->send_html(chan, subclass, data, datalen);
03495    return -1;
03496 }

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

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

Definition at line 3498 of file channel.c.

References ast_channel_sendhtml(), and AST_HTML_URL.

Referenced by sendurl_exec().

03499 {
03500    return ast_channel_sendhtml(chan, AST_HTML_URL, url, strlen(url) + 1);
03501 }

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

Sets an option on a channel.

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

Definition at line 4598 of file channel.c.

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

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

04599 {
04600    int res;
04601 
04602    if (chan->tech->setoption) {
04603       res = chan->tech->setoption(chan, option, data, datalen);
04604       if (res < 0)
04605          return res;
04606    } else {
04607       errno = ENOSYS;
04608       return -1;
04609    }
04610    if (block) {
04611       /* XXX Implement blocking -- just wait for our option frame reply, discarding
04612          intermediate packets. XXX */
04613       ast_log(LOG_ERROR, "XXX Blocking not implemented yet XXX\n");
04614       return -1;
04615    }
04616    return 0;
04617 }

void ast_channel_setwhentohangup ( struct ast_channel chan,
time_t  offset 
)

Set when to hang a channel up.

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

Definition at line 467 of file channel.c.

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

Referenced by action_timeout(), and timeout_write().

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

struct ast_silence_generator* ast_channel_start_silence_generator ( struct ast_channel chan  ) 

Starts a silence generator on the given channel.

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

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

Definition at line 4926 of file channel.c.

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

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

04927 {
04928    struct ast_silence_generator *state;
04929 
04930    if (!(state = ast_calloc(1, sizeof(*state)))) {
04931       return NULL;
04932    }
04933 
04934    state->old_write_format = chan->writeformat;
04935 
04936    if (ast_set_write_format(chan, AST_FORMAT_SLINEAR) < 0) {
04937       ast_log(LOG_ERROR, "Could not set write format to SLINEAR\n");
04938       free(state);
04939       return NULL;
04940    }
04941 
04942    ast_activate_generator(chan, &silence_generator, state);
04943 
04944    if (option_debug)
04945       ast_log(LOG_DEBUG, "Started silence generator on '%s'\n", chan->name);
04946 
04947    return state;
04948 }

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

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

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

04951 {
04952    if (!state)
04953       return;
04954 
04955    ast_deactivate_generator(chan);
04956 
04957    if (option_debug)
04958       ast_log(LOG_DEBUG, "Stopped silence generator on '%s'\n", chan->name);
04959 
04960    if (ast_set_write_format(chan, state->old_write_format) < 0)
04961       ast_log(LOG_ERROR, "Could not return write format to its original state\n");
04962 
04963    free(state);
04964 }

int ast_channel_supports_html ( struct ast_channel channel  ) 

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

Definition at line 3486 of file channel.c.

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

Referenced by sendurl_exec().

03487 {
03488    return (chan->tech->send_html) ? 1 : 0;
03489 }

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

References ast_clear_flag, and AST_FLAG_DEFER_DTMF.

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

01047 {
01048    if (chan)
01049       ast_clear_flag(chan, AST_FLAG_DEFER_DTMF);
01050 }

void ast_channel_unregister ( const struct ast_channel_tech tech  ) 

Unregister a channel technology.

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

Definition at line 529 of file channel.c.

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

Referenced by __unload_module(), and unload_module().

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

struct ast_channel* ast_channel_walk_locked ( const struct ast_channel prev  ) 

Browse channels in use Browse the channels currently in use.

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

Definition at line 1162 of file channel.c.

References channel_find_locked().

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

01163 {
01164    return channel_find_locked(prev, NULL, 0, NULL, NULL);
01165 }

int ast_channel_whisper_feed ( struct ast_channel chan,
struct ast_frame f 
)

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

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

int ast_channel_whisper_start ( struct ast_channel chan  ) 

Begin 'whispering' onto a channel.

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

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

void ast_channel_whisper_stop ( struct ast_channel chan  ) 

Stop 'whispering' onto a channel.

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

struct ast_variable* ast_channeltype_list ( void   ) 

return an ast_variable list of channeltypes

Definition at line 163 of file channel.c.

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

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

int ast_check_hangup ( struct ast_channel chan  ) 

Check to see if a channel is needing hang up.

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

Definition at line 385 of file channel.c.

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

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

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

void ast_deactivate_generator ( struct ast_channel chan  ) 

Deactive an active generator

Definition at line 1612 of file channel.c.

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

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

01613 {
01614    ast_channel_lock(chan);
01615    if (chan->generatordata) {
01616       if (chan->generator && chan->generator->release)
01617          chan->generator->release(chan, chan->generatordata);
01618       chan->generatordata = NULL;
01619       chan->generator = NULL;
01620       chan->fds[AST_GENERATOR_FD] = -1;
01621       ast_clear_flag(chan, AST_FLAG_WRITE_INT);
01622       ast_settimeout(chan, 0, NULL, NULL);
01623    }
01624    ast_channel_unlock(chan);
01625 }

int ast_do_masquerade ( struct ast_channel original  ) 

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

Note:
Assumes channel will be locked when called

Definition at line 3744 of file channel.c.

References ast_channel::_softhangup, ast_channel::_state, ast_channel::adsicpe, ast_channel::alertpipe, ast_app_group_update(), ast_cause2str(), ast_channel_free(), ast_channel_lock, ast_channel_unlock, ast_copy_string(), 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_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, ast_datastore::entry, errno, ast_channel::fdno, ast_channel::fds, ast_channel_tech::fixup, free_translation(), ast_channel_tech::hangup, ast_datastore::info, ast_channel::language, language, ast_channel::lock, LOG_DEBUG, manager_event(), ast_channel::masq, ast_channel::masqr, ast_channel::monitor, musicclass, name, ast_channel::name, ast_channel::nativeformats, option_debug, ast_channel::rawreadformat, ast_channel::rawwriteformat, ast_channel::readformat, ast_channel::readq, report_new_callerid(), t, ast_channel::tech, ast_channel::tech_pvt, ast_channel::timingfd, ast_channel_tech::type, ast_cdr::uniqueid, 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(), iax_park(), sip_park(), and sip_park_thread().

03745 {
03746    int x,i;
03747    int res=0;
03748    int origstate;
03749    struct ast_frame *cur;
03750    const struct ast_channel_tech *t;
03751    void *t_pvt;
03752    struct ast_callerid tmpcid;
03753    struct ast_channel *clone = original->masq;
03754    struct ast_cdr *cdr;
03755    int rformat = original->readformat;
03756    int wformat = original->writeformat;
03757    char newn[100];
03758    char orig[100];
03759    char masqn[100];
03760    char zombn[100];
03761 
03762    if (option_debug > 3)
03763       ast_log(LOG_DEBUG, "Actually Masquerading %s(%d) into the structure of %s(%d)\n",
03764          clone->name, clone->_state, original->name, original->_state);
03765 
03766    /* XXX This is a seriously wacked out operation.  We're essentially putting the guts of
03767       the clone channel into the original channel.  Start by killing off the original
03768       channel's backend.   I'm not sure we're going to keep this function, because
03769       while the features are nice, the cost is very high in terms of pure nastiness. XXX */
03770 
03771    /* We need the clone's lock, too */
03772    ast_channel_lock(clone);
03773 
03774    if (option_debug > 1)
03775       ast_log(LOG_DEBUG, "Got clone lock for masquerade on '%s' at %p\n", clone->name, &clone->lock);
03776 
03777    /* Having remembered the original read/write formats, we turn off any translation on either
03778       one */
03779    free_translation(clone);
03780    free_translation(original);
03781 
03782 
03783    /* Unlink the masquerade */
03784    original->masq = NULL;
03785    clone->masqr = NULL;
03786    
03787    /* Save the original name */
03788    ast_copy_string(orig, original->name, sizeof(orig));
03789    /* Save the new name */
03790    ast_copy_string(newn, clone->name, sizeof(newn));
03791    /* Create the masq name */
03792    snprintf(masqn, sizeof(masqn), "%s<MASQ>", newn);
03793       
03794    /* Copy the name from the clone channel */
03795    ast_string_field_set(original, name, newn);
03796 
03797    /* Mangle the name of the clone channel */
03798    ast_string_field_set(clone, name, masqn);
03799    
03800    /* Notify any managers of the change, first the masq then the other */
03801    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", newn, masqn, clone->uniqueid);
03802    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", orig, newn, original->uniqueid);
03803 
03804    /* Swap the technologies */   
03805    t = original->tech;
03806    original->tech = clone->tech;
03807    clone->tech = t;
03808 
03809    /* Swap the cdrs */
03810    cdr = original->cdr;
03811    /* swap cdr uniqueid between channels, to get cdr uniqueid = channel uniqueid */
03812    ast_copy_string(clone->cdr->uniqueid, cdr->uniqueid, sizeof(cdr->uniqueid));
03813    original->cdr = clone->cdr;
03814    clone->cdr = cdr;
03815 
03816    t_pvt = original->tech_pvt;
03817    original->tech_pvt = clone->tech_pvt;
03818    clone->tech_pvt = t_pvt;
03819 
03820    /* Swap the alertpipes */
03821    for (i = 0; i < 2; i++) {
03822       x = original->alertpipe[i];
03823       original->alertpipe[i] = clone->alertpipe[i];
03824       clone->alertpipe[i] = x;
03825    }
03826 
03827    /* 
03828     * Swap the readq's.  The end result should be this:
03829     *
03830     *  1) All frames should be on the new (original) channel.
03831     *  2) Any frames that were already on the new channel before this
03832     *     masquerade need to be at the end of the readq, after all of the
03833     *     frames on the old (clone) channel.
03834     *  3) The alertpipe needs to get poked for every frame that was already
03835     *     on the new channel, since we are now using the alert pipe from the
03836     *     old (clone) channel.
03837     */
03838    {
03839       AST_LIST_HEAD_NOLOCK(, ast_frame) tmp_readq;
03840       AST_LIST_HEAD_SET_NOLOCK(&tmp_readq, NULL);
03841 
03842       AST_LIST_APPEND_LIST(&tmp_readq, &original->readq, frame_list);
03843       AST_LIST_APPEND_LIST(&original->readq, &clone->readq, frame_list);
03844 
03845       while ((cur = AST_LIST_REMOVE_HEAD(&tmp_readq, frame_list))) {
03846          AST_LIST_INSERT_TAIL(&original->readq, cur, frame_list);
03847          if (original->alertpipe[1] > -1) {
03848             int poke = 0;
03849 
03850             if (write(original->alertpipe[1], &poke, sizeof(poke)) < 0) {
03851                ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
03852             }
03853          }
03854       }
03855    }
03856 
03857    /* Swap the raw formats */
03858    x = original->rawreadformat;
03859    original->rawreadformat = clone->rawreadformat;
03860    clone->rawreadformat = x;
03861    x = original->rawwriteformat;
03862    original->rawwriteformat = clone->rawwriteformat;
03863    clone->rawwriteformat = x;
03864 
03865    clone->_softhangup = AST_SOFTHANGUP_DEV;
03866 
03867    /* And of course, so does our current state.  Note we need not
03868       call ast_setstate since the event manager doesn't really consider
03869       these separate.  We do this early so that the clone has the proper
03870       state of the original channel. */
03871    origstate = original->_state;
03872    original->_state = clone->_state;
03873    clone->_state = origstate;
03874 
03875    if (clone->tech->fixup){
03876       res = clone->tech->fixup(original, clone);
03877       if (res)
03878          ast_log(LOG_WARNING, "Fixup failed on channel %s, strange things may happen.\n", clone->name);
03879    }
03880 
03881    /* Start by disconnecting the original's physical side */
03882    if (clone->tech->hangup)
03883       res = clone->tech->hangup(clone);
03884    if (res) {
03885       ast_log(LOG_WARNING, "Hangup failed!  Strange things may happen!\n");
03886       ast_channel_unlock(clone);
03887       return -1;
03888    }
03889    
03890    snprintf(zombn, sizeof(zombn), "%s<ZOMBIE>", orig);
03891    /* Mangle the name of the clone channel */
03892    ast_string_field_set(clone, name, zombn);
03893    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", masqn, zombn, clone->uniqueid);
03894 
03895    /* Update the type. */
03896    t_pvt = original->monitor;
03897    original->monitor = clone->monitor;
03898    clone->monitor = t_pvt;
03899    
03900    /* Keep the same language.  */
03901    ast_string_field_set(original, language, clone->language);
03902    /* Copy the FD's other than the generator fd */
03903    for (x = 0; x < AST_MAX_FDS; x++) {
03904       if (x != AST_GENERATOR_FD)
03905          original->fds[x] = clone->fds[x];
03906    }
03907 
03908    ast_app_group_update(clone, original);
03909    /* Move data stores over */
03910    if (AST_LIST_FIRST(&clone->datastores)) {
03911       struct ast_datastore *ds;
03912       /* We use a safe traversal here because some fixup routines actually
03913        * remove the datastore from the list and free them.
03914        */
03915       AST_LIST_TRAVERSE_SAFE_BEGIN(&clone->datastores, ds, entry) {
03916          if (ds->info->chan_fixup)
03917             ds->info->chan_fixup(ds->data, clone, original);
03918       }
03919       AST_LIST_TRAVERSE_SAFE_END;
03920       AST_LIST_APPEND_LIST(&original->datastores, &clone->datastores, entry);
03921    }
03922 
03923    clone_variables(original, clone);
03924    /* Presense of ADSI capable CPE follows clone */
03925    original->adsicpe = clone->adsicpe;
03926    /* Bridge remains the same */
03927    /* CDR fields remain the same */
03928    /* XXX What about blocking, softhangup, blocker, and lock and blockproc? XXX */
03929    /* Application and data remain the same */
03930    /* Clone exception  becomes real one, as with fdno */
03931    ast_set_flag(original, ast_test_flag(clone, AST_FLAG_OUTGOING | AST_FLAG_EXCEPTION));
03932    original->fdno = clone->fdno;
03933    /* Schedule context remains the same */
03934    /* Stream stuff stays the same */
03935    /* Keep the original state.  The fixup code will need to work with it most likely */
03936 
03937    /* Just swap the whole structures, nevermind the allocations, they'll work themselves
03938       out. */
03939    tmpcid = original->cid;
03940    original->cid = clone->cid;
03941    clone->cid = tmpcid;
03942    report_new_callerid(original);
03943 
03944    /* Restore original timing file descriptor */
03945    original->fds[AST_TIMING_FD] = original->timingfd;
03946    
03947    /* Our native formats are different now */
03948    original->nativeformats = clone->nativeformats;
03949    
03950    /* Context, extension, priority, app data, jump table,  remain the same */
03951    /* pvt switches.  pbx stays the same, as does next */
03952    
03953    /* Set the write format */
03954    ast_set_write_format(original, wformat);
03955 
03956    /* Set the read format */
03957    ast_set_read_format(original, rformat);
03958 
03959    /* Copy the music class */
03960    ast_string_field_set(original, musicclass, clone->musicclass);
03961 
03962    if (option_debug)
03963       ast_log(LOG_DEBUG, "Putting channel %s in %d/%d formats\n", original->name, wformat, rformat);
03964 
03965    /* Okay.  Last thing is to let the channel driver know about all this mess, so he
03966       can fix up everything as best as possible */
03967    if (original->tech->fixup) {
03968       res = original->tech->fixup(clone, original);
03969       if (res) {
03970          ast_log(LOG_WARNING, "Channel for type '%s' could not fixup channel %s\n",
03971             original->tech->type, original->name);
03972          ast_channel_unlock(clone);
03973          return -1;
03974       }
03975    } else
03976       ast_log(LOG_WARNING, "Channel type '%s' does not have a fixup routine (for %s)!  Bad things may happen.\n",
03977          original->tech->type, original->name);
03978 
03979    /* 
03980     * If an indication is currently playing, maintain it on the channel 
03981     * that is taking the place of original 
03982     *
03983     * This is needed because the masquerade is swapping out in the internals
03984     * of this channel, and the new channel private data needs to be made
03985     * aware of the current visible indication (RINGING, CONGESTION, etc.)
03986     */
03987    if (original->visible_indication) {
03988       ast_indicate(original, original->visible_indication);
03989    }
03990    
03991    /* Now, at this point, the "clone" channel is totally F'd up.  We mark it as
03992       a zombie so nothing tries to touch it.  If it's already been marked as a
03993       zombie, then free it now (since it already is considered invalid). */
03994    if (ast_test_flag(clone, AST_FLAG_ZOMBIE)) {
03995       if (option_debug)
03996          ast_log(LOG_DEBUG, "Destroying channel clone '%s'\n", clone->name);
03997       ast_channel_unlock(clone);
03998       manager_event(EVENT_FLAG_CALL, "Hangup",
03999          "Channel: %s\r\n"
04000          "Uniqueid: %s\r\n"
04001          "Cause: %d\r\n"
04002          "Cause-txt: %s\r\n",
04003          clone->name,
04004          clone->uniqueid,
04005          clone->hangupcause,
04006          ast_cause2str(clone->hangupcause)
04007          );
04008       ast_channel_free(clone);
04009    } else {
04010       if (option_debug)
04011          ast_log(LOG_DEBUG, "Released clone lock on '%s'\n", clone->name);
04012       ast_set_flag(clone, AST_FLAG_ZOMBIE);
04013       ast_queue_frame(clone, &ast_null_frame);
04014       ast_channel_unlock(clone);
04015    }
04016    
04017    /* Signal any blocker */
04018    if (ast_test_flag(original, AST_FLAG_BLOCKING))
04019       pthread_kill(original->blocker, SIGURG);
04020    if (option_debug)
04021       ast_log(LOG_DEBUG, "Done Masquerading %s (%d)\n", original->name, original->_state);
04022    return 0;
04023 }

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

01333 {
01334    int x;
01335    int dummy=0;
01336 
01337    if (fd < 0)
01338       return 0;
01339    if (!start)
01340       start = &dummy;
01341    for (x = *start; x<max; x++)
01342       if (pfds[x].fd == fd) {
01343          if (x == *start)
01344             (*start)++;
01345          return pfds[x].revents;
01346       }
01347    return 0;
01348 }

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

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

Definition at line 1187 of file channel.c.

References channel_find_locked().

01188 {
01189    return channel_find_locked(NULL, NULL, 0, context, exten);
01190 }

struct ast_channel* ast_get_channel_by_name_locked ( const char *  chan  ) 

Get channel by name (locks channel).

Definition at line 1168 of file channel.c.

References channel_find_locked().

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

01169 {
01170    return channel_find_locked(NULL, name, 0, NULL, NULL);
01171 }

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

Get channel by name prefix (locks channel).

Definition at line 1174 of file channel.c.

References channel_find_locked().

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

01175 {
01176    return channel_find_locked(NULL, name, namelen, NULL, NULL);
01177 }

struct ast_channel_tech* ast_get_channel_tech ( const char *  name  ) 

Get a channel technology structure by name.

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

Definition at line 552 of file channel.c.

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

Referenced by ast_device_state().

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

ast_group_t ast_get_group ( const char *  s  ) 

Definition at line 4771 of file channel.c.

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

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

04772 {
04773    char *piece;
04774    char *c;
04775    int start=0, finish=0, x;
04776    ast_group_t group = 0;
04777 
04778    if (ast_strlen_zero(s))
04779       return 0;
04780 
04781    c = ast_strdupa(s);
04782    
04783    while ((piece = strsep(&c, ","))) {
04784       if (sscanf(piece, "%30d-%30d", &start, &finish) == 2) {
04785          /* Range */
04786       } else if (sscanf(piece, "%30d", &start)) {
04787          /* Just one */
04788          finish = start;
04789       } else {
04790          ast_log(LOG_ERROR, "Syntax error parsing group configuration '%s' at '%s'. Ignoring.\n", s, piece);
04791          continue;
04792       }
04793       for (x = start; x <= finish; x++) {
04794          if ((x > 63) || (x < 0)) {
04795             ast_log(LOG_WARNING, "Ignoring invalid group %d (maximum group is 63)\n", x);
04796          } else
04797             group |= ((ast_group_t) 1 << x);
04798       }
04799    }
04800    return group;
04801 }

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

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

Referenced by __ast_request_and_dial(), __oh323_new(), agent_hangup(), agent_read(), alsa_new(), answer_exec_run(), app_exec(), ast_async_goto(), ast_bridge_call_thread(), ast_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(), build_conf(), chanavail_exec(), check_compat(), check_goto_on_transfer(), clear_caller(), conf_run(), connect_link(), dahdi_handle_event(), dahdi_new(), do_atxfer(), do_hang(), do_idle_thread(), do_parking_thread(), features_hangup(), findmeexec(), gtalk_new(), handle_enbloc_call_message(), handle_frame(), handle_frame_ownerless(), handle_hd_hf(), handle_init_event(), handle_invite_replaces(), handle_offhook_message(), handle_request_invite(), handle_soft_key_event_message(), handle_stimulus_message(), hangup_chan(), hangupcalls(), hanguptree(), iax2_request(), iax_park(), iax_park_thread(), local_attended_transfer(), local_hangup(), masq_park_call(), mgcp_new(), mgcp_ss(), monitor_dial(), nbs_new(), oss_new(), park_exec(), parkandannounce_exec(), phone_new(), rpt(), rpt_call(), rpt_tele_thread(), sip_new(), sip_park(), sip_park_thread(), skinny_new(), skinny_ss(), ss_thread(), wait_for_answer(), and wait_for_winner().

01486 {
01487    int res = 0;
01488 
01489    /* Don't actually hang up a channel that will masquerade as someone else, or
01490       if someone is going to masquerade as us */
01491    ast_channel_lock(chan);
01492 
01493    if (chan->audiohooks) {
01494       ast_audiohook_detach_list(chan->audiohooks);
01495       chan->audiohooks = NULL;
01496    }
01497 
01498    ast_autoservice_stop(chan);
01499 
01500    if (chan->masq) {
01501       if (ast_do_masquerade(chan))
01502          ast_log(LOG_WARNING, "Failed to perform masquerade\n");
01503    }
01504 
01505    if (chan->masq) {
01506       ast_log(LOG_WARNING, "%s getting hung up, but someone is trying to masq into us?!?\n", chan->name);
01507       ast_channel_unlock(chan);
01508       return 0;
01509    }
01510    /* If this channel is one which will be masqueraded into something,
01511       mark it as a zombie already, so we know to free it later */
01512    if (chan->masqr) {
01513       ast_set_flag(chan, AST_FLAG_ZOMBIE);
01514       ast_channel_unlock(chan);
01515       return 0;
01516    }
01517    free_translation(chan);
01518    /* Close audio stream */
01519    if (chan->stream) {
01520       ast_closestream(chan->stream);
01521       chan->stream = NULL;
01522    }
01523    /* Close video stream */
01524    if (chan->vstream) {
01525       ast_closestream(chan->vstream);
01526       chan->vstream = NULL;
01527    }
01528    if (chan->sched) {
01529       sched_context_destroy(chan->sched);
01530       chan->sched = NULL;
01531    }
01532    
01533    if (chan->generatordata)   /* Clear any tone stuff remaining */
01534       chan->generator->release(chan, chan->generatordata);
01535    chan->generatordata = NULL;
01536    chan->generator = NULL;
01537    if (ast_test_flag(chan, AST_FLAG_BLOCKING)) {
01538       ast_log(LOG_WARNING, "Hard hangup called by thread %ld on %s, while fd "
01539                "is blocked by thread %ld in procedure %s!  Expect a failure\n",
01540                (long)pthread_self(), chan->name, (long)chan->blocker, chan->blockproc);
01541       ast_assert(ast_test_flag(chan, AST_FLAG_BLOCKING) == 0);
01542    }
01543    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE)) {
01544       if (option_debug)
01545          ast_log(LOG_DEBUG, "Hanging up channel '%s'\n", chan->name);
01546       if (chan->tech->hangup)
01547          res = chan->tech->hangup(chan);
01548    } else {
01549       if (option_debug)
01550          ast_log(LOG_DEBUG, "Hanging up zombie '%s'\n", chan->name);
01551    }
01552          
01553    ast_channel_unlock(chan);
01554    manager_event(EVENT_FLAG_CALL, "Hangup",
01555          "Channel: %s\r\n"
01556          "Uniqueid: %s\r\n"
01557          "Cause: %d\r\n"
01558          "Cause-txt: %s\r\n",
01559          chan->name,
01560          chan->uniqueid,
01561          chan->hangupcause,
01562          ast_cause2str(chan->hangupcause)
01563          );
01564 
01565    if (chan->cdr && !ast_test_flag(chan->cdr, AST_CDR_FLAG_BRIDGED) && 
01566       !ast_test_flag(chan->cdr, AST_CDR_FLAG_POST_DISABLED) && 
01567        (chan->cdr->disposition != AST_CDR_NULL || ast_test_flag(chan->cdr, AST_CDR_FLAG_DIALED))) {
01568          
01569       ast_cdr_end(chan->cdr);
01570       ast_cdr_detach(chan->cdr);
01571       chan->cdr = NULL;
01572    }
01573    
01574    ast_channel_free(chan);
01575 
01576    return res;
01577 }

int ast_indicate ( struct ast_channel chan,
int  condition 
)

Indicates condition of channel.

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

Definition at line 2517 of file channel.c.

References ast_indicate_data().

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

02518 {
02519    return ast_indicate_data(chan, condition, NULL, 0);
02520 }

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

Indicates condition of channel, with payload.

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

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

References ast_channel::_state, 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_TAKEOFFHOOK, AST_CONTROL_UNHOLD, AST_CONTROL_VIDUPDATE, AST_CONTROL_WINK, 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_DEBUG, ast_channel::name, option_debug, ast_channel::tech, ast_channel::visible_indication, and ast_channel::zone.

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

02557 {
02558    /* By using an enum, we'll get compiler warnings for values not handled 
02559     * in switch statements. */
02560    enum ast_control_frame_type condition = _condition;
02561    const struct tone_zone_sound *ts = NULL;
02562    int res = -1;
02563 
02564    ast_channel_lock(chan);
02565 
02566    /* Don't bother if the channel is about to go away, anyway. */
02567    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
02568       ast_channel_unlock(chan);
02569       return -1;
02570    }
02571 
02572    if (chan->tech->indicate) {
02573       /* See if the channel driver can handle this condition. */
02574       res = chan->tech->indicate(chan, condition, data, datalen);
02575    }
02576 
02577    ast_channel_unlock(chan);
02578 
02579    if (chan->tech->indicate && !res) {
02580       /* The channel driver successfully handled this indication */
02581       if (is_visible_indication(condition)) {
02582          chan->visible_indication = condition;
02583       }
02584       return 0;
02585    }
02586 
02587    /* The channel driver does not support this indication, let's fake
02588     * it by doing our own tone generation if applicable. */
02589 
02590    /*!\note If we compare the enumeration type, which does not have any
02591     * negative constants, the compiler may optimize this code away.
02592     * Therefore, we must perform an integer comparison here. */
02593    if (_condition < 0) {
02594       /* Stop any tones that are playing */
02595       ast_playtones_stop(chan);
02596       return 0;
02597    }
02598 
02599    /* Handle conditions that we have tones for. */
02600    switch (condition) {
02601    case AST_CONTROL_RINGING:
02602       ts = ast_get_indication_tone(chan->zone, "ring");
02603       /* It is common practice for channel drivers to return -1 if trying
02604        * to indicate ringing on a channel which is up. The idea is to let the
02605        * core generate the ringing inband. However, we don't want the
02606        * warning message about not being able to handle the specific indication
02607        * to print nor do we want ast_indicate_data to return an "error" for this
02608        * condition
02609        */
02610       if (chan->_state == AST_STATE_UP) {
02611          res = 0;
02612       }
02613       break;
02614    case AST_CONTROL_BUSY:
02615       ts = ast_get_indication_tone(chan->zone, "busy");
02616       break;
02617    case AST_CONTROL_CONGESTION:
02618       ts = ast_get_indication_tone(chan->zone, "congestion");
02619       break;
02620    case AST_CONTROL_PROGRESS:
02621    case AST_CONTROL_PROCEEDING:
02622    case AST_CONTROL_VIDUPDATE:
02623    case AST_CONTROL_SRCUPDATE:
02624    case AST_CONTROL_RADIO_KEY:
02625    case AST_CONTROL_RADIO_UNKEY:
02626    case AST_CONTROL_OPTION:
02627    case AST_CONTROL_WINK:
02628    case AST_CONTROL_FLASH:
02629    case AST_CONTROL_OFFHOOK:
02630    case AST_CONTROL_TAKEOFFHOOK:
02631    case AST_CONTROL_ANSWER:
02632    case AST_CONTROL_HANGUP:
02633    case AST_CONTROL_RING:
02634    case AST_CONTROL_HOLD:
02635    case AST_CONTROL_UNHOLD:
02636       /* Nothing left to do for these. */
02637       res = 0;
02638       break;
02639    }
02640 
02641    if (ts && ts->data[0]) {
02642       /* We have a tone to play, yay. */
02643       if (option_debug) {
02644             ast_log(LOG_DEBUG, "Driver for channel '%s' does not support indication %d, emulating it\n", chan->name, condition);
02645       }
02646       ast_playtones_start(chan, 0, ts->data, 1);
02647       res = 0;
02648       chan->visible_indication = condition;
02649    }
02650 
02651    if (res) {
02652       /* not handled */
02653       ast_log(LOG_WARNING, "Unable to handle indication %d for '%s'\n", condition, chan->name);
02654    }
02655 
02656    return res;
02657 }

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

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

Referenced by add_sdp(), and ast_read_generator_actions().

02500 {
02501    int ret = ast_opt_internal_timing && chan->timingfd > -1;
02502    if (option_debug > 4)
02503       ast_log(LOG_DEBUG, "Internal timing is %s (option_internal_timing=%d chan->timingfd=%d)\n", ret? "enabled": "disabled", ast_opt_internal_timing, chan->timingfd);
02504    return ret;
02505 }

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

print call- and pickup groups into buffer

Definition at line 4856 of file channel.c.

References first.

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

04857 {
04858    unsigned int i;
04859    int first=1;
04860    char num[3];
04861 
04862    buf[0] = '\0';
04863    
04864    if (!group) /* Return empty string if no group */
04865       return buf;
04866 
04867    for (i = 0; i <= 63; i++) {   /* Max group is 63 */
04868       if (group & ((ast_group_t) 1 << i)) {
04869             if (!first) {
04870             strncat(buf, ", ", buflen - strlen(buf) - 1);
04871          } else {
04872             first=0;
04873          }
04874          snprintf(num, sizeof(num), "%u", i);
04875          strncat(buf, num, buflen - strlen(buf) - 1);
04876       }
04877    }
04878    return buf;
04879 }

int ast_prod ( struct ast_channel chan  ) 

Send empty audio to prime a channel driver.

Definition at line 2779 of file channel.c.

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

Referenced by ast_activate_generator().

02780 {
02781    struct ast_frame a = { AST_FRAME_VOICE };
02782    char nothing[128];
02783 
02784    /* Send an empty audio frame to get things moving */
02785    if (chan->_state != AST_STATE_UP) {
02786       if (option_debug)
02787          ast_log(LOG_DEBUG, "Prodding channel '%s'\n", chan->name);
02788       a.subclass = chan->rawwriteformat;
02789       a.data = nothing + AST_FRIENDLY_OFFSET;
02790       a.src = "ast_prod";
02791       if (ast_write(chan, &a))
02792          ast_log(LOG_WARNING, "Prodding channel '%s' failed\n", chan->name);
02793    }
02794    return 0;
02795 }

int ast_queue_control ( struct ast_channel chan,
enum ast_control_frame_type  control 
)

Queue a control frame with payload.

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

Definition at line 1011 of file channel.c.

References AST_FRAME_CONTROL, ast_queue_frame(), and f.

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

01012 {
01013    struct ast_frame f = { AST_FRAME_CONTROL, };
01014 
01015    f.subclass = control;
01016 
01017    return ast_queue_frame(chan, &f);
01018 }

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

Queue a control frame with payload.

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

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

Definition at line 1021 of file channel.c.

References AST_FRAME_CONTROL, ast_queue_frame(), and f.

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

01023 {
01024    struct ast_frame f = { AST_FRAME_CONTROL, };
01025 
01026    f.subclass = control;
01027    f.data = (void *) data;
01028    f.datalen = datalen;
01029 
01030    return ast_queue_frame(chan, &f);
01031 }

int ast_queue_frame ( struct ast_channel chan,
struct ast_frame f 
)

Queue one or more frames to 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 988 of file channel.c.

References __ast_queue_frame().

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

00989 {
00990    return __ast_queue_frame(chan, fin, 0, NULL);
00991 }

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

References __ast_queue_frame().

Referenced by __ast_read(), and ast_autoservice_stop().

00994 {
00995    return __ast_queue_frame(chan, fin, 1, NULL);
00996 }

int ast_queue_hangup ( struct ast_channel chan  ) 

Queue a hangup frame.

Definition at line 999 of file channel.c.

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

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

01000 {
01001    struct ast_frame f = { AST_FRAME_CONTROL, AST_CONTROL_HANGUP };
01002    /* Yeah, let's not change a lock-critical value without locking */
01003    if (!ast_channel_trylock(chan)) {
01004       chan->_softhangup |= AST_SOFTHANGUP_DEV;
01005       ast_channel_unlock(chan);
01006    }
01007    return ast_queue_frame(chan, &f);
01008 }

struct ast_frame* ast_read ( struct ast_channel chan  ) 

Reads a frame.

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

Definition at line 2507 of file channel.c.

References __ast_read().

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

02508 {
02509    return __ast_read(chan, 0);
02510 }

struct ast_frame* ast_read_noaudio ( struct ast_channel chan  ) 

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

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

Definition at line 2512 of file channel.c.

References __ast_read().

Referenced by conf_run().

02513 {
02514    return __ast_read(chan, 1);
02515 }

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

03439 {
03440    return ast_readstring_full(c, s, len, timeout, ftimeout, enders, -1, -1);
03441 }

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

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

Referenced by ast_app_getdata_full(), and ast_readstring().

03444 {
03445    int pos = 0;   /* index in the buffer where we accumulate digits */
03446    int to = ftimeout;
03447 
03448    /* Stop if we're a zombie or need a soft hangup */
03449    if (ast_test_flag(c, AST_FLAG_ZOMBIE) || ast_check_hangup(c))
03450       return -1;
03451    if (!len)
03452       return -1;
03453    for (;;) {
03454       int d;
03455       if (c->stream) {
03456          d = ast_waitstream_full(c, AST_DIGIT_ANY, audiofd, ctrlfd);
03457          ast_stopstream(c);
03458          usleep(1000);
03459          if (!d)
03460             d = ast_waitfordigit_full(c, to, audiofd, ctrlfd);
03461       } else {
03462          d = ast_waitfordigit_full(c, to, audiofd, ctrlfd);
03463       }
03464       if (d < 0)
03465          return -1;
03466       if (d == 0) {
03467          s[pos]='\0';
03468          return 1;
03469       }
03470       if (d == 1) {
03471          s[pos]='\0';
03472          return 2;
03473       }
03474       if (!strchr(enders, d))
03475          s[pos++] = d;
03476       if (strchr(enders, d) || (pos >= len)) {
03477          s[pos]='\0';
03478          return 0;
03479       }
03480       to = timeout;
03481    }
03482    /* Never reached */
03483    return 0;
03484 }

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

References ast_recvtext(), and free.

Referenced by handle_recvchar().

02660 {
02661    int c;
02662    char *buf = ast_recvtext(chan, timeout);
02663    if (buf == NULL)
02664       return -1;  /* error or timeout */
02665    c = *(unsigned char *)buf;
02666    free(buf);
02667    return c;
02668 }

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

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

Referenced by ast_recvchar(), and handle_recvtext().

02671 {
02672    int res, done = 0;
02673    char *buf = NULL;
02674    
02675    while (!done) {
02676       struct ast_frame *f;
02677       if (ast_check_hangup(chan))
02678          break;
02679       res = ast_waitfor(chan, timeout);
02680       if (res <= 0) /* timeout or error */
02681          break;
02682       timeout = res; /* update timeout */
02683       f = ast_read(chan);
02684       if (f == NULL)
02685          break; /* no frame */
02686       if (f->frametype == AST_FRAME_CONTROL && f->subclass == AST_CONTROL_HANGUP)
02687          done = 1;   /* force a break */
02688       else if (f->frametype == AST_FRAME_TEXT) {      /* what we want */
02689          buf = ast_strndup((char *) f->data, f->datalen);   /* dup and break */
02690          done = 1;
02691       }
02692       ast_frfree(f);
02693    }
02694    return buf;
02695 }

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

Requests a channel.

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

Definition at line 3344 of file channel.c.

References AST_CAUSE_BEARERCAPABILITY_NOTAVAIL, AST_CAUSE_NOSUCHDRIVER, AST_CAUSE_NOTDEFINED, AST_FORMAT_AUDIO_MASK, AST_FORMAT_VIDEO_MASK, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), ast_translator_best_choice(), ast_channel_tech::capabilities, capabilities, 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(), build_conf(), chanavail_exec(), conf_run(), connect_link(), features_alloc(), findmeexec(), ring_entry(), rpt(), rpt_call(), rpt_tele_thread(), and wait_for_answer().

03345 {
03346    struct chanlist *chan;
03347    struct ast_channel *c;
03348    int capabilities;
03349    int fmt;
03350    int res;
03351    int foo;
03352    int videoformat = format & AST_FORMAT_VIDEO_MASK;
03353 
03354    if (!cause)
03355       cause = &foo;
03356    *cause = AST_CAUSE_NOTDEFINED;
03357 
03358    if (AST_LIST_LOCK(&channels)) {
03359       ast_log(LOG_WARNING, "Unable to lock channel list\n");
03360       return NULL;
03361    }
03362 
03363    AST_LIST_TRAVERSE(&backends, chan, list) {
03364       if (strcasecmp(type, chan->tech->type))
03365          continue;
03366 
03367       capabilities = chan->tech->capabilities;
03368       fmt = format & AST_FORMAT_AUDIO_MASK;
03369       res = ast_translator_best_choice(&fmt, &capabilities);
03370       if (res < 0) {
03371          ast_log(LOG_WARNING, "No translator path exists for channel type %s (native %d) to %d\n", type, chan->tech->capabilities, format);
03372          *cause = AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
03373          AST_LIST_UNLOCK(&channels);
03374          return NULL;
03375       }
03376       AST_LIST_UNLOCK(&channels);
03377       if (!chan->tech->requester)
03378          return NULL;
03379       
03380       if (!(c = chan->tech->requester(type, capabilities | videoformat, data, cause)))
03381          return NULL;
03382 
03383       /* no need to generate a Newchannel event here; it is done in the channel_alloc call */
03384       return c;
03385    }
03386 
03387    ast_log(LOG_WARNING, "No channel type registered for '%s'\n", type);
03388    *cause = AST_CAUSE_NOSUCHDRIVER;
03389    AST_LIST_UNLOCK(&channels);
03390 
03391    return NULL;
03392 }

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

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

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

Definition at line 3339 of file channel.c.

References __ast_request_and_dial().

Referenced by ast_pbx_outgoing_exten().

03340 {
03341    return __ast_request_and_dial(type, format, data, timeout, outstate, cidnum, cidname, NULL);
03342 }

int ast_safe_sleep ( struct ast_channel chan,
int  ms 
)

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

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

Definition at line 1221 of file channel.c.

References ast_safe_sleep_conditional().

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

01222 {
01223    return ast_safe_sleep_conditional(chan, ms, NULL, NULL);
01224 }

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

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

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

Definition at line 1200 of file channel.c.

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

Referenced by __login_exec(), and ast_safe_sleep().

01201 {
01202    struct ast_frame *f;
01203 
01204    while (ms > 0) {
01205       if (cond && ((*cond)(data) == 0))
01206          return 0;
01207       ms = ast_waitfor(chan, ms);
01208       if (ms < 0)
01209          return -1;
01210       if (ms > 0) {
01211          f = ast_read(chan);
01212          if (!f)
01213             return -1;
01214          ast_frfree(f);
01215       }
01216    }
01217    return 0;
01218 }

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

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

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

Definition at line 409 of file channel.c.

References ast_malloc, and len().

Referenced by dahdi_new(), and features_new().

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

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

Waits for activity on a group of channels.

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

Definition at line 1373 of file channel.h.

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

01374 {
01375 #ifdef __linux__
01376    return select(nfds, rfds, wfds, efds, tvp);
01377 #else
01378    if (tvp) {
01379       struct timeval tv, tvstart, tvend, tvlen;
01380       int res;
01381 
01382       tv = *tvp;
01383       gettimeofday(&tvstart, NULL);
01384       res = select(nfds, rfds, wfds, efds, tvp);
01385       gettimeofday(&tvend, NULL);
01386       timersub(&tvend, &tvstart, &tvlen);
01387       timersub(&tv, &tvlen, tvp);
01388       if (tvp->tv_sec < 0 || (tvp->tv_sec == 0 && tvp->tv_usec < 0)) {
01389          tvp->tv_sec = 0;
01390          tvp->tv_usec = 0;
01391       }
01392       return res;
01393    }
01394    else
01395       return select(nfds, rfds, wfds, efds, NULL);
01396 #endif
01397 }

int ast_senddigit ( struct ast_channel chan,
char  digit 
)

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

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

Definition at line 2769 of file channel.c.

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

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

02770 {
02771    if (chan->tech->send_digit_begin) {
02772       ast_senddigit_begin(chan, digit);
02773       ast_safe_sleep(chan, AST_DEFAULT_EMULATE_DTMF_DURATION);
02774    }
02775    
02776    return ast_senddigit_end(chan, digit, AST_DEFAULT_EMULATE_DTMF_DURATION);
02777 }

int ast_senddigit_begin ( struct ast_channel chan,
char  digit 
)

Definition at line 2710 of file channel.c.

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

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

02711 {
02712    /* Device does not support DTMF tones, lets fake
02713     * it by doing our own generation. */
02714    static const char* dtmf_tones[] = {
02715       "941+1336", /* 0 */
02716       "697+1209", /* 1 */
02717       "697+1336", /* 2 */
02718       "697+1477", /* 3 */
02719       "770+1209", /* 4 */
02720       "770+1336", /* 5 */
02721       "770+1477", /* 6 */
02722       "852+1209", /* 7 */
02723       "852+1336", /* 8 */
02724       "852+1477", /* 9 */
02725       "697+1633", /* A */
02726       "770+1633", /* B */
02727       "852+1633", /* C */
02728       "941+1633", /* D */
02729       "941+1209", /* * */
02730       "941+1477"  /* # */
02731    };
02732 
02733    if (!chan->tech->send_digit_begin)
02734       return 0;
02735 
02736    if (!chan->tech->send_digit_begin(chan, digit))
02737       return 0;
02738 
02739    if (digit >= '0' && digit <='9')
02740       ast_playtones_start(chan, 0, dtmf_tones[digit-'0'], 0);
02741    else if (digit >= 'A' && digit <= 'D')
02742       ast_playtones_start(chan, 0, dtmf_tones[digit-'A'+10], 0);
02743    else if (digit == '*')
02744       ast_playtones_start(chan, 0, dtmf_tones[14], 0);
02745    else if (digit == '#')
02746       ast_playtones_start(chan, 0, dtmf_tones[15], 0);
02747    else {
02748       /* not handled */
02749       if (option_debug)
02750          ast_log(LOG_DEBUG, "Unable to generate DTMF tone '%c' for '%s'\n", digit, chan->name);
02751    }
02752 
02753    return 0;
02754 }

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

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

02757 {
02758    int res = -1;
02759 
02760    if (chan->tech->send_digit_end)
02761       res = chan->tech->send_digit_end(chan, digit, duration);
02762 
02763    if (res && chan->generator)
02764       ast_playtones_stop(chan);
02765    
02766    return 0;
02767 }

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

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

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

Definition at line 2697 of file channel.c.

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

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

02698 {
02699    int res = 0;
02700    /* Stop if we're a zombie or need a soft hangup */
02701    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan))
02702       return -1;
02703    CHECK_BLOCKING(chan);
02704    if (chan->tech->send_text)
02705       res = chan->tech->send_text(chan, text);
02706    ast_clear_flag(chan, AST_FLAG_BLOCKING);
02707    return res;
02708 }

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

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

Definition at line 4025 of file channel.c.

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

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

04026 {
04027    ast_channel_lock(chan);
04028 
04029    if (callerid) {
04030       if (chan->cid.cid_num)
04031          free(chan->cid.cid_num);
04032       chan->cid.cid_num = ast_strdup(callerid);
04033    }
04034    if (calleridname) {
04035       if (chan->cid.cid_name)
04036          free(chan->cid.cid_name);
04037       chan->cid.cid_name = ast_strdup(calleridname);
04038    }
04039    if (ani) {
04040       if (chan->cid.cid_ani)
04041          free(chan->cid.cid_ani);
04042       chan->cid.cid_ani = ast_strdup(ani);
04043    }
04044 
04045    report_new_callerid(chan);
04046 
04047    ast_channel_unlock(chan);
04048 }

int ast_set_read_format ( struct ast_channel chan,
int  format 
)

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

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

Definition at line 3089 of file channel.c.

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

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

03090 {
03091    return set_format(chan, fmt, &chan->rawreadformat, &chan->readformat,
03092            &chan->readtrans, 0);
03093 }

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

04882 {
04883    struct ast_variable *cur;
04884 
04885    for (cur = vars; cur; cur = cur->next)
04886       pbx_builtin_setvar_helper(chan, cur->name, cur->value);  
04887 }

int ast_set_write_format ( struct ast_channel chan,
int  format 
)

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

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

Definition at line 3095 of file channel.c.

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

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

03096 {
03097    return set_format(chan, fmt, &chan->rawwriteformat, &chan->writeformat,
03098            &chan->writetrans, 1);
03099 }

int ast_setstate ( struct ast_channel chan,
enum  ast_channel_state 
)

Change the state of a channel.

Definition at line 4050 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, 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_answer(), cb_events(), check_availability(), dahdi_answer(), dahdi_call(), dahdi_handle_event(), dahdi_indicate(), dahdi_read(), gtalk_call(), gtalk_newcall(), handle_invite_replaces(), handle_offhook_message(), handle_request_invite(), handle_response_invite(), handle_soft_key_event_message(), handle_stimulus_message(), iax2_call(), mgcp_answer(), mgcp_call(), mgcp_ss(), misdn_call(), misdn_indication(), nbs_call(), nbs_hangup(), oh323_answer(), oss_answer(), pbx_builtin_busy(), pbx_builtin_congestion(), phone_answer(), phone_call(), phone_exception(), phone_hangup(), phone_write(), release_chan(), sip_answer(), skinny_answer(), skinny_call(), skinny_newcall(), ss_thread(), and update_state().

04051 {
04052    char name[AST_CHANNEL_NAME], *dashptr;
04053    int oldstate = chan->_state;
04054 
04055    if (oldstate == state)
04056       return 0;
04057 
04058    ast_copy_string(name, chan->name, sizeof(name));
04059    if ((dashptr = strrchr(name, '-'))) {
04060       *dashptr = '\0';
04061    }
04062 
04063    chan->_state = state;
04064    ast_device_state_changed_literal(name);
04065    /* setstate used to conditionally report Newchannel; this is no more */
04066    manager_event(EVENT_FLAG_CALL,
04067             "Newstate",
04068             "Channel: %s\r\n"
04069             "State: %s\r\n"
04070             "CallerID: %s\r\n"
04071             "CallerIDName: %s\r\n"
04072             "Uniqueid: %s\r\n",
04073             chan->name, ast_state2str(chan->_state),
04074             S_OR(chan->cid.cid_num, "<unknown>"),
04075             S_OR(chan->cid.cid_name, "<unknown>"),
04076             chan->uniqueid);
04077 
04078    return 0;
04079 }

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

Definition at line 1863 of file channel.c.

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

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

01864 {
01865    int res = -1;
01866 #ifdef HAVE_DAHDI
01867    ast_channel_lock(c);
01868    if (c->timingfd > -1) {
01869       if (!func) {
01870          samples = 0;
01871          data = 0;
01872       }
01873       if (option_debug)
01874          ast_log(LOG_DEBUG, "Scheduling timer at %d sample intervals\n", samples);
01875       res = ioctl(c->timingfd, DAHDI_TIMERCONFIG, &samples);
01876       c->timingfunc = func;
01877       c->timingdata = data;
01878    }
01879    ast_channel_unlock(c);
01880 #endif   
01881    return res;
01882 }

int ast_shutting_down ( void   ) 

Returns non-zero if Asterisk is being shut down.

Returns non-zero if Asterisk is being shut down

Definition at line 461 of file channel.c.

Referenced by handle_request_options().

00462 {
00463    return shutting_down;
00464 }

int ast_softhangup ( struct ast_channel chan,
int  cause 
)

Softly hangup up a channel.

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

Definition at line 1463 of file channel.c.

References ast_channel_lock, ast_channel_unlock, and ast_softhangup_nolock().

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

01464 {
01465    int res;
01466    ast_channel_lock(chan);
01467    res = ast_softhangup_nolock(chan, cause);
01468    ast_channel_unlock(chan);
01469    return res;
01470 }

int ast_softhangup_nolock ( struct ast_channel chan,
int  cause 
)

Softly hangup up a channel (no channel lock).

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

Definition at line 1449 of file channel.c.

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

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

01450 {
01451    if (option_debug)
01452       ast_log(LOG_DEBUG, "Soft-Hanging up channel '%s'\n", chan->name);
01453    /* Inform channel driver that we need to be hung up, if it cares */
01454    chan->_softhangup |= cause;
01455    ast_queue_frame(chan, &ast_null_frame);
01456    /* Interrupt any poll call or such */
01457    if (ast_test_flag(chan, AST_FLAG_BLOCKING))
01458       pthread_kill(chan->blocker, SIGURG);
01459    return 0;
01460 }

char* ast_state2str ( enum  ast_channel_state  ) 

Gives the string form of a given channel state.

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

Definition at line 600 of file channel.c.

References AST_STATE_BUSY, AST_STATE_DIALING, AST_STATE_DIALING_OFFHOOK, AST_STATE_DOWN, AST_STATE_OFFHOOK, AST_STATE_PRERING, AST_STATE_RESERVED, AST_STATE_RING, AST_STATE_RINGING, AST_STATE_UP, ast_threadstorage_get(), STATE2STR_BUFSIZE, and state2str_threadbuf.

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

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

int ast_str2cause ( const char *  name  ) 

Convert a symbolic hangup cause to number.

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

Definition at line 588 of file channel.c.

References causes.

Referenced by pbx_builtin_hangup().

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

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

Play a tone pair for a given amount of time

Definition at line 4753 of file channel.c.

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

Referenced by zapateller_exec().

04754 {
04755    int res;
04756 
04757    if ((res = ast_tonepair_start(chan, freq1, freq2, duration, vol)))
04758       return res;
04759 
04760    /* Give us some wiggle room */
04761    while (chan->generatordata && ast_waitfor(chan, 100) >= 0) {
04762       struct ast_frame *f = ast_read(chan);
04763       if (f)
04764          ast_frfree(f);
04765       else
04766          return -1;
04767    }
04768    return 0;
04769 }

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

Start a tone going

Definition at line 4735 of file channel.c.

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

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

04736 {
04737    struct tonepair_def d = { 0, };
04738 
04739    d.freq1 = freq1;
04740    d.freq2 = freq2;
04741    d.duration = duration;
04742    d.vol = (vol < 1) ? 8192 : vol; /* force invalid to 8192 */
04743    if (ast_activate_generator(chan, &tonepair, &d))
04744       return -1;
04745    return 0;
04746 }

void ast_tonepair_stop ( struct ast_channel chan  ) 

Stop a tone from playing

Definition at line 4748 of file channel.c.

References ast_deactivate_generator().

Referenced by sendnoise().

04749 {
04750    ast_deactivate_generator(chan);
04751 }

int ast_transfer ( struct ast_channel chan,
char *  dest 
)

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

Called by:

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

03421 {
03422    int res = -1;
03423 
03424    /* Stop if we're a zombie or need a soft hangup */
03425    ast_channel_lock(chan);
03426    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
03427       if (chan->tech->transfer) {
03428          res = chan->tech->transfer(chan, dest);
03429          if (!res)
03430             res = 1;
03431       } else
03432          res = 0;
03433    }
03434    ast_channel_unlock(chan);
03435    return res;
03436 }

char* ast_transfercapability2str ( int  transfercapability  )  const

Gives the string form of a given transfer capability.

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

Definition at line 634 of file channel.c.

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

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

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

int ast_waitfor ( struct ast_channel chan,
int  ms 
)

Wait for input on a channel.

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

Definition at line 1847 of file channel.c.

References ast_waitfor_nandfds().

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

01848 {
01849    int oldms = ms;   /* -1 if no timeout */
01850 
01851    ast_waitfor_nandfds(&c, 1, NULL, 0, NULL, NULL, &ms);
01852    if ((ms < 0) && (oldms < 0))
01853       ms = 0;
01854    return ms;
01855 }

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

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

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

Definition at line 1842 of file channel.c.

References ast_waitfor_nandfds().

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

01843 {
01844    return ast_waitfor_nandfds(c, n, NULL, 0, NULL, NULL, ms);
01845 }

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

References ast_waitfor_nandfds().

Referenced by dundi_lookup_internal(), and dundi_precache_internal().

01687 {
01688    int winner = -1;
01689    ast_waitfor_nandfds(NULL, 0, fds, n, exception, &winner, ms);
01690    return winner;
01691 }

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

Waits for activity on a group of channels.

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

Definition at line 1694 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, and ast_channel::whentohangup.

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

01696 {
01697    struct timeval start = { 0 , 0 };
01698    struct pollfd *pfds = NULL;
01699    int res;
01700    long rms;
01701    int x, y, max;
01702    int sz;
01703    time_t now = 0;
01704    long whentohangup = 0, diff;
01705    struct ast_channel *winner = NULL;
01706    struct fdmap {
01707       int chan;
01708       int fdno;
01709    } *fdmap = NULL;
01710 
01711    if ((sz = n * AST_MAX_FDS + nfds)) {
01712       pfds = alloca(sizeof(*pfds) * sz);
01713       fdmap = alloca(sizeof(*fdmap) * sz);
01714    }
01715 
01716    if (outfd)
01717       *outfd = -99999;
01718    if (exception)
01719       *exception = 0;
01720    
01721    /* Perform any pending masquerades */
01722    for (x=0; x < n; x++) {
01723       ast_channel_lock(c[x]);
01724       if (c[x]->masq) {
01725          if (ast_do_masquerade(c[x])) {
01726             ast_log(LOG_WARNING, "Masquerade failed\n");
01727             *ms = -1;
01728             ast_channel_unlock(c[x]);
01729             return NULL;
01730          }
01731       }
01732       if (c[x]->whentohangup) {
01733          if (!whentohangup)
01734             time(&now);
01735          diff = c[x]->whentohangup - now;
01736          if (diff < 1) {
01737             /* Should already be hungup */
01738             c[x]->_softhangup |= AST_SOFTHANGUP_TIMEOUT;
01739             ast_channel_unlock(c[x]);
01740             return c[x];
01741          }
01742          if (!whentohangup || (diff < whentohangup))
01743             whentohangup = diff;
01744       }
01745       ast_channel_unlock(c[x]);
01746    }
01747    /* Wait full interval */
01748    rms = *ms;
01749    if (whentohangup) {
01750       rms = whentohangup * 1000;              /* timeout in milliseconds */
01751       if (*ms >= 0 && *ms < rms)    /* original *ms still smaller */
01752          rms =  *ms;
01753    }
01754    /*
01755     * Build the pollfd array, putting the channels' fds first,
01756     * followed by individual fds. Order is important because
01757     * individual fd's must have priority over channel fds.
01758     */
01759    max = 0;
01760    for (x=0; x<n; x++) {
01761       for (y=0; y<AST_MAX_FDS; y++) {
01762          fdmap[max].fdno = y;  /* fd y is linked to this pfds */
01763          fdmap[max].chan = x;  /* channel x is linked to this pfds */
01764          max += ast_add_fd(&pfds[max], c[x]->fds[y]);
01765       }
01766       CHECK_BLOCKING(c[x]);
01767    }
01768    /* Add the individual fds */
01769    for (x=0; x<nfds; x++) {
01770       fdmap[max].chan = -1;
01771       max += ast_add_fd(&pfds[max], fds[x]);
01772    }
01773 
01774    if (*ms > 0)
01775       start = ast_tvnow();
01776    
01777    if (sizeof(int) == 4) { /* XXX fix timeout > 600000 on linux x86-32 */
01778       do {
01779          int kbrms = rms;
01780          if (kbrms > 600000)
01781             kbrms = 600000;
01782          res = ast_poll(pfds, max, kbrms);
01783          if (!res)
01784             rms -= kbrms;
01785       } while (!res && (rms > 0));
01786    } else {
01787       res = ast_poll(pfds, max, rms);
01788    }
01789    for (x=0; x<n; x++)
01790       ast_clear_flag(c[x], AST_FLAG_BLOCKING);
01791    if (res < 0) { /* Simulate a timeout if we were interrupted */
01792       if (errno != EINTR)
01793          *ms = -1;
01794       return NULL;
01795    }
01796    if (whentohangup) {   /* if we have a timeout, check who expired */
01797       time(&now);
01798       for (x=0; x<n; x++) {
01799          if (c[x]->whentohangup && now >= c[x]->whentohangup) {
01800             c[x]->_softhangup |= AST_SOFTHANGUP_TIMEOUT;
01801             if (winner == NULL)
01802                winner = c[x];
01803          }
01804       }
01805    }
01806    if (res == 0) { /* no fd ready, reset timeout and done */
01807       *ms = 0; /* XXX use 0 since we may not have an exact timeout. */
01808       return winner;
01809    }
01810    /*
01811     * Then check if any channel or fd has a pending event.
01812     * Remember to check channels first and fds last, as they
01813     * must have priority on setting 'winner'
01814     */
01815    for (x = 0; x < max; x++) {
01816       res = pfds[x].revents;
01817       if (res == 0)
01818          continue;
01819       if (fdmap[x].chan >= 0) {  /* this is a channel */
01820          winner = c[fdmap[x].chan]; /* override previous winners */
01821          if (res & POLLPRI)
01822             ast_set_flag(winner, AST_FLAG_EXCEPTION);
01823          else
01824             ast_clear_flag(winner, AST_FLAG_EXCEPTION);
01825          winner->fdno = fdmap[x].fdno;
01826       } else {       /* this is an fd */
01827          if (outfd)
01828             *outfd = pfds[x].fd;
01829          if (exception)
01830             *exception = (res & POLLPRI) ? -1 : 0;
01831          winner = NULL;
01832       }
01833    }
01834    if (*ms > 0) {
01835       *ms -= ast_tvdiff_ms(ast_tvnow(), start);
01836       if (*ms < 0)
01837          *ms = 0;
01838    }
01839    return winner;
01840 }

int ast_waitfordigit ( struct ast_channel c,
int  ms 
)

Waits for a digit.

!

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

Definition at line 1858 of file channel.c.

References ast_waitfordigit_full().

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

01859 {
01860    return ast_waitfordigit_full(c, ms, -1, -1);
01861 }

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

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

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

01885 {
01886    /* Stop if we're a zombie or need a soft hangup */
01887    if (ast_test_flag(c, AST_FLAG_ZOMBIE) || ast_check_hangup(c))
01888       return -1;
01889 
01890    /* Only look for the end of DTMF, don't bother with the beginning and don't emulate things */
01891    ast_set_flag(c, AST_FLAG_END_DTMF_ONLY);
01892 
01893    /* Wait for a digit, no more than ms milliseconds total. */
01894    while (ms) {
01895       struct ast_channel *rchan;
01896       int outfd;
01897 
01898       errno = 0;
01899       rchan = ast_waitfor_nandfds(&c, 1, &cmdfd, (cmdfd > -1) ? 1 : 0, NULL, &outfd, &ms);
01900       if (!rchan && outfd < 0 && ms) {
01901          if (errno == 0 || errno == EINTR)
01902             continue;
01903          ast_log(LOG_WARNING, "Wait failed (%s)\n", strerror(errno));
01904          ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01905          return -1;
01906       } else if (outfd > -1) {
01907          /* The FD we were watching has something waiting */
01908          ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01909          return 1;
01910       } else if (rchan) {
01911          int res;
01912          struct ast_frame *f = ast_read(c);
01913          if (!f)
01914             return -1;
01915 
01916          switch(f->frametype) {
01917          case AST_FRAME_DTMF_BEGIN:
01918             break;
01919          case AST_FRAME_DTMF_END:
01920             res = f->subclass;
01921             ast_frfree(f);
01922             ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01923             return res;
01924          case AST_FRAME_CONTROL:
01925             switch(f->subclass) {
01926             case AST_CONTROL_HANGUP:
01927                ast_frfree(f);
01928                ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01929                return -1;
01930             case AST_CONTROL_RINGING:
01931             case AST_CONTROL_ANSWER:
01932             case AST_CONTROL_SRCUPDATE:
01933                /* Unimportant */
01934                break;
01935             default:
01936                ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", f->subclass);
01937                break;
01938             }
01939             break;
01940          case AST_FRAME_VOICE:
01941             /* Write audio if appropriate */
01942             if (audiofd > -1) {
01943                if (write(audiofd, f->data, f->datalen) < 0) {
01944                   ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
01945                }
01946             }
01947          default:
01948             /* Ignore */
01949             break;
01950          }
01951          ast_frfree(f);
01952       }
01953    }
01954 
01955    ast_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
01956 
01957    return 0; /* Time is up */
01958 }

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

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

Definition at line 1193 of file channel.c.

References channel_find_locked().

Referenced by next_channel().

01195 {
01196    return channel_find_locked(chan, NULL, 0, context, exten);
01197 }

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

Get channel by name prefix (locks channel).

Definition at line 1180 of file channel.c.

References channel_find_locked().

Referenced by next_channel().

01182 {
01183    return channel_find_locked(chan, name, namelen, NULL, NULL);
01184 }

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

References ast_channel::_softhangup, AST_AUDIOHOOK_DIRECTION_WRITE, ast_audiohook_write_list(), ast_channel_lock, ast_channel_trylock, ast_channel_unlock, ast_check_hangup(), ast_clear_flag, AST_CONTROL_UNHOLD, ast_deactivate_generator(), ast_do_masquerade(), AST_FLAG_BLOCKING, AST_FLAG_WRITE_INT, AST_FLAG_ZOMBIE, AST_FRAME_CONTROL, AST_FRAME_DTMF_BEGIN, AST_FRAME_DTMF_END, ast_frame_dump(), AST_FRAME_HTML, AST_FRAME_IAX, AST_FRAME_MODEM, AST_FRAME_NULL, AST_FRAME_TEXT, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_frfree, AST_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_DEBUG, ast_channel::masq, ast_channel::masqr, ast_channel::monitor, MONITOR_CONSTANT_DELAY, MONITOR_DELAY, ast_channel::name, ast_frame::next, option_debug, ast_channel::outsmpl, ast_channel::rawwriteformat, ast_frame::samples, SEEK_FORCECUR, ast_channel_tech::send_html, ast_channel_tech::send_text, ast_channel_monitor::state, ast_frame::subclass, ast_channel::tech, ast_channel_tech::write, ast_channel_monitor::write_stream, ast_channel_tech::write_video, and ast_channel::writetrans.

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

02809 {
02810    int res = -1;
02811    int count = 0;
02812    struct ast_frame *f = NULL;
02813 
02814    /*Deadlock avoidance*/
02815    while(ast_channel_trylock(chan)) {
02816       /*cannot goto done since the channel is not locked*/
02817       if(count++ > 10) {
02818          if(option_debug)
02819             ast_log(LOG_DEBUG, "Deadlock avoided for write to channel '%s'\n", chan->name);
02820          return 0;
02821       }
02822       usleep(1);
02823    }
02824    /* Stop if we're a zombie or need a soft hangup */
02825    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan))
02826       goto done;
02827 
02828    /* Handle any pending masquerades */
02829    if (chan->masq && ast_do_masquerade(chan)) {
02830       ast_log(LOG_WARNING, "Failed to perform masquerade\n");
02831       goto done;
02832    }
02833    if (chan->masqr) {
02834       res = 0; /* XXX explain, why 0 ? */
02835       goto done;
02836    }
02837    if (chan->generatordata) {
02838       if (ast_test_flag(chan, AST_FLAG_WRITE_INT))
02839          ast_deactivate_generator(chan);
02840       else {
02841          if (fr->frametype == AST_FRAME_DTMF_END) {
02842             /* There is a generator running while we're in the middle of a digit.
02843              * It's probably inband DTMF, so go ahead and pass it so it can
02844              * stop the generator */
02845             ast_clear_flag(chan, AST_FLAG_BLOCKING);
02846             ast_channel_unlock(chan);
02847             res = ast_senddigit_end(chan, fr->subclass, fr->len);
02848             ast_channel_lock(chan);
02849             CHECK_BLOCKING(chan);
02850          } else if (fr->frametype == AST_FRAME_CONTROL && fr->subclass == AST_CONTROL_UNHOLD) {
02851             /* This is a side case where Echo is basically being called and the person put themselves on hold and took themselves off hold */
02852             res = (chan->tech->indicate == NULL) ? 0 :
02853                chan->tech->indicate(chan, fr->subclass, fr->data, fr->datalen);
02854          }
02855          res = 0; /* XXX explain, why 0 ? */
02856          goto done;
02857       }
02858    }
02859    /* High bit prints debugging */
02860    if (chan->fout & DEBUGCHAN_FLAG)
02861       ast_frame_dump(chan->name, fr, ">>");
02862    CHECK_BLOCKING(chan);
02863    switch(fr->frametype) {
02864    case AST_FRAME_CONTROL:
02865       res = (chan->tech->indicate == NULL) ? 0 :
02866          chan->tech->indicate(chan, fr->subclass, fr->data, fr->datalen);
02867       break;
02868    case AST_FRAME_DTMF_BEGIN:
02869       if (chan->audiohooks) {
02870          struct ast_frame *old_frame = fr;
02871          fr = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_WRITE, fr);
02872          if (old_frame != fr)
02873             f = fr;
02874       }
02875       ast_clear_flag(chan, AST_FLAG_BLOCKING);
02876       ast_channel_unlock(chan);
02877       res = ast_senddigit_begin(chan, fr->subclass);
02878       ast_channel_lock(chan);
02879       CHECK_BLOCKING(chan);
02880       break;
02881    case AST_FRAME_DTMF_END:
02882       if (chan->audiohooks) {
02883          struct ast_frame *new_frame = fr;
02884 
02885          new_frame = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_WRITE, fr);
02886          if (new_frame != fr) {
02887             ast_frfree(new_frame);
02888          }
02889       }
02890       ast_clear_flag(chan, AST_FLAG_BLOCKING);
02891       ast_channel_unlock(chan);
02892       res = ast_senddigit_end(chan, fr->subclass, fr->len);
02893       ast_channel_lock(chan);
02894       CHECK_BLOCKING(chan);
02895       break;
02896    case AST_FRAME_TEXT:
02897       res = (chan->tech->send_text == NULL) ? 0 :
02898          chan->tech->send_text(chan, (char *) fr->data);
02899       break;
02900    case AST_FRAME_HTML:
02901       res = (chan->tech->send_html == NULL) ? 0 :
02902          chan->tech->send_html(chan, fr->subclass, (char *) fr->data, fr->datalen);
02903       break;
02904    case AST_FRAME_VIDEO:
02905       /* XXX Handle translation of video codecs one day XXX */
02906       res = (chan->tech->write_video == NULL) ? 0 :
02907          chan->tech->write_video(chan, fr);
02908       break;
02909    case AST_FRAME_MODEM:
02910       res = (chan->tech->write == NULL) ? 0 :
02911          chan->tech->write(chan, fr);
02912       break;
02913    case AST_FRAME_VOICE:
02914       if (chan->tech->write == NULL)
02915          break;   /*! \todo XXX should return 0 maybe ? */
02916 
02917       /* If the frame is in the raw write format, then it's easy... just use the frame - otherwise we will have to translate */
02918       if (fr->subclass == chan->rawwriteformat)
02919          f = fr;
02920       else
02921          f = (chan->writetrans) ? ast_translate(chan->writetrans, fr, 0) : fr;
02922 
02923       /* If we have no frame of audio, then we have to bail out */
02924       if (!f) {
02925          res = 0;
02926          break;
02927       }
02928 
02929       if (chan->audiohooks) {
02930          struct ast_frame *new_frame, *cur;
02931 
02932          for (cur = f; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
02933             new_frame = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_WRITE, cur);
02934             if (new_frame != cur) {
02935                ast_frfree(new_frame);
02936             }
02937          }
02938       }
02939       
02940       /* If Monitor is running on this channel, then we have to write frames out there too */
02941       /* the translator on chan->writetrans may have returned multiple frames
02942          from the single frame we passed in; if so, feed each one of them to the
02943          monitor */
02944       if (chan->monitor && chan->monitor->write_stream) {
02945          struct ast_frame *cur;
02946 
02947          for (cur = f; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
02948          /* XXX must explain this code */
02949 #ifndef MONITOR_CONSTANT_DELAY
02950             int jump = chan->insmpl - chan->outsmpl - 4 * cur->samples;
02951             if (jump >= 0) {
02952                jump = chan->insmpl - chan->outsmpl;
02953                if (ast_seekstream(chan->monitor->write_stream, jump, SEEK_FORCECUR) == -1)
02954                   ast_log(LOG_WARNING, "Failed to perform seek in monitoring write stream, synchronization between the files may be broken\n");
02955                chan->outsmpl += jump + cur->samples;
02956             } else {
02957                chan->outsmpl += cur->samples;
02958             }
02959 #else
02960             int jump = chan->insmpl - chan->outsmpl;
02961             if (jump - MONITOR_DELAY >= 0) {
02962                if (ast_seekstream(chan->monitor->write_stream, jump - cur->samples, SEEK_FORCECUR) == -1)
02963                   ast_log(LOG_WARNING, "Failed to perform seek in monitoring write stream, synchronization between the files may be broken\n");
02964                chan->outsmpl += jump;
02965             } else {
02966                chan->outsmpl += cur->samples;
02967             }
02968 #endif
02969             if (chan->monitor->state == AST_MONITOR_RUNNING) {
02970                if (ast_writestream(chan->monitor->write_stream, cur) < 0)
02971                   ast_log(LOG_WARNING, "Failed to write data to channel monitor write stream\n");
02972             }
02973          }
02974       }
02975 
02976       /* the translator on chan->writetrans may have returned multiple frames
02977          from the single frame we passed in; if so, feed each one of them to the
02978          channel, freeing each one after it has been written */
02979       if ((f != fr) && AST_LIST_NEXT(f, frame_list)) {
02980          struct ast_frame *cur, *next;
02981          unsigned int skip = 0;
02982 
02983          for (cur = f, next = AST_LIST_NEXT(cur, frame_list);
02984               cur;
02985               cur = next, next = cur ? AST_LIST_NEXT(cur, frame_list) : NULL) {
02986             if (!skip) {
02987                if ((res = chan->tech->write(chan, cur)) < 0) {
02988                   chan->_softhangup |= AST_SOFTHANGUP_DEV;
02989                   skip = 1;
02990                } else if (next) {
02991                   /* don't do this for the last frame in the list,
02992                      as the code outside the loop will do it once
02993                   */
02994                   chan->fout = FRAMECOUNT_INC(chan->fout);
02995                }
02996             }
02997             ast_frfree(cur);
02998          }
02999 
03000          /* reset f so the code below doesn't attempt to free it */
03001          f = NULL;
03002       } else {
03003          res = chan->tech->write(chan, f);
03004       }
03005       break;
03006    case AST_FRAME_NULL:
03007    case AST_FRAME_IAX:
03008       /* Ignore these */
03009       res = 0;
03010       break;
03011    default:
03012       /* At this point, fr is the incoming frame and f is NULL.  Channels do
03013        * not expect to get NULL as a frame pointer and will segfault.  Hence,
03014        * we output the original frame passed in. */
03015       res = chan->tech->write(chan, fr);
03016       break;
03017    }
03018 
03019    if (f && f != fr)
03020       ast_frfree(f);
03021    ast_clear_flag(chan, AST_FLAG_BLOCKING);
03022 
03023    /* Consider a write failure to force a soft hangup */
03024    if (res < 0) {
03025       chan->_softhangup |= AST_SOFTHANGUP_DEV;
03026    } else {
03027       chan->fout = FRAMECOUNT_INC(chan->fout);
03028    }
03029 done:
03030    ast_channel_unlock(chan);
03031    return res;
03032 }

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

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

02798 {
02799    int res;
02800    if (!chan->tech->write_video)
02801       return 0;
02802    res = ast_write(chan, fr);
02803    if (!res)
02804       res = 1;
02805    return res;
02806 }

const char* channelreloadreason2txt ( enum channelreloadreason  reason  ) 

Convert enum channelreloadreason to text string for manager event.

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

Definition at line 4968 of file channel.c.

References CHANNEL_CLI_RELOAD, CHANNEL_MODULE_LOAD, and CHANNEL_MODULE_RELOAD.

04969 {
04970    switch (reason) {
04971    case CHANNEL_MODULE_LOAD:
04972       return "LOAD (Channel module load)";
04973 
04974    case CHANNEL_MODULE_RELOAD:
04975       return "RELOAD (Channel module reload)";
04976 
04977    case CHANNEL_CLI_RELOAD:
04978       return "CLIRELOAD (Channel module reload by CLI command)";
04979 
04980    default:
04981       return "MANAGERRELOAD (Channel module reload by manager)";
04982    }
04983 };


Generated on Thu Oct 1 13:09:55 2009 for Asterisk - the Open Source PBX by  doxygen 1.4.7