channel.c File Reference

Channel Management. More...

#include "asterisk.h"
#include "asterisk/_private.h"
#include <sys/time.h>
#include <signal.h>
#include <math.h>
#include "asterisk/paths.h"
#include "asterisk/pbx.h"
#include "asterisk/frame.h"
#include "asterisk/sched.h"
#include "asterisk/channel.h"
#include "asterisk/musiconhold.h"
#include "asterisk/say.h"
#include "asterisk/file.h"
#include "asterisk/cli.h"
#include "asterisk/translate.h"
#include "asterisk/manager.h"
#include "asterisk/chanvars.h"
#include "asterisk/linkedlists.h"
#include "asterisk/indications.h"
#include "asterisk/monitor.h"
#include "asterisk/causes.h"
#include "asterisk/callerid.h"
#include "asterisk/utils.h"
#include "asterisk/lock.h"
#include "asterisk/app.h"
#include "asterisk/transcap.h"
#include "asterisk/devicestate.h"
#include "asterisk/sha1.h"
#include "asterisk/threadstorage.h"
#include "asterisk/slinfactory.h"
#include "asterisk/audiohook.h"
#include "asterisk/timing.h"

Include dependency graph for channel.c:

Go to the source code of this file.

Data Structures
struct	ast_cause
	map AST_CAUSE's to readable string representations More...
struct	ast_epoll_data
struct	ast_silence_generator
struct	backends
	the list of registered channel types More...
struct	chanlist
	List of channel drivers. More...
struct	channels
	the list of channels we have. Note that the lock for this list is used for both the channels list and the backends list. More...
struct	tonepair_def
struct	tonepair_state
Defines
#define	AST_DEFAULT_EMULATE_DTMF_DURATION   100
#define	AST_MIN_DTMF_DURATION   80
#define	AST_MIN_DTMF_GAP   45
#define	FORMAT   "%-10.10s %-40.40s %-12.12s %-12.12s %-12.12s\n"
#define	STATE2STR_BUFSIZE   32
Functions
int	__ast_answer (struct ast_channel *chan, unsigned int delay, int cdr_answer)
	Answer a channel, with a selectable delay before returning.
struct ast_channel *	__ast_channel_alloc (int needqueue, int state, const char *cid_num, const char *cid_name, const char *acctcode, const char *exten, const char *context, const int amaflag, const char *file, int line, const char *function, const char *name_fmt,...)
	Create a channel structure.
static struct ast_channel *attribute_malloc	__ast_channel_alloc_ap (int needqueue, int state, const char *cid_num, const char *cid_name, const char *acctcode, const char *exten, const char *context, const int amaflag, const char *file, int line, const char *function, const char *name_fmt, va_list ap1, va_list ap2)
	Create a new channel structure.
static int	__ast_queue_frame (struct ast_channel *chan, struct ast_frame *fin, int head, struct ast_frame *after)
static struct ast_frame *	__ast_read (struct ast_channel *chan, int dropaudio)
struct ast_channel *	__ast_request_and_dial (const char *type, int format, void *data, int timeout, int *outstate, const char *cid_num, const char *cid_name, struct outgoing_helper *oh)
	Request a channel of a given type, with data as optional information used by the low level module and attempt to place a call on it.
static void	__fini_channels (void)
static void	__init_channels (void)
static void	__init_state2str_threadbuf (void)
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
int	ast_answer (struct ast_channel *chan)
	Answer a channel.
void	ast_begin_shutdown (int hangup)
	Initiate system shutdown.
int	ast_best_codec (int fmts)
	Pick the best audio codec.
struct ast_channel *	ast_bridged_channel (struct ast_channel *chan)
	Find bridged channel.
int	ast_call (struct ast_channel *chan, char *addr, int timeout)
	Make a call.
struct ast_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.
void	ast_cancel_shutdown (void)
	Cancel a shutdown in progress.
const char *	ast_cause2str (int cause)
	Gives the string form of a given hangup cause.
void	ast_change_name (struct ast_channel *chan, char *newname)
	Change channel name.
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,...)
enum ast_bridge_result	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_cmpwhentohangup_tv (struct ast_channel *chan, struct timeval offset)
	Compare a offset with when to hangup channel.
int	ast_channel_datastore_add (struct ast_channel *chan, struct ast_datastore *datastore)
	Add a datastore to a channel.
struct ast_datastore *	ast_channel_datastore_alloc (const struct ast_datastore_info *info, const char *uid)
	Create a channel data store object.
struct ast_datastore *	ast_channel_datastore_find (struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid)
	Find a datastore on a channel.
int	ast_channel_datastore_free (struct ast_datastore *datastore)
	Free a channel data store object.
int	ast_channel_datastore_inherit (struct ast_channel *from, struct ast_channel *to)
	Inherit datastores from a parent to a child.
int	ast_channel_datastore_remove (struct ast_channel *chan, struct ast_datastore *datastore)
	Remove a datastore from a channel.
int	ast_channel_defer_dtmf (struct ast_channel *chan)
	Set defer DTMF flag on channel.
int	ast_channel_early_bridge (struct ast_channel *c0, struct ast_channel *c1)
	Bridge two channels together (early).
void	ast_channel_free (struct ast_channel *chan)
	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 *chan, struct ast_channel *peer)
	Makes two channel formats compatible.
static int	ast_channel_make_compatible_helper (struct ast_channel *from, struct ast_channel *to)
	Set up translation from one channel to another.
int	ast_channel_masquerade (struct ast_channel *original, struct ast_channel *clonechan)
	Weird function made for call transfers.
int	ast_channel_queryoption (struct ast_channel *chan, int option, void *data, int *datalen, int block)
const char *	ast_channel_reason2str (int reason)
	return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
int	ast_channel_register (const struct ast_channel_tech *tech)
	Register a new telephony channel in Asterisk.
int	ast_channel_sendhtml (struct ast_channel *chan, int subclass, const char *data, int datalen)
int	ast_channel_sendurl (struct ast_channel *chan, const char *url)
void	ast_channel_set_fd (struct ast_channel *chan, int which, int fd)
int	ast_channel_setoption (struct ast_channel *chan, 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.
void	ast_channel_setwhentohangup_tv (struct ast_channel *chan, struct timeval offset)
	Set when to hangup channel.
struct ast_silence_generator *	ast_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 *chan)
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 channel driver.
struct ast_channel *	ast_channel_walk_locked (const struct ast_channel *prev)
	Browse channels in use.
void	ast_channels_init (void)
struct ast_variable *	ast_channeltype_list (void)
	return an ast_variable list of channeltypes
int	ast_check_hangup (struct ast_channel *chan)
	Checks to see if a channel is needing hang up.
static int	ast_check_hangup_locked (struct ast_channel *chan)
void	ast_deactivate_generator (struct ast_channel *chan)
int	ast_do_masquerade (struct ast_channel *original)
	Masquerade a channel.
static enum ast_bridge_result	ast_generic_bridge (struct ast_channel *c0, struct ast_channel *c1, struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc, struct timeval bridge_end)
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.
struct ast_channel *	ast_get_channel_by_name_locked (const char *name)
	Get channel by name and lock it.
struct ast_channel *	ast_get_channel_by_name_prefix_locked (const char *name, const int namelen)
	Get channel by name prefix and lock it.
struct ast_channel_tech *	ast_get_channel_tech (const char *name)
	Get handle to channel driver based on name.
ast_group_t	ast_get_group (const char *s)
int	ast_hangup (struct ast_channel *chan)
	Hangup 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.
void	ast_install_music_functions (int(*start_ptr)(struct ast_channel *, const char *, const char *), void(*stop_ptr)(struct ast_channel *), void(*cleanup_ptr)(struct ast_channel *))
int	ast_internal_timing_enabled (struct ast_channel *chan)
	Check if the channel can run in internal timing mode.
void	ast_moh_cleanup (struct ast_channel *chan)
int	ast_moh_start (struct ast_channel *chan, const char *mclass, const char *interpclass)
	Turn on music on hold on a given channel.
void	ast_moh_stop (struct ast_channel *chan)
	Turn off music on hold on a given channel.
void	ast_poll_channel_add (struct ast_channel *chan0, struct ast_channel *chan1)
void	ast_poll_channel_del (struct ast_channel *chan0, struct ast_channel *chan1)
char *	ast_print_group (char *buf, int buflen, ast_group_t group)
	Print call group and pickup group ---.
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.
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 *fin)
	Queue one or more frames to a channel's frame queue.
int	ast_queue_frame_head (struct ast_channel *chan, struct ast_frame *fin)
	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 for channel.
int	ast_queue_hangup_with_cause (struct ast_channel *chan, int cause)
	Queue a hangup frame for channel.
int	ast_raw_answer (struct ast_channel *chan, int cdr_answer)
	Answer a channel.
struct ast_frame *	ast_read (struct ast_channel *chan)
	Reads a frame.
static void	ast_read_generator_actions (struct ast_channel *chan, struct ast_frame *f)
struct ast_frame *	ast_read_noaudio (struct ast_channel *chan)
	Reads a frame, returning AST_FRAME_NULL frame if audio.
int	ast_readstring (struct ast_channel *c, char *s, int len, int timeout, int ftimeout, char *enders)
int	ast_readstring_full (struct ast_channel *c, char *s, int len, int timeout, int ftimeout, char *enders, int audiofd, int ctrlfd)
int	ast_recvchar (struct ast_channel *chan, int timeout)
	Receives a text character from a channel.
char *	ast_recvtext (struct ast_channel *chan, int timeout)
	Receives a text string from a channel Read a string of text from a channel.
struct ast_channel *	ast_request (const char *type, int format, void *data, int *cause)
	Requests a channel.
struct ast_channel *	ast_request_and_dial (const char *type, int format, void *data, int timeout, int *outstate, 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, look for hangups.
int	ast_safe_sleep_conditional (struct ast_channel *chan, int ms, int(*cond)(void *), void *data)
	Wait, look for hangups and condition arg.
int	ast_say_character_str (struct ast_channel *chan, const char *str, const char *ints, const char *lang)
int	ast_say_digit_str (struct ast_channel *chan, const char *str, const char *ints, const char *lang)
int	ast_say_digits (struct ast_channel *chan, int num, const char *ints, const char *lang)
int	ast_say_digits_full (struct ast_channel *chan, int num, const char *ints, const char *lang, int audiofd, int ctrlfd)
int	ast_say_enumeration (struct ast_channel *chan, int num, const char *ints, const char *language, const char *options)
int	ast_say_number (struct ast_channel *chan, int num, const char *ints, const char *language, const char *options)
int	ast_say_phonetic_str (struct ast_channel *chan, const char *str, const char *ints, const char *lang)
int	ast_senddigit (struct ast_channel *chan, char digit, unsigned int duration)
	Send a DTMF digit to a channel Send a DTMF digit to a channel.
int	ast_senddigit_begin (struct ast_channel *chan, char digit)
	Send a DTMF digit to a channel Send a DTMF digit to a channel.
int	ast_senddigit_end (struct ast_channel *chan, char digit, unsigned int duration)
	Send a DTMF digit to a channel.
int	ast_sendtext (struct ast_channel *chan, const char *text)
	Sends text to a channel.
void	ast_set_callerid (struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani)
	Set caller ID number, name and ANI.
int	ast_set_read_format (struct ast_channel *chan, int fmt)
	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 fmt)
	Sets write format on channel chan Set write format for channel to whichever component of "format" is best.
int	ast_setstate (struct ast_channel *chan, enum ast_channel_state state)
	Change the state of a channel.
int	ast_settimeout (struct ast_channel *c, unsigned int rate, int(*func)(const void *data), void *data)
	Enable or disable timer ticks for a channel.
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 a channel, lock.
int	ast_softhangup_nolock (struct ast_channel *chan, int cause)
	Softly hangup a channel, don't lock.
const char *	ast_state2str (enum ast_channel_state state)
	Gives the string form of a given channel state.
int	ast_str2cause (const char *name)
	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 call to dest, if the channel supports transfer.
char *	ast_transfercapability2str (int transfercapability)
	Gives the string form of a given transfer capability.
void	ast_uninstall_music_functions (void)
int	ast_waitfor (struct ast_channel *c, int ms)
	Wait for input on a channel.
struct ast_channel *	ast_waitfor_n (struct ast_channel **c, 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)
	Wait for x amount of time on a file descriptor to have input.
struct ast_channel *	ast_waitfor_nandfds (struct ast_channel **c, int n, int *fds, int nfds, int *exception, int *outfd, int *ms)
	Wait for x amount of time on a file descriptor to have input.
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 cmdfd)
	Wait for a digit Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
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.
struct ast_channel *	ast_walk_channel_by_name_prefix_locked (const struct ast_channel *chan, const char *name, const int namelen)
	Get next channel by name prefix and lock it.
int	ast_write (struct ast_channel *chan, struct ast_frame *fr)
	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 *fr)
	Write video frame to a channel This function writes the given frame to the indicated channel.
static void	bridge_play_sounds (struct ast_channel *c0, struct ast_channel *c1)
static void	bridge_playfile (struct ast_channel *chan, struct ast_channel *peer, const char *sound, int remain)
static struct ast_channel *	channel_find_locked (const struct ast_channel *prev, const char *name, const int namelen, const char *context, const char *exten)
	Helper function to find channels.
const char *	channelreloadreason2txt (enum channelreloadreason reason)
	Convert enum channelreloadreason to text string for manager event.
static void	clone_variables (struct ast_channel *original, struct ast_channel *clonechan)
	Clone channel variables from 'clone' channel into 'original' channel.
