Sun Aug 15 20:33:38 2010

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_FLAG_IN_CHANNEL_LIST = (1 << 19), AST_FLAG_DISABLE_WORKAROUNDS = (1 << 20)
}
 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 1052 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 1054 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 1060 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 1056 of file channel.h.

#define AST_BRIDGE_REC_CHANNEL_1   (1 << 3)

Return all voice frames on channel 1.

Definition at line 1058 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(), process_dahdi(), 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 1405 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 563 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.
AST_FLAG_IN_CHANNEL_LIST  This flag indicates whether the channel is in the channel list or not.
AST_FLAG_DISABLE_WORKAROUNDS  Disable certain workarounds. This reintroduces certain bugs, but allows some non-traditional dialplans (like AGI) to continue to function.

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    /*! This flag indicates whether the channel is in the channel list or not. */
00519    AST_FLAG_IN_CHANNEL_LIST = (1 << 19),
00520    /*! Disable certain workarounds.  This reintroduces certain bugs, but allows
00521     *  some non-traditional dialplans (like AGI) to continue to function.
00522     */
00523    AST_FLAG_DISABLE_WORKAROUNDS = (1 << 20),
00524 };

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

00527      {
00528    AST_FEATURE_PLAY_WARNING = (1 << 0),
00529    AST_FEATURE_REDIRECT =     (1 << 1),
00530    AST_FEATURE_DISCONNECT =   (1 << 2),
00531    AST_FEATURE_ATXFER =       (1 << 3),
00532    AST_FEATURE_AUTOMON =      (1 << 4),
00533    AST_FEATURE_PARKCALL =     (1 << 5),
00534    AST_FEATURE_NO_H_EXTEN =   (1 << 6),
00535    AST_FEATURE_WARNING_ACTIVE = (1 << 7),
00536 };

anonymous enum

Enumerator:
AST_CDR_TRANSFER 
AST_CDR_FORWARD 
AST_CDR_CALLWAIT 
AST_CDR_CONFERENCE 

Definition at line 585 of file channel.h.

00585      {
00586    AST_CDR_TRANSFER =   (1 << 0),
00587    AST_CDR_FORWARD =    (1 << 1),
00588    AST_CDR_CALLWAIT =   (1 << 2),
00589    AST_CDR_CONFERENCE = (1 << 3),
00590 };

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

00592      {
00593    /*! Soft hangup by device */
00594    AST_SOFTHANGUP_DEV =       (1 << 0),
00595    /*! Soft hangup for async goto */
00596    AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
00597    AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
00598    AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
00599    AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
00600    AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
00601    AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
00602 };

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 606 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 3269 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().

03270 {
03271    int dummy_outstate;
03272    int cause = 0;
03273    struct ast_channel *chan;
03274    int res = 0;
03275    int last_subclass = 0;
03276    
03277    if (outstate)
03278       *outstate = 0;
03279    else
03280       outstate = &dummy_outstate;   /* make outstate always a valid pointer */
03281 
03282    chan = ast_request(type, format, data, &cause);
03283    if (!chan) {
03284       ast_log(LOG_NOTICE, "Unable to request channel %s/%s\n", type, (char *)data);
03285       handle_cause(cause, outstate);
03286       return NULL;
03287    }
03288 
03289    if (oh) {
03290       if (oh->vars)  
03291          ast_set_variables(chan, oh->vars);
03292       /* XXX why is this necessary, for the parent_channel perhaps ? */
03293       if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name))
03294          ast_set_callerid(chan, oh->cid_num, oh->cid_name, oh->cid_num);
03295       if (oh->parent_channel)
03296          ast_channel_inherit_variables(oh->parent_channel, chan);
03297       if (oh->account)
03298          ast_cdr_setaccount(chan, oh->account); 
03299    }
03300    ast_set_callerid(chan, cid_num, cid_name, cid_num);
03301    ast_set_flag(chan->cdr, AST_CDR_FLAG_ORIGINATED);
03302 
03303    if (ast_call(chan, data, 0)) {   /* ast_call failed... */
03304       ast_log(LOG_NOTICE, "Unable to call channel %s/%s\n", type, (char *)data);
03305    } else {
03306       res = 1; /* mark success in case chan->_state is already AST_STATE_UP */
03307       while (timeout && chan->_state != AST_STATE_UP) {
03308          struct ast_frame *f;
03309          res = ast_waitfor(chan, timeout);
03310          if (res == 0) { /* timeout, treat it like ringing */
03311             *outstate = AST_CONTROL_RINGING;
03312             break;
03313          }
03314          if (res < 0) /* error or done */
03315             break;
03316          if (timeout > -1)
03317             timeout = res;
03318          if (!ast_strlen_zero(chan->call_forward)) {
03319             if (!(chan = ast_call_forward(NULL, chan, &timeout, format, oh, outstate))) {
03320                return NULL;
03321             }
03322             continue;
03323          }
03324 
03325          f = ast_read(chan);
03326          if (!f) {
03327             *outstate = AST_CONTROL_HANGUP;
03328             res = 0;
03329             break;
03330          }
03331          if (f->frametype == AST_FRAME_CONTROL) {
03332             switch (f->subclass) {
03333             case AST_CONTROL_RINGING:  /* record but keep going */
03334                *outstate = f->subclass;
03335                break;
03336 
03337             case AST_CONTROL_BUSY:
03338                ast_cdr_busy(chan->cdr);
03339                *outstate = f->subclass;
03340                timeout = 0;
03341                break;
03342 
03343             case AST_CONTROL_CONGESTION:
03344                ast_cdr_failed(chan->cdr);
03345                *outstate = f->subclass;
03346                timeout = 0;
03347                break;
03348 
03349             case AST_CONTROL_ANSWER:
03350                ast_cdr_answer(chan->cdr);
03351                *outstate = f->subclass;
03352                timeout = 0;      /* trick to force exit from the while() */
03353                break;
03354 
03355             /* Ignore these */
03356             case AST_CONTROL_PROGRESS:
03357             case AST_CONTROL_PROCEEDING:
03358             case AST_CONTROL_HOLD:
03359             case AST_CONTROL_UNHOLD:
03360             case AST_CONTROL_VIDUPDATE:
03361             case AST_CONTROL_SRCUPDATE:
03362             case -1:       /* Ignore -- just stopping indications */
03363                break;
03364 
03365             default:
03366                ast_log(LOG_NOTICE, "Don't know what to do with control frame %d\n", f->subclass);
03367             }
03368             last_subclass = f->subclass;
03369          }
03370          ast_frfree(f);
03371       }
03372    }
03373 
03374    /* Final fixups */
03375    if (oh) {
03376       if (!ast_strlen_zero(oh->context))
03377          ast_copy_string(chan->context, oh->context, sizeof(chan->context));
03378       if (!ast_strlen_zero(oh->exten))
03379          ast_copy_string(chan->exten, oh->exten, sizeof(chan->exten));
03380       if (oh->priority) 
03381          chan->priority = oh->priority;
03382    }
03383    if (chan->_state == AST_STATE_UP)
03384       *outstate = AST_CONTROL_ANSWER;
03385 
03386    if (res <= 0) {
03387       if ( AST_CONTROL_RINGING == last_subclass ) 
03388          chan->hangupcause = AST_CAUSE_NO_ANSWER;
03389       if (!chan->cdr && (chan->cdr = ast_cdr_alloc()))
03390          ast_cdr_init(chan->cdr, chan);
03391       if (chan->cdr) {
03392          char tmp[256];
03393          snprintf(tmp, sizeof(tmp), "%s/%s", type, (char *)data);
03394          ast_cdr_setapp(chan->cdr,"Dial",tmp);
03395          ast_cdr_update(chan);
03396          ast_cdr_start(chan->cdr);
03397          ast_cdr_end(chan->cdr);
03398          /* If the cause wasn't handled properly */
03399          if (ast_cdr_disposition(chan->cdr,chan->hangupcause))
03400             ast_cdr_failed(chan->cdr);
03401       }
03402       ast_hangup(chan);
03403       chan = NULL;
03404    }
03405    return chan;
03406 }

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

Activate a given generator

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

01680 {
01681    int res = 0;
01682 
01683    ast_channel_lock(chan);
01684 
01685    if (chan->generatordata) {
01686       if (chan->generator && chan->generator->release)
01687          chan->generator->release(chan, chan->generatordata);
01688       chan->generatordata = NULL;
01689    }
01690 
01691    ast_prod(chan);
01692    if (gen->alloc && !(chan->generatordata = gen->alloc(chan, params))) {
01693       res = -1;
01694    }
01695    
01696    if (!res) {
01697       ast_settimeout(chan, 160, generator_force, chan);
01698       chan->generator = gen;
01699    }
01700 
01701    ast_channel_unlock(chan);
01702 
01703    return res;
01704 }

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

Referenced by ast_waitfor_nandfds().

01331 {
01332    pfd->fd = fd;
01333    pfd->events = POLLIN | POLLPRI;
01334    return fd >= 0;
01335 }

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

01601 {
01602    int res = 0;
01603    ast_channel_lock(chan);
01604    /* You can't answer an outbound call */
01605    if (ast_test_flag(chan, AST_FLAG_OUTGOING)) {
01606       ast_channel_unlock(chan);
01607       return 0;
01608    }
01609    /* Stop if we're a zombie or need a soft hangup */
01610    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
01611       ast_channel_unlock(chan);
01612       return -1;
01613    }
01614    switch(chan->_state) {
01615    case AST_STATE_RINGING:
01616    case AST_STATE_RING:
01617       if (chan->tech->answer)
01618          res = chan->tech->answer(chan);
01619       ast_setstate(chan, AST_STATE_UP);
01620       ast_cdr_answer(chan->cdr);
01621       break;
01622    case AST_STATE_UP:
01623       break;
01624    default:
01625       break;
01626    }
01627    ast_indicate(chan, -1);
01628    chan->visible_indication = 0;
01629    ast_channel_unlock(chan);
01630    return res;
01631 }

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

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

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

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

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 4156 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_attempt_transfer(), mixmonitor_thread(), park_call_full(), schedule_delivery(), sip_read(), sip_set_rtp_peer(), socket_process(), ss_thread(), start_spying(), and startmon().

04157 {
04158    struct ast_channel *bridged;
04159    bridged = chan->_bridge;
04160    if (bridged && bridged->tech->bridged_channel)
04161       bridged = bridged->tech->bridged_channel(chan, bridged);
04162    return bridged;
04163 }

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

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

03464 {
03465    /* Place an outgoing call, but don't wait any longer than timeout ms before returning.
03466       If the remote end does not answer within the timeout, then do NOT hang up, but
03467       return anyway.  */
03468    int res = -1;
03469    /* Stop if we're a zombie or need a soft hangup */
03470    ast_channel_lock(chan);
03471    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
03472       if (chan->cdr) {
03473          ast_set_flag(chan->cdr, AST_CDR_FLAG_DIALED);
03474          ast_set_flag(chan->cdr, AST_CDR_FLAG_ORIGINATED);
03475       }
03476       if (chan->tech->call)
03477          res = chan->tech->call(chan, addr, timeout);
03478       ast_set_flag(chan, AST_FLAG_OUTGOING);
03479    }
03480    ast_channel_unlock(chan);
03481    return res;
03482 }

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

03203 {
03204    char tmpchan[256];
03205    struct ast_channel *new = NULL;
03206    char *data, *type;
03207    int cause = 0;
03208 
03209    /* gather data and request the new forward channel */
03210    ast_copy_string(tmpchan, orig->call_forward, sizeof(tmpchan));
03211    if ((data = strchr(tmpchan, '/'))) {
03212       *data++ = '\0';
03213       type = tmpchan;
03214    } else {
03215       const char *forward_context;
03216       ast_channel_lock(orig);
03217       forward_context = pbx_builtin_getvar_helper(orig, "FORWARD_CONTEXT");
03218       snprintf(tmpchan, sizeof(tmpchan), "%s@%s", orig->call_forward, S_OR(forward_context, orig->context));
03219       ast_channel_unlock(orig);
03220       data = tmpchan;
03221       type = "Local";
03222    }
03223    if (!(new = ast_request(type, format, data, &cause))) {
03224       ast_log(LOG_NOTICE, "Unable to create channel for call forward to '%s/%s' (cause = %d)\n", type, data, cause);
03225       handle_cause(cause, outstate);
03226       ast_hangup(orig);
03227       return NULL;
03228    }
03229 
03230    /* Copy/inherit important information into new channel */
03231    if (oh) {
03232       if (oh->vars) {
03233          ast_set_variables(new, oh->vars);
03234       }
03235       if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name)) {
03236          ast_set_callerid(new, oh->cid_num, oh->cid_name, oh->cid_num);
03237       }
03238       if (oh->parent_channel) {
03239          ast_channel_inherit_variables(oh->parent_channel, new);
03240          ast_channel_datastore_inherit(oh->parent_channel, new);
03241       }
03242       if (oh->account) {
03243          ast_cdr_setaccount(new, oh->account);
03244       }
03245    } else if (caller) { /* no outgoing helper so use caller if avaliable */
03246       ast_channel_inherit_variables(caller, new);
03247       ast_channel_datastore_inherit(caller, new);
03248    }
03249 
03250    ast_channel_lock(orig);
03251    ast_string_field_set(new, accountcode, orig->accountcode);
03252    if (!ast_strlen_zero(orig->cid.cid_num) && !ast_strlen_zero(new->cid.cid_name)) {
03253       ast_set_callerid(new, orig->cid.cid_num, orig->cid.cid_name, orig->cid.cid_num);
03254    }
03255    ast_channel_unlock(orig);
03256 
03257    /* call new channel */
03258    if ((*timeout = ast_call(new, data, 0))) {
03259       ast_log(LOG_NOTICE, "Unable to call forward to channel %s/%s\n", type, (char *)data);
03260       ast_hangup(orig);
03261       ast_hangup(new);
03262       return NULL;
03263    }
03264    ast_hangup(orig);
03265 
03266    return new;
03267 }

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

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

03716 {
03717    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", chan->name, newname, chan->uniqueid);
03718    ast_string_field_set(chan, name, newname);
03719 }

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! Try increasing max file descriptors with ulimit -n\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_set_flag(tmp, AST_FLAG_IN_CHANNEL_LIST);
00871 
00872    AST_LIST_LOCK(&channels);
00873    AST_LIST_INSERT_HEAD(&channels, tmp, chan_list);
00874    AST_LIST_UNLOCK(&channels);
00875 
00876    /*\!note
00877     * and now, since the channel structure is built, and has its name, let's
00878     * call the manager event generator with this Newchannel event. This is the
00879     * proper and correct place to make this call, but you sure do have to pass
00880     * a lot of data into this func to do it here!
00881     */
00882    if (!ast_strlen_zero(name_fmt)) {
00883       manager_event(EVENT_FLAG_CALL, "Newchannel",
00884             "Channel: %s\r\n"
00885             "State: %s\r\n"
00886             "CallerIDNum: %s\r\n"
00887             "CallerIDName: %s\r\n"
00888             "Uniqueid: %s\r\n",
00889             tmp->name, ast_state2str(state),
00890             S_OR(cid_num, "<unknown>"),
00891             S_OR(cid_name, "<unknown>"),
00892             tmp->uniqueid);
00893    }
00894 
00895    return tmp;
00896 }

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

04400 {
04401    struct ast_channel *who = NULL;
04402    enum ast_bridge_result res = AST_BRIDGE_COMPLETE;
04403    int nativefailed=0;
04404    int firstpass;
04405    int o0nativeformats;
04406    int o1nativeformats;
04407    long time_left_ms=0;
04408    char caller_warning = 0;
04409    char callee_warning = 0;
04410 
04411    if (c0->_bridge) {
04412       ast_log(LOG_WARNING, "%s is already in a bridge with %s\n",
04413          c0->name, c0->_bridge->name);
04414       return -1;
04415    }
04416    if (c1->_bridge) {
04417       ast_log(LOG_WARNING, "%s is already in a bridge with %s\n",
04418          c1->name, c1->_bridge->name);
04419       return -1;
04420    }
04421    
04422    /* Stop if we're a zombie or need a soft hangup */
04423    if (ast_test_flag(c0, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c0) ||
04424        ast_test_flag(c1, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c1))
04425       return -1;
04426 
04427    *fo = NULL;
04428    firstpass = config->firstpass;
04429    config->firstpass = 0;
04430 
04431    if (ast_tvzero(config->start_time))
04432       config->start_time = ast_tvnow();
04433    time_left_ms = config->timelimit;
04434 
04435    caller_warning = ast_test_flag(&config->features_caller, AST_FEATURE_PLAY_WARNING);
04436    callee_warning = ast_test_flag(&config->features_callee, AST_FEATURE_PLAY_WARNING);
04437 
04438    if (config->start_sound && firstpass) {
04439       if (caller_warning)
04440          bridge_playfile(c0, c1, config->start_sound, time_left_ms / 1000);
04441       if (callee_warning)
04442          bridge_playfile(c1, c0, config->start_sound, time_left_ms / 1000);
04443    }
04444 
04445    /* Keep track of bridge */
04446    c0->_bridge = c1;
04447    c1->_bridge = c0;
04448 
04449    /* \todo  XXX here should check that cid_num is not NULL */
04450    manager_event(EVENT_FLAG_CALL, "Link",
04451             "Channel1: %s\r\n"
04452             "Channel2: %s\r\n"
04453             "Uniqueid1: %s\r\n"
04454             "Uniqueid2: %s\r\n"
04455             "CallerID1: %s\r\n"
04456             "CallerID2: %s\r\n",
04457             c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
04458 
04459    o0nativeformats = c0->nativeformats;
04460    o1nativeformats = c1->nativeformats;
04461 
04462    if (config->feature_timer && !ast_tvzero(config->nexteventts)) {
04463       config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->feature_timer, 1000));
04464    } else if (config->timelimit && firstpass) {
04465       config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->timelimit, 1000));
04466       if (caller_warning || callee_warning)
04467          config->nexteventts = ast_tvsub(config->nexteventts, ast_samp2tv(config->play_warning, 1000));
04468    }
04469 
04470    if (!c0->tech->send_digit_begin)
04471       ast_set_flag(c1, AST_FLAG_END_DTMF_ONLY);
04472    if (!c1->tech->send_digit_begin)
04473       ast_set_flag(c0, AST_FLAG_END_DTMF_ONLY);
04474 
04475    /* Before we enter in and bridge these two together tell them both the source of audio has changed */
04476    ast_indicate(c0, AST_CONTROL_SRCUPDATE);
04477    ast_indicate(c1, AST_CONTROL_SRCUPDATE);
04478 
04479    for (/* ever */;;) {
04480       struct timeval now = { 0, };
04481       int to;
04482 
04483       to = -1;
04484 
04485       if (!ast_tvzero(config->nexteventts)) {
04486          now = ast_tvnow();
04487          to = ast_tvdiff_ms(config->nexteventts, now);
04488          if (to <= 0) {
04489             if (!config->timelimit) {
04490                res = AST_BRIDGE_COMPLETE;
04491                break;
04492             }
04493             to = 0;
04494          }
04495       }
04496 
04497       if (config->timelimit) {
04498          time_left_ms = config->timelimit - ast_tvdiff_ms(now, config->start_time);
04499          if (time_left_ms < to)
04500             to = time_left_ms;
04501 
04502          if (time_left_ms <= 0) {
04503             if (caller_warning && config->end_sound)
04504                bridge_playfile(c0, c1, config->end_sound, 0);
04505             if (callee_warning && config->end_sound)
04506                bridge_playfile(c1, c0, config->end_sound, 0);
04507             *fo = NULL;
04508             if (who)
04509                *rc = who;
04510             res = 0;
04511             break;
04512          }
04513 
04514          if (!to) {
04515             if (time_left_ms >= 5000 && config->warning_sound && config->play_warning && ast_test_flag(config, AST_FEATURE_WARNING_ACTIVE)) {
04516                int t = (time_left_ms + 500) / 1000; /* round to nearest second */
04517                if (caller_warning)
04518                   bridge_playfile(c0, c1, config->warning_sound, t);
04519                if (callee_warning)
04520                   bridge_playfile(c1, c0, config->warning_sound, t);
04521             }
04522             if (config->warning_freq && (time_left_ms > (config->warning_freq + 5000)))
04523                config->nexteventts = ast_tvadd(config->nexteventts, ast_samp2tv(config->warning_freq, 1000));
04524             else
04525                config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->timelimit, 1000));
04526          }
04527          ast_clear_flag(config, AST_FEATURE_WARNING_ACTIVE);
04528       }
04529 
04530       if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE || c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE) {
04531          if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
04532             c0->_softhangup = 0;
04533          if (c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
04534             c1->_softhangup = 0;
04535          c0->_bridge = c1;
04536          c1->_bridge = c0;
04537          if (option_debug)
04538             ast_log(LOG_DEBUG, "Unbridge signal received. Ending native bridge.\n");
04539          continue;
04540       }
04541 
04542       /* Stop if we're a zombie or need a soft hangup */
04543       if (ast_test_flag(c0, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c0) ||
04544           ast_test_flag(c1, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c1)) {
04545          *fo = NULL;
04546          if (who)
04547             *rc = who;
04548          res = 0;
04549          if (option_debug)
04550             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",
04551                c0->name, c1->name,
04552                ast_test_flag(c0, AST_FLAG_ZOMBIE) ? "Yes" : "No",
04553                ast_check_hangup(c0) ? "Yes" : "No",
04554                ast_test_flag(c1, AST_FLAG_ZOMBIE) ? "Yes" : "No",
04555                ast_check_hangup(c1) ? "Yes" : "No");
04556          break;
04557       }
04558 
04559       update_bridgepeer(c0, c1);
04560 
04561       if (c0->tech->bridge &&
04562           (config->timelimit == 0) &&
04563           (c0->tech->bridge == c1->tech->bridge) &&
04564           !nativefailed && !c0->monitor && !c1->monitor &&
04565           !c0->audiohooks && !c1->audiohooks && !ast_test_flag(&(config->features_callee),AST_FEATURE_REDIRECT) &&
04566           !ast_test_flag(&(config->features_caller),AST_FEATURE_REDIRECT) &&
04567           !c0->masq && !c0->masqr && !c1->masq && !c1->masqr) {
04568          /* Looks like they share a bridge method and nothing else is in the way */
04569          ast_set_flag(c0, AST_FLAG_NBRIDGE);
04570          ast_set_flag(c1, AST_FLAG_NBRIDGE);
04571          if ((res = c0->tech->bridge(c0, c1, config->flags, fo, rc, to)) == AST_BRIDGE_COMPLETE) {
04572             /* \todo  XXX here should check that cid_num is not NULL */
04573             manager_event(EVENT_FLAG_CALL, "Unlink",
04574                      "Channel1: %s\r\n"
04575                      "Channel2: %s\r\n"
04576                      "Uniqueid1: %s\r\n"
04577                      "Uniqueid2: %s\r\n"
04578                      "CallerID1: %s\r\n"
04579                      "CallerID2: %s\r\n",
04580                      c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
04581             if (option_debug)
04582                ast_log(LOG_DEBUG, "Returning from native bridge, channels: %s, %s\n", c0->name, c1->name);
04583 
04584             ast_clear_flag(c0, AST_FLAG_NBRIDGE);
04585             ast_clear_flag(c1, AST_FLAG_NBRIDGE);
04586 
04587             if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE || c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
04588                continue;
04589 
04590             c0->_bridge = NULL;
04591             c1->_bridge = NULL;
04592 
04593             return res;
04594          } else {
04595             ast_clear_flag(c0, AST_FLAG_NBRIDGE);
04596             ast_clear_flag(c1, AST_FLAG_NBRIDGE);
04597          }
04598          switch (res) {
04599          case AST_BRIDGE_RETRY:
04600             if (config->play_warning) {
04601                ast_set_flag(config, AST_FEATURE_WARNING_ACTIVE);
04602             }
04603             continue;
04604          default:
04605             if (option_verbose > 2)
04606                ast_verbose(VERBOSE_PREFIX_3 "Native bridging %s and %s ended\n",
04607                       c0->name, c1->name);
04608             /* fallthrough */
04609          case AST_BRIDGE_FAILED_NOWARN:
04610             nativefailed++;
04611             break;
04612          }
04613       }
04614 
04615       if (((c0->writeformat != c1->readformat) || (c0->readformat != c1->writeformat) ||
04616           (c0->nativeformats != o0nativeformats) || (c1->nativeformats != o1nativeformats)) &&
04617           !(c0->generator || c1->generator)) {
04618          if (ast_channel_make_compatible(c0, c1)) {
04619             ast_log(LOG_WARNING, "Can't make %s and %s compatible\n", c0->name, c1->name);
04620             /* \todo  XXX here should check that cid_num is not NULL */
04621                                 manager_event(EVENT_FLAG_CALL, "Unlink",
04622                      "Channel1: %s\r\n"
04623                      "Channel2: %s\r\n"
04624                      "Uniqueid1: %s\r\n"
04625                      "Uniqueid2: %s\r\n"
04626                      "CallerID1: %s\r\n"
04627                      "CallerID2: %s\r\n",
04628                      c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
04629             return AST_BRIDGE_FAILED;
04630          }
04631          o0nativeformats = c0->nativeformats;
04632          o1nativeformats = c1->nativeformats;
04633       }
04634 
04635       update_bridgepeer(c0, c1);
04636 
04637       res = ast_generic_bridge(c0, c1, config, fo, rc, config->nexteventts);
04638       if (res != AST_BRIDGE_RETRY) {
04639          break;
04640       } else if (config->feature_timer) {
04641          /* feature timer expired but has not been updated, sending to ast_bridge_call to do so */
04642          break;
04643       }
04644    }
04645 
04646    ast_clear_flag(c0, AST_FLAG_END_DTMF_ONLY);
04647    ast_clear_flag(c1, AST_FLAG_END_DTMF_ONLY);
04648 
04649    /* Now that we have broken the bridge the source will change yet again */
04650    ast_indicate(c0, AST_CONTROL_SRCUPDATE);
04651    ast_indicate(c1, AST_CONTROL_SRCUPDATE);
04652 
04653    c0->_bridge = NULL;
04654    c1->_bridge = NULL;
04655 
04656    /* \todo  XXX here should check that cid_num is not NULL */
04657    manager_event(EVENT_FLAG_CALL, "Unlink",
04658             "Channel1: %s\r\n"
04659             "Channel2: %s\r\n"
04660             "Uniqueid1: %s\r\n"
04661             "Uniqueid2: %s\r\n"
04662             "CallerID1: %s\r\n"
04663             "CallerID2: %s\r\n",
04664             c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
04665    if (option_debug)
04666       ast_log(LOG_DEBUG, "Bridge stops bridging channels %s and %s\n", c0->name, c1->name);
04667 
04668    return res;
04669 }

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

01406 {
01407    int res = 0;
01408 
01409    AST_LIST_INSERT_HEAD(&chan->datastores, datastore, entry);
01410 
01411    return res;
01412 }

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

Create a channel datastore structure.

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

01345 {
01346    struct ast_datastore *datastore = NULL;
01347 
01348    /* Make sure we at least have type so we can identify this */
01349    if (info == NULL) {
01350       return NULL;
01351    }
01352 
01353    /* Allocate memory for datastore and clear it */
01354    datastore = ast_calloc(1, sizeof(*datastore));
01355    if (datastore == NULL) {
01356       return NULL;
01357    }
01358 
01359    datastore->info = info;
01360 
01361    datastore->uid = ast_strdup(uid);
01362 
01363    return datastore;
01364 }

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

01433 {
01434    struct ast_datastore *datastore = NULL;
01435    
01436    if (info == NULL)
01437       return NULL;
01438 
01439    AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->datastores, datastore, entry) {
01440       if (datastore->info == info) {
01441          if (uid != NULL && datastore->uid != NULL) {
01442             if (!strcasecmp(uid, datastore->uid)) {
01443                /* Matched by type AND uid */
01444                break;
01445             }
01446          } else {
01447             /* Matched by type at least */
01448             break;
01449          }
01450       }
01451    }
01452    AST_LIST_TRAVERSE_SAFE_END
01453 
01454    return datastore;
01455 }