static char *	complete_channeltypes (struct ast_cli_args *a)
static void	free_cid (struct ast_callerid *cid)
static void	free_translation (struct ast_channel *clonechan)
static int	generator_force (const void *data)
static void	handle_cause (int cause, int *outstate)
static char *	handle_cli_core_show_channeltype (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
	Show details about a channel driver - CLI command.
static char *	handle_cli_core_show_channeltypes (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
	Show channel types - CLI command.
static int attribute_const	is_visible_indication (enum ast_control_frame_type condition)
static void	manager_bridge_event (int onoff, int type, struct ast_channel *c0, struct ast_channel *c1)
	Send manager event for bridge link and unlink events.
static void	queue_dtmf_readq (struct ast_channel *chan, struct ast_frame *f)
static void	report_new_callerid (const struct ast_channel *chan)
static void	send_dtmf_event (const struct ast_channel *chan, const char *direction, const char digit, const char *begin, const char *end)
static int	set_format (struct ast_channel *chan, int fmt, int *rawformat, int *format, struct ast_trans_pvt **trans, const int direction)
static int	should_skip_dtmf (struct ast_channel *chan)
	Determine whether or not we should ignore DTMF in the readq.
static void *	silence_generator_alloc (struct ast_channel *chan, void *data)
static int	silence_generator_generate (struct ast_channel *chan, void *data, int len, int samples)
static void	silence_generator_release (struct ast_channel *chan, void *data)
static void *	tonepair_alloc (struct ast_channel *chan, void *params)
static int	tonepair_generator (struct ast_channel *chan, void *data, int len, int samples)
static void	tonepair_release (struct ast_channel *chan, void *params)
static void	update_bridge_vars (struct ast_channel *c0, struct ast_channel *c1)
Variables
static void(*	ast_moh_cleanup_ptr )(struct ast_channel *) = NULL
static int(*	ast_moh_start_ptr )(struct ast_channel *, const char *, const char *) = NULL
static void(*	ast_moh_stop_ptr )(struct ast_channel *) = NULL
struct ast_cause	causes []
	map AST_CAUSE's to readable string representations
static struct ast_cli_entry	cli_channel []
unsigned long	global_fin
unsigned long	global_fout
static struct ast_channel_tech	null_tech
static int	shutting_down
	Prevent new channel allocation if shutting down.
static struct ast_generator	silence_generator
static struct ast_threadstorage	state2str_threadbuf = { .once = PTHREAD_ONCE_INIT, .key_init = __init_state2str_threadbuf , .custom_init = NULL , }
static struct ast_generator	tonepair
static int	uniqueint

---

Detailed Description

Channel Management.

Author:

Mark Spencer <markster@digium.com>

Definition in file channel.c.

---

Define Documentation

#define AST_DEFAULT_EMULATE_DTMF_DURATION   100

Default amount of time to use when emulating a digit as a begin and end 100ms

Definition at line 92 of file channel.c.

Referenced by __ast_read(), and ast_senddigit().

#define AST_MIN_DTMF_DURATION   80

Minimum allowed digit length - 80ms

Definition at line 95 of file channel.c.

Referenced by __ast_read().

#define AST_MIN_DTMF_GAP   45

Minimum amount of time between the end of the last digit and the beginning of a new one - 45ms

Definition at line 99 of file channel.c.

Referenced by __ast_read(), and should_skip_dtmf().

#define FORMAT   "%-10.10s %-40.40s %-12.12s %-12.12s %-12.12s\n"

#define STATE2STR_BUFSIZE   32

Definition at line 88 of file channel.c.

Referenced by ast_state2str().

---

Function Documentation

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

Answer a channel, with a selectable delay before returning.

Parameters:

	chan	channel to answer
	delay	maximum amount of time to wait for incoming media
	cdr_answer	flag to control whether any associated CDR should be marked as 'answered'

This function answers a channel and handles all necessary call setup functions.

Note:

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

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

Return values:

	0	on success
	non-zero	on failure

Definition at line 1801 of file channel.c.

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

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

{
   int res = 0;
   enum ast_channel_state old_state;

   old_state = chan->_state;
   if ((res = ast_raw_answer(chan, cdr_answer))) {
      return res;
   }

   switch (old_state) {
   case AST_STATE_RINGING:
   case AST_STATE_RING:
      /* wait for media to start flowing, but don't wait any longer
       * than 'delay' or 500 milliseconds, whichever is longer
       */
      do {
         AST_LIST_HEAD_NOLOCK(, ast_frame) frames;
         struct ast_frame *cur, *new;
         int ms = MAX(delay, 500);
         unsigned int done = 0;

         AST_LIST_HEAD_INIT_NOLOCK(&frames);

         for (;;) {
            ms = ast_waitfor(chan, ms);
            if (ms < 0) {
               ast_log(LOG_WARNING, "Error condition occurred when polling channel %s for a voice frame: %s\n", chan->name, strerror(errno));
               res = -1;
               break;
            }
            if (ms == 0) {
               ast_debug(2, "Didn't receive a media frame from %s within %d ms of answering. Continuing anyway\n", chan->name, MAX(delay, 500));
               break;
            }
            cur = ast_read(chan);
            if (!cur || ((cur->frametype == AST_FRAME_CONTROL) &&
                    (cur->subclass == AST_CONTROL_HANGUP))) {
               if (cur) {
                  ast_frfree(cur);
               }
               res = -1;
               ast_debug(2, "Hangup of channel %s detected in answer routine\n", chan->name);
               break;
            }

            if ((new = ast_frisolate(cur)) != cur) {
               ast_frfree(cur);
            }

            AST_LIST_INSERT_HEAD(&frames, new, frame_list);

            /* if a specific delay period was requested, continue
             * until that delay has passed. don't stop just because
             * incoming media has arrived.
             */
            if (delay) {
               continue;
            }

            switch (new->frametype) {
               /* all of these frametypes qualify as 'media' */
            case AST_FRAME_VOICE:
            case AST_FRAME_VIDEO:
            case AST_FRAME_TEXT:
            case AST_FRAME_DTMF_BEGIN:
            case AST_FRAME_DTMF_END:
            case AST_FRAME_IMAGE:
            case AST_FRAME_HTML:
            case AST_FRAME_MODEM:
               done = 1;
               break;
            case AST_FRAME_CONTROL:
            case AST_FRAME_IAX:
            case AST_FRAME_NULL:
            case AST_FRAME_CNG:
               break;
            }

            if (done) {
               break;
            }
         }

         if (res == 0) {
            ast_channel_lock(chan);
            while ((cur = AST_LIST_REMOVE_HEAD(&frames, frame_list))) {
               ast_queue_frame_head(chan, cur);
               ast_frfree(cur);
            }
            ast_channel_unlock(chan);
         }
      } while (0);
      break;
   default:
      break;
   }

   return res;
}

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

Create a channel structure.

Return values:

	NULL	failure
	non-NULL	successfully allocated channel

Note:

By default, new channels are set to the "s" extension and "default" context.

Definition at line 966 of file channel.c.

References __ast_channel_alloc_ap().

{
   va_list ap1, ap2;
   struct ast_channel *result;

   va_start(ap1, name_fmt);
   va_start(ap2, name_fmt);
   result = __ast_channel_alloc_ap(needqueue, state, cid_num, cid_name, acctcode, exten, context,
               amaflag, file, line, function, name_fmt, ap1, ap2);
   va_end(ap1);
   va_end(ap2);

   return result;
}

static struct ast_channel* attribute_malloc __ast_channel_alloc_ap	(	int	needqueue,
		int	state,
		const char *	cid_num,
		const char *	cid_name,
		const char *	acctcode,
		const char *	exten,
		const char *	context,
		const int	amaflag,
		const char *	file,
		int	line,
		const char *	function,
		const char *	name_fmt,
		va_list	ap1,
		va_list	ap2
	)			[static, read]

Create a new channel structure.

Definition at line 770 of file channel.c.

References __ast_calloc(), ast_channel::_state, ast_channel::accountcode, accountcode, ast_channel::alertpipe, ast_channel::amaflags, AST_ALERT_FD, ast_atomic_fetchadd_int(), ast_calloc, ast_cdr_alloc(), ast_cdr_init(), ast_cdr_start(), ast_channel_set_fd(), ast_config_AST_SYSTEM_NAME, ast_copy_string(), ast_default_accountcode, ast_default_amaflags, AST_FLAG_IN_CHANNEL_LIST, ast_free, AST_LIST_HEAD_INIT_NOLOCK, ast_log(), AST_MAX_FDS, ast_mutex_init(), AST_RWLIST_INSERT_HEAD, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_set_flag, ast_state2str(), ast_strdup, ast_string_field_build, ast_string_field_build_va, ast_string_field_free_memory, ast_string_field_init, ast_string_field_set, ast_strlen_zero(), ast_timer_close(), ast_timer_fd(), ast_timer_open(), AST_TIMING_FD, ast_channel::cdr, ast_channel::cid, ast_callerid::cid_name, ast_callerid::cid_num, ast_channel::context, ast_channel::datastores, defaultlanguage, errno, EVENT_FLAG_CALL, ast_channel::exten, ast_channel::fds, ast_channel::fin, chanlist::flags, ast_channel::fout, language, ast_channel::lock_dont_use, LOG_WARNING, manager_event, ast_channel::name, name, null_tech, ast_channel::priority, S_OR, ast_channel::sched, sched_context_create(), sched_context_destroy(), ast_channel::streamid, ast_channel::tech, ast_channel::timer, ast_channel::timingfd, ast_channel::uniqueid, and ast_channel::varshead.

Referenced by __ast_channel_alloc(), and ast_channel_alloc().

{
   struct ast_channel *tmp;
   int x;
   int flags;
   struct varshead *headp;

   /* If shutting down, don't allocate any new channels */
   if (shutting_down) {
      ast_log(LOG_WARNING, "Channel allocation failed: Refusing due to active shutdown\n");
      return NULL;
   }

#if defined(__AST_DEBUG_MALLOC)
   if (!(tmp = __ast_calloc(1, sizeof(*tmp), file, line, function))) {
      return NULL;
   }
#else
   if (!(tmp = ast_calloc(1, sizeof(*tmp)))) {
      return NULL;
   }
#endif

   if (!(tmp->sched = sched_context_create())) {
      ast_log(LOG_WARNING, "Channel allocation failed: Unable to create schedule context\n");
      ast_free(tmp);
      return NULL;
   }
   
   if ((ast_string_field_init(tmp, 128))) {
      sched_context_destroy(tmp->sched);
      ast_free(tmp);
      return NULL;
   }

#ifdef HAVE_EPOLL
   tmp->epfd = epoll_create(25);
#endif

   for (x = 0; x < AST_MAX_FDS; x++) {
      tmp->fds[x] = -1;
#ifdef HAVE_EPOLL
      tmp->epfd_data[x] = NULL;
#endif
   }

   if ((tmp->timer = ast_timer_open())) {
      needqueue = 0;
      tmp->timingfd = ast_timer_fd(tmp->timer);
   } else {
      tmp->timingfd = -1;
   }

   if (needqueue) {
      if (pipe(tmp->alertpipe)) {
         ast_log(LOG_WARNING, "Channel allocation failed: Can't create alert pipe!\n");
alertpipe_failed:
         if (tmp->timer) {
            ast_timer_close(tmp->timer);
         }

         sched_context_destroy(tmp->sched);
         ast_string_field_free_memory(tmp);
         ast_free(tmp);
         return NULL;
      } else {
         flags = fcntl(tmp->alertpipe[0], F_GETFL);
         if (fcntl(tmp->alertpipe[0], F_SETFL, flags | O_NONBLOCK) < 0) {
            ast_log(LOG_WARNING, "Channel allocation failed: Unable to set alertpipe nonblocking! (%d: %s)\n", errno, strerror(errno));
            close(tmp->alertpipe[0]);
            close(tmp->alertpipe[1]);
            goto alertpipe_failed;
         }
         flags = fcntl(tmp->alertpipe[1], F_GETFL);
         if (fcntl(tmp->alertpipe[1], F_SETFL, flags | O_NONBLOCK) < 0) {
            ast_log(LOG_WARNING, "Channel allocation failed: Unable to set alertpipe nonblocking! (%d: %s)\n", errno, strerror(errno));
            close(tmp->alertpipe[0]);
            close(tmp->alertpipe[1]);
            goto alertpipe_failed;
         }
      }
   } else   /* Make sure we've got it done right if they don't */
      tmp->alertpipe[0] = tmp->alertpipe[1] = -1;

   /* Always watch the alertpipe */
   ast_channel_set_fd(tmp, AST_ALERT_FD, tmp->alertpipe[0]);
   /* And timing pipe */
   ast_channel_set_fd(tmp, AST_TIMING_FD, tmp->timingfd);
   ast_string_field_set(tmp, name, "**Unknown**");

   /* Initial state */
   tmp->_state = state;

   tmp->streamid = -1;
   
   tmp->fin = global_fin;
   tmp->fout = global_fout;

   if (ast_strlen_zero(ast_config_AST_SYSTEM_NAME)) {
      ast_string_field_build(tmp, uniqueid, "%li.%d", (long) time(NULL), 
                   ast_atomic_fetchadd_int(&uniqueint, 1));
   } else {
      ast_string_field_build(tmp, uniqueid, "%s-%li.%d", ast_config_AST_SYSTEM_NAME, 
                   (long) time(NULL), ast_atomic_fetchadd_int(&uniqueint, 1));
   }

   tmp->cid.cid_name = ast_strdup(cid_name);
   tmp->cid.cid_num = ast_strdup(cid_num);
   
   if (!ast_strlen_zero(name_fmt)) {
      /* Almost every channel is calling this function, and setting the name via the ast_string_field_build() call.
       * And they all use slightly different formats for their name string.
       * This means, to set the name here, we have to accept variable args, and call the string_field_build from here.
       * This means, that the stringfields must have a routine that takes the va_lists directly, and 
       * uses them to build the string, instead of forming the va_lists internally from the vararg ... list.
       * This new function was written so this can be accomplished.
       */
      ast_string_field_build_va(tmp, name, name_fmt, ap1, ap2);
   }

   /* Reminder for the future: under what conditions do we NOT want to track cdrs on channels? */

   /* These 4 variables need to be set up for the cdr_init() to work right */
   if (amaflag)
      tmp->amaflags = amaflag;
   else
      tmp->amaflags = ast_default_amaflags;
   
   if (!ast_strlen_zero(acctcode))
      ast_string_field_set(tmp, accountcode, acctcode);
   else
      ast_string_field_set(tmp, accountcode, ast_default_accountcode);
      
   if (!ast_strlen_zero(context))
      ast_copy_string(tmp->context, context, sizeof(tmp->context));
   else
      strcpy(tmp->context, "default");

   if (!ast_strlen_zero(exten))
      ast_copy_string(tmp->exten, exten, sizeof(tmp->exten));
   else
      strcpy(tmp->exten, "s");

   tmp->priority = 1;
      
   tmp->cdr = ast_cdr_alloc();
   ast_cdr_init(tmp->cdr, tmp);
   ast_cdr_start(tmp->cdr);
   
   headp = &tmp->varshead;
   AST_LIST_HEAD_INIT_NOLOCK(headp);
   
   ast_mutex_init(&tmp->lock_dont_use);
   
   AST_LIST_HEAD_INIT_NOLOCK(&tmp->datastores);
   
   ast_string_field_set(tmp, language, defaultlanguage);

   tmp->tech = &null_tech;

   ast_set_flag(tmp, AST_FLAG_IN_CHANNEL_LIST);

   AST_RWLIST_WRLOCK(&channels);
   AST_RWLIST_INSERT_HEAD(&channels, tmp, chan_list);
   AST_RWLIST_UNLOCK(&channels);

   /*\!note
    * and now, since the channel structure is built, and has its name, let's
    * call the manager event generator with this Newchannel event. This is the
    * proper and correct place to make this call, but you sure do have to pass
    * a lot of data into this func to do it here!
    */
   if (!ast_strlen_zero(name_fmt)) {
      manager_event(EVENT_FLAG_CALL, "Newchannel",
         "Channel: %s\r\n"
         "ChannelState: %d\r\n"
         "ChannelStateDesc: %s\r\n"
         "CallerIDNum: %s\r\n"
         "CallerIDName: %s\r\n"
         "AccountCode: %s\r\n"
         "Uniqueid: %s\r\n",
         tmp->name, 
         state, 
         ast_state2str(state),
         S_OR(cid_num, ""),
         S_OR(cid_name, ""),
         tmp->accountcode,
         tmp->uniqueid);
   }

   return tmp;
}

static int __ast_queue_frame	(	struct ast_channel *	chan,
		struct ast_frame *	fin,
		int	head,
		struct ast_frame *	after
	)			[static]

Definition at line 985 of file channel.c.

References ast_channel::alertpipe, ast_channel_lock, ast_channel_unlock, AST_CONTROL_HANGUP, AST_FLAG_BLOCKING, AST_FRAME_CONTROL, AST_FRAME_VOICE, ast_frdup(), ast_frfree, AST_LIST_APPEND_LIST, AST_LIST_FIRST, AST_LIST_HEAD_INIT_NOLOCK, AST_LIST_HEAD_NOLOCK, AST_LIST_INSERT_LIST_AFTER, AST_LIST_INSERT_TAIL, AST_LIST_LAST, AST_LIST_NEXT, AST_LIST_REMOVE_HEAD, AST_LIST_TRAVERSE, ast_log(), ast_test_flag, ast_timer_enable_continuous(), ast_channel::blocker, errno, f, ast_frame::frame_list, frames, ast_frame::frametype, LOG_WARNING, ast_channel::name, ast_channel::readq, ast_frame::subclass, ast_channel::timer, and ast_channel::timingfd.

Referenced by __ast_read(), ast_queue_frame(), and ast_queue_frame_head().

{
   struct ast_frame *f;
   struct ast_frame *cur;
   int blah = 1;
   unsigned int new_frames = 0;
   unsigned int new_voice_frames = 0;
   unsigned int queued_frames = 0;
   unsigned int queued_voice_frames = 0;
   AST_LIST_HEAD_NOLOCK(, ast_frame) frames;

   ast_channel_lock(chan);

   /* See if the last frame on the queue is a hangup, if so don't queue anything */
   if ((cur = AST_LIST_LAST(&chan->readq)) &&
       (cur->frametype == AST_FRAME_CONTROL) &&
       (cur->subclass == AST_CONTROL_HANGUP)) {
      ast_channel_unlock(chan);
      return 0;
   }

   /* Build copies of all the frames and count them */
   AST_LIST_HEAD_INIT_NOLOCK(&frames);
   for (cur = fin; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
      if (!(f = ast_frdup(cur))) {
         ast_frfree(AST_LIST_FIRST(&frames));
         return -1;
      }

      AST_LIST_INSERT_TAIL(&frames, f, frame_list);
      new_frames++;
      if (f->frametype == AST_FRAME_VOICE) {
         new_voice_frames++;
      }
   }

   /* Count how many frames exist on the queue */
   AST_LIST_TRAVERSE(&chan->readq, cur, frame_list) {
      queued_frames++;
      if (cur->frametype == AST_FRAME_VOICE) {
         queued_voice_frames++;
      }
   }

   if ((queued_frames + new_frames) > 128) {
      ast_log(LOG_WARNING, "Exceptionally long queue length queuing to %s\n", chan->name);
      while ((f = AST_LIST_REMOVE_HEAD(&frames, frame_list))) {
         ast_frfree(f);
      }
      ast_channel_unlock(chan);
      return 0;
   }

   if ((queued_voice_frames + new_voice_frames) > 96) {
      ast_log(LOG_WARNING, "Exceptionally long voice queue length queuing to %s\n", chan->name);
      while ((f = AST_LIST_REMOVE_HEAD(&frames, frame_list))) {
         ast_frfree(f);
      }
      ast_channel_unlock(chan);
      return 0;
   }

   if (after) {
      AST_LIST_INSERT_LIST_AFTER(&chan->readq, &frames, after, frame_list);
   } else {
      if (head) {
         AST_LIST_APPEND_LIST(&frames, &chan->readq, frame_list);
         AST_LIST_HEAD_INIT_NOLOCK(&chan->readq);
      }
      AST_LIST_APPEND_LIST(&chan->readq, &frames, frame_list);
   }

   if (chan->alertpipe[1] > -1) {
      if (write(chan->alertpipe[1], &blah, new_frames * sizeof(blah)) != (new_frames * sizeof(blah))) {
         ast_log(LOG_WARNING, "Unable to write to alert pipe on %s (qlen = %d): %s!\n",
            chan->name, queued_frames, strerror(errno));
      }
   } else if (chan->timingfd > -1) {
      ast_timer_enable_continuous(chan->timer);
   } else if (ast_test_flag(chan, AST_FLAG_BLOCKING)) {
      pthread_kill(chan->blocker, SIGURG);
   }

   ast_channel_unlock(chan);

   return 0;
}

static struct ast_frame* __ast_read	(	struct ast_channel *	chan,
		int	dropaudio
	)			[static, read]

Todo:

XXX It is possible to write a digit to the audiohook twice if the digit was originally read while the channel was in autoservice.

Definition at line 2565 of file channel.c.

References __ast_queue_frame(), ast_channel::_softhangup, ast_channel::_state, ast_channel::alertpipe, AST_AUDIOHOOK_DIRECTION_READ, ast_audiohook_write_list(), ast_channel_trylock, ast_channel_unlock, ast_check_hangup(), ast_clear_flag, AST_CONTROL_ANSWER, AST_CONTROL_HANGUP, ast_deactivate_generator(), ast_debug, AST_DEFAULT_EMULATE_DTMF_DURATION, ast_do_masquerade(), AST_FLAG_DEFER_DTMF, AST_FLAG_EMULATE_DTMF, AST_FLAG_END_DTMF_ONLY, AST_FLAG_EXCEPTION, AST_FLAG_IN_DTMF, AST_FLAG_OUTGOING, AST_FLAG_ZOMBIE, AST_FRAME_CONTROL, AST_FRAME_DTMF_BEGIN, AST_FRAME_DTMF_END, ast_frame_dump(), AST_FRAME_NULL, AST_FRAME_VOICE, ast_frfree, AST_GENERATOR_FD, ast_getformatname(), ast_getformatname_multiple(), AST_LIST_EMPTY, AST_LIST_FIRST, AST_LIST_LAST, AST_LIST_NEXT, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_log(), AST_MIN_DTMF_DURATION, AST_MIN_DTMF_GAP, AST_MONITOR_RUNNING, ast_null_frame, ast_queue_frame(), ast_queue_frame_head(), ast_read_generator_actions(), ast_seekstream(), ast_set_flag, ast_setstate(), AST_SOFTHANGUP_DEV, AST_STATE_UP, ast_test_flag, ast_timer_ack(), ast_timer_disable_continuous(), ast_timer_get_event(), ast_timer_set_rate(), AST_TIMING_EVENT_CONTINUOUS, AST_TIMING_EVENT_EXPIRED, AST_TIMING_FD, ast_translate(), ast_tvdiff_ms(), ast_tvnow(), ast_tvzero(), ast_writestream(), ast_channel::audiohooks, ast_channel::blocker, ast_frame::data, DEBUGCHAN_FLAG, ast_generator::digit, ast_channel::dtmf_tv, ast_channel::dtmff, ast_channel::emulate_dtmf_digit, ast_channel::emulate_dtmf_duration, errno, ast_channel_tech::exception, f, ast_channel::fdno, ast_channel::fds, ast_channel::fin, chanlist::flags, ast_frame::frame_list, FRAMECOUNT_INC, ast_frame::frametype, ast_generator::generate, ast_channel::generator, ast_channel::generatordata, ast_channel::hangupcause, ast_channel::insmpl, ast_frame::len, LOG_DTMF, LOG_ERROR, LOG_NOTICE, LOG_WARNING, ast_channel::masq, ast_channel::monitor, ast_channel::music_state, ast_channel::name, ast_channel::nativeformats, ast_channel::outsmpl, queue_dtmf_readq(), ast_channel_tech::read, ast_channel_monitor::read_stream, ast_channel::readq, ast_channel::readtrans, ast_frame::samples, SEEK_FORCECUR, send_dtmf_event(), should_skip_dtmf(), ast_channel_monitor::state, ast_frame::subclass, ast_channel::tech, ast_channel::timer, ast_channel::timingdata, ast_channel::timingfd, ast_channel::timingfunc, and ast_frame::uint32.

Referenced by ast_read(), and ast_read_noaudio().

{
   struct ast_frame *f = NULL;   /* the return value */
   int blah;
   int prestate;
   int count = 0, cause = 0;

   /* this function is very long so make sure there is only one return
    * point at the end (there are only two exceptions to this).
    */
   while(ast_channel_trylock(chan)) {
      if(count++ > 10) 
         /*cannot goto done since the channel is not locked*/
         return &ast_null_frame;
      usleep(1);
   }

   if (chan->masq) {
      if (ast_do_masquerade(chan))
         ast_log(LOG_WARNING, "Failed to perform masquerade\n");
      else
         f =  &ast_null_frame;
      goto done;
   }

   /* Stop if we're a zombie or need a soft hangup */
   if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
      if (chan->generator)
         ast_deactivate_generator(chan);
      goto done;
   }

#ifdef AST_DEVMODE
   /* 
    * The ast_waitfor() code records which of the channel's file descriptors reported that
    * data is available.  In theory, ast_read() should only be called after ast_waitfor()
    * reports that a channel has data available for reading.  However, there still may be
    * some edge cases throughout the code where ast_read() is called improperly.  This can
    * potentially cause problems, so if this is a developer build, make a lot of noise if
    * this happens so that it can be addressed. 
    */
   if (chan->fdno == -1) {
      ast_log(LOG_ERROR, "ast_read() called with no recorded file descriptor.\n");
   }
#endif

   prestate = chan->_state;

   /* Read and ignore anything on the alertpipe, but read only
      one sizeof(blah) per frame that we send from it */
   if (chan->alertpipe[0] > -1) {
      int flags = fcntl(chan->alertpipe[0], F_GETFL);
      /* For some odd reason, the alertpipe occasionally loses nonblocking status,
       * which immediately causes a deadlock scenario.  Detect and prevent this. */
      if ((flags & O_NONBLOCK) == 0) {
         ast_log(LOG_ERROR, "Alertpipe on channel %s lost O_NONBLOCK?!!\n", chan->name);
         if (fcntl(chan->alertpipe[0], F_SETFL, flags | O_NONBLOCK) < 0) {
            ast_log(LOG_WARNING, "Unable to set alertpipe nonblocking! (%d: %s)\n", errno, strerror(errno));
            f = &ast_null_frame;
            goto done;
         }
      }
      if (read(chan->alertpipe[0], &blah, sizeof(blah)) < 0) {
         if (errno != EINTR && errno != EAGAIN)
            ast_log(LOG_WARNING, "read() failed: %s\n", strerror(errno));
      }
   }

   if (chan->timingfd > -1 && chan->fdno == AST_TIMING_FD) {
      enum ast_timer_event res;

      ast_clear_flag(chan, AST_FLAG_EXCEPTION);

      res = ast_timer_get_event(chan->timer);

      switch (res) {
      case AST_TIMING_EVENT_EXPIRED:
         ast_timer_ack(chan->timer, 1);

         if (chan->timingfunc) {
            /* save a copy of func/data before unlocking the channel */
            int (*func)(const void *) = chan->timingfunc;
            void *data = chan->timingdata;
            chan->fdno = -1;
            ast_channel_unlock(chan);
            func(data);
         } else {
            ast_timer_set_rate(chan->timer, 0);
            chan->fdno = -1;
            ast_channel_unlock(chan);
         }

         /* cannot 'goto done' because the channel is already unlocked */
         return &ast_null_frame;

      case AST_TIMING_EVENT_CONTINUOUS:
         if (AST_LIST_EMPTY(&chan->readq) || 
            !AST_LIST_NEXT(AST_LIST_FIRST(&chan->readq), frame_list)) {
            ast_timer_disable_continuous(chan->timer);
         }
         break;
      }

   } else if (chan->fds[AST_GENERATOR_FD] > -1 && chan->fdno == AST_GENERATOR_FD) {
      /* if the AST_GENERATOR_FD is set, call the generator with args
       * set to -1 so it can do whatever it needs to.
       */
      void *tmp = chan->generatordata;
      chan->generatordata = NULL;     /* reset to let ast_write get through */
      chan->generator->generate(chan, tmp, -1, -1);
      chan->generatordata = tmp;
      f = &ast_null_frame;
      chan->fdno = -1;
      goto done;
   }

   /* Check for pending read queue */
   if (!AST_LIST_EMPTY(&chan->readq)) {
      int skip_dtmf = should_skip_dtmf(chan);

      AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->readq, f, frame_list) {
         /* We have to be picky about which frame we pull off of the readq because
          * there are cases where we want to leave DTMF frames on the queue until
          * some later time. */

         if ( (f->frametype == AST_FRAME_DTMF_BEGIN || f->frametype == AST_FRAME_DTMF_END) && skip_dtmf) {
            continue;
         }

         AST_LIST_REMOVE_CURRENT(frame_list);
         break;
      }
      AST_LIST_TRAVERSE_SAFE_END;
      
      if (!f) {
         /* There were no acceptable frames on the readq. */
         f = &ast_null_frame;
         if (chan->alertpipe[0] > -1) {
            int poke = 0;
            /* Restore the state of the alertpipe since we aren't ready for any
             * of the frames in the readq. */
            if (write(chan->alertpipe[1], &poke, sizeof(poke)) != sizeof(poke)) {
               ast_log(LOG_ERROR, "Failed to write to alertpipe: %s\n", strerror(errno));
            }
         }
      }

      /* Interpret hangup and return NULL */
      /* XXX why not the same for frames from the channel ? */
      if (f->frametype == AST_FRAME_CONTROL && f->subclass == AST_CONTROL_HANGUP) {
         cause = f->data.uint32;
         ast_frfree(f);
         f = NULL;
      }
   } else {
      chan->blocker = pthread_self();
      if (ast_test_flag(chan, AST_FLAG_EXCEPTION)) {
         if (chan->tech->exception)
            f = chan->tech->exception(chan);
         else {
            ast_log(LOG_WARNING, "Exception flag set on '%s', but no exception handler\n", chan->name);
            f = &ast_null_frame;
         }
         /* Clear the exception flag */
         ast_clear_flag(chan, AST_FLAG_EXCEPTION);
      } else if (chan->tech->read)
         f = chan->tech->read(chan);
      else
         ast_log(LOG_WARNING, "No read routine on channel %s\n", chan->name);
   }

   /*
    * Reset the recorded file descriptor that triggered this read so that we can
    * easily detect when ast_read() is called without properly using ast_waitfor().
    */
   chan->fdno = -1;

   if (f) {
      struct ast_frame *readq_tail = AST_LIST_LAST(&chan->readq);

      /* if the channel driver returned more than one frame, stuff the excess
         into the readq for the next ast_read call
      */
      if (AST_LIST_NEXT(f, frame_list)) {
         ast_queue_frame(chan, AST_LIST_NEXT(f, frame_list));
         ast_frfree(AST_LIST_NEXT(f, frame_list));
         AST_LIST_NEXT(f, frame_list) = NULL;
      }

      switch (f->frametype) {
      case AST_FRAME_CONTROL:
         if (f->subclass == AST_CONTROL_ANSWER) {
            if (!ast_test_flag(chan, AST_FLAG_OUTGOING)) {
               ast_debug(1, "Ignoring answer on an inbound call!\n");
               ast_frfree(f);
               f = &ast_null_frame;
            } else if (prestate == AST_STATE_UP) {
               ast_debug(1, "Dropping duplicate answer!\n");
               ast_frfree(f);
               f = &ast_null_frame;
            } else {
               /* Answer the CDR */
               ast_setstate(chan, AST_STATE_UP);
               /* removed a call to ast_cdr_answer(chan->cdr) from here. */
            }
         }
         break;
      case AST_FRAME_DTMF_END:
         send_dtmf_event(chan, "Received", f->subclass, "No", "Yes");
         ast_log(LOG_DTMF, "DTMF end '%c' received on %s, duration %ld ms\n", f->subclass, chan->name, f->len);
         /* Queue it up if DTMF is deferred, or if DTMF emulation is forced. */
         if (ast_test_flag(chan, AST_FLAG_DEFER_DTMF) || ast_test_flag(chan, AST_FLAG_EMULATE_DTMF)) {
            queue_dtmf_readq(chan, f);
            ast_frfree(f);
            f = &ast_null_frame;
         } else if (!ast_test_flag(chan, AST_FLAG_IN_DTMF | AST_FLAG_END_DTMF_ONLY)) {
            if (!ast_tvzero(chan->dtmf_tv) && 
                ast_tvdiff_ms(ast_tvnow(), chan->dtmf_tv) < AST_MIN_DTMF_GAP) {
               /* If it hasn't been long enough, defer this digit */
               queue_dtmf_readq(chan, f);
               ast_frfree(f);
               f = &ast_null_frame;
            } else {
               /* There was no begin, turn this into a begin and send the end later */
               f->frametype = AST_FRAME_DTMF_BEGIN;
               ast_set_flag(chan, AST_FLAG_EMULATE_DTMF);
               chan->emulate_dtmf_digit = f->subclass;
               chan->dtmf_tv = ast_tvnow();
               if (f->len) {
                  if (f->len > AST_MIN_DTMF_DURATION)
                     chan->emulate_dtmf_duration = f->len;
                  else 
                     chan->emulate_dtmf_duration = AST_MIN_DTMF_DURATION;
               } else
                  chan->emulate_dtmf_duration = AST_DEFAULT_EMULATE_DTMF_DURATION;
               ast_log(LOG_DTMF, "DTMF begin emulation of '%c' with duration %u queued on %s\n", f->subclass, chan->emulate_dtmf_duration, chan->name);
            }
            if (chan->audiohooks) {
               struct ast_frame *old_frame = f;
               /*!
                * \todo XXX It is possible to write a digit to the audiohook twice
                * if the digit was originally read while the channel was in autoservice. */
               f = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_READ, f);
               if (old_frame != f)
                  ast_frfree(old_frame);
            }
         } else {
            struct timeval now = ast_tvnow();
            if (ast_test_flag(chan, AST_FLAG_IN_DTMF)) {
               ast_log(LOG_DTMF, "DTMF end accepted with begin '%c' on %s\n", f->subclass, chan->name);
               ast_clear_flag(chan, AST_FLAG_IN_DTMF);
               if (!f->len)
                  f->len = ast_tvdiff_ms(now, chan->dtmf_tv);
            } else if (!f->len) {
               ast_log(LOG_DTMF, "DTMF end accepted without begin '%c' on %s\n", f->subclass, chan->name);
               f->len = AST_MIN_DTMF_DURATION;
            }
            if (f->len < AST_MIN_DTMF_DURATION && !ast_test_flag(chan, AST_FLAG_END_DTMF_ONLY)) {
               ast_log(LOG_DTMF, "DTMF end '%c' has duration %ld but want minimum %d, emulating on %s\n", f->subclass, f->len, AST_MIN_DTMF_DURATION, chan->name);
               ast_set_flag(chan, AST_FLAG_EMULATE_DTMF);
               chan->emulate_dtmf_digit = f->subclass;
               chan->emulate_dtmf_duration = AST_MIN_DTMF_DURATION - f->len;
               ast_frfree(f);
               f = &ast_null_frame;
            } else {
               ast_log(LOG_DTMF, "DTMF end passthrough '%c' on %s\n", f->subclass, chan->name);
               if (f->len < AST_MIN_DTMF_DURATION) {
                  f->len = AST_MIN_DTMF_DURATION;
               }
               chan->dtmf_tv = now;
            }
            if (chan->audiohooks) {
               struct ast_frame *old_frame = f;
               f = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_READ, f);
               if (old_frame != f)
                  ast_frfree(old_frame);
            }
         }
         break;
      case AST_FRAME_DTMF_BEGIN:
         send_dtmf_event(chan, "Received", f->subclass, "Yes", "No");
         ast_log(LOG_DTMF, "DTMF begin '%c' received on %s\n", f->subclass, chan->name);
         if ( ast_test_flag(chan, AST_FLAG_DEFER_DTMF | AST_FLAG_END_DTMF_ONLY | AST_FLAG_EMULATE_DTMF) || 
             (!ast_tvzero(chan->dtmf_tv) && 
               ast_tvdiff_ms(ast_tvnow(), chan->dtmf_tv) < AST_MIN_DTMF_GAP) ) {
            ast_log(LOG_DTMF, "DTMF begin ignored '%c' on %s\n", f->subclass, chan->name);
            ast_frfree(f);
            f = &ast_null_frame;
         } else {
            ast_set_flag(chan, AST_FLAG_IN_DTMF);
            chan->dtmf_tv = ast_tvnow();
            ast_log(LOG_DTMF, "DTMF begin passthrough '%c' on %s\n", f->subclass, chan->name);
         }
         break;
      case AST_FRAME_NULL:
         /* The EMULATE_DTMF flag must be cleared here as opposed to when the duration
          * is reached , because we want to make sure we pass at least one
          * voice frame through before starting the next digit, to ensure a gap
          * between DTMF digits. */
         if (ast_test_flag(chan, AST_FLAG_EMULATE_DTMF)) {
            struct timeval now = ast_tvnow();
            if (!chan->emulate_dtmf_duration) {
               ast_clear_flag(chan, AST_FLAG_EMULATE_DTMF);
               chan->emulate_dtmf_digit = 0;
            } else if (ast_tvdiff_ms(now, chan->dtmf_tv) >= chan->emulate_dtmf_duration) {
               chan->emulate_dtmf_duration = 0;
               ast_frfree(f);
               f = &chan->dtmff;
               f->frametype = AST_FRAME_DTMF_END;
               f->subclass = chan->emulate_dtmf_digit;
               f->len = ast_tvdiff_ms(now, chan->dtmf_tv);
               chan->dtmf_tv = now;
               ast_clear_flag(chan, AST_FLAG_EMULATE_DTMF);
               chan->emulate_dtmf_digit = 0;
               ast_log(LOG_DTMF, "DTMF end emulation of '%c' queued on %s\n", f->subclass, chan->name);
               if (chan->audiohooks) {
                  struct ast_frame *old_frame = f;
                  f = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_READ, f);
                  if (old_frame != f) {
                     ast_frfree(old_frame);
                  }
               }
            }
         }
         break;
      case AST_FRAME_VOICE:
         /* The EMULATE_DTMF flag must be cleared here as opposed to when the duration
          * is reached , because we want to make sure we pass at least one
          * voice frame through before starting the next digit, to ensure a gap
          * between DTMF digits. */
         if (ast_test_flag(chan, AST_FLAG_EMULATE_DTMF) && !chan->emulate_dtmf_duration) {
            ast_clear_flag(chan, AST_FLAG_EMULATE_DTMF);
            chan->emulate_dtmf_digit = 0;
         }

         if (dropaudio || ast_test_flag(chan, AST_FLAG_IN_DTMF)) {
            if (dropaudio)
               ast_read_generator_actions(chan, f);
            ast_frfree(f);
            f = &ast_null_frame;
         }

         if (ast_test_flag(chan, AST_FLAG_EMULATE_DTMF) && !ast_test_flag(chan, AST_FLAG_IN_DTMF)) {
            struct timeval now = ast_tvnow();
            if (ast_tvdiff_ms(now, chan->dtmf_tv) >= chan->emulate_dtmf_duration) {
               chan->emulate_dtmf_duration = 0;
               ast_frfree(f);
               f = &chan->dtmff;
               f->frametype = AST_FRAME_DTMF_END;
               f->subclass = chan->emulate_dtmf_digit;
               f->len = ast_tvdiff_ms(now, chan->dtmf_tv);
               chan->dtmf_tv = now;
               if (chan->audiohooks) {
                  struct ast_frame *old_frame = f;
                  f = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_READ, f);
                  if (old_frame != f)
                     ast_frfree(old_frame);
               }
               ast_log(LOG_DTMF, "DTMF end emulation of '%c' queued on %s\n", f->subclass, chan->name);
            } else {
               /* Drop voice frames while we're still in the middle of the digit */
               ast_frfree(f);
               f = &ast_null_frame;
            }
         } else if ((f->frametype == AST_FRAME_VOICE) && !(f->subclass & chan->nativeformats)) {
            /* This frame is not one of the current native formats -- drop it on the floor */
            char to[200];
            ast_log(LOG_NOTICE, "Dropping incompatible voice frame on %s of format %s since our native format has changed to %s\n",
               chan->name, ast_getformatname(f->subclass), ast_getformatname_multiple(to, sizeof(to), chan->nativeformats));
            ast_frfree(f);
            f = &ast_null_frame;
         } else if ((f->frametype == AST_FRAME_VOICE)) {
            /* Send frame to audiohooks if present */
            if (chan->audiohooks) {
               struct ast_frame *old_frame = f;
               f = ast_audiohook_write_list(chan, chan->audiohooks, AST_AUDIOHOOK_DIRECTION_READ, f);
               if (old_frame != f)
                  ast_frfree(old_frame);
            }
            if (chan->monitor && chan->monitor->read_stream ) {
               /* XXX what does this do ? */
#ifndef MONITOR_CONSTANT_DELAY
               int jump = chan->outsmpl - chan->insmpl - 4 * f->samples;
               if (jump >= 0) {
                  jump = chan->outsmpl - chan->insmpl;
                  if (ast_seekstream(chan->monitor->read_stream, jump, SEEK_FORCECUR) == -1)
                     ast_log(LOG_WARNING, "Failed to perform seek in monitoring read stream, synchronization between the files may be broken\n");
                  chan->insmpl += jump + f->samples;
               } else
                  chan->insmpl+= f->samples;
#else
               int jump = chan->outsmpl - chan->insmpl;
               if (jump - MONITOR_DELAY >= 0) {
                  if (ast_seekstream(chan->monitor->read_stream, jump - f->samples, SEEK_FORCECUR) == -1)
                     ast_log(LOG_WARNING, "Failed to perform seek in monitoring read stream, synchronization between the files may be broken\n");
                  chan->insmpl += jump;
               } else
                  chan->insmpl += f->samples;
#endif
               if (chan->monitor->state == AST_MONITOR_RUNNING) {
                  if (ast_writestream(chan->monitor->read_stream, f) < 0)
                     ast_log(LOG_WARNING, "Failed to write data to channel monitor read stream\n");
               }
            }

            if (chan->readtrans && (f = ast_translate(chan->readtrans, f, 1)) == NULL) {
               f = &ast_null_frame;
            }

            /* it is possible for the translation process on chan->readtrans to have
               produced multiple frames from the single input frame we passed it; if
               this happens, queue the additional frames *before* the frames we may
               have queued earlier. if the readq was empty, put them at the head of
               the queue, and if it was not, put them just after the frame that was
               at the end of the queue.
            */
            if (AST_LIST_NEXT(f, frame_list)) {
               if (!readq_tail) {
                  ast_queue_frame_head(chan, AST_LIST_NEXT(f, frame_list));
               } else {
                  __ast_queue_frame(chan, AST_LIST_NEXT(f, frame_list), 0, readq_tail);
               }
               ast_frfree(AST_LIST_NEXT(f, frame_list));
               AST_LIST_NEXT(f, frame_list) = NULL;
            }

            /* Run generator sitting on the line if timing device not available
            * and synchronous generation of outgoing frames is necessary       */
            ast_read_generator_actions(chan, f);
         }
      default:
         /* Just pass it on! */
         break;
      }
   } else {
      /* Make sure we always return NULL in the future */
      chan->_softhangup |= AST_SOFTHANGUP_DEV;
      if (cause)
         chan->hangupcause = cause;
      if (chan->generator)
         ast_deactivate_generator(chan);
      /* We no longer End the CDR here */
   }

   /* High bit prints debugging */
   if (chan->fin & DEBUGCHAN_FLAG)
      ast_frame_dump(chan->name, f, "<<");
   chan->fin = FRAMECOUNT_INC(chan->fin);

done:
   if (chan->music_state && chan->generator && chan->generator->digit && f && f->frametype == AST_FRAME_DTMF_END)
      chan->generator->digit(chan, f->subclass);

   ast_channel_unlock(chan);
   return f;
}

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

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

Parameters:

	type	type of channel to request
	format	requested channel format
	data	data to pass to the channel requester
	timeout	maximum amount of time to wait for an answer
	reason	why unsuccessful (if unsuccessful)
	cid_num	Caller-ID Number
	cid_name	Caller-ID Name (ascii)
	oh	Outgoing helper

Returns:

Returns an ast_channel on success or no answer, NULL on failure. Check the value of chan->_state to know if the call was answered or not.

Definition at line 3771 of file channel.c.

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

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

{
   int dummy_outstate;
   int cause = 0;
   struct ast_channel *chan;
   int res = 0;
   int last_subclass = 0;
   
   if (outstate)
      *outstate = 0;
   else
      outstate = &dummy_outstate;   /* make outstate always a valid pointer */

   chan = ast_request(type, format, data, &cause);
   if (!chan) {
      ast_log(LOG_NOTICE, "Unable to request channel %s/%s\n", type, (char *)data);
      handle_cause(cause, outstate);
      return NULL;
   }

   if (oh) {
      if (oh->vars)  
         ast_set_variables(chan, oh->vars);
      /* XXX why is this necessary, for the parent_channel perhaps ? */
      if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name))
         ast_set_callerid(chan, oh->cid_num, oh->cid_name, oh->cid_num);
      if (oh->parent_channel) {
         ast_channel_inherit_variables(oh->parent_channel, chan);
         ast_channel_datastore_inherit(oh->parent_channel, chan);
      }
      if (oh->account)
         ast_cdr_setaccount(chan, oh->account); 
   }
   ast_set_callerid(chan, cid_num, cid_name, cid_num);
   ast_set_flag(chan->cdr, AST_CDR_FLAG_ORIGINATED);

   if (ast_call(chan, data, 0)) {   /* ast_call failed... */
      ast_log(LOG_NOTICE, "Unable to call channel %s/%s\n", type, (char *)data);
   } else {
      res = 1; /* mark success in case chan->_state is already AST_STATE_UP */
      while (timeout && chan->_state != AST_STATE_UP) {
         struct ast_frame *f;
         res = ast_waitfor(chan, timeout);
         if (res == 0) { /* timeout, treat it like ringing */
            *outstate = AST_CONTROL_RINGING;
            break;
         }
         if (res < 0) /* error or done */
            break;
         if (timeout > -1)
            timeout = res;
         if (!ast_strlen_zero(chan->call_forward)) {
            if (!(chan = ast_call_forward(NULL, chan, &timeout, format, oh, outstate))) {
               return NULL;
            }
            continue;
         }

         f = ast_read(chan);
         if (!f) {
            *outstate = AST_CONTROL_HANGUP;
            res = 0;
            break;
         }
         if (f->frametype == AST_FRAME_CONTROL) {
            switch (f->subclass) {
            case AST_CONTROL_RINGING:  /* record but keep going */
               *outstate = f->subclass;
               break;

            case AST_CONTROL_BUSY:
            case AST_CONTROL_CONGESTION:
            case AST_CONTROL_ANSWER:
               *outstate = f->subclass;
               timeout = 0;      /* trick to force exit from the while() */
               break;

            /* Ignore these */
            case AST_CONTROL_PROGRESS:
            case AST_CONTROL_PROCEEDING:
            case AST_CONTROL_HOLD:
            case AST_CONTROL_UNHOLD:
            case AST_CONTROL_VIDUPDATE:
            case AST_CONTROL_SRCUPDATE:
            case -1:       /* Ignore -- just stopping indications */
               break;

            default:
               ast_log(LOG_NOTICE, "Don't know what to do with control frame %d\n", f->subclass);
            }
            last_subclass = f->subclass;
         }
         ast_frfree(f);
      }
   }

   /* Final fixups */
   if (oh) {
      if (!ast_strlen_zero(oh->context))
         ast_copy_string(chan->context, oh->context, sizeof(chan->context));
      if (!ast_strlen_zero(oh->exten))
         ast_copy_string(chan->exten, oh->exten, sizeof(chan->exten));
      if (oh->priority) 
         chan->priority = oh->priority;
   }
   if (chan->_state == AST_STATE_UP)
      *outstate = AST_CONTROL_ANSWER;

   if (res <= 0) {
      if ( AST_CONTROL_RINGING == last_subclass ) 
         chan->hangupcause = AST_CAUSE_NO_ANSWER;
      if (!chan->cdr && (chan->cdr = ast_cdr_alloc()))
         ast_cdr_init(chan->cdr, chan);
      if (chan->cdr) {
         char tmp[256];
         snprintf(tmp, sizeof(tmp), "%s/%s", type, (char *)data);
         ast_cdr_setapp(chan->cdr,"Dial",tmp);
         ast_cdr_update(chan);
         ast_cdr_start(chan->cdr);
         ast_cdr_end(chan->cdr);
         /* If the cause wasn't handled properly */
         if (ast_cdr_disposition(chan->cdr,chan->hangupcause))
            ast_cdr_failed(chan->cdr);
      }
      ast_hangup(chan);
      chan = NULL;
   }
   return chan;
}

static void __fini_channels

(

void

)

[static]

Definition at line 128 of file channel.c.

{

static void __init_channels

(

void

)

[static]

Definition at line 128 of file channel.c.

{

static void __init_state2str_threadbuf

(

void

)

[static]

Definition at line 87 of file channel.c.

{

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

Activate a given generator

Definition at line 1952 of file channel.c.

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

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

{
   int res = 0;

   ast_channel_lock(chan);

   if (chan->generatordata) {
      if (chan->generator && chan->generator->release)
         chan->generator->release(chan, chan->generatordata);
      chan->generatordata = NULL;
   }

   ast_prod(chan);
   if (gen->alloc && !(chan->generatordata = gen->alloc(chan, params))) {
      res = -1;
   }
   
   if (!res) {
      ast_settimeout(chan, 50, generator_force, chan);
      chan->generator = gen;
   }

   ast_channel_unlock(chan);

   return res;
}

int ast_active_channels

(

void

)

returns number of active/allocated channels

Returns number of active/allocated channels

Definition at line 497 of file channel.c.

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, and AST_RWLIST_UNLOCK.

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

{
   struct ast_channel *c;
   int cnt = 0;
   AST_RWLIST_RDLOCK(&channels);
   AST_RWLIST_TRAVERSE(&channels, c, chan_list)
      cnt++;
   AST_RWLIST_UNLOCK(&channels);
   return cnt;
}

int ast_answer

(

struct ast_channel *

chan

)

Answer a channel.

Parameters:

chan

channel to answer

This function answers a channel and handles all necessary call setup functions.

Note:

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

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

Return values:

	0	on success
	non-zero	on failure

Definition at line 1902 of file channel.c.

References __ast_answer().

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

{
   return __ast_answer(chan, 0, 1);
}

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

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

Referenced by quit_handler().

{
   struct ast_channel *c;
   shutting_down = 1;
   if (hangup) {
      AST_RWLIST_RDLOCK(&channels);
      AST_RWLIST_TRAVERSE(&channels, c, chan_list) {
         ast_softhangup(c, AST_SOFTHANGUP_SHUTDOWN);
      }
      AST_RWLIST_UNLOCK(&channels);
   }
}

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

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

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

{
   /* This just our opinion, expressed in code.  We are asked to choose
      the best codec to use, given no information */
   int x;
   static const int prefs[] =
   {
      /*! Okay, ulaw is used by all telephony equipment, so start with it */
      AST_FORMAT_ULAW,
      /*! Unless of course, you're a silly European, so then prefer ALAW */
      AST_FORMAT_ALAW,
      /*! G.722 is better then all below, but not as common as the above... so give ulaw and alaw priority */
      AST_FORMAT_G722,
      /*! Okay, well, signed linear is easy to translate into other stuff */
      AST_FORMAT_SLINEAR16,
      AST_FORMAT_SLINEAR,
      /*! G.726 is standard ADPCM, in RFC3551 packing order */
      AST_FORMAT_G726,
      /*! G.726 is standard ADPCM, in AAL2 packing order */
      AST_FORMAT_G726_AAL2,
      /*! ADPCM has great sound quality and is still pretty easy to translate */
      AST_FORMAT_ADPCM,
      /*! Okay, we're down to vocoders now, so pick GSM because it's small and easier to
          translate and sounds pretty good */
      AST_FORMAT_GSM,
      /*! iLBC is not too bad */
      AST_FORMAT_ILBC,
      /*! Speex is free, but computationally more expensive than GSM */
      AST_FORMAT_SPEEX,
      /*! Ick, LPC10 sounds terrible, but at least we have code for it, if you're tacky enough
          to use it */
      AST_FORMAT_LPC10,
      /*! G.729a is faster than 723 and slightly less expensive */
      AST_FORMAT_G729A,
      /*! Down to G.723.1 which is proprietary but at least designed for voice */
      AST_FORMAT_G723_1,
   };

   /* Strip out video */
   fmts &= AST_FORMAT_AUDIO_MASK;
   
   /* Find the first preferred codec in the format given */
   for (x = 0; x < ARRAY_LEN(prefs); x++) {
      if (fmts & prefs[x])
         return prefs[x];
   }

   ast_log(LOG_WARNING, "Don't know any of 0x%x formats\n", fmts);

   return 0;
}

struct ast_channel* ast_bridged_channel

(

struct ast_channel *

chan

)

[read]

Find bridged channel.

Parameters:

chan

Current channel

Definition at line 4651 of file channel.c.

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

Referenced by __dahdi_exception(), action_agents(), action_coreshowchannels(), agents_show(), agents_show_online(), ast_bridge_call(), ast_channel_masquerade(), ast_park_call_full(), ast_rtp_set_vars(), attempt_transfer(), cb_events(), channel_spy(), check_bridge(), common_exec(), console_transfer(), create_jb(), dahdi_handle_event(), dahdi_hangup(), export_aoc_vars(), get_refer_info(), handle_chanlist(), handle_hd_hf(), handle_invite_replaces(), handle_request(), handle_request_bye(), handle_request_info(), handle_request_refer(), handle_showchan(), handle_soft_key_event_message(), handle_stimulus_message(), key_call(), key_dial_page(), local_attended_transfer(), mgcp_hangup(), mgcp_ss(), misdn_attempt_transfer(), mixmonitor_thread(), schedule_delivery(), sip_hangup(), sip_read(), sip_set_rtp_peer(), skinny_transfer(), socket_process(), ss_thread(), start_spying(), startmon(), TransferCallStep1(), and unistim_hangup().

{
   struct ast_channel *bridged;
   bridged = chan->_bridge;
   if (bridged && bridged->tech->bridged_channel)
      bridged = bridged->tech->bridged_channel(chan, bridged);
   return bridged;
}

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

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

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

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

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

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

Parameters:

	caller	in channel that requested orig
	orig	channel being replaced by the call forward channel
	timeout	maximum amount of time to wait for setup of new forward channel
	format	requested channel format
	oh	outgoing helper used with original channel
	outstate	reason why unsuccessful (if uncuccessful)

Returns:

Returns the forwarded call's ast_channel on success or NULL on failure

Definition at line 3699 of file channel.c.

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

Referenced by __ast_request_and_dial(), and ast_feature_request_and_dial().

{
   char tmpchan[256];
   struct ast_channel *new = NULL;
   char *data, *type;
   int cause = 0;

   /* gather data and request the new forward channel */
   ast_copy_string(tmpchan, orig->call_forward, sizeof(tmpchan));
   if ((data = strchr(tmpchan, '/'))) {
      *data++ = '\0';
      type = tmpchan;
   } else {
      const char *forward_context;
      ast_channel_lock(orig);
      forward_context = pbx_builtin_getvar_helper(orig, "FORWARD_CONTEXT");
      snprintf(tmpchan, sizeof(tmpchan), "%s@%s", orig->call_forward, S_OR(forward_context, orig->context));
      ast_channel_unlock(orig);
      data = tmpchan;
      type = "Local";
   }
   if (!(new = ast_request(type, format, data, &cause))) {
      ast_log(LOG_NOTICE, "Unable to create channel for call forward to '%s/%s' (cause = %d)\n", type, data, cause);
      handle_cause(cause, outstate);
      ast_hangup(orig);
      return NULL;
   }

   /* Copy/inherit important information into new channel */
   if (oh) {
      if (oh->vars) {
         ast_set_variables(new, oh->vars);
      }
      if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name)) {
         ast_set_callerid(new, oh->cid_num, oh->cid_name, oh->cid_num);
      }
      if (oh->parent_channel) {
         ast_channel_inherit_variables(oh->parent_channel, new);
         ast_channel_datastore_inherit(oh->parent_channel, new);
      }
      if (oh->account) {
         ast_cdr_setaccount(new, oh->account);
      }
   } else if (caller) { /* no outgoing helper so use caller if avaliable */
      ast_channel_inherit_variables(caller, new);
      ast_channel_datastore_inherit(caller, new);
   }

   ast_channel_lock(orig);
   while (ast_channel_trylock(new)) {
      CHANNEL_DEADLOCK_AVOIDANCE(orig);
   }
   ast_copy_flags(new->cdr, orig->cdr, AST_CDR_FLAG_ORIGINATED);
   ast_string_field_set(new, accountcode, orig->accountcode);
   if (!ast_strlen_zero(orig->cid.cid_num) && !ast_strlen_zero(new->cid.cid_name)) {
      ast_set_callerid(new, orig->cid.cid_num, orig->cid.cid_name, orig->cid.cid_num);
   }
   ast_channel_unlock(new);
   ast_channel_unlock(orig);

   /* call new channel */
   if ((*timeout = ast_call(new, data, 0))) {
      ast_log(LOG_NOTICE, "Unable to call forward to channel %s/%s\n", type, (char *)data);
      ast_hangup(orig);
      ast_hangup(new);
      return NULL;
   }
   ast_hangup(orig);

   return new;
}

void ast_cancel_shutdown

(

void

)

Cancel a shutdown in progress.

Cancels an existing shutdown and returns to normal operation

Definition at line 509 of file channel.c.

Referenced by handle_abort_shutdown().

{
   shutting_down = 0;
}

const char* ast_cause2str

(

int

state

)

Gives the string form of a given hangup cause.

Gives the string form of a given cause code

Parameters:

state

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

Definition at line 629 of file channel.c.

References ARRAY_LEN, causes, and ast_cause::desc.

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

{
   int x;

   for (x = 0; x < ARRAY_LEN(causes); x++) {
      if (causes[x].cause == cause)
         return causes[x].desc;
   }

   return "Unknown";
}

void ast_change_name	(	struct ast_channel *	chan,
		char *	newname
	)

Change channel name.

Note:

The channel must be locked before calling this function.

Definition at line 4214 of file channel.c.

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

Referenced by update_name().

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

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,
			...
	)			[read]