int ast_channel_datastore_free ( struct ast_datastore datastore  ) 

Free a channel datastore structure.

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

01367 {
01368    int res = 0;
01369 
01370    /* Using the destroy function (if present) destroy the data */
01371    if (datastore->info->destroy != NULL && datastore->data != NULL) {
01372       datastore->info->destroy(datastore->data);
01373       datastore->data = NULL;
01374    }
01375 
01376    /* Free allocated UID memory */
01377    if (datastore->uid != NULL) {
01378       free(datastore->uid);
01379       datastore->uid = NULL;
01380    }
01381 
01382    /* Finally free memory used by ourselves */
01383    free(datastore);
01384 
01385    return res;
01386 }

int ast_channel_datastore_inherit ( struct ast_channel from,
struct ast_channel to 
)

Inherit datastores from a parent to a child.

Definition at line 1388 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(), findmeexec(), local_call(), ring_entry(), and wait_for_answer().

01389 {
01390    struct ast_datastore *datastore = NULL, *datastore2;
01391 
01392    AST_LIST_TRAVERSE(&from->datastores, datastore, entry) {
01393       if (datastore->inheritance > 0) {
01394          datastore2 = ast_channel_datastore_alloc(datastore->info, datastore->uid);
01395          if (datastore2) {
01396             datastore2->data = datastore->info->duplicate ? datastore->info->duplicate(datastore->data) : NULL;
01397             datastore2->inheritance = datastore->inheritance == DATASTORE_INHERIT_FOREVER ? DATASTORE_INHERIT_FOREVER : datastore->inheritance - 1;
01398             AST_LIST_INSERT_TAIL(&to->datastores, datastore2, entry);
01399          }
01400       }
01401    }
01402    return 0;
01403 }

int ast_channel_datastore_remove ( struct ast_channel chan,
struct ast_datastore datastore 
)

Remove a datastore from a channel.

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

01415 {
01416    struct ast_datastore *datastore2 = NULL;
01417    int res = -1;
01418 
01419    /* Find our position and remove ourselves */
01420    AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->datastores, datastore2, entry) {
01421       if (datastore2 == datastore) {
01422          AST_LIST_REMOVE_CURRENT(&chan->datastores, entry);
01423          res = 0;
01424          break;
01425       }
01426    }
01427    AST_LIST_TRAVERSE_SAFE_END
01428 
01429    return res;
01430 }

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

References AST_FLAG_DEFER_DTMF, ast_set_flag, and ast_test_flag.

Referenced by __adsi_transmit_messages(), and find_cache().

01038 {
01039    int pre = 0;
01040 
01041    if (chan) {
01042       pre = ast_test_flag(chan, AST_FLAG_DEFER_DTMF);
01043       ast_set_flag(chan, AST_FLAG_DEFER_DTMF);
01044    }
01045    return pre;
01046 }

void ast_channel_free ( struct ast_channel  ) 

Free a channel structure.

Definition at line 1244 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_FLAG_IN_CHANNEL_LIST, 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_test_flag, 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_DEBUG, ast_channel::monitor, ast_channel::music_state, ast_channel::name, name, option_debug, 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().

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

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

03722 {
03723    struct ast_var_t *current, *newvar;
03724    const char *varname;
03725 
03726    AST_LIST_TRAVERSE(&parent->varshead, current, entries) {
03727       int vartype = 0;
03728 
03729       varname = ast_var_full_name(current);
03730       if (!varname)
03731          continue;
03732 
03733       if (varname[0] == '_') {
03734          vartype = 1;
03735          if (varname[1] == '_')
03736             vartype = 2;
03737       }
03738 
03739       switch (vartype) {
03740       case 1:
03741          newvar = ast_var_assign(&varname[1], ast_var_value(current));
03742          if (newvar) {
03743             AST_LIST_INSERT_TAIL(&child->varshead, newvar, entries);
03744             if (option_debug)
03745                ast_log(LOG_DEBUG, "Copying soft-transferable variable %s.\n", ast_var_name(newvar));
03746          }
03747          break;
03748       case 2:
03749          newvar = ast_var_assign(ast_var_full_name(current), ast_var_value(current));
03750          if (newvar) {
03751             AST_LIST_INSERT_TAIL(&child->varshead, newvar, entries);
03752             if (option_debug)
03753                ast_log(LOG_DEBUG, "Copying hard-transferable variable %s.\n", ast_var_name(newvar));
03754          }
03755          break;
03756       default:
03757          if (option_debug)
03758             ast_log(LOG_DEBUG, "Not copying variable %s.\n", ast_var_name(current));
03759          break;
03760       }
03761    }
03762 }

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

03575 {
03576    int src;
03577    int dst;
03578 
03579    if (chan->readformat == peer->writeformat && chan->writeformat == peer->readformat) {
03580       /* Already compatible!  Moving on ... */
03581       return 0;
03582    }
03583 
03584    /* Set up translation from the chan to the peer */
03585    src = chan->nativeformats;
03586    dst = peer->nativeformats;
03587    if (ast_translator_best_choice(&dst, &src) < 0) {
03588       ast_log(LOG_WARNING, "No path to translate from %s(%d) to %s(%d)\n", chan->name, src, peer->name, dst);
03589       return -1;
03590    }
03591 
03592    /* if the best path is not 'pass through', then
03593       transcoding is needed; if desired, force transcode path
03594       to use SLINEAR between channels, but only if there is
03595       no direct conversion available */
03596    if ((src != dst) && ast_opt_transcode_via_slin &&
03597        (ast_translate_path_steps(dst, src) != 1))
03598       dst = AST_FORMAT_SLINEAR;
03599    if (ast_set_read_format(chan, dst) < 0) {
03600       ast_log(LOG_WARNING, "Unable to set read format on channel %s to %d\n", chan->name, dst);
03601       return -1;
03602    }
03603    if (ast_set_write_format(peer, dst) < 0) {
03604       ast_log(LOG_WARNING, "Unable to set write format on channel %s to %d\n", peer->name, dst);
03605       return -1;
03606    }
03607 
03608    /* Set up translation from the peer to the chan */
03609    src = peer->nativeformats;
03610    dst = chan->nativeformats;
03611    if (ast_translator_best_choice(&dst, &src) < 0) {
03612       ast_log(LOG_WARNING, "No path to translate from %s(%d) to %s(%d)\n", peer->name, src, chan->name, dst);
03613       return -1;
03614    }
03615 
03616    /* if the best path is not 'pass through', then
03617       transcoding is needed; if desired, force transcode path
03618       to use SLINEAR between channels, but only if there is
03619       no direct conversion available */
03620    if ((src != dst) && ast_opt_transcode_via_slin &&
03621        (ast_translate_path_steps(dst, src) != 1))
03622       dst = AST_FORMAT_SLINEAR;
03623    if (ast_set_read_format(peer, dst) < 0) {
03624       ast_log(LOG_WARNING, "Unable to set read format on channel %s to %d\n", peer->name, dst);
03625       return -1;
03626    }
03627    if (ast_set_write_format(chan, dst) < 0) {
03628       ast_log(LOG_WARNING, "Unable to set write format on channel %s to %d\n", chan->name, dst);
03629       return -1;
03630    }
03631    return 0;
03632 }

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 3634 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_attempt_transfer(), pickup_do(), and sip_park().

03635 {
03636    int res = -1;
03637    struct ast_channel *final_orig, *final_clone, *base;
03638 
03639 retrymasq:
03640    final_orig = original;
03641    final_clone = clone;
03642 
03643    ast_channel_lock(original);
03644    while (ast_channel_trylock(clone)) {
03645       ast_channel_unlock(original);
03646       usleep(1);
03647       ast_channel_lock(original);
03648    }
03649 
03650    /* each of these channels may be sitting behind a channel proxy (i.e. chan_agent)
03651       and if so, we don't really want to masquerade it, but its proxy */
03652    if (original->_bridge && (original->_bridge != ast_bridged_channel(original)) && (original->_bridge->_bridge != original))
03653       final_orig = original->_bridge;
03654 
03655    if (clone->_bridge && (clone->_bridge != ast_bridged_channel(clone)) && (clone->_bridge->_bridge != clone))
03656       final_clone = clone->_bridge;
03657    
03658    if (final_clone->tech->get_base_channel && (base = final_clone->tech->get_base_channel(final_clone))) {
03659       final_clone = base;
03660    }
03661 
03662    if ((final_orig != original) || (final_clone != clone)) {
03663       /* Lots and lots of deadlock avoidance.  The main one we're competing with
03664        * is ast_write(), which locks channels recursively, when working with a
03665        * proxy channel. */
03666       if (ast_channel_trylock(final_orig)) {
03667          ast_channel_unlock(clone);
03668          ast_channel_unlock(original);
03669          goto retrymasq;
03670       }
03671       if (ast_channel_trylock(final_clone)) {
03672          ast_channel_unlock(final_orig);
03673          ast_channel_unlock(clone);
03674          ast_channel_unlock(original);
03675          goto retrymasq;
03676       }
03677       ast_channel_unlock(clone);
03678       ast_channel_unlock(original);
03679       original = final_orig;
03680       clone = final_clone;
03681    }
03682 
03683    if (original == clone) {
03684       ast_log(LOG_WARNING, "Can't masquerade channel '%s' into itself!\n", original->name);
03685       ast_channel_unlock(clone);
03686       ast_channel_unlock(original);
03687       return -1;
03688    }
03689 
03690    if (option_debug)
03691       ast_log(LOG_DEBUG, "Planning to masquerade channel %s into the structure of %s\n",
03692          clone->name, original->name);
03693    if (original->masq) {
03694       ast_log(LOG_WARNING, "%s is already going to masquerade as %s\n",
03695          original->masq->name, original->name);
03696    } else if (clone->masqr) {
03697       ast_log(LOG_WARNING, "%s is already going to masquerade as %s\n",
03698          clone->name, clone->masqr->name);
03699    } else {
03700       original->masq = clone;
03701       clone->masqr = original;
03702       ast_queue_frame(original, &ast_null_frame);
03703       ast_queue_frame(clone, &ast_null_frame);
03704       if (option_debug)
03705          ast_log(LOG_DEBUG, "Done planning to masquerade channel %s into the structure of %s\n", clone->name, original->name);
03706       res = 0;
03707    }
03708 
03709    ast_channel_unlock(clone);
03710    ast_channel_unlock(original);
03711 
03712    return res;
03713 }

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

03167 {
03168    switch (reason) /* the following appear to be the only ones actually returned by request_and_dial */
03169    {
03170    case 0:
03171       return "Call Failure (not BUSY, and not NO_ANSWER, maybe Circuit busy or down?)";
03172    case AST_CONTROL_HANGUP:
03173       return "Hangup";
03174    case AST_CONTROL_RING:
03175       return "Local Ring";
03176    case AST_CONTROL_RINGING:
03177       return "Remote end Ringing";
03178    case AST_CONTROL_ANSWER:
03179       return "Remote end has Answered";
03180    case AST_CONTROL_BUSY:
03181       return "Remote end is Busy";
03182    case AST_CONTROL_CONGESTION:
03183       return "Congestion (circuits busy)";
03184    default:
03185       return "Unknown Reason!!";
03186    }
03187 }

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

03563 {
03564    if (chan->tech->send_html)
03565       return chan->tech->send_html(chan, subclass, data, datalen);
03566    return -1;
03567 }

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

References ast_channel_sendhtml(), and AST_HTML_URL.

Referenced by sendurl_exec().

03570 {
03571    return ast_channel_sendhtml(chan, AST_HTML_URL, url, strlen(url) + 1);
03572 }

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

04673 {
04674    int res;
04675 
04676    if (chan->tech->setoption) {
04677       res = chan->tech->setoption(chan, option, data, datalen);
04678       if (res < 0)
04679          return res;
04680    } else {
04681       errno = ENOSYS;
04682       return -1;
04683    }
04684    if (block) {
04685       /* XXX Implement blocking -- just wait for our option frame reply, discarding
04686          intermediate packets. XXX */
04687       ast_log(LOG_ERROR, "XXX Blocking not implemented yet XXX\n");
04688       return -1;
04689    }
04690    return 0;
04691 }

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

05001 {
05002    struct ast_silence_generator *state;
05003 
05004    if (!(state = ast_calloc(1, sizeof(*state)))) {
05005       return NULL;
05006    }
05007 
05008    state->old_write_format = chan->writeformat;
05009 
05010    if (ast_set_write_format(chan, AST_FORMAT_SLINEAR) < 0) {
05011       ast_log(LOG_ERROR, "Could not set write format to SLINEAR\n");
05012       free(state);
05013       return NULL;
05014    }
05015 
05016    ast_activate_generator(chan, &silence_generator, state);
05017 
05018    if (option_debug)
05019       ast_log(LOG_DEBUG, "Started silence generator on '%s'\n", chan->name);
05020 
05021    return state;
05022 }

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

05025 {
05026    if (!state)
05027       return;
05028 
05029    ast_deactivate_generator(chan);
05030 
05031    if (option_debug)
05032       ast_log(LOG_DEBUG, "Stopped silence generator on '%s'\n", chan->name);
05033 
05034    if (ast_set_write_format(chan, state->old_write_format) < 0)
05035       ast_log(LOG_ERROR, "Could not return write format to its original state\n");
05036 
05037    free(state);
05038 }

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

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

Referenced by sendurl_exec().

03558 {
03559    return (chan->tech->send_html) ? 1 : 0;
03560 }

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

References ast_clear_flag, and AST_FLAG_DEFER_DTMF.

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

01050 {
01051    if (chan)
01052       ast_clear_flag(chan, AST_FLAG_DEFER_DTMF);
01053 }

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

01166 {
01167    return channel_find_locked(prev, NULL, 0, NULL, NULL);
01168 }

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

01634 {
01635    ast_channel_lock(chan);
01636    if (chan->generatordata) {
01637       if (chan->generator && chan->generator->release)
01638          chan->generator->release(chan, chan->generatordata);
01639       chan->generatordata = NULL;
01640       chan->generator = NULL;
01641       chan->fds[AST_GENERATOR_FD] = -1;
01642       ast_clear_flag(chan, AST_FLAG_WRITE_INT);
01643       ast_settimeout(chan, 0, NULL, NULL);
01644    }
01645    ast_channel_unlock(chan);
01646 }

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 3815 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, ast_channel::whentohangup, and ast_channel::writeformat.

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