Definition at line 5794 of file channel.c.

References __ast_channel_alloc_ap().

{
   va_list ap1, ap2;
   struct ast_channel *result;


   va_start(ap1, name_fmt);
   va_start(ap2, name_fmt);
   result = __ast_channel_alloc_ap(needqueue, state, cid_num, cid_name, acctcode, exten, context,
               amaflag, __FILE__, __LINE__, __FUNCTION__, name_fmt, ap1, ap2);
   va_end(ap1);
   va_end(ap2);

   return result;
}

enum ast_bridge_result 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 4973 of file channel.c.

References ast_channel::_bridge, ast_channel::_softhangup, AST_BRIDGE_COMPLETE, AST_BRIDGE_FAILED, AST_BRIDGE_FAILED_NOWARN, AST_BRIDGE_RETRY, ast_channel_make_compatible(), ast_check_hangup(), ast_check_hangup_locked(), ast_clear_flag, AST_CONTROL_SRCUPDATE, ast_debug, AST_FEATURE_PLAY_WARNING, AST_FEATURE_WARNING_ACTIVE, AST_FLAG_END_DTMF_ONLY, AST_FLAG_NBRIDGE, AST_FLAG_ZOMBIE, ast_generic_bridge(), ast_indicate(), ast_log(), ast_samp2tv(), ast_set_flag, AST_SOFTHANGUP_UNBRIDGE, ast_test_flag, ast_tvadd(), ast_tvdiff_ms(), ast_tvnow(), ast_tvsub(), ast_tvzero(), ast_verb, ast_channel::audiohooks, ast_channel_tech::bridge, bridge_play_sounds(), bridge_playfile(), ast_channel::cid, ast_callerid::cid_num, ast_bridge_config::end_sound, EVENT_FLAG_CALL, ast_bridge_config::feature_timer, ast_bridge_config::features_callee, ast_bridge_config::features_caller, ast_bridge_config::firstpass, ast_bridge_config::flags, ast_channel::generator, LOG_WARNING, manager_bridge_event(), manager_event, ast_channel::masq, ast_channel::masqr, ast_channel::monitor, ast_channel::name, ast_channel::nativeformats, ast_bridge_config::nexteventts, ast_bridge_config::play_warning, ast_channel::readformat, ast_channel_tech::send_digit_begin, ast_bridge_config::start_sound, ast_bridge_config::start_time, ast_channel::tech, ast_bridge_config::timelimit, ast_channel::uniqueid, update_bridge_vars(), ast_bridge_config::warning_freq, ast_bridge_config::warning_sound, and ast_channel::writeformat.

Referenced by ast_bridge_call().

{
   struct ast_channel *who = NULL;
   enum ast_bridge_result res = AST_BRIDGE_COMPLETE;
   int nativefailed=0;
   int firstpass;
   int o0nativeformats;
   int o1nativeformats;
   long time_left_ms=0;
   char caller_warning = 0;
   char callee_warning = 0;

   if (c0->_bridge) {
      ast_log(LOG_WARNING, "%s is already in a bridge with %s\n",
         c0->name, c0->_bridge->name);
      return -1;
   }
   if (c1->_bridge) {
      ast_log(LOG_WARNING, "%s is already in a bridge with %s\n",
         c1->name, c1->_bridge->name);
      return -1;
   }
   
   /* Stop if we're a zombie or need a soft hangup */
   if (ast_test_flag(c0, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c0) ||
       ast_test_flag(c1, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c1))
      return -1;

   *fo = NULL;
   firstpass = config->firstpass;
   config->firstpass = 0;

   if (ast_tvzero(config->start_time))
      config->start_time = ast_tvnow();
   time_left_ms = config->timelimit;

   caller_warning = ast_test_flag(&config->features_caller, AST_FEATURE_PLAY_WARNING);
   callee_warning = ast_test_flag(&config->features_callee, AST_FEATURE_PLAY_WARNING);

   if (config->start_sound && firstpass) {
      if (caller_warning)
         bridge_playfile(c0, c1, config->start_sound, time_left_ms / 1000);
      if (callee_warning)
         bridge_playfile(c1, c0, config->start_sound, time_left_ms / 1000);
   }

   /* Keep track of bridge */
   c0->_bridge = c1;
   c1->_bridge = c0;


   o0nativeformats = c0->nativeformats;
   o1nativeformats = c1->nativeformats;

   if (config->feature_timer && !ast_tvzero(config->nexteventts)) {
      config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->feature_timer, 1000));
   } else if (config->timelimit && firstpass) {
      config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->timelimit, 1000));
      if (caller_warning || callee_warning)
         config->nexteventts = ast_tvsub(config->nexteventts, ast_samp2tv(config->play_warning, 1000));
   }

   if (!c0->tech->send_digit_begin)
      ast_set_flag(c1, AST_FLAG_END_DTMF_ONLY);
   if (!c1->tech->send_digit_begin)
      ast_set_flag(c0, AST_FLAG_END_DTMF_ONLY);
   manager_bridge_event(1, 1, c0, c1);

   /* Before we enter in and bridge these two together tell them both the source of audio has changed */
   ast_indicate(c0, AST_CONTROL_SRCUPDATE);
   ast_indicate(c1, AST_CONTROL_SRCUPDATE);

   for (/* ever */;;) {
      struct timeval now = { 0, };
      int to;

      to = -1;

      if (!ast_tvzero(config->nexteventts)) {
         now = ast_tvnow();
         to = ast_tvdiff_ms(config->nexteventts, now);
         if (to <= 0) {
            if (!config->timelimit) {
               res = AST_BRIDGE_COMPLETE;
               break;
            }
            to = 0;
         }
      }

      if (config->timelimit) {
         time_left_ms = config->timelimit - ast_tvdiff_ms(now, config->start_time);
         if (time_left_ms < to)
            to = time_left_ms;

         if (time_left_ms <= 0) {
            if (caller_warning && config->end_sound)
               bridge_playfile(c0, c1, config->end_sound, 0);
            if (callee_warning && config->end_sound)
               bridge_playfile(c1, c0, config->end_sound, 0);
            *fo = NULL;
            if (who)
               *rc = who;
            res = 0;
            break;
         }

         if (!to) {
            if (time_left_ms >= 5000 && config->warning_sound && config->play_warning && ast_test_flag(config, AST_FEATURE_WARNING_ACTIVE)) {
               int t = (time_left_ms + 500) / 1000; /* round to nearest second */
               if (caller_warning)
                  bridge_playfile(c0, c1, config->warning_sound, t);
               if (callee_warning)
                  bridge_playfile(c1, c0, config->warning_sound, t);
            }
            if (config->warning_freq && (time_left_ms > (config->warning_freq + 5000)))
               config->nexteventts = ast_tvadd(config->nexteventts, ast_samp2tv(config->warning_freq, 1000));
            else
               config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->timelimit, 1000));
         }
         ast_clear_flag(config, AST_FEATURE_WARNING_ACTIVE);
      }

      if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE || c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE) {
         if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
            c0->_softhangup = 0;
         if (c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
            c1->_softhangup = 0;
         c0->_bridge = c1;
         c1->_bridge = c0;
         ast_debug(1, "Unbridge signal received. Ending native bridge.\n");
         continue;
      }

      /* Stop if we're a zombie or need a soft hangup */
      if (ast_test_flag(c0, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c0) ||
          ast_test_flag(c1, AST_FLAG_ZOMBIE) || ast_check_hangup_locked(c1)) {
         *fo = NULL;
         if (who)
            *rc = who;
         res = 0;
         ast_debug(1, "Bridge stops because we're zombie or need a soft hangup: c0=%s, c1=%s, flags: %s,%s,%s,%s\n",
            c0->name, c1->name,
            ast_test_flag(c0, AST_FLAG_ZOMBIE) ? "Yes" : "No",
            ast_check_hangup(c0) ? "Yes" : "No",
            ast_test_flag(c1, AST_FLAG_ZOMBIE) ? "Yes" : "No",
            ast_check_hangup(c1) ? "Yes" : "No");
         break;
      }

      update_bridge_vars(c0, c1);

      bridge_play_sounds(c0, c1);

      if (c0->tech->bridge &&
          (c0->tech->bridge == c1->tech->bridge) &&
          !nativefailed && !c0->monitor && !c1->monitor &&
          !c0->audiohooks && !c1->audiohooks && 
          !c0->masq && !c0->masqr && !c1->masq && !c1->masqr) {
         /* Looks like they share a bridge method and nothing else is in the way */
         ast_set_flag(c0, AST_FLAG_NBRIDGE);
         ast_set_flag(c1, AST_FLAG_NBRIDGE);
         if ((res = c0->tech->bridge(c0, c1, config->flags, fo, rc, to)) == AST_BRIDGE_COMPLETE) {
            /* \todo  XXX here should check that cid_num is not NULL */
            manager_event(EVENT_FLAG_CALL, "Unlink",
                     "Channel1: %s\r\n"
                     "Channel2: %s\r\n"
                     "Uniqueid1: %s\r\n"
                     "Uniqueid2: %s\r\n"
                     "CallerID1: %s\r\n"
                     "CallerID2: %s\r\n",
                     c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
            ast_debug(1, "Returning from native bridge, channels: %s, %s\n", c0->name, c1->name);

            ast_clear_flag(c0, AST_FLAG_NBRIDGE);
            ast_clear_flag(c1, AST_FLAG_NBRIDGE);

            if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE || c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
               continue;

            c0->_bridge = NULL;
            c1->_bridge = NULL;

            return res;
         } else {
            ast_clear_flag(c0, AST_FLAG_NBRIDGE);
            ast_clear_flag(c1, AST_FLAG_NBRIDGE);
         }
         switch (res) {
         case AST_BRIDGE_RETRY:
            if (config->play_warning) {
               ast_set_flag(config, AST_FEATURE_WARNING_ACTIVE);
            }
            continue;
         default:
            ast_verb(3, "Native bridging %s and %s ended\n", c0->name, c1->name);
            /* fallthrough */
         case AST_BRIDGE_FAILED_NOWARN:
            nativefailed++;
            break;
         }
      }

      if (((c0->writeformat != c1->readformat) || (c0->readformat != c1->writeformat) ||
          (c0->nativeformats != o0nativeformats) || (c1->nativeformats != o1nativeformats)) &&
          !(c0->generator || c1->generator)) {
         if (ast_channel_make_compatible(c0, c1)) {
            ast_log(LOG_WARNING, "Can't make %s and %s compatible\n", c0->name, c1->name);
            manager_bridge_event(0, 1, c0, c1);
            return AST_BRIDGE_FAILED;
         }
         o0nativeformats = c0->nativeformats;
         o1nativeformats = c1->nativeformats;
      }

      update_bridge_vars(c0, c1);

      res = ast_generic_bridge(c0, c1, config, fo, rc, config->nexteventts);
      if (res != AST_BRIDGE_RETRY) {
         break;
      } else if (config->feature_timer) {
         /* feature timer expired but has not been updated, sending to ast_bridge_call to do so */
         break;
      }
   }

   ast_clear_flag(c0, AST_FLAG_END_DTMF_ONLY);
   ast_clear_flag(c1, AST_FLAG_END_DTMF_ONLY);

   /* Now that we have broken the bridge the source will change yet again */
   ast_indicate(c0, AST_CONTROL_SRCUPDATE);
   ast_indicate(c1, AST_CONTROL_SRCUPDATE);

   c0->_bridge = NULL;
   c1->_bridge = NULL;

   /* \todo  XXX here should check that cid_num is not NULL */
   manager_event(EVENT_FLAG_CALL, "Unlink",
            "Channel1: %s\r\n"
            "Channel2: %s\r\n"
            "Uniqueid1: %s\r\n"
            "Uniqueid2: %s\r\n"
            "CallerID1: %s\r\n"
            "CallerID2: %s\r\n",
            c0->name, c1->name, c0->uniqueid, c1->uniqueid, c0->cid.cid_num, c1->cid.cid_num);
   ast_debug(1, "Bridge stops bridging channels %s and %s\n", c0->name, c1->name);

   return res;
}

int ast_channel_cmpwhentohangup	(	struct ast_channel *	chan,
		time_t	offset
	)

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

Parameters:

	chan	channel on which to check for hang up
	offset	offset in seconds from current time

Returns:

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

See also:

ast_channel_cmpwhentohangup_tv()

Version:

1.6.1 deprecated function (only had seconds precision)

Definition at line 550 of file channel.c.

References ast_channel_cmpwhentohangup_tv().

{
   struct timeval when = { offset, };
   return ast_channel_cmpwhentohangup_tv(chan, when);
}

int ast_channel_cmpwhentohangup_tv	(	struct ast_channel *	chan,
		struct timeval	offset
	)

Compare a offset with when to hangup channel.

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

Definition at line 535 of file channel.c.

References ast_tvadd(), ast_tvdiff_ms(), ast_tvnow(), ast_tvzero(), and ast_channel::whentohangup.

Referenced by ast_channel_cmpwhentohangup().

{
   struct timeval whentohangup;

   if (ast_tvzero(chan->whentohangup))
      return ast_tvzero(offset) ? 0 : -1;

   if (ast_tvzero(offset))
      return 1;

   whentohangup = ast_tvadd(offset, ast_tvnow());

   return ast_tvdiff_ms(whentohangup, chan->whentohangup);
}

int ast_channel_datastore_add	(	struct ast_channel *	chan,
		struct ast_datastore *	datastore
	)

Add a datastore to a channel.

Note:

The channel should be locked before calling this function.

Return values:

	0	success
	non-zero	failure

Definition at line 1485 of file channel.c.

References AST_LIST_INSERT_HEAD, and ast_channel::datastores.

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

{
   int res = 0;

   AST_LIST_INSERT_HEAD(&chan->datastores, datastore, entry);

   return res;
}

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

Create a channel data store object.

Note:

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

Deprecated:

You should use the ast_datastore_alloc() generic function instead.

Version:

1.6.1 deprecated

Definition at line 1458 of file channel.c.

References ast_datastore_alloc.

{
   return ast_datastore_alloc(info, uid);
}

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

Find a datastore on a channel.

Note:

The channel should be locked before calling this function.

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

Return values:

	pointer	to the datastore if found
	NULL	if not found

Definition at line 1499 of file channel.c.

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

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

{
   struct ast_datastore *datastore = NULL;
   
   if (info == NULL)
      return NULL;

   AST_LIST_TRAVERSE_SAFE_BEGIN(&chan->datastores, datastore, entry) {
      if (datastore->info != info) {
         continue;
      }

      if (uid == NULL) {
         /* matched by type only */
         break;
      }

      if ((datastore->uid != NULL) && !strcasecmp(uid, datastore->uid)) {
         /* Matched by type AND uid */
         break;
      }
   }
   AST_LIST_TRAVERSE_SAFE_END;

   return datastore;
}

int ast_channel_datastore_free

(

struct ast_datastore *

datastore

)

Free a channel data store object.

Deprecated:

You should use the ast_datastore_free() generic function instead.

Version:

1.6.1 deprecated

Definition at line 1463 of file channel.c.

References ast_datastore_free().

{
   return ast_datastore_free(datastore);
}

int ast_channel_datastore_inherit	(	struct ast_channel *	from,
		struct ast_channel *	to
	)

Inherit datastores from a parent to a child.

Definition at line 1468 of file channel.c.

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

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

{
   struct ast_datastore *datastore = NULL, *datastore2;

   AST_LIST_TRAVERSE(&from->datastores, datastore, entry) {
      if (datastore->inheritance > 0) {
         datastore2 = ast_datastore_alloc(datastore->info, datastore->uid);
         if (datastore2) {
            datastore2->data = datastore->info->duplicate ? datastore->info->duplicate(datastore->data) : NULL;
            datastore2->inheritance = datastore->inheritance == DATASTORE_INHERIT_FOREVER ? DATASTORE_INHERIT_FOREVER : datastore->inheritance - 1;
            AST_LIST_INSERT_TAIL(&to->datastores, datastore2, entry);
         }
      }
   }
   return 0;
}

int ast_channel_datastore_remove	(	struct ast_channel *	chan,
		struct ast_datastore *	datastore
	)

Remove a datastore from a channel.

Note:

The channel should be locked before calling this function.

Return values:

	0	success
	non-zero	failure

Definition at line 1494 of file channel.c.

References AST_LIST_REMOVE, and ast_channel::datastores.

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

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

int ast_channel_defer_dtmf

(

struct ast_channel *

chan

)

Set defer DTMF flag on channel.

Defers DTMF

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

Definition at line 1139 of file channel.c.

References AST_FLAG_DEFER_DTMF, ast_set_flag, and ast_test_flag.

Referenced by __adsi_transmit_messages(), and find_cache().

{
   int pre = 0;

   if (chan) {
      pre = ast_test_flag(chan, AST_FLAG_DEFER_DTMF);
      ast_set_flag(chan, AST_FLAG_DEFER_DTMF);
   }
   return pre;
}

int ast_channel_early_bridge	(	struct ast_channel *	c0,
		struct ast_channel *	c1
	)

Bridge two channels together (early).

Bridge two channels together (early)

Parameters:

	c0	first channel to bridge
	c1	second channel to bridge Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.

Returns:

Returns 0 on success and -1 if it could not be done

Definition at line 4875 of file channel.c.

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

Referenced by dial_exec_full(), and wait_for_answer().

{
   /* Make sure we can early bridge, if not error out */
   if (!c0->tech->early_bridge || (c1 && (!c1->tech->early_bridge || c0->tech->early_bridge != c1->tech->early_bridge)))
      return -1;

   return c0->tech->early_bridge(c0, c1);
}

void ast_channel_free

(

struct ast_channel *

chan

)

Free a channel structure.

Definition at line 1345 of file channel.c.

References ast_channel::alertpipe, ast_app_group_discard(), ast_cdr_discard(), ast_channel_lock, AST_CHANNEL_NAME, ast_channel_unlock, ast_copy_string(), ast_datastore_free(), ast_debug, AST_DEVICE_UNKNOWN, ast_devstate_changed_literal(), AST_FLAG_IN_CHANNEL_LIST, ast_free, ast_frfree, ast_jb_destroy(), AST_LIST_REMOVE_HEAD, ast_log(), AST_MAX_FDS, ast_moh_cleanup(), ast_mutex_destroy(), AST_RWLIST_REMOVE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_string_field_free_memory, ast_test_flag, ast_timer_close(), ast_translator_free_path(), ast_var_delete(), ast_channel::cdr, ast_channel::cid, ast_channel::datastores, f, free, free_cid(), ast_channel::lock_dont_use, LOG_WARNING, ast_channel::monitor, ast_channel::music_state, ast_channel::name, name, ast_channel::pbx, ast_channel::readq, ast_channel::readtrans, ast_channel::sched, sched_context_destroy(), ast_channel_monitor::stop, ast_channel::tech_pvt, ast_channel::timer, ast_channel::varshead, and ast_channel::writetrans.

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

{
   int fd;
#ifdef HAVE_EPOLL
   int i;
#endif
   struct ast_var_t *vardata;
   struct ast_frame *f;
   struct varshead *headp;
   struct ast_datastore *datastore = NULL;
   char name[AST_CHANNEL_NAME], *dashptr;
   int inlist;
   
   headp=&chan->varshead;
   
   inlist = ast_test_flag(chan, AST_FLAG_IN_CHANNEL_LIST);
   if (inlist) {
      AST_RWLIST_WRLOCK(&channels);
      if (!AST_RWLIST_REMOVE(&channels, chan, chan_list)) {
         ast_debug(1, "Unable to find channel in list to free. Assuming it has already been done.\n");
      }
      /* Lock and unlock the channel just to be sure nobody has it locked still
         due to a reference retrieved from the channel list. */
      ast_channel_lock(chan);
      ast_channel_unlock(chan);
   }

   /* Get rid of each of the data stores on the channel */
   while ((datastore = AST_LIST_REMOVE_HEAD(&chan->datastores, entry)))
      /* Free the data store */
      ast_datastore_free(datastore);

   /* Lock and unlock the channel just to be sure nobody has it locked still
      due to a reference that was stored in a datastore. (i.e. app_chanspy) */
   ast_channel_lock(chan);
   ast_channel_unlock(chan);

   if (chan->tech_pvt) {
      ast_log(LOG_WARNING, "Channel '%s' may not have been hung up properly\n", chan->name);
      ast_free(chan->tech_pvt);
   }

   if (chan->sched)
      sched_context_destroy(chan->sched);

   ast_copy_string(name, chan->name, sizeof(name));
   if ((dashptr = strrchr(name, '-'))) {
      *dashptr = '\0';
   }

   /* Stop monitoring */
   if (chan->monitor)
      chan->monitor->stop( chan, 0 );

   /* If there is native format music-on-hold state, free it */
   if (chan->music_state)
      ast_moh_cleanup(chan);

   /* Free translators */
   if (chan->readtrans)
      ast_translator_free_path(chan->readtrans);
   if (chan->writetrans)
      ast_translator_free_path(chan->writetrans);
   if (chan->pbx)
      ast_log(LOG_WARNING, "PBX may not have been terminated properly on '%s'\n", chan->name);
   free_cid(&chan->cid);
   /* Close pipes if appropriate */
   if ((fd = chan->alertpipe[0]) > -1)
      close(fd);
   if ((fd = chan->alertpipe[1]) > -1)
      close(fd);
   if (chan->timer) {
      ast_timer_close(chan->timer);
   }
#ifdef HAVE_EPOLL
   for (i = 0; i < AST_MAX_FDS; i++) {
      if (chan->epfd_data[i])
         free(chan->epfd_data[i]);
   }
   close(chan->epfd);
#endif
   while ((f = AST_LIST_REMOVE_HEAD(&chan->readq, frame_list)))
      ast_frfree(f);
   
   /* loop over the variables list, freeing all data and deleting list items */
   /* no need to lock the list, as the channel is already locked */
   
   while ((vardata = AST_LIST_REMOVE_HEAD(headp, entries)))
      ast_var_delete(vardata);

   ast_app_group_discard(chan);

   /* Destroy the jitterbuffer */
   ast_jb_destroy(chan);

   if (chan->cdr) {
      ast_cdr_discard(chan->cdr);
      chan->cdr = NULL;
   }
   
   ast_mutex_destroy(&chan->lock_dont_use);

   ast_string_field_free_memory(chan);
   ast_free(chan);
   if (inlist)
      AST_RWLIST_UNLOCK(&channels);

   /* Queue an unknown state, because, while we know that this particular
    * instance is dead, we don't know the state of all other possible
    * instances. */
   ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, name);
}

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

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

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