03816 {
03817    int x,i;
03818    int res=0;
03819    int origstate;
03820    struct ast_frame *cur;
03821    const struct ast_channel_tech *t;
03822    void *t_pvt;
03823    struct ast_callerid tmpcid;
03824    struct ast_channel *clone = original->masq;
03825    struct ast_cdr *cdr;
03826    int rformat = original->readformat;
03827    int wformat = original->writeformat;
03828    char newn[100];
03829    char orig[100];
03830    char masqn[100];
03831    char zombn[100];
03832 
03833    if (option_debug > 3)
03834       ast_log(LOG_DEBUG, "Actually Masquerading %s(%d) into the structure of %s(%d)\n",
03835          clone->name, clone->_state, original->name, original->_state);
03836 
03837    /* XXX This operation is a bit odd.  We're essentially putting the guts of
03838     * the clone channel into the original channel.  Start by killing off the
03839     * original channel's backend.  While the features are nice, which is the
03840     * reason we're keeping it, it's still awesomely weird. XXX */
03841 
03842    /* We need the clone's lock, too */
03843    ast_channel_lock(clone);
03844 
03845    if (option_debug > 1)
03846       ast_log(LOG_DEBUG, "Got clone lock for masquerade on '%s' at %p\n", clone->name, &clone->lock);
03847 
03848    /* Having remembered the original read/write formats, we turn off any translation on either
03849       one */
03850    free_translation(clone);
03851    free_translation(original);
03852 
03853 
03854    /* Unlink the masquerade */
03855    original->masq = NULL;
03856    clone->masqr = NULL;
03857    
03858    /* Save the original name */
03859    ast_copy_string(orig, original->name, sizeof(orig));
03860    /* Save the new name */
03861    ast_copy_string(newn, clone->name, sizeof(newn));
03862    /* Create the masq name */
03863    snprintf(masqn, sizeof(masqn), "%s<MASQ>", newn);
03864       
03865    /* Copy the name from the clone channel */
03866    ast_string_field_set(original, name, newn);
03867 
03868    /* Mangle the name of the clone channel */
03869    ast_string_field_set(clone, name, masqn);
03870    
03871    /* Notify any managers of the change, first the masq then the other */
03872    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", newn, masqn, clone->uniqueid);
03873    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", orig, newn, original->uniqueid);
03874 
03875    /* Swap the technologies */   
03876    t = original->tech;
03877    original->tech = clone->tech;
03878    clone->tech = t;
03879 
03880    /* Swap the cdrs */
03881    cdr = original->cdr;
03882    /* swap cdr uniqueid between channels, to get cdr uniqueid = channel uniqueid */
03883    ast_copy_string(clone->cdr->uniqueid, cdr->uniqueid, sizeof(cdr->uniqueid));
03884    original->cdr = clone->cdr;
03885    clone->cdr = cdr;
03886 
03887    t_pvt = original->tech_pvt;
03888    original->tech_pvt = clone->tech_pvt;
03889    clone->tech_pvt = t_pvt;
03890 
03891    /* Swap the alertpipes */
03892    for (i = 0; i < 2; i++) {
03893       x = original->alertpipe[i];
03894       original->alertpipe[i] = clone->alertpipe[i];
03895       clone->alertpipe[i] = x;
03896    }
03897 
03898    /* 
03899     * Swap the readq's.  The end result should be this:
03900     *
03901     *  1) All frames should be on the new (original) channel.
03902     *  2) Any frames that were already on the new channel before this
03903     *     masquerade need to be at the end of the readq, after all of the
03904     *     frames on the old (clone) channel.
03905     *  3) The alertpipe needs to get poked for every frame that was already
03906     *     on the new channel, since we are now using the alert pipe from the
03907     *     old (clone) channel.
03908     */
03909    {
03910       AST_LIST_HEAD_NOLOCK(, ast_frame) tmp_readq;
03911       AST_LIST_HEAD_SET_NOLOCK(&tmp_readq, NULL);
03912 
03913       AST_LIST_APPEND_LIST(&tmp_readq, &original->readq, frame_list);
03914       AST_LIST_APPEND_LIST(&original->readq, &clone->readq, frame_list);
03915 
03916       while ((cur = AST_LIST_REMOVE_HEAD(&tmp_readq, frame_list))) {
03917          AST_LIST_INSERT_TAIL(&original->readq, cur, frame_list);
03918          if (original->alertpipe[1] > -1) {
03919             int poke = 0;
03920 
03921             if (write(original->alertpipe[1], &poke, sizeof(poke)) < 0) {
03922                ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
03923             }
03924          }
03925       }
03926    }
03927 
03928    /* Swap the raw formats */
03929    x = original->rawreadformat;
03930    original->rawreadformat = clone->rawreadformat;
03931    clone->rawreadformat = x;
03932    x = original->rawwriteformat;
03933    original->rawwriteformat = clone->rawwriteformat;
03934    clone->rawwriteformat = x;
03935 
03936    clone->_softhangup = AST_SOFTHANGUP_DEV;
03937 
03938    /* And of course, so does our current state.  Note we need not
03939       call ast_setstate since the event manager doesn't really consider
03940       these separate.  We do this early so that the clone has the proper
03941       state of the original channel. */
03942    origstate = original->_state;
03943    original->_state = clone->_state;
03944    clone->_state = origstate;
03945 
03946    if (clone->tech->fixup){
03947       res = clone->tech->fixup(original, clone);
03948       if (res)
03949          ast_log(LOG_WARNING, "Fixup failed on channel %s, strange things may happen.\n", clone->name);
03950    }
03951 
03952    /* Start by disconnecting the original's physical side */
03953    if (clone->tech->hangup)
03954       res = clone->tech->hangup(clone);
03955    if (res) {
03956       ast_log(LOG_WARNING, "Hangup failed!  Strange things may happen!\n");
03957       ast_channel_unlock(clone);
03958       return -1;
03959    }
03960    
03961    snprintf(zombn, sizeof(zombn), "%s<ZOMBIE>", orig);
03962    /* Mangle the name of the clone channel */
03963    ast_string_field_set(clone, name, zombn);
03964    manager_event(EVENT_FLAG_CALL, "Rename", "Oldname: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", masqn, zombn, clone->uniqueid);
03965 
03966    /* Update the type. */
03967    t_pvt = original->monitor;
03968    original->monitor = clone->monitor;
03969    clone->monitor = t_pvt;
03970    
03971    /* Keep the same language.  */
03972    ast_string_field_set(original, language, clone->language);
03973    /* Copy the FD's other than the generator fd */
03974    for (x = 0; x < AST_MAX_FDS; x++) {
03975       if (x != AST_GENERATOR_FD)
03976          original->fds[x] = clone->fds[x];
03977    }
03978 
03979    ast_app_group_update(clone, original);
03980    /* Move data stores over */
03981    if (AST_LIST_FIRST(&clone->datastores)) {
03982       struct ast_datastore *ds;
03983       /* We use a safe traversal here because some fixup routines actually
03984        * remove the datastore from the list and free them.
03985        */
03986       AST_LIST_TRAVERSE_SAFE_BEGIN(&clone->datastores, ds, entry) {
03987          if (ds->info->chan_fixup)
03988             ds->info->chan_fixup(ds->data, clone, original);
03989       }
03990       AST_LIST_TRAVERSE_SAFE_END;
03991       AST_LIST_APPEND_LIST(&original->datastores, &clone->datastores, entry);
03992    }
03993 
03994    clone_variables(original, clone);
03995    /* Presense of ADSI capable CPE follows clone */
03996    original->adsicpe = clone->adsicpe;
03997    /* Bridge remains the same */
03998    /* CDR fields remain the same */
03999    /* XXX What about blocking, softhangup, blocker, and lock and blockproc? XXX */
04000    /* Application and data remain the same */
04001    /* Clone exception  becomes real one, as with fdno */
04002    ast_set_flag(original, ast_test_flag(clone, AST_FLAG_OUTGOING | AST_FLAG_EXCEPTION));
04003    original->fdno = clone->fdno;
04004    /* Schedule context remains the same */
04005    /* Stream stuff stays the same */
04006    /* Keep the original state.  The fixup code will need to work with it most likely */
04007 
04008    /* Just swap the whole structures, nevermind the allocations, they'll work themselves
04009       out. */
04010    tmpcid = original->cid;
04011    original->cid = clone->cid;
04012    clone->cid = tmpcid;
04013    report_new_callerid(original);
04014 
04015    /* Restore original timing file descriptor */
04016    original->fds[AST_TIMING_FD] = original->timingfd;
04017    
04018    /* Our native formats are different now */
04019    original->nativeformats = clone->nativeformats;
04020    
04021    /* Context, extension, priority, app data, jump table,  remain the same */
04022    /* pvt switches.  pbx stays the same, as does next */
04023    
04024    /* Set the write format */
04025    ast_set_write_format(original, wformat);
04026 
04027    /* Set the read format */
04028    ast_set_read_format(original, rformat);
04029 
04030    /* Copy the music class */
04031    ast_string_field_set(original, musicclass, clone->musicclass);
04032 
04033    /* Copy whentohangup time */
04034    original->whentohangup = clone->whentohangup;
04035 
04036    if (option_debug)
04037       ast_log(LOG_DEBUG, "Putting channel %s in %d/%d formats\n", original->name, wformat, rformat);
04038 
04039    /* Okay.  Last thing is to let the channel driver know about all this mess, so he
04040       can fix up everything as best as possible */
04041    if (original->tech->fixup) {
04042       res = original->tech->fixup(clone, original);
04043       if (res) {
04044          ast_log(LOG_WARNING, "Channel for type '%s' could not fixup channel %s\n",
04045             original->tech->type, original->name);
04046          ast_channel_unlock(clone);
04047          return -1;
04048       }
04049    } else
04050       ast_log(LOG_WARNING, "Channel type '%s' does not have a fixup routine (for %s)!  Bad things may happen.\n",
04051          original->tech->type, original->name);
04052 
04053    /* 
04054     * If an indication is currently playing, maintain it on the channel 
04055     * that is taking the place of original 
04056     *
04057     * This is needed because the masquerade is swapping out in the internals
04058     * of this channel, and the new channel private data needs to be made
04059     * aware of the current visible indication (RINGING, CONGESTION, etc.)
04060     */
04061    if (original->visible_indication) {
04062       ast_indicate(original, original->visible_indication);
04063    }
04064    
04065    /* Now, at this point, the "clone" channel is totally F'd up.  We mark it as
04066       a zombie so nothing tries to touch it.  If it's already been marked as a
04067       zombie, then free it now (since it already is considered invalid). */
04068    if (ast_test_flag(clone, AST_FLAG_ZOMBIE)) {
04069       if (option_debug)
04070          ast_log(LOG_DEBUG, "Destroying channel clone '%s'\n", clone->name);
04071       ast_channel_unlock(clone);
04072       manager_event(EVENT_FLAG_CALL, "Hangup",
04073          "Channel: %s\r\n"
04074          "Uniqueid: %s\r\n"
04075          "Cause: %d\r\n"
04076          "Cause-txt: %s\r\n",
04077          clone->name,
04078          clone->uniqueid,
04079          clone->hangupcause,
04080          ast_cause2str(clone->hangupcause)
04081          );
04082       ast_channel_free(clone);
04083    } else {
04084       if (option_debug)
04085          ast_log(LOG_DEBUG, "Released clone lock on '%s'\n", clone->name);
04086       ast_set_flag(clone, AST_FLAG_ZOMBIE);
04087       ast_queue_frame(clone, &ast_null_frame);
04088       ast_channel_unlock(clone);
04089    }
04090    
04091    /* Signal any blocker */
04092    if (ast_test_flag(original, AST_FLAG_BLOCKING))
04093       pthread_kill(original->blocker, SIGURG);
04094    if (option_debug)
04095       ast_log(LOG_DEBUG, "Done Masquerading %s (%d)\n", original->name, original->_state);
04096    return 0;
04097 }

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

01339 {
01340    int x;
01341    int dummy=0;
01342 
01343    if (fd < 0)
01344       return 0;
01345    if (!start)
01346       start = &dummy;
01347    for (x = *start; x<max; x++)
01348       if (pfds[x].fd == fd) {
01349          if (x == *start)
01350             (*start)++;
01351          return pfds[x].revents;
01352       }
01353    return 0;
01354 }

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

References channel_find_locked().

01191 {
01192    return channel_find_locked(NULL, NULL, 0, context, exten);
01193 }

struct ast_channel* ast_get_channel_by_name_locked ( const char *  chan  ) 

Get channel by name (locks channel).

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

01172 {
01173    return channel_find_locked(NULL, name, 0, NULL, NULL);
01174 }

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

References channel_find_locked().

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

01178 {
01179    return channel_find_locked(NULL, name, namelen, NULL, NULL);
01180 }

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

04846 {
04847    char *piece;
04848    char *c;
04849    int start=0, finish=0, x;
04850    ast_group_t group = 0;
04851 
04852    if (ast_strlen_zero(s))
04853       return 0;
04854 
04855    c = ast_strdupa(s);
04856    
04857    while ((piece = strsep(&c, ","))) {
04858       if (sscanf(piece, "%30d-%30d", &start, &finish) == 2) {
04859          /* Range */
04860       } else if (sscanf(piece, "%30d", &start)) {
04861          /* Just one */
04862          finish = start;
04863       } else {
04864          ast_log(LOG_ERROR, "Syntax error parsing group configuration '%s' at '%s'. Ignoring.\n", s, piece);
04865          continue;
04866       }
04867       for (x = start; x <= finish; x++) {
04868          if ((x > 63) || (x < 0)) {
04869             ast_log(LOG_WARNING, "Ignoring invalid group %d (maximum group is 63)\n", x);
04870          } else
04871             group |= ((ast_group_t) 1 << x);
04872       }
04873    }
04874    return group;
04875 }

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

References ast_assert, ast_audiohook_detach_list(), ast_autoservice_stop(), ast_cause2str(), ast_cdr_detach(), ast_cdr_end(), AST_CDR_FLAG_BRIDGED, AST_CDR_FLAG_DIALED, AST_CDR_FLAG_POST_DISABLED, AST_CDR_NULL, ast_channel_free(), ast_channel_lock, ast_channel_unlock, ast_clear_flag, ast_closestream(), ast_do_masquerade(), AST_FLAG_BLOCKING, AST_FLAG_IN_CHANNEL_LIST, AST_FLAG_ZOMBIE, AST_LIST_LOCK, AST_LIST_REMOVE, AST_LIST_UNLOCK, 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, LOG_ERROR, 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().

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

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 2551 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(), rna(), rpt(), send_waveform_to_channel(), skinny_ss(), sla_handle_hold_event(), sla_station_exec(), sla_trunk_exec(), and wait_for_answer().

02552 {
02553    return ast_indicate_data(chan, condition, NULL, 0);
02554 }

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

02591 {
02592    /* By using an enum, we'll get compiler warnings for values not handled 
02593     * in switch statements. */
02594    enum ast_control_frame_type condition = _condition;
02595    const struct tone_zone_sound *ts = NULL;
02596    int res = -1;
02597 
02598    ast_channel_lock(chan);
02599 
02600    /* Don't bother if the channel is about to go away, anyway. */
02601    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
02602       ast_channel_unlock(chan);
02603       return -1;
02604    }
02605 
02606    if (chan->tech->indicate) {
02607       /* See if the channel driver can handle this condition. */
02608       res = chan->tech->indicate(chan, condition, data, datalen);
02609    }
02610 
02611    ast_channel_unlock(chan);
02612 
02613    if (chan->tech->indicate && !res) {
02614       /* The channel driver successfully handled this indication */
02615       if (is_visible_indication(condition)) {
02616          chan->visible_indication = condition;
02617       }
02618       return 0;
02619    }
02620 
02621    /* The channel driver does not support this indication, let's fake
02622     * it by doing our own tone generation if applicable. */
02623 
02624    /*!\note If we compare the enumeration type, which does not have any
02625     * negative constants, the compiler may optimize this code away.
02626     * Therefore, we must perform an integer comparison here. */
02627    if (_condition < 0) {
02628       /* Stop any tones that are playing */
02629       ast_playtones_stop(chan);
02630       return 0;
02631    }
02632 
02633    /* Handle conditions that we have tones for. */
02634    switch (condition) {
02635    case AST_CONTROL_RINGING:
02636       ts = ast_get_indication_tone(chan->zone, "ring");
02637       /* It is common practice for channel drivers to return -1 if trying
02638        * to indicate ringing on a channel which is up. The idea is to let the
02639        * core generate the ringing inband. However, we don't want the
02640        * warning message about not being able to handle the specific indication
02641        * to print nor do we want ast_indicate_data to return an "error" for this
02642        * condition
02643        */
02644       if (chan->_state == AST_STATE_UP) {
02645          res = 0;
02646       }
02647       break;
02648    case AST_CONTROL_BUSY:
02649       ts = ast_get_indication_tone(chan->zone, "busy");
02650       break;
02651    case AST_CONTROL_CONGESTION:
02652       ts = ast_get_indication_tone(chan->zone, "congestion");
02653       break;
02654    case AST_CONTROL_PROGRESS:
02655    case AST_CONTROL_PROCEEDING:
02656    case AST_CONTROL_VIDUPDATE:
02657    case AST_CONTROL_SRCUPDATE:
02658    case AST_CONTROL_RADIO_KEY:
02659    case AST_CONTROL_RADIO_UNKEY:
02660    case AST_CONTROL_OPTION:
02661    case AST_CONTROL_WINK:
02662    case AST_CONTROL_FLASH:
02663    case AST_CONTROL_OFFHOOK:
02664    case AST_CONTROL_TAKEOFFHOOK:
02665    case AST_CONTROL_ANSWER:
02666    case AST_CONTROL_HANGUP:
02667    case AST_CONTROL_RING:
02668    case AST_CONTROL_HOLD:
02669    case AST_CONTROL_UNHOLD:
02670       /* Nothing left to do for these. */
02671       res = 0;
02672       break;
02673    }
02674 
02675    if (ts && ts->data[0]) {
02676       /* We have a tone to play, yay. */
02677       if (option_debug) {
02678             ast_log(LOG_DEBUG, "Driver for channel '%s' does not support indication %d, emulating it\n", chan->name, condition);
02679       }
02680       ast_playtones_start(chan, 0, ts->data, 1);
02681       res = 0;
02682       chan->visible_indication = condition;
02683    }
02684 
02685    if (res) {
02686       /* not handled */
02687       ast_log(LOG_WARNING, "Unable to handle indication %d for '%s'\n", condition, chan->name);
02688    }
02689 
02690    return res;
02691 }

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

02534 {
02535    int ret = ast_opt_internal_timing && chan->timingfd > -1;
02536    if (option_debug > 4)
02537       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);
02538    return ret;
02539 }

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

print call- and pickup groups into buffer

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

04931 {
04932    unsigned int i;
04933    int first=1;
04934    char num[3];
04935 
04936    buf[0] = '\0';
04937    
04938    if (!group) /* Return empty string if no group */
04939       return buf;
04940 
04941    for (i = 0; i <= 63; i++) {   /* Max group is 63 */
04942       if (group & ((ast_group_t) 1 << i)) {
04943             if (!first) {
04944             strncat(buf, ", ", buflen - strlen(buf) - 1);
04945          } else {
04946             first=0;
04947          }
04948          snprintf(num, sizeof(num), "%u", i);
04949          strncat(buf, num, buflen - strlen(buf) - 1);
04950       }
04951    }
04952    return buf;
04953 }

int ast_prod ( struct ast_channel chan  ) 

Send empty audio to prime a channel driver.

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

02814 {
02815    struct ast_frame a = { AST_FRAME_VOICE };
02816    char nothing[128];
02817 
02818    /* Send an empty audio frame to get things moving */
02819    if (chan->_state != AST_STATE_UP) {
02820       if (option_debug)
02821          ast_log(LOG_DEBUG, "Prodding channel '%s'\n", chan->name);
02822       a.subclass = chan->rawwriteformat;
02823       a.data = nothing + AST_FRIENDLY_OFFSET;
02824       a.src = "ast_prod";
02825       if (ast_write(chan, &a))
02826          ast_log(LOG_WARNING, "Prodding channel '%s' failed\n", chan->name);
02827    }
02828    return 0;
02829 }

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 1014 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(), misdn_attempt_transfer(), nbs_call(), phone_call(), pickup_do(), process_sdp(), receive_digit(), send_cause2ast(), setup_rtp_connection(), skinny_call(), skinny_unhold(), ss_thread(), and update_state().

01015 {
01016    struct ast_frame f = { AST_FRAME_CONTROL, };
01017 
01018    f.subclass = control;
01019 
01020    return ast_queue_frame(chan, &f);
01021 }

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

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

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

00992 {
00993    return __ast_queue_frame(chan, fin, 0, NULL);
00994 }

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

References __ast_queue_frame().

Referenced by __ast_read(), and ast_autoservice_stop().

00997 {
00998    return __ast_queue_frame(chan, fin, 1, NULL);
00999 }

int ast_queue_hangup ( struct ast_channel chan  ) 

Queue a hangup frame.

Definition at line 1002 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(), dahdi_r2_on_call_disconnect(), 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().

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

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 2541 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_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().

02542 {
02543    return __ast_read(chan, 0);
02544 }

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

References __ast_read().

Referenced by conf_run().

02547 {
02548    return __ast_read(chan, 1);
02549 }

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

03510 {
03511    return ast_readstring_full(c, s, len, timeout, ftimeout, enders, -1, -1);
03512 }

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

03515 {
03516    int pos = 0;   /* index in the buffer where we accumulate digits */
03517    int to = ftimeout;
03518 
03519    /* Stop if we're a zombie or need a soft hangup */
03520    if (ast_test_flag(c, AST_FLAG_ZOMBIE) || ast_check_hangup(c))
03521       return -1;
03522    if (!len)
03523       return -1;
03524    for (;;) {
03525       int d;
03526       if (c->stream) {
03527          d = ast_waitstream_full(c, AST_DIGIT_ANY, audiofd, ctrlfd);
03528          ast_stopstream(c);
03529          usleep(1000);
03530          if (!d)
03531             d = ast_waitfordigit_full(c, to, audiofd, ctrlfd);
03532       } else {
03533          d = ast_waitfordigit_full(c, to, audiofd, ctrlfd);
03534       }
03535       if (d < 0)
03536          return -1;
03537       if (d == 0) {
03538          s[pos]='\0';
03539          return 1;
03540       }
03541       if (d == 1) {
03542          s[pos]='\0';
03543          return 2;
03544       }
03545       if (!strchr(enders, d))
03546          s[pos++] = d;
03547       if (strchr(enders, d) || (pos >= len)) {
03548          s[pos]='\0';
03549          return 0;
03550       }
03551       to = timeout;
03552    }
03553    /* Never reached */
03554    return 0;
03555 }

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

References ast_recvtext(), and free.

Referenced by handle_recvchar().

02694 {
02695    int c;
02696    char *buf = ast_recvtext(chan, timeout);
02697    if (buf == NULL)
02698       return -1;  /* error or timeout */
02699    c = *(unsigned char *)buf;
02700    free(buf);
02701    return c;
02702 }

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

02705 {
02706    int res, done = 0;
02707    char *buf = NULL;
02708    
02709    while (!done) {
02710       struct ast_frame *f;
02711       if (ast_check_hangup(chan))
02712          break;
02713       res = ast_waitfor(chan, timeout);
02714       if (res <= 0) /* timeout or error */
02715          break;
02716       timeout = res; /* update timeout */
02717       f = ast_read(chan);
02718       if (f == NULL)
02719          break; /* no frame */
02720       if (f->frametype == AST_FRAME_CONTROL && f->subclass == AST_CONTROL_HANGUP)
02721          done = 1;   /* force a break */
02722       else if (f->frametype == AST_FRAME_TEXT) {      /* what we want */
02723          buf = ast_strndup((char *) f->data, f->datalen);   /* dup and break */
02724          done = 1;
02725       }
02726       ast_frfree(f);
02727    }
02728    return buf;
02729 }

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

03414 {
03415    struct chanlist *chan;
03416    struct ast_channel *c;
03417    int capabilities;
03418    int fmt;
03419    int res;
03420    int foo;
03421    int videoformat = format & AST_FORMAT_VIDEO_MASK;
03422 
03423    if (!cause)
03424       cause = &foo;
03425    *cause = AST_CAUSE_NOTDEFINED;
03426 
03427    if (AST_LIST_LOCK(&channels)) {
03428       ast_log(LOG_WARNING, "Unable to lock channel list\n");
03429       return NULL;
03430    }
03431 
03432    AST_LIST_TRAVERSE(&backends, chan, list) {
03433       if (strcasecmp(type, chan->tech->type))
03434          continue;
03435 
03436       capabilities = chan->tech->capabilities;
03437       fmt = format & AST_FORMAT_AUDIO_MASK;
03438       res = ast_translator_best_choice(&fmt, &capabilities);
03439       if (res < 0) {
03440          ast_log(LOG_WARNING, "No translator path exists for channel type %s (native %d) to %d\n", type, chan->tech->capabilities, format);
03441          *cause = AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
03442          AST_LIST_UNLOCK(&channels);
03443          return NULL;
03444       }
03445       AST_LIST_UNLOCK(&channels);
03446       if (!chan->tech->requester)
03447          return NULL;
03448       
03449       if (!(c = chan->tech->requester(type, capabilities | videoformat, data, cause)))
03450          return NULL;
03451 
03452       /* no need to generate a Newchannel event here; it is done in the channel_alloc call */
03453       return c;
03454    }
03455 
03456    ast_log(LOG_WARNING, "No channel type registered for '%s'\n", type);
03457    *cause = AST_CAUSE_NOSUCHDRIVER;
03458    AST_LIST_UNLOCK(&channels);
03459 
03460    return NULL;
03461 }

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

References __ast_request_and_dial().