{
   struct ast_var_t *current, *newvar;
   const char *varname;

   AST_LIST_TRAVERSE(&parent->varshead, current, entries) {
      int vartype = 0;

      varname = ast_var_full_name(current);
      if (!varname)
         continue;

      if (varname[0] == '_') {
         vartype = 1;
         if (varname[1] == '_')
            vartype = 2;
      }

      switch (vartype) {
      case 1:
         newvar = ast_var_assign(&varname[1], ast_var_value(current));
         if (newvar) {
            AST_LIST_INSERT_TAIL(&child->varshead, newvar, entries);
            ast_debug(1, "Copying soft-transferable variable %s.\n", ast_var_name(newvar));
         }
         break;
      case 2:
         newvar = ast_var_assign(varname, ast_var_value(current));
         if (newvar) {
            AST_LIST_INSERT_TAIL(&child->varshead, newvar, entries);
            ast_debug(1, "Copying hard-transferable variable %s.\n", ast_var_name(newvar));
         }
         break;
      default:
         ast_debug(1, "Not copying variable %s.\n", ast_var_name(current));
         break;
      }
   }
}

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

References ast_channel_make_compatible_helper().

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

{
   /* Some callers do not check return code, and we must try to set all call legs correctly */
   int rc = 0;

   /* Set up translation from the chan to the peer */
   rc = ast_channel_make_compatible_helper(chan, peer);

   if (rc < 0)
      return rc;

   /* Set up translation from the peer to the chan */
   rc = ast_channel_make_compatible_helper(peer, chan);

   return rc;
}

static int ast_channel_make_compatible_helper	(	struct ast_channel *	from,
		struct ast_channel *	to
	)			[static]

Set up translation from one channel to another.

Definition at line 4077 of file channel.c.

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

Referenced by ast_channel_make_compatible().

{
   int src;
   int dst;

   if (from->readformat == to->writeformat && from->writeformat == to->readformat) {
      /* Already compatible!  Moving on ... */
      return 0;
   }

   /* Set up translation from the 'from' channel to the 'to' channel */
   src = from->nativeformats;
   dst = to->nativeformats;

   /* If there's no audio in this call, don't bother with trying to find a translation path */
   if ((src & AST_FORMAT_AUDIO_MASK) == 0 || (dst & AST_FORMAT_AUDIO_MASK) == 0)
      return 0;

   if (ast_translator_best_choice(&dst, &src) < 0) {
      ast_log(LOG_WARNING, "No path to translate from %s(%d) to %s(%d)\n", from->name, src, to->name, dst);
      return -1;
   }

   /* if the best path is not 'pass through', then
      transcoding is needed; if desired, force transcode path
      to use SLINEAR between channels, but only if there is
      no direct conversion available */
   if ((src != dst) && ast_opt_transcode_via_slin &&
       (ast_translate_path_steps(dst, src) != 1))
      dst = AST_FORMAT_SLINEAR;
   if (ast_set_read_format(from, dst) < 0) {
      ast_log(LOG_WARNING, "Unable to set read format on channel %s to %d\n", from->name, dst);
      return -1;
   }
   if (ast_set_write_format(to, dst) < 0) {
      ast_log(LOG_WARNING, "Unable to set write format on channel %s to %d\n", to->name, dst);
      return -1;
   }
   return 0;
}

int ast_channel_masquerade	(	struct ast_channel *	original,
		struct ast_channel *	clone
	)

Weird function made for call transfers.

Parameters:

	original	channel to make a copy of
	clone	copy of the original channel

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

Note:

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

Definition at line 4135 of file channel.c.

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

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

{
   int res = -1;
   struct ast_channel *final_orig, *final_clone, *base;

retrymasq:
   final_orig = original;
   final_clone = clonechan;

   ast_channel_lock(original);
   while (ast_channel_trylock(clonechan)) {
      ast_channel_unlock(original);
      usleep(1);
      ast_channel_lock(original);
   }

   /* each of these channels may be sitting behind a channel proxy (i.e. chan_agent)
      and if so, we don't really want to masquerade it, but its proxy */
   if (original->_bridge && (original->_bridge != ast_bridged_channel(original)) && (original->_bridge->_bridge != original))
      final_orig = original->_bridge;

   if (clonechan->_bridge && (clonechan->_bridge != ast_bridged_channel(clonechan)) && (clonechan->_bridge->_bridge != clonechan))
      final_clone = clonechan->_bridge;
   
   if (final_clone->tech->get_base_channel && (base = final_clone->tech->get_base_channel(final_clone))) {
      final_clone = base;
   }

   if ((final_orig != original) || (final_clone != clonechan)) {
      /* Lots and lots of deadlock avoidance.  The main one we're competing with
       * is ast_write(), which locks channels recursively, when working with a
       * proxy channel. */
      if (ast_channel_trylock(final_orig)) {
         ast_channel_unlock(clonechan);
         ast_channel_unlock(original);
         goto retrymasq;
      }
      if (ast_channel_trylock(final_clone)) {
         ast_channel_unlock(final_orig);
         ast_channel_unlock(clonechan);
         ast_channel_unlock(original);
         goto retrymasq;
      }
      ast_channel_unlock(clonechan);
      ast_channel_unlock(original);
      original = final_orig;
      clonechan = final_clone;
   }

   if (original == clonechan) {
      ast_log(LOG_WARNING, "Can't masquerade channel '%s' into itself!\n", original->name);
      ast_channel_unlock(clonechan);
      ast_channel_unlock(original);
      return -1;
   }

   ast_debug(1, "Planning to masquerade channel %s into the structure of %s\n",
      clonechan->name, original->name);
   if (original->masq) {
      ast_log(LOG_WARNING, "%s is already going to masquerade as %s\n",
         original->masq->name, original->name);
   } else if (clonechan->masqr) {
      ast_log(LOG_WARNING, "%s is already going to masquerade as %s\n",
         clonechan->name, clonechan->masqr->name);
   } else {
      original->masq = clonechan;
      clonechan->masqr = original;
      ast_queue_frame(original, &ast_null_frame);
      ast_queue_frame(clonechan, &ast_null_frame);
      ast_debug(1, "Done planning to masquerade channel %s into the structure of %s\n", clonechan->name, original->name);
      res = 0;
   }

   ast_channel_unlock(clonechan);
   ast_channel_unlock(original);

   return res;
}

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

Checks the value of an option

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

Definition at line 5238 of file channel.c.

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

Referenced by ast_channel_get_t38_state().

{
   if (!chan->tech->queryoption) {
      errno = ENOSYS;
      return -1;
   }

   if (block)
      ast_log(LOG_ERROR, "XXX Blocking not implemented yet XXX\n");

   return chan->tech->queryoption(chan, option, data, datalen);
}

const char* ast_channel_reason2str

(

int

reason

)

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

Parameters:

reason

The integer argument, usually taken from AST_CONTROL_ macros

Returns:

char pointer explaining the code

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

{
   switch (reason) /* the following appear to be the only ones actually returned by request_and_dial */
   {
   case 0:
      return "Call Failure (not BUSY, and not NO_ANSWER, maybe Circuit busy or down?)";
   case AST_CONTROL_HANGUP:
      return "Hangup";
   case AST_CONTROL_RING:
      return "Local Ring";
   case AST_CONTROL_RINGING:
      return "Remote end Ringing";
   case AST_CONTROL_ANSWER:
      return "Remote end has Answered";
   case AST_CONTROL_BUSY:
      return "Remote end is Busy";
   case AST_CONTROL_CONGESTION:
      return "Congestion (circuits busy)";
   default:
      return "Unknown Reason!!";
   }
}

int ast_channel_register

(

const struct ast_channel_tech *

tech

)

Register a new telephony channel in Asterisk.

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

Definition at line 557 of file channel.c.

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

Referenced by load_module(), and unload_module().

{
   struct chanlist *chan;

   AST_RWLIST_WRLOCK(&channels);

   AST_LIST_TRAVERSE(&backends, chan, list) {
      if (!strcasecmp(tech->type, chan->tech->type)) {
         ast_log(LOG_WARNING, "Already have a handler for type '%s'\n", tech->type);
         AST_RWLIST_UNLOCK(&channels);
         return -1;
      }
   }
   
   if (!(chan = ast_calloc(1, sizeof(*chan)))) {
      AST_RWLIST_UNLOCK(&channels);
      return -1;
   }
   chan->tech = tech;
   AST_LIST_INSERT_HEAD(&backends, chan, list);

   ast_debug(1, "Registered handler for '%s' (%s)\n", chan->tech->type, chan->tech->description);

   ast_verb(2, "Registered channel type '%s' (%s)\n", chan->tech->type, chan->tech->description);

   AST_RWLIST_UNLOCK(&channels);
   return 0;
}

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

Sends HTML on given channel

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

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

{
   if (chan->tech->send_html)
      return chan->tech->send_html(chan, subclass, data, datalen);
   return -1;
}

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

Sends a URL on a given link

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

Definition at line 4071 of file channel.c.

References ast_channel_sendhtml(), and AST_HTML_URL.

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

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

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

Set the file descriptor on the channel

Definition at line 1527 of file channel.c.

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

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

{
#ifdef HAVE_EPOLL
   struct epoll_event ev;
   struct ast_epoll_data *aed = NULL;

   if (chan->fds[which] > -1) {
      epoll_ctl(chan->epfd, EPOLL_CTL_DEL, chan->fds[which], &ev);
      aed = chan->epfd_data[which];
   }

   /* If this new fd is valid, add it to the epoll */
   if (fd > -1) {
      if (!aed && (!(aed = ast_calloc(1, sizeof(*aed)))))
         return;
      
      chan->epfd_data[which] = aed;
      aed->chan = chan;
      aed->which = which;
      
      ev.events = EPOLLIN | EPOLLPRI | EPOLLERR | EPOLLHUP;
      ev.data.ptr = aed;
      epoll_ctl(chan->epfd, EPOLL_CTL_ADD, fd, &ev);
   } else if (aed) {
      /* We don't have to keep around this epoll data structure now */
      free(aed);
      chan->epfd_data[which] = NULL;
   }
#endif
   chan->fds[which] = fd;
   return;
}

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

Sets an option on a channel.

Sets an option on a channel

Parameters:

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

Definition at line 5225 of file channel.c.

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

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

{
   if (!chan->tech->setoption) {
      errno = ENOSYS;
      return -1;
   }

   if (block)
      ast_log(LOG_ERROR, "XXX Blocking not implemented yet XXX\n");

   return chan->tech->setoption(chan, option, data, datalen);
}

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 relative to the current time of when to hang up

This function sets the absolute time out on a channel (when to hang up).

Note:

This function does not require that the channel is locked before calling it.

Returns:

Nothing

See also:

ast_channel_setwhentohangup_tv()

Version:

1.6.1 deprecated function (only had seconds precision)

Definition at line 528 of file channel.c.

References ast_channel_setwhentohangup_tv().

{
   struct timeval when = { offset, };
   ast_channel_setwhentohangup_tv(chan, when);
}

void ast_channel_setwhentohangup_tv	(	struct ast_channel *	chan,
		struct timeval	offset
	)

Set when to hangup channel.

Set when to hang a channel up.

Definition at line 521 of file channel.c.

References ast_null_frame, ast_queue_frame(), ast_tvadd(), ast_tvnow(), ast_tvzero(), and ast_channel::whentohangup.

Referenced by action_timeout(), ast_channel_setwhentohangup(), handle_autohangup(), and timeout_write().

{
   chan->whentohangup = ast_tvzero(offset) ? offset : ast_tvadd(offset, ast_tvnow());
   ast_queue_frame(chan, &ast_null_frame);
   return;
}

struct ast_silence_generator* ast_channel_start_silence_generator

(

struct ast_channel *

chan

)

[read]

Starts a silence generator on the given channel.

Parameters:

chan

The channel to generate silence on

Returns:

An ast_silence_generator pointer, or NULL if an error occurs

This function will cause SLINEAR silence to be generated on the supplied channel until it is disabled; if the channel cannot be put into SLINEAR mode then the function will fail.

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

Definition at line 5558 of file channel.c.

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

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

{
   struct ast_silence_generator *state;

   if (!(state = ast_calloc(1, sizeof(*state)))) {
      return NULL;
   }

   state->old_write_format = chan->writeformat;

   if (ast_set_write_format(chan, AST_FORMAT_SLINEAR) < 0) {
      ast_log(LOG_ERROR, "Could not set write format to SLINEAR\n");
      ast_free(state);
      return NULL;
   }

   ast_activate_generator(chan, &silence_generator, state);

   ast_debug(1, "Started silence generator on '%s'\n", chan->name);

   return state;
}

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

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

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

{
   if (!state)
      return;

   ast_deactivate_generator(chan);

   ast_debug(1, "Stopped silence generator on '%s'\n", chan->name);

   if (ast_set_write_format(chan, state->old_write_format) < 0)
      ast_log(LOG_ERROR, "Could not return write format to its original state\n");

   ast_free(state);
}

int ast_channel_supports_html

(

struct ast_channel *

channel

)

Checks for HTML support on a channel

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

Definition at line 4059 of file channel.c.

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

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

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

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

References ast_clear_flag, and AST_FLAG_DEFER_DTMF.

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

{
   if (chan)
      ast_clear_flag(chan, AST_FLAG_DEFER_DTMF);
}

void ast_channel_unregister

(

const struct ast_channel_tech *

tech

)

Unregister channel driver.

Unregister a channel technology.

Definition at line 587 of file channel.c.

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

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

{
   struct chanlist *chan;

   ast_debug(1, "Unregistering channel type '%s'\n", tech->type);

   AST_RWLIST_WRLOCK(&channels);

   AST_LIST_TRAVERSE_SAFE_BEGIN(&backends, chan, list) {
      if (chan->tech == tech) {
         AST_LIST_REMOVE_CURRENT(list);
         ast_free(chan);
         ast_verb(2, "Unregistered channel type '%s'\n", tech->type);
         break;   
      }
   }
   AST_LIST_TRAVERSE_SAFE_END;

   AST_RWLIST_UNLOCK(&channels);
}

struct ast_channel* ast_channel_walk_locked

(

const struct ast_channel *

prev

)

[read]

Browse channels in use.

Browse channels in use Browse the channels currently in use.

Definition at line 1265 of file channel.c.

References channel_find_locked().

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

{
   return channel_find_locked(prev, NULL, 0, NULL, NULL);
}

void ast_channels_init

(

void

)

Provided by channel.c

Definition at line 5479 of file channel.c.

References ARRAY_LEN, ast_cli_register_multiple(), and cli_channel.

Referenced by main().

{
   ast_cli_register_multiple(cli_channel, ARRAY_LEN(cli_channel));
}

struct ast_variable* ast_channeltype_list

(

void

)

[read]

return an ast_variable list of channeltypes

Definition at line 185 of file channel.c.

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

{
   struct chanlist *cl;
   struct ast_variable *var=NULL, *prev = NULL;
   AST_LIST_TRAVERSE(&backends, cl, list) {
      if (prev)  {
         if ((prev->next = ast_variable_new(cl->tech->type, cl->tech->description, "")))
            prev = prev->next;
      } else {
         var = ast_variable_new(cl->tech->type, cl->tech->description, "");
         prev = var;
      }
   }
   return var;
}

int ast_check_hangup

(

struct ast_channel *

chan

)

Checks to see if a channel is needing hang up.

Check to see if a channel is needing hang up.

Definition at line 461 of file channel.c.

References ast_channel::_softhangup, AST_SOFTHANGUP_TIMEOUT, ast_tvdiff_ms(), ast_tvnow(), ast_tvzero(), and ast_channel::whentohangup.

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

{
   if (chan->_softhangup)     /* yes if soft hangup flag set */
      return 1;
   if (ast_tvzero(chan->whentohangup)) /* no if no hangup scheduled */
      return 0;
   if (ast_tvdiff_ms(chan->whentohangup, ast_tvnow()) > 0)  /* no if hangup time has not come yet. */
      return 0;
   chan->_softhangup |= AST_SOFTHANGUP_TIMEOUT; /* record event */
   return 1;
}

static int ast_check_hangup_locked

(

struct ast_channel *

chan

)

[static]

Definition at line 473 of file channel.c.

References ast_channel_lock, ast_channel_unlock, and ast_check_hangup().

Referenced by ast_channel_bridge().

{
   int res;
   ast_channel_lock(chan);
   res = ast_check_hangup(chan);
   ast_channel_unlock(chan);
   return res;
}

void ast_deactivate_generator

(

struct ast_channel *

chan

)

Deactivate an active generator

Definition at line 1907 of file channel.c.

References ast_channel_lock, ast_channel_set_fd(), ast_channel_unlock, ast_clear_flag, AST_FLAG_WRITE_INT, AST_GENERATOR_FD, ast_settimeout(), 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(), dial_exec_full(), generator_force(), local_ast_moh_stop(), old_milliwatt_exec(), transmit_audio(), and wait_for_answer().

{
   ast_channel_lock(chan);
   if (chan->generatordata) {
      if (chan->generator && chan->generator->release)
         chan->generator->release(chan, chan->generatordata);
      chan->generatordata = NULL;
      chan->generator = NULL;
      ast_channel_set_fd(chan, AST_GENERATOR_FD, -1);
      ast_clear_flag(chan, AST_FLAG_WRITE_INT);
      ast_settimeout(chan, 0, NULL, NULL);
   }
   ast_channel_unlock(chan);
}

int ast_do_masquerade

(

struct ast_channel *

original

)

Masquerade a channel.

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

Note:

Assumes channel will be locked when called

Definition at line 4311 of file channel.c.

References ast_channel::_softhangup, ast_channel::_state, ast_channel::adsicpe, ast_channel::alertpipe, ast_app_group_update(), ast_cause2str(), ast_channel_free(), ast_channel_lock, AST_CHANNEL_NAME, ast_channel_set_fd(), ast_channel_unlock, ast_copy_string(), ast_debug, AST_FLAG_BLOCKING, AST_FLAG_EXCEPTION, AST_FLAG_OUTGOING, AST_FLAG_ZOMBIE, AST_GENERATOR_FD, ast_indicate(), AST_LIST_APPEND_LIST, AST_LIST_FIRST, AST_LIST_HEAD_NOLOCK, AST_LIST_HEAD_SET_NOLOCK, AST_LIST_INSERT_TAIL, AST_LIST_REMOVE_HEAD, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, ast_log(), AST_MAX_FDS, ast_null_frame, ast_queue_frame(), ast_set_flag, ast_set_read_format(), ast_set_write_format(), AST_SOFTHANGUP_DEV, ast_state2str(), ast_string_field_set, ast_test_flag, AST_TIMING_FD, ast_channel::blocker, ast_channel::cdr, ast_datastore_info::chan_fixup, ast_channel::cid, clone_variables(), ast_datastore::data, ast_channel::datastores, errno, EVENT_FLAG_CALL, ast_channel::fdno, ast_channel::fds, ast_channel_tech::fixup, free_translation(), ast_channel_tech::hangup, ast_channel::hangupcause, ast_datastore::info, ast_channel::language, language, ast_channel::lock_dont_use, LOG_WARNING, manager_event, ast_channel::masq, ast_channel::masqr, ast_channel::monitor, ast_channel::musicclass, musicclass, name, ast_channel::name, ast_channel::nativeformats, ast_channel::rawreadformat, ast_channel::rawwriteformat, ast_channel::readformat, ast_channel::readq, report_new_callerid(), ast_channel::tech, ast_channel::tech_pvt, ast_channel::timingfd, ast_channel_tech::type, ast_channel::uniqueid, ast_channel::visible_indication, and ast_channel::writeformat.

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