Referenced by ast_pbx_outgoing_exten().

03409 {
03410    return __ast_request_and_dial(type, format, data, timeout, outstate, cidnum, cidname, NULL);
03411 }

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

01225 {
01226    return ast_safe_sleep_conditional(chan, ms, NULL, NULL);
01227 }

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

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

Referenced by __login_exec(), and ast_safe_sleep().

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

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

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

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

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

02804 {
02805    if (chan->tech->send_digit_begin) {
02806       ast_senddigit_begin(chan, digit);
02807       ast_safe_sleep(chan, AST_DEFAULT_EMULATE_DTMF_DURATION);
02808    }
02809    
02810    return ast_senddigit_end(chan, digit, AST_DEFAULT_EMULATE_DTMF_DURATION);
02811 }

int ast_senddigit_begin ( struct ast_channel chan,
char  digit 
)

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

02745 {
02746    /* Device does not support DTMF tones, lets fake
02747     * it by doing our own generation. */
02748    static const char* dtmf_tones[] = {
02749       "941+1336", /* 0 */
02750       "697+1209", /* 1 */
02751       "697+1336", /* 2 */
02752       "697+1477", /* 3 */
02753       "770+1209", /* 4 */
02754       "770+1336", /* 5 */
02755       "770+1477", /* 6 */
02756       "852+1209", /* 7 */
02757       "852+1336", /* 8 */
02758       "852+1477", /* 9 */
02759       "697+1633", /* A */
02760       "770+1633", /* B */
02761       "852+1633", /* C */
02762       "941+1633", /* D */
02763       "941+1209", /* * */
02764       "941+1477"  /* # */
02765    };
02766 
02767    if (!chan->tech->send_digit_begin)
02768       return 0;
02769 
02770    if (!chan->tech->send_digit_begin(chan, digit))
02771       return 0;
02772 
02773    if (digit >= '0' && digit <='9')
02774       ast_playtones_start(chan, 0, dtmf_tones[digit-'0'], 0);
02775    else if (digit >= 'A' && digit <= 'D')
02776       ast_playtones_start(chan, 0, dtmf_tones[digit-'A'+10], 0);
02777    else if (digit == '*')
02778       ast_playtones_start(chan, 0, dtmf_tones[14], 0);
02779    else if (digit == '#')
02780       ast_playtones_start(chan, 0, dtmf_tones[15], 0);
02781    else {
02782       /* not handled */
02783       if (option_debug)
02784          ast_log(LOG_DEBUG, "Unable to generate DTMF tone '%c' for '%s'\n", digit, chan->name);
02785    }
02786 
02787    return 0;
02788 }

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

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

02791 {
02792    int res = -1;
02793 
02794    if (chan->tech->send_digit_end)
02795       res = chan->tech->send_digit_end(chan, digit, duration);
02796 
02797    if (res && chan->generator)
02798       ast_playtones_stop(chan);
02799    
02800    return 0;
02801 }

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

02732 {
02733    int res = 0;
02734    /* Stop if we're a zombie or need a soft hangup */
02735    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan))
02736       return -1;
02737    CHECK_BLOCKING(chan);
02738    if (chan->tech->send_text)
02739       res = chan->tech->send_text(chan, text);
02740    ast_clear_flag(chan, AST_FLAG_BLOCKING);
02741    return res;
02742 }

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

04100 {
04101    ast_channel_lock(chan);
04102 
04103    if (callerid) {
04104       if (chan->cid.cid_num)
04105          free(chan->cid.cid_num);
04106       chan->cid.cid_num = ast_strdup(callerid);
04107    }
04108    if (calleridname) {
04109       if (chan->cid.cid_name)
04110          free(chan->cid.cid_name);
04111       chan->cid.cid_name = ast_strdup(calleridname);
04112    }
04113    if (ani) {
04114       if (chan->cid.cid_ani)
04115          free(chan->cid.cid_ani);
04116       chan->cid.cid_ani = ast_strdup(ani);
04117    }
04118 
04119    report_new_callerid(chan);
04120 
04121    ast_channel_unlock(chan);
04122 }

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

03155 {
03156    return set_format(chan, fmt, &chan->rawreadformat, &chan->readformat,
03157            &chan->readtrans, 0);
03158 }

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

04956 {
04957    struct ast_variable *cur;
04958 
04959    for (cur = vars; cur; cur = cur->next)
04960       pbx_builtin_setvar_helper(chan, cur->name, cur->value);  
04961 }

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

03161 {
03162    return set_format(chan, fmt, &chan->rawwriteformat, &chan->writeformat,
03163            &chan->writetrans, 1);
03164 }

int ast_setstate ( struct ast_channel chan,
enum  ast_channel_state 
)

Change the state of a channel.

Definition at line 4124 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(), release_chan_early(), sip_answer(), skinny_answer(), skinny_call(), skinny_newcall(), ss_thread(), and update_state().

04125 {
04126    char name[AST_CHANNEL_NAME], *dashptr;
04127    int oldstate = chan->_state;
04128 
04129    if (oldstate == state)
04130       return 0;
04131 
04132    ast_copy_string(name, chan->name, sizeof(name));
04133    if ((dashptr = strrchr(name, '-'))) {
04134       *dashptr = '\0';
04135    }
04136 
04137    chan->_state = state;
04138    ast_device_state_changed_literal(name);
04139    /* setstate used to conditionally report Newchannel; this is no more */
04140    manager_event(EVENT_FLAG_CALL,
04141             "Newstate",
04142             "Channel: %s\r\n"
04143             "State: %s\r\n"
04144             "CallerID: %s\r\n"
04145             "CallerIDName: %s\r\n"
04146             "Uniqueid: %s\r\n",
04147             chan->name, ast_state2str(chan->_state),
04148             S_OR(chan->cid.cid_num, "<unknown>"),
04149             S_OR(chan->cid.cid_name, "<unknown>"),
04150             chan->uniqueid);
04151 
04152    return 0;
04153 }

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

Definition at line 1884 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_closestream(), ast_deactivate_generator(), ast_read_generator_actions(), ast_readaudio_callback(), and filestream_destructor().

01885 {
01886    int res = -1;
01887 #ifdef HAVE_DAHDI
01888    ast_channel_lock(c);
01889    if (c->timingfd > -1) {
01890       if (!func) {
01891          samples = 0;
01892          data = 0;
01893       }
01894       if (option_debug)
01895          ast_log(LOG_DEBUG, "Scheduling timer at %d sample intervals\n", samples);
01896       res = ioctl(c->timingfd, DAHDI_TIMERCONFIG, &samples);
01897       c->timingfunc = func;
01898       c->timingdata = data;
01899    }
01900    ast_channel_unlock(c);
01901 #endif   
01902    return res;
01903 }

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.
reason an AST_SOFTHANGUP_* reason code
Returns:
Returns 0 regardless

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

01473 {
01474    int res;
01475    ast_channel_lock(chan);
01476    res = ast_softhangup_nolock(chan, cause);
01477    ast_channel_unlock(chan);
01478    return res;
01479 }

int ast_softhangup_nolock ( struct ast_channel chan,
int  cause 
)

Softly hangup up a channel (no channel lock).

Parameters:
chan channel to be soft-hung-up
reason an AST_SOFTHANGUP_* reason code

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

01459 {
01460    if (option_debug)
01461       ast_log(LOG_DEBUG, "Soft-Hanging up channel '%s'\n", chan->name);
01462    /* Inform channel driver that we need to be hung up, if it cares */
01463    chan->_softhangup |= cause;
01464    ast_queue_frame(chan, &ast_null_frame);
01465    /* Interrupt any poll call or such */
01466    if (ast_test_flag(chan, AST_FLAG_BLOCKING))
01467       pthread_kill(chan->blocker, SIGURG);
01468    return 0;
01469 }

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

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

Referenced by zapateller_exec().

04828 {
04829    int res;
04830 
04831    if ((res = ast_tonepair_start(chan, freq1, freq2, duration, vol)))
04832       return res;
04833 
04834    /* Give us some wiggle room */
04835    while (chan->generatordata && ast_waitfor(chan, 100) >= 0) {
04836       struct ast_frame *f = ast_read(chan);
04837       if (f)
04838          ast_frfree(f);
04839       else
04840          return -1;
04841    }
04842    return 0;
04843 }

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

Start a tone going

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

04810 {
04811    struct tonepair_def d = { 0, };
04812 
04813    d.freq1 = freq1;
04814    d.freq2 = freq2;
04815    d.duration = duration;
04816    d.vol = (vol < 1) ? 8192 : vol; /* force invalid to 8192 */
04817    if (ast_activate_generator(chan, &tonepair, &d))
04818       return -1;
04819    return 0;
04820 }

void ast_tonepair_stop ( struct ast_channel chan  ) 

Stop a tone from playing

Definition at line 4822 of file channel.c.

References ast_deactivate_generator().

Referenced by sendnoise().

04823 {
04824    ast_deactivate_generator(chan);
04825 }

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