{
   int x,i;
   int res=0;
   int origstate;
   struct ast_frame *current;
   const struct ast_channel_tech *t;
   void *t_pvt;
   struct ast_callerid tmpcid;
   struct ast_channel *clonechan = original->masq;
   struct ast_cdr *cdr;
   int rformat = original->readformat;
   int wformat = original->writeformat;
   char newn[AST_CHANNEL_NAME];
   char orig[AST_CHANNEL_NAME];
   char masqn[AST_CHANNEL_NAME];
   char zombn[AST_CHANNEL_NAME];

   ast_debug(4, "Actually Masquerading %s(%d) into the structure of %s(%d)\n",
      clonechan->name, clonechan->_state, original->name, original->_state);

   manager_event(EVENT_FLAG_CALL, "Masquerade", "Clone: %s\r\nCloneState: %s\r\nOriginal: %s\r\nOriginalState: %s\r\n",
            clonechan->name, ast_state2str(clonechan->_state), original->name, ast_state2str(original->_state));

   /* XXX This operation is a bit odd.  We're essentially putting the guts of
    * the clone channel into the original channel.  Start by killing off the
    * original channel's backend.  While the features are nice, which is the
    * reason we're keeping it, it's still awesomely weird. XXX */

   /* We need the clone's lock, too */
   ast_channel_lock(clonechan);

   ast_debug(2, "Got clone lock for masquerade on '%s' at %p\n", clonechan->name, &clonechan->lock_dont_use);

   /* Having remembered the original read/write formats, we turn off any translation on either
      one */
   free_translation(clonechan);
   free_translation(original);


   /* Unlink the masquerade */
   original->masq = NULL;
   clonechan->masqr = NULL;
   
   /* Save the original name */
   ast_copy_string(orig, original->name, sizeof(orig));
   /* Save the new name */
   ast_copy_string(newn, clonechan->name, sizeof(newn));
   /* Create the masq name */
   snprintf(masqn, sizeof(masqn), "%s<MASQ>", newn);
      
   /* Copy the name from the clone channel */
   ast_string_field_set(original, name, newn);

   /* Mangle the name of the clone channel */
   ast_string_field_set(clonechan, name, masqn);
   
   /* Notify any managers of the change, first the masq then the other */
   manager_event(EVENT_FLAG_CALL, "Rename", "Channel: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", newn, masqn, clonechan->uniqueid);
   manager_event(EVENT_FLAG_CALL, "Rename", "Channel: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", orig, newn, original->uniqueid);

   /* Swap the technologies */   
   t = original->tech;
   original->tech = clonechan->tech;
   clonechan->tech = t;

   /* Swap the cdrs */
   cdr = original->cdr;
   original->cdr = clonechan->cdr;
   clonechan->cdr = cdr;

   t_pvt = original->tech_pvt;
   original->tech_pvt = clonechan->tech_pvt;
   clonechan->tech_pvt = t_pvt;

   /* Swap the alertpipes */
   for (i = 0; i < 2; i++) {
      x = original->alertpipe[i];
      original->alertpipe[i] = clonechan->alertpipe[i];
      clonechan->alertpipe[i] = x;
   }

   /* 
    * Swap the readq's.  The end result should be this:
    *
    *  1) All frames should be on the new (original) channel.
    *  2) Any frames that were already on the new channel before this
    *     masquerade need to be at the end of the readq, after all of the
    *     frames on the old (clone) channel.
    *  3) The alertpipe needs to get poked for every frame that was already
    *     on the new channel, since we are now using the alert pipe from the
    *     old (clone) channel.
    */
   {
      AST_LIST_HEAD_NOLOCK(, ast_frame) tmp_readq;
      AST_LIST_HEAD_SET_NOLOCK(&tmp_readq, NULL);

      AST_LIST_APPEND_LIST(&tmp_readq, &original->readq, frame_list);
      AST_LIST_APPEND_LIST(&original->readq, &clonechan->readq, frame_list);

      while ((current = AST_LIST_REMOVE_HEAD(&tmp_readq, frame_list))) {
         AST_LIST_INSERT_TAIL(&original->readq, current, frame_list);
         if (original->alertpipe[1] > -1) {
            int poke = 0;

            if (write(original->alertpipe[1], &poke, sizeof(poke)) < 0) {
               ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
            }
         }
      }
   }

   /* Swap the raw formats */
   x = original->rawreadformat;
   original->rawreadformat = clonechan->rawreadformat;
   clonechan->rawreadformat = x;
   x = original->rawwriteformat;
   original->rawwriteformat = clonechan->rawwriteformat;
   clonechan->rawwriteformat = x;

   clonechan->_softhangup = AST_SOFTHANGUP_DEV;

   /* And of course, so does our current state.  Note we need not
      call ast_setstate since the event manager doesn't really consider
      these separate.  We do this early so that the clone has the proper
      state of the original channel. */
   origstate = original->_state;
   original->_state = clonechan->_state;
   clonechan->_state = origstate;

   if (clonechan->tech->fixup){
      res = clonechan->tech->fixup(original, clonechan);
      if (res)
         ast_log(LOG_WARNING, "Fixup failed on channel %s, strange things may happen.\n", clonechan->name);
   }

   /* Start by disconnecting the original's physical side */
   if (clonechan->tech->hangup)
      res = clonechan->tech->hangup(clonechan);
   if (res) {
      ast_log(LOG_WARNING, "Hangup failed!  Strange things may happen!\n");
      ast_channel_unlock(clonechan);
      return -1;
   }

   snprintf(zombn, sizeof(zombn), "%s<ZOMBIE>", orig);
   /* Mangle the name of the clone channel */
   ast_string_field_set(clonechan, name, zombn);
   manager_event(EVENT_FLAG_CALL, "Rename", "Channel: %s\r\nNewname: %s\r\nUniqueid: %s\r\n", masqn, zombn, clonechan->uniqueid);

   /* Update the type. */
   t_pvt = original->monitor;
   original->monitor = clonechan->monitor;
   clonechan->monitor = t_pvt;

   /* Keep the same language.  */
   ast_string_field_set(original, language, clonechan->language);
   /* Copy the FD's other than the generator fd */
   for (x = 0; x < AST_MAX_FDS; x++) {
      if (x != AST_GENERATOR_FD)
         ast_channel_set_fd(original, x, clonechan->fds[x]);
   }

   ast_app_group_update(clonechan, original);

   /* Move data stores over */
   if (AST_LIST_FIRST(&clonechan->datastores)) {
      struct ast_datastore *ds;
      /* We use a safe traversal here because some fixup routines actually
       * remove the datastore from the list and free them.
       */
      AST_LIST_TRAVERSE_SAFE_BEGIN(&clonechan->datastores, ds, entry) {
         if (ds->info->chan_fixup)
            ds->info->chan_fixup(ds->data, clonechan, original);
      }
      AST_LIST_TRAVERSE_SAFE_END;
      AST_LIST_APPEND_LIST(&original->datastores, &clonechan->datastores, entry);
   }

   clone_variables(original, clonechan);
   /* Presense of ADSI capable CPE follows clone */
   original->adsicpe = clonechan->adsicpe;
   /* Bridge remains the same */
   /* CDR fields remain the same */
   /* XXX What about blocking, softhangup, blocker, and lock and blockproc? XXX */
   /* Application and data remain the same */
   /* Clone exception  becomes real one, as with fdno */
   ast_set_flag(original, ast_test_flag(clonechan, AST_FLAG_OUTGOING | AST_FLAG_EXCEPTION));
   original->fdno = clonechan->fdno;
   /* Schedule context remains the same */
   /* Stream stuff stays the same */
   /* Keep the original state.  The fixup code will need to work with it most likely */

   /* Just swap the whole structures, nevermind the allocations, they'll work themselves
      out. */
   tmpcid = original->cid;
   original->cid = clonechan->cid;
   clonechan->cid = tmpcid;
   report_new_callerid(original);

   /* Restore original timing file descriptor */
   ast_channel_set_fd(original, AST_TIMING_FD, original->timingfd);

   /* Our native formats are different now */
   original->nativeformats = clonechan->nativeformats;

   /* Context, extension, priority, app data, jump table,  remain the same */
   /* pvt switches.  pbx stays the same, as does next */

   /* Set the write format */
   ast_set_write_format(original, wformat);

   /* Set the read format */
   ast_set_read_format(original, rformat);

   /* Copy the music class */
   ast_string_field_set(original, musicclass, clonechan->musicclass);

   ast_debug(1, "Putting channel %s in %d/%d formats\n", original->name, wformat, rformat);

   /* Okay.  Last thing is to let the channel driver know about all this mess, so he
      can fix up everything as best as possible */
   if (original->tech->fixup) {
      res = original->tech->fixup(clonechan, original);
      if (res) {
         ast_log(LOG_WARNING, "Channel for type '%s' could not fixup channel %s\n",
            original->tech->type, original->name);
         ast_channel_unlock(clonechan);
         return -1;
      }
   } else
      ast_log(LOG_WARNING, "Channel type '%s' does not have a fixup routine (for %s)!  Bad things may happen.\n",
         original->tech->type, original->name);

   /* 
    * If an indication is currently playing, maintain it on the channel 
    * that is taking the place of original 
    *
    * This is needed because the masquerade is swapping out in the internals
    * of this channel, and the new channel private data needs to be made
    * aware of the current visible indication (RINGING, CONGESTION, etc.)
    */
   if (original->visible_indication) {
      ast_indicate(original, original->visible_indication);
   }
   
   /* Now, at this point, the "clone" channel is totally F'd up.  We mark it as
      a zombie so nothing tries to touch it.  If it's already been marked as a
      zombie, then free it now (since it already is considered invalid). */
   if (ast_test_flag(clonechan, AST_FLAG_ZOMBIE)) {
      ast_debug(1, "Destroying channel clone '%s'\n", clonechan->name);
      ast_channel_unlock(clonechan);
      manager_event(EVENT_FLAG_CALL, "Hangup",
         "Channel: %s\r\n"
         "Uniqueid: %s\r\n"
         "Cause: %d\r\n"
         "Cause-txt: %s\r\n",
         clonechan->name,
         clonechan->uniqueid,
         clonechan->hangupcause,
         ast_cause2str(clonechan->hangupcause)
         );
      ast_channel_free(clonechan);
   } else {
      ast_debug(1, "Released clone lock on '%s'\n", clonechan->name);
      ast_set_flag(clonechan, AST_FLAG_ZOMBIE);
      ast_queue_frame(clonechan, &ast_null_frame);
      ast_channel_unlock(clonechan);
   }

   /* Signal any blocker */
   if (ast_test_flag(original, AST_FLAG_BLOCKING))
      pthread_kill(original->blocker, SIGURG);
   ast_debug(1, "Done Masquerading %s (%d)\n", original->name, original->_state);
   return 0;
}

static enum ast_bridge_result ast_generic_bridge	(	struct ast_channel *	c0,
		struct ast_channel *	c1,
		struct ast_bridge_config *	config,
		struct ast_frame **	fo,
		struct ast_channel **	rc,
		struct timeval	bridge_end
	)			[static]

Definition at line 4694 of file channel.c.

References ast_channel::_bridge, ast_channel::_softhangup, AST_BRIDGE_COMPLETE, AST_BRIDGE_DTMF_CHANNEL_0, AST_BRIDGE_DTMF_CHANNEL_1, AST_BRIDGE_IGNORE_SIGS, AST_BRIDGE_RETRY, AST_CONTROL_HOLD, AST_CONTROL_SRCUPDATE, AST_CONTROL_T38_PARAMETERS, AST_CONTROL_UNHOLD, AST_CONTROL_VIDUPDATE, ast_debug, AST_FEATURE_WARNING_ACTIVE, AST_FRAME_CONTROL, AST_FRAME_DTMF, AST_FRAME_DTMF_BEGIN, AST_FRAME_DTMF_END, AST_FRAME_HTML, AST_FRAME_IMAGE, AST_FRAME_MODEM, AST_FRAME_TEXT, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_frfree, ast_indicate_data(), ast_jb_do_usecheck(), ast_jb_empty_and_reset(), ast_jb_get_and_deliver(), ast_jb_get_when_to_wakeup(), ast_jb_put(), ast_poll_channel_add(), ast_poll_channel_del(), ast_read(), ast_samp2tv(), ast_set_flag, AST_SOFTHANGUP_UNBRIDGE, ast_tvadd(), ast_tvdiff_ms(), ast_tvnow(), ast_tvzero(), ast_waitfor_n(), ast_write(), ast_frame::data, ast_frame::datalen, f, ast_bridge_config::feature_timer, ast_bridge_config::flags, ast_frame::frametype, ast_channel::name, ast_channel::nativeformats, ast_bridge_config::nexteventts, ast_bridge_config::partialfeature_timer, ast_frame::ptr, ast_frame::subclass, ast_channel::tech_pvt, and ast_bridge_config::timelimit.

Referenced by ast_channel_bridge().

{
   /* Copy voice back and forth between the two channels. */
   struct ast_channel *cs[3];
   struct ast_frame *f;
   enum ast_bridge_result res = AST_BRIDGE_COMPLETE;
   int o0nativeformats;
   int o1nativeformats;
   int watch_c0_dtmf;
   int watch_c1_dtmf;
   void *pvt0, *pvt1;
   /* Indicates whether a frame was queued into a jitterbuffer */
   int frame_put_in_jb = 0;
   int jb_in_use;
   int to;
   
   cs[0] = c0;
   cs[1] = c1;
   pvt0 = c0->tech_pvt;
   pvt1 = c1->tech_pvt;
   o0nativeformats = c0->nativeformats;
   o1nativeformats = c1->nativeformats;
   watch_c0_dtmf = config->flags & AST_BRIDGE_DTMF_CHANNEL_0;
   watch_c1_dtmf = config->flags & AST_BRIDGE_DTMF_CHANNEL_1;

   /* Check the need of a jitterbuffer for each channel */
   jb_in_use = ast_jb_do_usecheck(c0, c1);
   if (jb_in_use)
      ast_jb_empty_and_reset(c0, c1);

   ast_poll_channel_add(c0, c1);

   if (config->feature_timer > 0 && ast_tvzero(config->nexteventts)) {
      /* calculate when the bridge should possibly break
       * if a partial feature match timed out */
      config->partialfeature_timer = ast_tvadd(ast_tvnow(), ast_samp2tv(config->feature_timer, 1000));
   } else {
      memset(&config->partialfeature_timer, 0, sizeof(config->partialfeature_timer));
   }

   for (;;) {
      struct ast_channel *who, *other;

      if ((c0->tech_pvt != pvt0) || (c1->tech_pvt != pvt1) ||
          (o0nativeformats != c0->nativeformats) ||
          (o1nativeformats != c1->nativeformats)) {
         /* Check for Masquerade, codec changes, etc */
         res = AST_BRIDGE_RETRY;
         break;
      }
      if (bridge_end.tv_sec) {
         to = ast_tvdiff_ms(bridge_end, ast_tvnow());
         if (to <= 0) {
            if (config->timelimit) {
               res = AST_BRIDGE_RETRY;
               /* generic bridge ending to play warning */
               ast_set_flag(config, AST_FEATURE_WARNING_ACTIVE);
            } else {
               res = AST_BRIDGE_COMPLETE;
            }
            break;
         }
      } else {
         /* If a feature has been started and the bridge is configured to 
          * to not break, leave the channel bridge when the feature timer
          * time has elapsed so the DTMF will be sent to the other side. 
          */
         if (!ast_tvzero(config->partialfeature_timer)) {
            int diff = ast_tvdiff_ms(config->partialfeature_timer, ast_tvnow());
            if (diff <= 0) {
               res = AST_BRIDGE_RETRY;
               break;
            }
         }
         to = -1;
      }
      /* Calculate the appropriate max sleep interval - in general, this is the time,
         left to the closest jb delivery moment */
      if (jb_in_use)
         to = ast_jb_get_when_to_wakeup(c0, c1, to);
      who = ast_waitfor_n(cs, 2, &to);
      if (!who) {
         /* No frame received within the specified timeout - check if we have to deliver now */
         if (jb_in_use)
            ast_jb_get_and_deliver(c0, c1);
         if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE || c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE) {
            if (c0->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
               c0->_softhangup = 0;
            if (c1->_softhangup == AST_SOFTHANGUP_UNBRIDGE)
               c1->_softhangup = 0;
            c0->_bridge = c1;
            c1->_bridge = c0;
         }
         continue;
      }
      f = ast_read(who);
      if (!f) {
         *fo = NULL;
         *rc = who;
         ast_debug(1, "Didn't get a frame from channel: %s\n",who->name);
         break;
      }

      other = (who == c0) ? c1 : c0; /* the 'other' channel */
      /* Try add the frame info the who's bridged channel jitterbuff */
      if (jb_in_use)
         frame_put_in_jb = !ast_jb_put(other, f);

      if ((f->frametype == AST_FRAME_CONTROL) && !(config->flags & AST_BRIDGE_IGNORE_SIGS)) {
         int bridge_exit = 0;

         switch (f->subclass) {
         case AST_CONTROL_HOLD:
         case AST_CONTROL_UNHOLD:
         case AST_CONTROL_VIDUPDATE:
         case AST_CONTROL_SRCUPDATE:
         case AST_CONTROL_T38_PARAMETERS:
            ast_indicate_data(other, f->subclass, f->data.ptr, f->datalen);
            if (jb_in_use) {
               ast_jb_empty_and_reset(c0, c1);
            }
            break;
         default:
            *fo = f;
            *rc = who;
            bridge_exit = 1;
            ast_debug(1, "Got a FRAME_CONTROL (%d) frame on channel %s\n", f->subclass, who->name);
            break;
         }
         if (bridge_exit)
            break;
      }
      if ((f->frametype == AST_FRAME_VOICE) ||
          (f->frametype == AST_FRAME_DTMF_BEGIN) ||
          (f->frametype == AST_FRAME_DTMF) ||
          (f->frametype == AST_FRAME_VIDEO) ||
          (f->frametype == AST_FRAME_IMAGE) ||
          (f->frametype == AST_FRAME_HTML) ||
          (f->frametype == AST_FRAME_MODEM) ||
          (f->frametype == AST_FRAME_TEXT)) {
         /* monitored dtmf causes exit from bridge */
         int monitored_source = (who == c0) ? watch_c0_dtmf : watch_c1_dtmf;

         if (monitored_source && 
            (f->frametype == AST_FRAME_DTMF_END || 
            f->frametype == AST_FRAME_DTMF_BEGIN)) {
            *fo = f;
            *rc = who;
            ast_debug(1, "Got DTMF %s on channel (%s)\n", 
               f->frametype == AST_FRAME_DTMF_END ? "end" : "begin",
               who->name);

            break;
         }
         /* Write immediately frames, not passed through jb */
         if (!frame_put_in_jb)
            ast_write(other, f);
            
         /* Check if we have to deliver now */
         if (jb_in_use)
            ast_jb_get_and_deliver(c0, c1);
      }
      /* XXX do we want to pass on also frames not matched above ? */
      ast_frfree(f);

#ifndef HAVE_EPOLL
      /* Swap who gets priority */
      cs[2] = cs[0];
      cs[0] = cs[1];
      cs[1] = cs[2];
#endif
   }

   ast_poll_channel_del(c0, c1);

   return res;
}

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

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

Definition at line 1290 of file channel.c.

References channel_find_locked().

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

struct ast_channel* ast_get_channel_by_name_locked

(

const char *

name

)

[read]

Get channel by name and lock it.

Get channel by name or uniqueid (locks channel).

Definition at line 1271 of file channel.c.

References channel_find_locked().

Referenced by acf_import(), action_add_agi_cmd(), action_atxfer(), action_getvar(), action_hangup(), action_redirect(), action_sendtext(), action_setvar(), action_status(), action_timeout(), ast_async_goto_by_name(), ast_bridge_call(), ast_park_call_full(), asyncgoto_exec(), change_monitor_action(), do_pause_or_unpause(), get_dahdi_channel_locked(), handle_channelstatus(), handle_cli_agi_add_cmd(), handle_core_set_debug_channel(), handle_getvariablefull(), handle_hangup(), handle_set_chanvar(), handle_show_chanvar(), handle_showchan(), handle_softhangup(), manager_park(), manager_play_dtmf(), pbx_builtin_importvar(), shared_read(), shared_write(), start_monitor_action(), and stop_monitor_action().

{
   return channel_find_locked(NULL, name, 0, NULL, NULL);
}

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

Get channel by name prefix and lock it.

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

Definition at line 1277 of file channel.c.

References channel_find_locked().

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

{
   return channel_find_locked(NULL, name, namelen, NULL, NULL);
}

struct ast_channel_tech* ast_get_channel_tech

(

const char *

name

)

[read]

Get handle to channel driver based on name.

Get a channel technology structure by name.

Definition at line 609 of file channel.c.

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

Referenced by _ast_device_state().

{
   struct chanlist *chanls;
   const struct ast_channel_tech *ret = NULL;

   AST_RWLIST_RDLOCK(&channels);

   AST_LIST_TRAVERSE(&backends, chanls, list) {
      if (!strcasecmp(name, chanls->tech->type)) {
         ret = chanls->tech;
         break;
      }
   }

   AST_RWLIST_UNLOCK(&channels);
   
   return ret;
}

ast_group_t ast_get_group

(

const char *

s

)

Definition at line 5403 of file channel.c.

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

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

{
   char *piece;
   char *c;
   int start=0, finish=0, x;
   ast_group_t group = 0;

   if (ast_strlen_zero(s))
      return 0;

   c = ast_strdupa(s);
   
   while ((piece = strsep(&c, ","))) {
      if (sscanf(piece, "%30d-%30d", &start, &finish) == 2) {
         /* Range */
      } else if (sscanf(piece, "%30d", &start)) {
         /* Just one */
         finish = start;
      } else {
         ast_log(LOG_ERROR, "Syntax error parsing group configuration '%s' at '%s'. Ignoring.\n", s, piece);
         continue;
      }
      for (x = start; x <= finish; x++) {
         if ((x > 63) || (x < 0)) {
            ast_log(LOG_WARNING, "Ignoring invalid group %d (maximum group is 63)\n", x);
         } else
            group |= ((ast_group_t) 1 << x);
      }
   }
   return group;
}

int ast_hangup

(

struct ast_channel *

chan

)

Hangup a channel.

Hang up a channel.

Definition at line 1641 of file channel.c.

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

Referenced by __ast_pbx_run(), __ast_request_and_dial(), __oh323_new(), action_bridge(), agent_hangup(), agent_read(), alsa_new(), answer_exec_run(), app_exec(), ast_async_goto(), ast_bridge_call_thread(), ast_call_forward(), ast_dial_destroy(), ast_dial_hangup(), ast_feature_request_and_dial(), ast_iax2_new(), ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_pbx_run_app(), async_wait(), begin_dial_channel(), bridge_exec(), build_conf(), builtin_atxfer(), chanavail_exec(), check_compat(), check_goto_on_transfer(), clear_caller(), conf_free(), conf_run(), connect_link(), console_new(), dahdi_handle_event(), dahdi_new(), dial_exec_full(), do_forward(), do_hang(), findmeexec(), gtalk_new(), handle_call_forward(), handle_callforward_button(), handle_enbloc_call_message(), handle_frame(), handle_frame_ownerless(), handle_hd_hf(), handle_init_event(), handle_invite_replaces(), handle_offhook_message(), handle_request_invite(), handle_soft_key_event_message(), handle_stimulus_message(), handle_timeout_trip(), handle_transfer_button(), HandleCallOutgoing(), hangup_chan(), hangupcalls(), hanguptree(), iax2_request(), iax_park(), iax_park_thread(), jingle_new(), local_hangup(), manage_parkinglot(), masq_park_call(), mgcp_new(), mgcp_ss(), monitor_dial(), mwi_thread(), nbs_new(), oss_new(), park_exec_full(), parkandannounce_exec(), phone_new(), rpt(), rpt_call(), rpt_exec(), rpt_tele_thread(), sip_new(), sip_park(), sip_park_thread(), skinny_new(), skinny_ss(), ss_thread(), try_calling(), unistim_new(), usbradio_new(), wait_for_answer(), and wait_for_winner().

{
   int res = 0;

   /* Don't actually hang up a channel that will masquerade as someone else, or
      if someone is going to masquerade as us */
   ast_channel_lock(chan);

   if (chan->audiohooks) {
      ast_audiohook_detach_list(chan->audiohooks);
      chan->audiohooks = NULL;
   }

   ast_autoservice_stop(chan);

   if (chan->masq) {
      if (ast_do_masquerade(chan))
         ast_log(LOG_WARNING, "Failed to perform masquerade\n");
   }

   if (chan->masq) {
      ast_log(LOG_WARNING, "%s getting hung up, but someone is trying to masq into us?!?\n", chan->name);
      ast_channel_unlock(chan);
      return 0;
   }
   /* If this channel is one which will be masqueraded into something,
      mark it as a zombie already, so we know to free it later */
   if (chan->masqr) {
      ast_set_flag(chan, AST_FLAG_ZOMBIE);
      ast_channel_unlock(chan);
      return 0;
   }
   ast_channel_unlock(chan);

   AST_RWLIST_WRLOCK(&channels);
   if (!AST_RWLIST_REMOVE(&channels, chan, chan_list)) {
      ast_log(LOG_ERROR, "Unable to find channel in list to free. Assuming it has already been done.\n");
   }
   ast_clear_flag(chan, AST_FLAG_IN_CHANNEL_LIST);
   AST_RWLIST_UNLOCK(&channels);

   ast_channel_lock(chan);
   free_translation(chan);
   /* Close audio stream */
   if (chan->stream) {
      ast_closestream(chan->stream);
      chan->stream = NULL;
   }
   /* Close video stream */
   if (chan->vstream) {
      ast_closestream(chan->vstream);
      chan->vstream = NULL;
   }
   if (chan->sched) {
      sched_context_destroy(chan->sched);
      chan->sched = NULL;
   }
   
   if (chan->generatordata)   /* Clear any tone stuff remaining */
      if (chan->generator && chan->generator->release)
         chan->generator->release(chan, chan->generatordata);
   chan->generatordata = NULL;
   chan->generator = NULL;
   if (ast_test_flag(chan, AST_FLAG_BLOCKING)) {
      ast_log(LOG_WARNING, "Hard hangup called by thread %ld on %s, while fd "
               "is blocked by thread %ld in procedure %s!  Expect a failure\n",
               (long)pthread_self(), chan->name, (long)chan->blocker, chan->blockproc);
      ast_assert(ast_test_flag(chan, AST_FLAG_BLOCKING) == 0);
   }
   if (!ast_test_flag(chan, AST_FLAG_ZOMBIE)) {
      ast_debug(1, "Hanging up channel '%s'\n", chan->name);
      if (chan->tech->hangup)
         res = chan->tech->hangup(chan);
   } else {
      ast_debug(1, "Hanging up zombie '%s'\n", chan->name);
   }
         
   ast_channel_unlock(chan);
   manager_event(EVENT_FLAG_CALL, "Hangup",
         "Channel: %s\r\n"
         "Uniqueid: %s\r\n"
         "CallerIDNum: %s\r\n"
         "CallerIDName: %s\r\n"
         "Cause: %d\r\n"
         "Cause-txt: %s\r\n",
         chan->name,
         chan->uniqueid,
         S_OR(chan->cid.cid_num, "<unknown>"),
         S_OR(chan->cid.cid_name, "<unknown>"),
         chan->hangupcause,
         ast_cause2str(chan->hangupcause)
         );

   if (chan->cdr && !ast_test_flag(chan->cdr, AST_CDR_FLAG_BRIDGED) && 
      !ast_test_flag(chan->cdr, AST_CDR_FLAG_POST_DISABLED) && 
       (chan->cdr->disposition != AST_CDR_NULL || ast_test_flag(chan->cdr, AST_CDR_FLAG_DIALED))) {
      ast_channel_lock(chan);
         
      ast_cdr_end(chan->cdr);
      ast_cdr_detach(chan->cdr);
      chan->cdr = NULL;
      ast_channel_unlock(chan);
   }
   
   ast_channel_free(chan);

   return res;
}

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

References ast_indicate_data().

Referenced by __ast_play_and_record(), agent_new(), alsa_call(), answer_trunk_chan(), ast_bridge_call(), ast_channel_bridge(), ast_do_masquerade(), ast_dtmf_stream(), ast_feature_request_and_dial(), ast_park_call_full(), ast_raw_answer(), attempt_transfer(), builtin_atxfer(), builtin_blindtransfer(), cli_console_answer(), conf_run(), console_call(), dial_exec_full(), disa_exec(), do_forward(), finishup(), function_remote(), handle_callforward_button(), handle_frame(), handle_recordfile(), manage_parkinglot(), mgcp_ss(), monitor_dial(), oss_call(), park_exec_full(), pbx_builtin_busy(), pbx_builtin_congestion(), pbx_builtin_proceeding(), pbx_builtin_progress(), pbx_builtin_ringing(), pbx_builtin_waitexten(), queue_exec(), record_exec(), rpt(), rpt_exec(), say_periodic_announcement(), say_position(), send_waveform_to_channel(), skinny_ss(), sla_handle_hold_event(), sla_station_exec(), sla_trunk_exec(), try_calling(), and wait_for_answer().

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

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

Indicates condition of channel, with payload.

Note:

Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class

Parameters:

	chan	channel to change the indication
	condition	which condition to indicate on the channel
	data	pointer to payload data
	datalen	size of payload data

Returns:

Returns 0 on success, -1 on failure

Note:

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

Definition at line 3079 of file channel.c.

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

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

{
   /* By using an enum, we'll get compiler warnings for values not handled 
    * in switch statements. */
   enum ast_control_frame_type condition = _condition;
   const struct tone_zone_sound *ts = NULL;
   int res = -1;

   ast_channel_lock(chan);

   /* Don't bother if the channel is about to go away, anyway. */
   if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
      ast_channel_unlock(chan);
      return -1;
   }

   if (chan->tech->indicate) {
      /* See if the channel driver can handle this condition. */
      res = chan->tech->indicate(chan, condition, data, datalen);
   }

   ast_channel_unlock(chan);

   if (!res) {
      /* The channel driver successfully handled this indication */
      if (is_visible_indication(condition)) {
         chan->visible_indication = condition;
      }
      return 0;
   }

   /* The channel driver does not support this indication, let's fake
    * it by doing our own tone generation if applicable. */

   /*!\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. */
   if (_condition < 0) {
      /* Stop any tones that are playing */
      ast_playtones_stop(chan);
      return 0;
   }

   /* Handle conditions that we have tones for. */
   switch (condition) {
   case _XXX_AST_CONTROL_T38:
      /* deprecated T.38 control frame */
      return -1;
   case AST_CONTROL_T38_PARAMETERS:
      /* there is no way to provide 'default' behavior for these
       * control frames, so we need to return failure, but there
       * is also no value in the log message below being emitted
       * since failure to handle these frames is not an 'error'
       * so just return right now.
       */
      return -1;
   case AST_CONTROL_RINGING:
      ts = ast_get_indication_tone(chan->zone, "ring");
      /* It is common practice for channel drivers to return -1 if trying
       * to indicate ringing on a channel which is up. The idea is to let the
       * core generate the ringing inband. However, we don't want the
       * warning message about not being able to handle the specific indication
       * to print nor do we want ast_indicate_data to return an "error" for this
       * condition
       */
      if (chan->_state == AST_STATE_UP) {
         res = 0;
      }
      break;
   case AST_CONTROL_BUSY:
      ts = ast_get_indication_tone(chan->zone, "busy");
      break;
   case AST_CONTROL_CONGESTION:
      ts = ast_get_indication_tone(chan->zone, "congestion");
      break;
   case AST_CONTROL_PROGRESS:
   case AST_CONTROL_PROCEEDING:
   case AST_CONTROL_VIDUPDATE:
   case AST_CONTROL_SRCUPDATE:
   case AST_CONTROL_RADIO_KEY:
   case AST_CONTROL_RADIO_UNKEY:
   case AST_CONTROL_OPTION:
   case AST_CONTROL_WINK:
   case AST_CONTROL_FLASH:
   case AST_CONTROL_OFFHOOK:
   case AST_CONTROL_TAKEOFFHOOK:
   case AST_CONTROL_ANSWER:
   case AST_CONTROL_HANGUP:
   case AST_CONTROL_RING:
   case AST_CONTROL_HOLD:
   case AST_CONTROL_UNHOLD:
      /* Nothing left to do for these. */
      res = 0;
      break;
   }

   if (ts && ts->data[0]) {
      /* We have a tone to play, yay. */
      ast_debug(1, "Driver for channel '%s' does not support indication %d, emulating it\n", chan->name, condition);
      ast_playtones_start(chan, 0, ts->data, 1);
      res = 0;
      chan->visible_indication = condition;
   }

   if (res) {
      /* not handled */
      ast_log(LOG_WARNING, "Unable to handle indication %d for '%s'\n", condition, chan->name);
   }

   return res;
}

void ast_install_music_functions	(	int(*)(struct ast_channel *, const char *, const char *)	start_ptr,
		void(*)(struct ast_channel *)	stop_ptr,
		void(*)(struct ast_channel *)	cleanup_ptr
	)

Definition at line 5439 of file channel.c.

References ast_moh_cleanup_ptr, ast_moh_start_ptr, and ast_moh_stop_ptr.

Referenced by load_module().

{
   ast_moh_start_ptr = start_ptr;
   ast_moh_stop_ptr = stop_ptr;
   ast_moh_cleanup_ptr = cleanup_ptr;
}

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

References ast_debug, ast_opt_internal_timing, and ast_channel::timingfd.

Referenced by add_sdp(), and ast_read_generator_actions().

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

void ast_moh_cleanup

(

struct ast_channel *

chan

)

Definition at line 5473 of file channel.c.

References ast_moh_cleanup_ptr.

Referenced by ast_channel_free().

{
   if (ast_moh_cleanup_ptr)
      ast_moh_cleanup_ptr(chan);
}

int ast_moh_start	(	struct ast_channel *	chan,
		const char *	mclass,
		const char *	interpclass
	)

Turn on music on hold on a given channel.

Parameters:

	chan	The channel structure that will get music on hold
	mclass	The class to use if the musicclass is not currently set on the channel structure.
	interpclass	The class to use if the musicclass is not currently set on the channel structure or in the mclass argument.

Return values:

	Zero	on success
	non-zero	on failure

Definition at line 5456 of file channel.c.

References ast_moh_start_ptr, and ast_verb.

Referenced by alsa_indicate(), app_exec(), conf_run(), conf_start_moh(), console_indicate(), dahdi_indicate(), dial_exec_full(), feature_exec_app(), gtalk_indicate(), handle_setmusic(), iax2_indicate(), jingle_indicate(), key_call(), local_indicate(), mgcp_indicate(), misdn_indication(), moh_handle_digit(), monitor_dial(), oh323_indicate(), oss_indicate(), phone_indicate(), play_moh_exec(), queue_exec(), retrydial_exec(), say_periodic_announcement(), say_position(), sip_indicate(), skinny_indicate(), start_moh_exec(), TransferCallStep1(), unistim_indicate(), usbradio_indicate(), and wait_moh_exec().

{
   if (ast_moh_start_ptr)
      return ast_moh_start_ptr(chan, mclass, interpclass);

   ast_verb(3, "Music class %s requested but no musiconhold loaded.\n", mclass ? mclass : (interpclass ? interpclass : "default"));

   return 0;
}

void ast_moh_stop

(

struct ast_channel *

chan

)

Turn off music on hold on a given channel.

Turn off music on hold on a given channel

Definition at line 5467 of file channel.c.

References ast_moh_stop_ptr.

Referenced by alsa_indicate(), app_exec(), ast_quiet_chan(), conf_run(), console_indicate(), dahdi_indicate(), dial_exec_full(), do_bridge_masquerade(), feature_exec_app(), gtalk_indicate(), handle_setmusic(), iax2_indicate(), jingle_indicate(), key_call(), key_dial_page(), local_indicate(), mgcp_indicate(), misdn_indication(), moh_handle_digit(), monitor_dial(), oh323_indicate(), oss_indicate(), phone_indicate(), play_moh_exec(), queue_exec(), retrydial_exec(), say_periodic_announcement(), say_position(), sip_indicate(), skinny_indicate(), stop_moh_exec(), try_calling(), unistim_hangup(), unistim_indicate(), usbradio_indicate(), and wait_moh_exec().

{
   if (ast_moh_stop_ptr)
      ast_moh_stop_ptr(chan);
}

void ast_poll_channel_add	(	struct ast_channel *	chan0,
		struct ast_channel *	chan1
	)

Add a channel to an optimized waitfor

Definition at line 1561 of file channel.c.

References AST_MAX_FDS, and ast_channel::fds.

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

{
#ifdef HAVE_EPOLL
   struct epoll_event ev;
   int i = 0;

   if (chan0->epfd == -1)
      return;

   /* Iterate through the file descriptors on chan1, adding them to chan0 */
   for (i = 0; i < AST_MAX_FDS; i++) {
      if (chan1->fds[i] == -1)
         continue;
      ev.events = EPOLLIN | EPOLLPRI | EPOLLERR | EPOLLHUP;
      ev.data.ptr = chan1->epfd_data[i];
      epoll_ctl(chan0->epfd, EPOLL_CTL_ADD, chan1->fds[i], &ev);
   }

#endif
   return;
}

void ast_poll_channel_del	(	struct ast_channel *	chan0,
		struct ast_channel *	chan1
	)

Delete a channel from an optimized waitfor

Definition at line 1584 of file channel.c.

References AST_MAX_FDS, and ast_channel::fds.

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

{
#ifdef HAVE_EPOLL
   struct epoll_event ev;
   int i = 0;

   if (chan0->epfd == -1)
      return;

   for (i = 0; i < AST_MAX_FDS; i++) {
      if (chan1->fds[i] == -1)
         continue;
      epoll_ctl(chan0->epfd, EPOLL_CTL_DEL, chan1->fds[i], &ev);
   }

#endif
   return;
}

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

Print call group and pickup group ---.

print call- and pickup groups into buffer

Definition at line 5485 of file channel.c.

References first, and num.

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

{
   unsigned int i;
   int first = 1;
   char num[3];

   buf[0] = '\0';
   
   if (!group) /* Return empty string if no group */
      return buf;

   for (i = 0; i <= 63; i++) {   /* Max group is 63 */
      if (group & ((ast_group_t) 1 << i)) {
            if (!first) {
            strncat(buf, ", ", buflen - strlen(buf) - 1);
         } else {
            first = 0;
         }
         snprintf(num, sizeof(num), "%u", i);
         strncat(buf, num, buflen - strlen(buf) - 1);
      }
   }
   return buf;
}

int ast_prod

(

struct ast_channel *

chan

)

Send empty audio to prime a channel driver.

Definition at line 3311 of file channel.c.

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

Referenced by ast_activate_generator().

{
   struct ast_frame a = { AST_FRAME_VOICE };
   char nothing[128];

   /* Send an empty audio frame to get things moving */
   if (chan->_state != AST_STATE_UP) {
      ast_debug(1, "Prodding channel '%s'\n", chan->name);
      a.subclass = chan->rawwriteformat;
      a.data.ptr = nothing + AST_FRIENDLY_OFFSET;
      a.src = "ast_prod";
      if (ast_write(chan, &a))
         ast_log(LOG_WARNING, "Prodding channel '%s' failed\n", chan->name);
   }
   return 0;
}

int ast_queue_control	(	struct ast_channel *	chan,
		enum ast_control_frame_type	control
	)

Queue a control frame.

Queue a control frame with payload.

Definition at line 1116 of file channel.c.

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

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(), HandleCallIncoming(), jingle_is_answered(), jingle_ringing_ack(), mgcp_call(), misdn_attempt_transfer(), nbs_call(), phone_call(), pickup_do(), process_sdp(), receive_digit(), remote_hold(), send_cause2ast(), setup_rtp_connection(), skinny_call(), skinny_transfer(), skinny_unhold(), ss_thread(), unistim_call(), and update_state().

{
   struct ast_frame f = { AST_FRAME_CONTROL, };

   f.subclass = control;

   return ast_queue_frame(chan, &f);
}

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

Queue a control frame with payload.

Parameters:

	chan	channel to queue frame onto
	control	type of control frame
	data	pointer to payload data to be included in frame
	datalen	number of bytes of payload data

Return values:

	0	success
	non-zero	failure

The supplied payload data is copied into the frame, so the caller's copy is not modified nor freed, and the resulting frame will retain a copy of the data even if the caller frees their local copy.

Note:

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

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

Definition at line 1126 of file channel.c.

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

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

{
   struct ast_frame f = { AST_FRAME_CONTROL, };

   f.subclass = control;
   f.data.ptr = (void *) data;
   f.datalen = datalen;

   return ast_queue_frame(chan, &f);
}

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

References __ast_queue_frame().

Referenced by __ast_read(), __oh323_rtp_create(), __oh323_update_info(), action_atxfer(), agent_new(), alsa_call(), ast_channel_masquerade(), ast_channel_setwhentohangup_tv(), ast_do_masquerade(), ast_dsp_process(), ast_queue_control(), ast_queue_control_data(), ast_queue_hangup(), ast_queue_hangup_with_cause(), ast_softhangup_nolock(), cb_events(), cli_console_answer(), cli_console_dial(), cli_console_flash(), cli_console_sendtext(), console_answer(), console_call(), console_dial(), console_do_answer(), console_flash(), console_sendtext(), 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(), jingle_handle_dtmf(), local_queue_frame(), mgcp_queue_frame(), oh323_simulate_dtmf_end(), oss_call(), process_sdp(), queue_dtmf_readq(), receive_digit(), receive_message(), rpt_call(), stream_monitor(), unistim_do_senddigit(), unistim_senddigit_end(), usbradio_read(), and wakeup_sub().

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

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

References __ast_queue_frame().

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

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

int ast_queue_hangup

(

struct ast_channel *

chan

)

Queue a hangup frame for channel.

Queue a hangup frame.

Definition at line 1084 of file channel.c.

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

Referenced by cleanup_connection(), cli_console_hangup(), close_call(), gtalk_hangup_farend(), gtalk_is_answered(), handle_onhook_message(), handle_request_bye(), handle_request_cancel(), handle_soft_key_event_message(), iax2_destroy(), iax2_queue_hangup(), jingle_hangup_farend(), local_hangup(), and mgcp_queue_hangup().

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

int ast_queue_hangup_with_cause	(	struct ast_channel *	chan,
		int	cause
	)

Queue a hangup frame for channel.

Queue a hangup frame with hangupcause set.

Definition at line 1096 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, ast_frame::data, ast_channel::hangupcause, and ast_frame::uint32.

Referenced by __oh323_update_info(), __sip_autodestruct(), close_call(), close_client(), console_hangup(), dahdi_handle_event(), handle_request_bye(), handle_response(), handle_response_invite(), handle_response_notify(), HandleCallOutgoing(), hangup_chan(), hangup_connection(), misdn_answer(), retrans_pkt(), and TransferCallStep1().

{
   struct ast_frame f = { AST_FRAME_CONTROL, AST_CONTROL_HANGUP };

   if (cause >= 0)
      f.data.uint32 = cause;

   /* Yeah, let's not change a lock-critical value without locking */
   if (!ast_channel_trylock(chan)) {
      chan->_softhangup |= AST_SOFTHANGUP_DEV;
      if (cause < 0)
         f.data.uint32 = chan->hangupcause;

      ast_channel_unlock(chan);
   }

   return ast_queue_frame(chan, &f);
}

int ast_raw_answer	(	struct ast_channel *	chan,
		int	cdr_answer
	)

Answer a channel.

Parameters:

	chan	channel to answer
	cdr_answer	flag to control whether any associated CDR should be marked as 'answered'

This function answers a channel and handles all necessary call setup functions.

Note:

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

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

Return values:

	0	on success
	non-zero	on failure

Definition at line 1750 of file channel.c.

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

Referenced by __ast_answer(), and ast_bridge_call().

{
   int res = 0;

   ast_channel_lock(chan);

   /* You can't answer an outbound call */
   if (ast_test_flag(chan, AST_FLAG_OUTGOING)) {
      ast_channel_unlock(chan);
      return 0;
   }

   /* Stop if we're a zombie or need a soft hangup */
   if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
      ast_channel_unlock(chan);
      return -1;
   }

   ast_channel_unlock(chan);

   switch (chan->_state) {
   case AST_STATE_RINGING:
   case AST_STATE_RING:
      ast_channel_lock(chan);
      if (chan->tech->answer) {
         res = chan->tech->answer(chan);
      }
      ast_setstate(chan, AST_STATE_UP);
      if (cdr_answer) {
         ast_cdr_answer(chan->cdr);
      }
      ast_channel_unlock(chan);
      break;
   case AST_STATE_UP:
      /* Calling ast_cdr_answer when it it has previously been called
       * is essentially a no-op, so it is safe.
       */
      if (cdr_answer) {
         ast_cdr_answer(chan->cdr);
      }
      break;
   default:
      break;
   }

   ast_indicate(chan, -1);
   chan->visible_indication = 0;

   return res;
}

struct ast_frame* ast_read

(

struct ast_channel *

chan

)

[read]

Reads a frame.

Parameters:

chan

channel to read a frame from

Returns:

Returns a frame, or NULL on error. If it returns NULL, you best just stop reading frames and assume the channel has been disconnected.

Definition at line 3029 of file channel.c.

References __ast_read().

Referenced by __adsi_transmit_messages(), __ast_answer(), __ast_play_and_record(), __ast_request_and_dial(), adsi_careful_send(), agent_ack_sleep(), agent_read(), ast_feature_request_and_dial(), ast_generic_bridge(), ast_recvtext(), ast_safe_sleep_conditional(), ast_tonepair(), ast_udptl_bridge(), ast_waitfordigit_full(), async_wait(), autoservice_run(), background_detect_exec(), bridge_native_loop(), bridge_p2p_loop(), builtin_atxfer(), channel_spy(), check_goto_on_transfer(), conf_exec(), conf_flush(), conf_run(), dahdi_bridge(), dictate_exec(), disa_exec(), do_waiting(), echo_exec(), eivr_comm(), find_cache(), handle_recordfile(), handle_speechrecognize(), iax2_bridge(), iax_park_thread(), ices_exec(), isAnsweringMachine(), jack_exec(), launch_asyncagi(), manage_parkinglot(), masq_park_call(), measurenoise(), misdn_bridge(), monitor_dial(), mp3_exec(), NBScat_exec(), receive_dtmf_digits(), record_exec(), recordthread(), rpt(), rpt_exec(), run_agi(), send_tone_burst(), send_waveform_to_channel(), sendurl_exec(), speech_background(), ss_thread(), transmit_audio(), transmit_t38(), wait_for_answer(), wait_for_hangup(), wait_for_winner(), waitforring_exec(), and waitstream_core().

{
   return __ast_read(chan, 0);
}

static void ast_read_generator_actions	(	struct ast_channel *	chan,
		struct ast_frame *	f
	)			[static]

Definition at line 2481 of file channel.c.

References ast_channel_lock, ast_channel_unlock, ast_deactivate_generator(), ast_debug, ast_format_rate(), AST_FRAME_CNG, ast_internal_timing_enabled(), ast_settimeout(), ast_frame::datalen, ast_frame::frametype, ast_generator::generate, ast_channel::generator, generator_force(), ast_channel::generatordata, ast_frame::samples, ast_frame::subclass, ast_channel::timingfd, ast_channel::timingfunc, and ast_channel::writeformat.

Referenced by __ast_read().

{
   if (chan->generator && chan->generator->generate && chan->generatordata &&  !ast_internal_timing_enabled(chan)) {
      void *tmp = chan->generatordata;
      int (*generate)(struct ast_channel *chan, void *tmp, int datalen, int samples) = chan->generator->generate;
      int res;
      int samples;

      if (chan->timingfunc) {
         ast_debug(1, "Generator got voice, switching to phase locked mode\n");
         ast_settimeout(chan, 0, NULL, NULL);
      }

      chan->generatordata = NULL;     /* reset, to let writes go through */

      if (f->subclass != chan->writeformat) {
         float factor;
         factor = ((float) ast_format_rate(chan->writeformat)) / ((float) ast_format_rate(f->subclass));
         samples = (int) ( ((float) f->samples) * factor );
      } else {
         samples = f->samples;
      }
      
      /* This unlock is here based on two assumptions that hold true at this point in the
       * code. 1) this function is only called from within __ast_read() and 2) all generators
       * call ast_write() in their generate callback.
       *
       * The reason this is added is so that when ast_write is called, the lock that occurs 
       * there will not recursively lock the channel. Doing this will cause intended deadlock 
       * avoidance not to work in deeper functions
       */
      ast_channel_unlock(chan);
      res = generate(chan, tmp, f->datalen, samples);
      ast_channel_lock(chan);
      chan->generatordata = tmp;
      if (res) {
         ast_debug(1, "Auto-deactivating generator\n");
         ast_deactivate_generator(chan);
      }

   } else if (f->frametype == AST_FRAME_CNG) {
      if (chan->generator && !chan->timingfunc && (chan->timingfd > -1)) {
         ast_debug(1, "Generator got CNG, switching to timed mode\n");
         ast_settimeout(chan, 50, generator_force, chan);
      }
   }
}

struct ast_frame* ast_read_noaudio

(

struct ast_channel *

chan

)

[read]

Reads a frame, returning AST_FRAME_NULL frame if audio.

Parameters:

chan

channel to read a frame from

Returns:

Returns a frame, or NULL on error. If it returns NULL, you best just stop reading frames and assume the channel has been disconnected.

Note:

Audio is replaced with AST_FRAME_NULL to avoid transcode when the resulting audio is not necessary.

Definition at line 3034 of file channel.c.

References __ast_read().

Referenced by conf_run().

{
   return __ast_read(chan, 1);
}

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

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

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

Definition at line 4011 of file channel.c.

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

Referenced by ast_app_getdata_full(), and ast_readstring().

{
   int pos = 0;   /* index in the buffer where we accumulate digits */
   int to = ftimeout;

   /* Stop if we're a zombie or need a soft hangup */
   if (ast_test_flag(c, AST_FLAG_ZOMBIE) || ast_check_hangup(c))
      return -1;
   if (!len)
      return -1;
   for (;;) {
      int d;
      if (c->stream) {
         d = ast_waitstream_full(c, AST_DIGIT_ANY, audiofd, ctrlfd);
         ast_stopstream(c);
         usleep(1000);
         if (!d)
            d = ast_waitfordigit_full(c, to, audiofd, ctrlfd);
      } else {
         d = ast_waitfordigit_full(c, to, audiofd, ctrlfd);
      }
      if (d < 0)
         return AST_GETDATA_FAILED;
      if (d == 0) {
         s[pos] = '\0';
         return AST_GETDATA_TIMEOUT;
      }
      if (d == 1) {
         s[pos] = '\0';
         return AST_GETDATA_INTERRUPTED;
      }
      if (strchr(enders, d) && (pos == 0)) {
         s[pos] = '\0';
         return AST_GETDATA_EMPTY_END_TERMINATED;
      }
      if (!strchr(enders, d)) {
         s[pos++] = d;
      }
      if (strchr(enders, d) || (pos >= len)) {
         s[pos] = '\0';
         return AST_GETDATA_COMPLETE;
      }
      to = timeout;
   }
   /* Never reached */
   return 0;
}

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

References ast_free, and ast_recvtext().

Referenced by handle_recvchar().

{
   int c;
   char *buf = ast_recvtext(chan, timeout);
   if (buf == NULL)
      return -1;  /* error or timeout */
   c = *(unsigned char *)buf;
   ast_free(buf);
   return c;
}

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