03492 {
03493    int res = -1;
03494 
03495    /* Stop if we're a zombie or need a soft hangup */
03496    ast_channel_lock(chan);
03497    if (!ast_test_flag(chan, AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
03498       if (chan->tech->transfer) {
03499          res = chan->tech->transfer(chan, dest);
03500          if (!res)
03501             res = 1;
03502       } else
03503          res = 0;
03504    }
03505    ast_channel_unlock(chan);
03506    return res;
03507 }

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

01869 {
01870    int oldms = ms;   /* -1 if no timeout */
01871 
01872    ast_waitfor_nandfds(&c, 1, NULL, 0, NULL, NULL, &ms);
01873    if ((ms < 0) && (oldms < 0))
01874       ms = 0;
01875    return ms;
01876 }

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

01864 {
01865    return ast_waitfor_nandfds(c, n, NULL, 0, NULL, NULL, ms);
01866 }

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

References ast_waitfor_nandfds().

Referenced by dundi_lookup_internal(), and dundi_precache_internal().

01708 {
01709    int winner = -1;
01710    ast_waitfor_nandfds(NULL, 0, fds, n, exception, &winner, ms);
01711    return winner;
01712 }

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

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

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

01880 {
01881    return ast_waitfordigit_full(c, ms, -1, -1);
01882 }

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

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

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

References channel_find_locked().

Referenced by next_channel().

01198 {
01199    return channel_find_locked(chan, NULL, 0, context, exten);
01200 }

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

References channel_find_locked().

Referenced by next_channel().

01185 {
01186    return channel_find_locked(chan, name, namelen, NULL, NULL);
01187 }

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 2842 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_frisolate(), AST_LIST_NEXT, ast_log(), AST_MONITOR_RUNNING, ast_seekstream(), ast_senddigit_begin(), ast_senddigit_end(), AST_SOFTHANGUP_DEV, ast_test_flag, ast_translate(), ast_writestream(), ast_channel::audiohooks, CHECK_BLOCKING, ast_frame::data, ast_frame::datalen, DEBUGCHAN_FLAG, f, ast_channel::fout, ast_frame::frame_list, FRAMECOUNT_INC, ast_frame::frametype, ast_channel::generatordata, ast_channel_tech::indicate, ast_channel::insmpl, ast_frame::len, LOG_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_feature_request_and_dial(), 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().

02843 {
02844    int res = -1;
02845    int count = 0;
02846    struct ast_frame *f = NULL;
02847 
02848    /*Deadlock avoidance*/
02849    while(ast_channel_trylock(chan)) {
02850       /*cannot goto done since the channel is not locked*/
02851       if(count++ > 10) {
02852          if(option_debug)
02853             ast_log(LOG_DEBUG, "Deadlock avoided for write to channel '%s'\n", chan->name);
02854          return 0;
02855       }
02856       usleep(1);
02857    }
02858    /* Stop if we're a zombie or need a soft hangup */
02859    if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan))
02860       goto done;
02861 
02862    /* Handle any pending masquerades */
02863    if (chan->masq && ast_do_masquerade(chan)) {
02864       ast_log(LOG_WARNING, "Failed to perform masquerade\n");
02865       goto done;
02866    }
02867    if (chan->masqr) {
02868       res = 0; /* XXX explain, why 0 ? */
02869       goto done;
02870    }
02871    if (chan->generatordata) {
02872       if (ast_test_flag(chan, AST_FLAG_WRITE_INT))
02873          ast_deactivate_generator(chan);
02874       else {
02875          if (fr->frametype == AST_FRAME_DTMF_END) {
02876             /* There is a generator running while we're in the middle of a digit.
02877              * It's probably inband DTMF, so go ahead and pass it so it can
02878              * stop the generator */
02879             ast_clear_flag(chan, AST_FLAG_BLOCKING);
02880             ast_channel_unlock(chan);
02881             res = ast_senddigit_end(chan, fr->subclass, fr->len);
02882             ast_channel_lock(chan);
02883             CHECK_BLOCKING(chan);
02884          } else if (fr->frametype == AST_FRAME_CONTROL && fr->subclass == AST_CONTROL_UNHOLD) {
02885             /* This is a side case where Echo is basically being called and the person put themselves on hold and took themselves off hold */
02886             res = (chan->tech->indicate == NULL) ? 0 :
02887                chan->tech->indicate(chan, fr->subclass, fr->data, fr->datalen);
02888          }
02889          res = 0; /* XXX explain, why 0 ? */
02890          goto done;
02891       }
02892    }
02893    /* High bit prints debugging */
02894    if (chan->fout & DEBUGCHAN_FLAG)
02895       ast_frame_dump(chan->name, fr, ">>");
02896    CHECK_BLOCKING(chan);
02897    switch(fr->frametype) {
02898    case AST_FRAME_CONTROL:
02899       res = (chan->tech->indicate == NULL) ? 0 :
02900          chan->tech->indicate(chan, fr->subclass, fr->data, fr->datalen);
02901       break;
02902    case AST_FRAME_DTMF_BEGIN:
02903       if (chan->audiohooks) {
02904          struct ast_frame *old_frame = fr;
02905          fr = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_WRITE, fr);
02906          if (old_frame != fr)
02907             f = fr;
02908       }
02909       ast_clear_flag(chan, AST_FLAG_BLOCKING);
02910       ast_channel_unlock(chan);
02911       res = ast_senddigit_begin(chan, fr->subclass);
02912       ast_channel_lock(chan);
02913       CHECK_BLOCKING(chan);
02914       break;
02915    case AST_FRAME_DTMF_END:
02916       if (chan->audiohooks) {
02917          struct ast_frame *new_frame = fr;
02918 
02919          new_frame = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_WRITE, fr);
02920          if (new_frame != fr) {
02921             ast_frfree(new_frame);
02922          }
02923       }
02924       ast_clear_flag(chan, AST_FLAG_BLOCKING);
02925       ast_channel_unlock(chan);
02926       res = ast_senddigit_end(chan, fr->subclass, fr->len);
02927       ast_channel_lock(chan);
02928       CHECK_BLOCKING(chan);
02929       break;
02930    case AST_FRAME_TEXT:
02931       res = (chan->tech->send_text == NULL) ? 0 :
02932          chan->tech->send_text(chan, (char *) fr->data);
02933       break;
02934    case AST_FRAME_HTML:
02935       res = (chan->tech->send_html == NULL) ? 0 :
02936          chan->tech->send_html(chan, fr->subclass, (char *) fr->data, fr->datalen);
02937       break;
02938    case AST_FRAME_VIDEO:
02939       /* XXX Handle translation of video codecs one day XXX */
02940       res = (chan->tech->write_video == NULL) ? 0 :
02941          chan->tech->write_video(chan, fr);
02942       break;
02943    case AST_FRAME_MODEM:
02944       res = (chan->tech->write == NULL) ? 0 :
02945          chan->tech->write(chan, fr);
02946       break;
02947    case AST_FRAME_VOICE:
02948       if (chan->tech->write == NULL)
02949          break;   /*! \todo XXX should return 0 maybe ? */
02950 
02951       /* If the frame is in the raw write format, then it's easy... just use the frame - otherwise we will have to translate */
02952       if (fr->subclass == chan->rawwriteformat)
02953          f = fr;
02954       else
02955          f = (chan->writetrans) ? ast_translate(chan->writetrans, fr, 0) : fr;
02956 
02957       /* If we have no frame of audio, then we have to bail out */
02958       if (!f) {
02959          res = 0;
02960          break;
02961       }
02962 
02963       if (chan->audiohooks) {
02964          struct ast_frame *prev = NULL, *new_frame, *cur, *dup;
02965          int freeoldlist = 0;
02966 
02967          if (f != fr) {
02968             freeoldlist = 1;
02969          }
02970 
02971          /* Since ast_audiohook_write may return a new frame, and the cur frame is
02972           * an item in a list of frames, create a new list adding each cur frame back to it
02973           * regardless if the cur frame changes or not. */
02974          for (cur = f; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
02975             new_frame = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_WRITE, cur);
02976 
02977             /* if this frame is different than cur, preserve the end of the list,
02978              * free the old frames, and set cur to be the new frame */
02979             if (new_frame != cur) {
02980 
02981                /* doing an ast_frisolate here seems silly, but we are not guaranteed the new_frame
02982                 * isn't part of local storage, meaning if ast_audiohook_write is called multiple
02983                 * times it may override the previous frame we got from it unless we dup it */
02984                if ((dup = ast_frisolate(new_frame))) {
02985                   AST_LIST_NEXT(dup, frame_list) = AST_LIST_NEXT(cur, frame_list);
02986                   if (freeoldlist) {
02987                      AST_LIST_NEXT(cur, frame_list) = NULL;
02988                      ast_frfree(cur);
02989                   }
02990                   cur = dup;
02991                }
02992             }
02993 
02994             /* now, regardless if cur is new or not, add it to the new list,
02995              * if the new list has not started, cur will become the first item. */
02996             if (prev) {
02997                AST_LIST_NEXT(prev, frame_list) = cur;
02998             } else {
02999                f = cur; /* set f to be the beginning of our new list */
03000             }
03001             prev = cur;
03002          }
03003       }
03004       
03005       /* If Monitor is running on this channel, then we have to write frames out there too */
03006       /* the translator on chan->writetrans may have returned multiple frames
03007          from the single frame we passed in; if so, feed each one of them to the
03008          monitor */
03009       if (chan->monitor && chan->monitor->write_stream) {
03010          struct ast_frame *cur;
03011 
03012          for (cur = f; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
03013          /* XXX must explain this code */
03014 #ifndef MONITOR_CONSTANT_DELAY
03015             int jump = chan->insmpl - chan->outsmpl - 4 * cur->samples;
03016             if (jump >= 0) {
03017                jump = chan->insmpl - chan->outsmpl;
03018                if (ast_seekstream(chan->monitor->write_stream, jump, SEEK_FORCECUR) == -1)
03019                   ast_log(LOG_WARNING, "Failed to perform seek in monitoring write stream, synchronization between the files may be broken\n");
03020                chan->outsmpl += jump + cur->samples;
03021             } else {
03022                chan->outsmpl += cur->samples;
03023             }
03024 #else
03025             int jump = chan->insmpl - chan->outsmpl;
03026             if (jump - MONITOR_DELAY >= 0) {
03027                if (ast_seekstream(chan->monitor->write_stream, jump - cur->samples, SEEK_FORCECUR) == -1)
03028                   ast_log(LOG_WARNING, "Failed to perform seek in monitoring write stream, synchronization between the files may be broken\n");
03029                chan->outsmpl += jump;
03030             } else {
03031                chan->outsmpl += cur->samples;
03032             }
03033 #endif
03034             if (chan->monitor->state == AST_MONITOR_RUNNING) {
03035                if (ast_writestream(chan->monitor->write_stream, cur) < 0)
03036                   ast_log(LOG_WARNING, "Failed to write data to channel monitor write stream\n");
03037             }
03038          }
03039       }
03040 
03041       /* the translator on chan->writetrans may have returned multiple frames
03042          from the single frame we passed in; if so, feed each one of them to the
03043          channel, freeing each one after it has been written */
03044       if ((f != fr) && AST_LIST_NEXT(f, frame_list)) {
03045          struct ast_frame *cur, *next;
03046          unsigned int skip = 0;
03047 
03048          for (cur = f, next = AST_LIST_NEXT(cur, frame_list);
03049               cur;
03050               cur = next, next = cur ? AST_LIST_NEXT(cur, frame_list) : NULL) {
03051             if (!skip) {
03052                if ((res = chan->tech->write(chan, cur)) < 0) {
03053                   chan->_softhangup |= AST_SOFTHANGUP_DEV;
03054                   skip = 1;
03055                } else if (next) {
03056                   /* don't do this for the last frame in the list,
03057                      as the code outside the loop will do it once
03058                   */
03059                   chan->fout = FRAMECOUNT_INC(chan->fout);
03060                }
03061             }
03062             ast_frfree(cur);
03063          }
03064 
03065          /* reset f so the code below doesn't attempt to free it */
03066          f = NULL;
03067       } else {
03068          res = chan->tech->write(chan, f);
03069       }
03070       break;
03071    case AST_FRAME_NULL:
03072    case AST_FRAME_IAX:
03073       /* Ignore these */
03074       res = 0;
03075       break;
03076    default:
03077       /* At this point, fr is the incoming frame and f is NULL.  Channels do
03078        * not expect to get NULL as a frame pointer and will segfault.  Hence,
03079        * we output the original frame passed in. */
03080       res = chan->tech->write(chan, fr);
03081       break;
03082    }
03083 
03084    if (f && f != fr)
03085       ast_frfree(f);
03086    ast_clear_flag(chan, AST_FLAG_BLOCKING);
03087 
03088    /* Consider a write failure to force a soft hangup */
03089    if (res < 0) {
03090       chan->_softhangup |= AST_SOFTHANGUP_DEV;
03091    } else {
03092       chan->fout = FRAMECOUNT_INC(chan->fout);
03093    }
03094 done:
03095    ast_channel_unlock(chan);
03096    return res;
03097 }

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

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

02832 {
02833    int res;
02834    if (!chan->tech->write_video)
02835       return 0;
02836    res = ast_write(chan, fr);
02837    if (!res)
02838       res = 1;
02839    return res;
02840 }

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

References CHANNEL_CLI_RELOAD, CHANNEL_MODULE_LOAD, and CHANNEL_MODULE_RELOAD.

05043 {
05044    switch (reason) {
05045    case CHANNEL_MODULE_LOAD:
05046       return "LOAD (Channel module load)";
05047 
05048    case CHANNEL_MODULE_RELOAD:
05049       return "RELOAD (Channel module reload)";
05050 
05051    case CHANNEL_CLI_RELOAD:
05052       return "CLIRELOAD (Channel module reload by CLI command)";
05053 
05054    default:
05055       return "MANAGERRELOAD (Channel module reload by manager)";
05056    }
05057 };


Generated on Sun Aug 15 20:33:38 2010 for Asterisk - the Open Source PBX by  doxygen 1.4.7