References ast_check_hangup(), AST_CONTROL_HANGUP, AST_FRAME_CONTROL, AST_FRAME_TEXT, ast_frfree, ast_read(), ast_strndup, ast_waitfor(), ast_frame::data, ast_frame::datalen, f, ast_frame::frametype, ast_frame::ptr, and ast_frame::subclass.

Referenced by ast_recvchar(), and handle_recvtext().

{
   int res, done = 0;
   char *buf = NULL;
   
   while (!done) {
      struct ast_frame *f;
      if (ast_check_hangup(chan))
         break;
      res = ast_waitfor(chan, timeout);
      if (res <= 0) /* timeout or error */
         break;
      timeout = res; /* update timeout */
      f = ast_read(chan);
      if (f == NULL)
         break; /* no frame */
      if (f->frametype == AST_FRAME_CONTROL && f->subclass == AST_CONTROL_HANGUP)
         done = 1;   /* force a break */
      else if (f->frametype == AST_FRAME_TEXT) {      /* what we want */
         buf = ast_strndup((char *) f->data.ptr, f->datalen);  /* dup and break */
         done = 1;
      }
      ast_frfree(f);
   }
   return buf;
}

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

Requests a channel.

Parameters:

	type	type of channel to request
	format	requested channel format (codec)
	data	data to pass to the channel requester
	status	status

Request a channel of a given type, with data as optional information used by the low level module

Return values:

	NULL	failure
	non-NULL	channel on success

Definition at line 3906 of file channel.c.

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

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

{
   struct chanlist *chan;
   struct ast_channel *c;
   int capabilities;
   int fmt;
   int res;
   int foo;
   int videoformat = format & AST_FORMAT_VIDEO_MASK;
   int textformat = format & AST_FORMAT_TEXT_MASK;

   if (!cause)
      cause = &foo;
   *cause = AST_CAUSE_NOTDEFINED;

   if (AST_RWLIST_RDLOCK(&channels)) {
      ast_log(LOG_WARNING, "Unable to lock channel list\n");
      return NULL;
   }

   AST_LIST_TRAVERSE(&backends, chan, list) {
      if (strcasecmp(type, chan->tech->type))
         continue;

      capabilities = chan->tech->capabilities;
      fmt = format & AST_FORMAT_AUDIO_MASK;
      if (fmt) {
         /* We have audio - is it possible to connect the various calls to each other? 
            (Avoid this check for calls without audio, like text+video calls)
         */
         res = ast_translator_best_choice(&fmt, &capabilities);
         if (res < 0) {
            ast_log(LOG_WARNING, "No translator path exists for channel type %s (native 0x%x) to 0x%x\n", type, chan->tech->capabilities, format);
            *cause = AST_CAUSE_BEARERCAPABILITY_NOTAVAIL;
            AST_RWLIST_UNLOCK(&channels);
            return NULL;
         }
      }
      AST_RWLIST_UNLOCK(&channels);
      if (!chan->tech->requester)
         return NULL;
      
      if (!(c = chan->tech->requester(type, capabilities | videoformat | textformat, data, cause)))
         return NULL;
      
      /* no need to generate a Newchannel event here; it is done in the channel_alloc call */
      return c;
   }

   ast_log(LOG_WARNING, "No channel type registered for '%s'\n", type);
   *cause = AST_CAUSE_NOSUCHDRIVER;
   AST_RWLIST_UNLOCK(&channels);

   return NULL;
}

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

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

Parameters:

	type	type of channel to request
	format	requested channel format
	data	data to pass to the channel requester
	timeout	maximum amount of time to wait for an answer
	reason	why unsuccessful (if unsuccessful)
	cid_num	Caller-ID Number
	cid_name	Caller-ID Name (ascii)

Returns:

Returns an ast_channel on success or no answer, NULL on failure. Check the value of chan->_state to know if the call was answered or not.

Definition at line 3901 of file channel.c.

References __ast_request_and_dial().

Referenced by ast_pbx_outgoing_exten().

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

int ast_safe_sleep	(	struct ast_channel *	chan,
		int	ms
	)

Wait, look for hangups.

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

Definition at line 1324 of file channel.c.

References ast_safe_sleep_conditional().

Referenced by _ast_adsi_transmit_message_full(), alarmreceiver_exec(), ast_dtmf_stream(), ast_senddigit(), builtin_atxfer(), builtin_parkcall(), conf_run(), dictate_exec(), disa_exec(), flash_exec(), function_ilink(), handle_callforward_button(), login_exec(), mgcp_ss(), milliwatt_exec(), misdn_check_l2l1(), old_milliwatt_exec(), park_call_exec(), pbx_builtin_wait(), play_moh_exec(), play_tone_pair(), playtone(), privacy_exec(), receive_ademco_contact_id(), rpt_call(), rpt_exec(), rpt_tele_thread(), send_morse(), send_tone_telemetry(), skinny_ss(), ss_thread(), testclient_exec(), testserver_exec(), try_calling(), wait_for_hangup(), wait_interval(), wait_moh_exec(), waituntil_exec(), and zapateller_exec().

{
   return ast_safe_sleep_conditional(chan, ms, NULL, NULL);
}

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

Wait, look for hangups and condition arg.

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

Definition at line 1303 of file channel.c.

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

Referenced by ast_safe_sleep(), and login_exec().

{
   struct ast_frame *f;

   while (ms > 0) {
      if (cond && ((*cond)(data) == 0))
         return 0;
      ms = ast_waitfor(chan, ms);
      if (ms < 0)
         return -1;
      if (ms > 0) {
         f = ast_read(chan);
         if (!f)
            return -1;
         ast_frfree(f);
      }
   }
   return 0;
}

int ast_say_character_str	(	struct ast_channel *	chan,
		const char *	str,
		const char *	ints,
		const char *	lang
	)

Definition at line 5757 of file channel.c.

References ast_say_character_str_full.

Referenced by common_exec(), pbx_builtin_saycharacters(), play_mailbox_owner(), rpt_tele_thread(), saycharstr(), and saynode().

{
   return ast_say_character_str_full(chan, str, ints, lang, -1, -1);
}

int ast_say_digit_str	(	struct ast_channel *	chan,
		const char *	str,
		const char *	ints,
		const char *	lang
	)

Definition at line 5751 of file channel.c.

References ast_say_digit_str_full.

Referenced by forward_message(), invent_message(), mgcp_ss(), pbx_builtin_saydigits(), play_message_callerid(), and ss_thread().

{
   return ast_say_digit_str_full(chan, str, ints, lang, -1, -1);
}

int ast_say_digits	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang
	)

Definition at line 5745 of file channel.c.

References ast_say_digits_full().

Referenced by ast_park_call_full(), common_exec(), conf_exec(), conf_run(), parkandannounce_exec(), and rpt_tele_thread().

{
   return ast_say_digits_full(chan, num, ints, lang, -1, -1);
}

int ast_say_digits_full	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	lang,
		int	audiofd,
		int	ctrlfd
	)

Definition at line 5769 of file channel.c.

References ast_say_digit_str_full.

Referenced by ast_say_digits(), ast_say_enumeration_full_da(), ast_say_enumeration_full_de(), ast_say_number_full_cs(), ast_say_number_full_da(), ast_say_number_full_de(), ast_say_number_full_en(), ast_say_number_full_en_GB(), ast_say_number_full_es(), ast_say_number_full_fr(), ast_say_number_full_he(), ast_say_number_full_hu(), ast_say_number_full_it(), ast_say_number_full_ka(), ast_say_number_full_nl(), ast_say_number_full_no(), ast_say_number_full_pt(), ast_say_number_full_ru(), ast_say_number_full_se(), ast_say_number_full_th(), ast_say_number_full_zh(), and say_init_mode().

{
   char buf[256];

   snprintf(buf, sizeof(buf), "%d", num);

   return ast_say_digit_str_full(chan, buf, ints, lang, audiofd, ctrlfd);
}

int ast_say_enumeration	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	language,
		const char *	options
	)

Definition at line 5739 of file channel.c.

References ast_say_enumeration_full.

Referenced by ast_say_date_da(), ast_say_date_de(), ast_say_date_with_format_da(), ast_say_date_with_format_de(), ast_say_date_with_format_en(), and ast_say_date_with_format_pl().

{
   return ast_say_enumeration_full(chan, num, ints, language, options, -1, -1);
}

int ast_say_number	(	struct ast_channel *	chan,
		int	num,
		const char *	ints,
		const char *	language,
		const char *	options
	)

Definition at line 5733 of file channel.c.

References ast_say_number_full.

Referenced by ast_say_date_da(), ast_say_date_de(), ast_say_date_en(), ast_say_date_fr(), ast_say_date_gr(), ast_say_date_he(), ast_say_date_hu(), ast_say_date_ka(), ast_say_date_nl(), ast_say_date_pt(), ast_say_date_th(), ast_say_date_with_format_da(), ast_say_date_with_format_de(), ast_say_date_with_format_en(), ast_say_date_with_format_es(), ast_say_date_with_format_fr(), ast_say_date_with_format_it(), ast_say_date_with_format_nl(), ast_say_date_with_format_pl(), ast_say_date_with_format_pt(), ast_say_date_with_format_th(), ast_say_datetime_en(), ast_say_datetime_fr(), ast_say_datetime_from_now_en(), ast_say_datetime_from_now_fr(), ast_say_datetime_from_now_he(), ast_say_datetime_from_now_ka(), ast_say_datetime_from_now_pt(), ast_say_datetime_he(), ast_say_datetime_pt(), ast_say_datetime_th(), ast_say_datetime_zh(), ast_say_time_de(), ast_say_time_en(), ast_say_time_fr(), ast_say_time_gr(), ast_say_time_hu(), ast_say_time_ka(), ast_say_time_nl(), ast_say_time_pt(), ast_say_time_pt_BR(), ast_say_time_th(), ast_say_time_zh(), bridge_playfile(), conf_exec(), conf_run(), count_exec(), dictate_exec(), get_folder(), gr_say_number_female(), pbx_builtin_saynumber(), play_message(), play_message_duration(), rpt_tele_thread(), say_and_wait(), say_position(), saynum(), try_calling(), vm_intro_gr(), vm_intro_he(), vm_intro_multilang(), vm_intro_pt(), and vm_intro_pt_BR().

{
   return ast_say_number_full(chan, num, ints, language, options, -1, -1);
}

int ast_say_phonetic_str	(	struct ast_channel *	chan,
		const char *	str,
		const char *	ints,
		const char *	lang
	)

Definition at line 5763 of file channel.c.

References ast_say_phonetic_str_full.

Referenced by pbx_builtin_sayphonetic().

{
   return ast_say_phonetic_str_full(chan, str, ints, lang, -1, -1);
}

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

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

Parameters:

	chan	channel to act upon
	digit	the DTMF digit to send, encoded in ASCII
	duration	the duration of the digit ending in ms

Returns:

Returns 0 on success, -1 on failure

Definition at line 3301 of file channel.c.

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

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

{
   if (chan->tech->send_digit_begin) {
      ast_senddigit_begin(chan, digit);
      ast_safe_sleep(chan, (duration >= AST_DEFAULT_EMULATE_DTMF_DURATION ? duration : AST_DEFAULT_EMULATE_DTMF_DURATION));
   }
   
   return ast_senddigit_end(chan, digit, (duration >= AST_DEFAULT_EMULATE_DTMF_DURATION ? duration : AST_DEFAULT_EMULATE_DTMF_DURATION));
}

int ast_senddigit_begin	(	struct ast_channel *	chan,
		char	digit
	)

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

Parameters:

	chan	channel to act upon
	digit	the DTMF digit to send, encoded in ASCII

Returns:

Returns 0 on success, -1 on failure

Definition at line 3243 of file channel.c.

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

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

{
   /* Device does not support DTMF tones, lets fake
    * it by doing our own generation. */
   static const char* dtmf_tones[] = {
      "941+1336", /* 0 */
      "697+1209", /* 1 */
      "697+1336", /* 2 */
      "697+1477", /* 3 */
      "770+1209", /* 4 */
      "770+1336", /* 5 */
      "770+1477", /* 6 */
      "852+1209", /* 7 */
      "852+1336", /* 8 */
      "852+1477", /* 9 */
      "697+1633", /* A */
      "770+1633", /* B */
      "852+1633", /* C */
      "941+1633", /* D */
      "941+1209", /* * */
      "941+1477"  /* # */
   };

   if (!chan->tech->send_digit_begin)
      return 0;

   if (!chan->tech->send_digit_begin(chan, digit))
      return 0;

   if (digit >= '0' && digit <='9')
      ast_playtones_start(chan, 0, dtmf_tones[digit-'0'], 0);
   else if (digit >= 'A' && digit <= 'D')
      ast_playtones_start(chan, 0, dtmf_tones[digit-'A'+10], 0);
   else if (digit == '*')
      ast_playtones_start(chan, 0, dtmf_tones[14], 0);
   else if (digit == '#')
      ast_playtones_start(chan, 0, dtmf_tones[15], 0);
   else {
      /* not handled */
      ast_debug(1, "Unable to generate DTMF tone '%c' for '%s'\n", digit, chan->name);
   }

   return 0;
}

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

Send a DTMF digit to a channel.

Send a DTMF digit to a channel.

Parameters:

	chan	channel to act upon
	digit	the DTMF digit to send, encoded in ASCII
	duration	the duration of the digit ending in ms

Returns:

Returns 0 on success, -1 on failure

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

{
   int res = -1;

   if (chan->tech->send_digit_end)
      res = chan->tech->send_digit_end(chan, digit, duration);

   if (res && chan->generator)
      ast_playtones_stop(chan);
   
   return 0;
}

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

Sends text to a channel.

Parameters:

	chan	channel to act upon
	text	string of text to send on the channel

Write text to a display on a channel

Note:

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

Return values:

	0	on success
	-1	on failure

Definition at line 3230 of file channel.c.

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

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

{
   int res = 0;
   /* Stop if we're a zombie or need a soft hangup */
   if (ast_test_flag(chan, AST_FLAG_ZOMBIE) || ast_check_hangup(chan))
      return -1;
   CHECK_BLOCKING(chan);
   if (chan->tech->send_text)
      res = chan->tech->send_text(chan, text);
   ast_clear_flag(chan, AST_FLAG_BLOCKING);
   return res;
}

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

Set caller ID number, name and ANI.

Note:

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

Definition at line 4588 of file channel.c.

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

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

{
   ast_channel_lock(chan);

   if (cid_num) {
      if (chan->cid.cid_num)
         ast_free(chan->cid.cid_num);
      chan->cid.cid_num = ast_strdup(cid_num);
   }
   if (cid_name) {
      if (chan->cid.cid_name)
         ast_free(chan->cid.cid_name);
      chan->cid.cid_name = ast_strdup(cid_name);
   }
   if (cid_ani) {
      if (chan->cid.cid_ani)
         ast_free(chan->cid.cid_ani);
      chan->cid.cid_ani = ast_strdup(cid_ani);
   }

   report_new_callerid(chan);

   ast_channel_unlock(chan);
}

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

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

Referenced by __ast_play_and_record(), __oh323_update_info(), _ast_adsi_transmit_message_full(), agent_call(), alarmreceiver_exec(), ast_channel_make_compatible_helper(), ast_do_masquerade(), attempt_reconnect(), background_detect_exec(), build_conf(), conf_run(), connect_link(), dictate_exec(), do_waiting(), eagi_exec(), echo_exec(), gtalk_rtp_read(), handle_recordfile(), handle_speechrecognize(), ices_exec(), isAnsweringMachine(), jack_exec(), jingle_rtp_read(), login_exec(), measurenoise(), mgcp_rtp_read(), oh323_rtp_read(), old_milliwatt_exec(), process_sdp(), record_exec(), rpt(), rpt_exec(), setup_rtp_connection(), sip_rtp_read(), skinny_rtp_read(), socket_process(), speech_background(), transmit_audio(), and unistim_rtp_read().

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

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

{
   struct ast_variable *cur;

   for (cur = vars; cur; cur = cur->next)
      pbx_builtin_setvar_helper(chan, cur->name, cur->value);  
}

int ast_set_write_format	(	struct ast_channel *	chan,
		int	format
	)

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

Parameters:

	chan	channel to change
	format	new format for writing

Returns:

Returns 0 on success, -1 on failure

Definition at line 3657 of file channel.c.

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

Referenced by __oh323_update_info(), _ast_adsi_transmit_message_full(), agent_call(), alarmreceiver_exec(), ast_channel_make_compatible_helper(), 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(), echo_exec(), extenspy_exec(), gtalk_rtp_read(), jack_exec(), jingle_rtp_read(), linear_alloc(), linear_release(), login_exec(), 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(), rpt_exec(), send_waveform_to_channel(), setup_rtp_connection(), sip_rtp_read(), skinny_rtp_read(), socket_process(), tonepair_alloc(), tonepair_release(), transmit_audio(), and unistim_rtp_read().

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

int ast_setstate	(	struct ast_channel *	chan,
		enum ast_channel_state	state
	)

Change the state of a channel.

Definition at line 4613 of file channel.c.

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

Referenced by __ast_read(), __dahdi_exception(), __oh323_update_info(), agent_call(), alsa_answer(), ast_raw_answer(), cb_events(), check_availability(), console_answer(), dahdi_answer(), dahdi_call(), dahdi_handle_event(), dahdi_indicate(), dahdi_read(), do_bridge_masquerade(), gtalk_call(), gtalk_newcall(), handle_invite_replaces(), handle_offhook_message(), handle_request_invite(), handle_response_invite(), handle_soft_key_event_message(), handle_stimulus_message(), iax2_call(), jingle_call(), jingle_newcall(), mgcp_answer(), mgcp_call(), mgcp_ss(), misdn_call(), misdn_indication(), nbs_call(), nbs_hangup(), oh323_answer(), oss_answer(), pbx_builtin_busy(), pbx_builtin_congestion(), phone_answer(), phone_call(), phone_exception(), phone_hangup(), phone_write(), release_chan(), release_chan_early(), sip_answer(), skinny_answer(), skinny_call(), skinny_newcall(), ss_thread(), unistim_answer(), unistim_call(), unistim_new(), unistim_ss(), update_state(), usbradio_answer(), and usbradio_call().

{
   int oldstate = chan->_state;
   char name[AST_CHANNEL_NAME], *dashptr;

   if (oldstate == state)
      return 0;

   ast_copy_string(name, chan->name, sizeof(name));
   if ((dashptr = strrchr(name, '-'))) {
      *dashptr = '\0';
   }

   chan->_state = state;

   /* We have to pass AST_DEVICE_UNKNOWN here because it is entirely possible that the channel driver
    * for this channel is using the callback method for device state. If we pass in an actual state here
    * we override what they are saying the state is and things go amuck. */
   ast_devstate_changed_literal(AST_DEVICE_UNKNOWN, name);

   /* setstate used to conditionally report Newchannel; this is no more */
   manager_event(EVENT_FLAG_CALL,
            "Newstate",
            "Channel: %s\r\n"
            "ChannelState: %d\r\n"
            "ChannelStateDesc: %s\r\n"
            "CallerIDNum: %s\r\n"
            "CallerIDName: %s\r\n"
            "Uniqueid: %s\r\n",
            chan->name, chan->_state, ast_state2str(chan->_state),
            S_OR(chan->cid.cid_num, ""),
            S_OR(chan->cid.cid_name, ""),
            chan->uniqueid);

   return 0;
}

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

Enable or disable timer ticks for a channel.

Parameters:

rate

number of timer ticks per second

If timers are supported, force a scheduled expiration on the timer fd, at which point we call the callback function / data

Call this function with a rate of 0 to turn off the timer ticks

Version:

1.6.1 changed samples parameter to rate, accomodates new timing methods

Definition at line 2356 of file channel.c.

References ast_channel_lock, ast_channel_unlock, ast_debug, ast_timer_get_max_rate(), ast_timer_set_rate(), ast_channel::timer, 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().

{
   int res;
   unsigned int real_rate = rate, max_rate;

   ast_channel_lock(c);

   if (c->timingfd == -1) {
      ast_channel_unlock(c);
      return -1;
   }

   if (!func) {
      rate = 0;
      data = NULL;
   }

   if (rate && rate > (max_rate = ast_timer_get_max_rate(c->timer))) {
      real_rate = max_rate;
   }

   ast_debug(1, "Scheduling timer at (%u requested / %u actual) timer ticks per second\n", rate, real_rate);

   res = ast_timer_set_rate(c->timer, real_rate);

   c->timingfunc = func;
   c->timingdata = data;

   ast_channel_unlock(c);

   return res;
}

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

Referenced by handle_request_options().

{
   return shutting_down;
}

int ast_softhangup	(	struct ast_channel *	chan,
		int	cause
	)

Softly hangup a channel, lock.

Softly hangup up a channel.

Definition at line 1617 of file channel.c.

References ast_channel_lock, ast_channel_unlock, and ast_softhangup_nolock().

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

{
   int res;

   ast_channel_lock(chan);
   res = ast_softhangup_nolock(chan, cause);
   ast_channel_unlock(chan);

   return res;
}

int ast_softhangup_nolock	(	struct ast_channel *	chan,
		int	cause
	)

Softly hangup a channel, don't lock.

Softly hangup up a channel (no channel lock).

Definition at line 1604 of file channel.c.

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

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

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

const char* ast_state2str

(

enum ast_channel_state

state

)

Gives the string form of a given channel state.

Note:

This function is not reentrant.

Definition at line 656 of file channel.c.

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

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

{
   char *buf;

   switch (state) {
   case AST_STATE_DOWN:
      return "Down";
   case AST_STATE_RESERVED:
      return "Rsrvd";
   case AST_STATE_OFFHOOK:
      return "OffHook";
   case AST_STATE_DIALING:
      return "Dialing";
   case AST_STATE_RING:
      return "Ring";
   case AST_STATE_RINGING:
      return "Ringing";
   case AST_STATE_UP:
      return "Up";
   case AST_STATE_BUSY:
      return "Busy";
   case AST_STATE_DIALING_OFFHOOK:
      return "Dialing Offhook";
   case AST_STATE_PRERING:
      return "Pre-ring";
   default:
      if (!(buf = ast_threadstorage_get(&state2str_threadbuf, STATE2STR_BUFSIZE)))
         return "Unknown";
      snprintf(buf, STATE2STR_BUFSIZE, "Unknown (%d)", state);
      return buf;
   }
}

int ast_str2cause

(

const char *

name

)

Convert a symbolic hangup cause to number.

Convert the string form of a cause code to a number

Parameters:

name

string form of the cause Returns the cause code

Definition at line 642 of file channel.c.

References ARRAY_LEN, and causes.

Referenced by pbx_builtin_hangup().

{
   int x;

   for (x = 0; x < ARRAY_LEN(causes); x++)
      if (!strncasecmp(causes[x].name, name, strlen(causes[x].name)))
         return causes[x].cause;

   return -1;
}

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

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

Referenced by zapateller_exec().

{
   int res;

   if ((res = ast_tonepair_start(chan, freq1, freq2, duration, vol)))
      return res;

   /* Give us some wiggle room */
   while (chan->generatordata && ast_waitfor(chan, 100) >= 0) {
      struct ast_frame *f = ast_read(chan);
      if (f)
         ast_frfree(f);
      else
         return -1;
   }
   return 0;
}

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

Start a tone going

Definition at line 5367 of file channel.c.

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

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

{
   struct tonepair_def d = { 0, };

   d.freq1 = freq1;
   d.freq2 = freq2;
   d.duration = duration;
   d.vol = (vol < 1) ? 8192 : vol; /* force invalid to 8192 */
   if (ast_activate_generator(chan, &tonepair, &d))
      return -1;
   return 0;
}

void ast_tonepair_stop

(

struct ast_channel *

chan

)

Stop a tone from playing

Definition at line 5380 of file channel.c.

References ast_deactivate_generator().

Referenced by sendnoise().

{
   ast_deactivate_generator(chan);
}

int ast_transfer