channel.h File Reference

General Asterisk PBX channel definitions. More...

#include "asterisk/abstract_jb.h"
#include "asterisk/astobj2.h"
#include "asterisk/poll-compat.h"
#include "asterisk/frame.h"
#include "asterisk/sched.h"
#include "asterisk/chanvars.h"
#include "asterisk/config.h"
#include "asterisk/lock.h"
#include "asterisk/cdr.h"
#include "asterisk/utils.h"
#include "asterisk/linkedlists.h"
#include "asterisk/stringfields.h"
#include "asterisk/datastore.h"

Include dependency graph for channel.h:

Go to the source code of this file.

Data Structures
struct	ast_bridge_config
	bridge configuration More...
struct	ast_callerid
	Structure for all kinds of caller ID identifications. More...
struct	ast_channel
	Main Channel structure associated with a channel. More...
struct	ast_channel::autochans
struct	ast_channel::datastores
struct	ast_channel_tech
	Structure to describe a channel "technology", ie a channel driver See for examples:. More...
struct	ast_generator
struct	ast_group_info
	channel group info More...
struct	ast_party_caller
	Caller Party information. More...
struct	ast_party_connected_line
	Connected Line/Party information. More...
struct	ast_party_id
	Information needed to identify an endpoint in a call. More...
struct	ast_party_redirecting
	Redirecting Line information. RDNIS (Redirecting Directory Number Information Service) Where a call diversion or transfer was invoked. More...
struct	ast_party_subaddress
	Information needed to specify a subaddress in a call. More...
struct	outgoing_helper
Defines
#define	AST_AGENT_FD   (AST_MAX_FDS-3)
#define	AST_ALERT_FD   (AST_MAX_FDS-1)
#define	AST_BRIDGE_DTMF_CHANNEL_0   (1 << 0)
	Report DTMF on channel 0.
#define	AST_BRIDGE_DTMF_CHANNEL_1   (1 << 1)
	Report DTMF on channel 1.
#define	AST_BRIDGE_IGNORE_SIGS   (1 << 4)
	Ignore all signal frames except NULL.
#define	AST_BRIDGE_REC_CHANNEL_0   (1 << 2)
	Return all voice frames on channel 0.
#define	AST_BRIDGE_REC_CHANNEL_1   (1 << 3)
	Return all voice frames on channel 1.
#define	ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag,...)
#define	ast_channel_lock(chan)   ao2_lock(chan)
#define	ast_channel_lock_both(chan1, chan2)
	Lock two channels.
#define	AST_CHANNEL_NAME   80
#define	ast_channel_ref(c)   ({ ao2_ref(c, +1); (c); })
	Increase channel reference count.
#define	ast_channel_trylock(chan)   ao2_trylock(chan)
#define	ast_channel_unlock(chan)   ao2_unlock(chan)
#define	ast_channel_unref(c)   ({ ao2_ref(c, -1); (struct ast_channel *) (NULL); })
	Decrease channel reference count.
#define	AST_GENERATOR_FD   (AST_MAX_FDS-4)
#define	AST_MAX_CONTEXT   80
#define	AST_MAX_EXTENSION   80
#define	AST_MAX_FDS   10
#define	AST_TIMING_FD   (AST_MAX_FDS-2)
#define	CHECK_BLOCKING(c)
#define	DATASTORE_INHERIT_FOREVER   INT_MAX
#define	DEBUGCHAN_FLAG   0x80000000
#define	FRAMECOUNT_INC(x)   ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
#define	MAX_LANGUAGE   20
#define	MAX_MUSICCLASS   80
Typedefs
typedef unsigned long long	ast_group_t
Enumerations
enum	{ AST_CHAN_TP_WANTSJITTER = (1 << 0), AST_CHAN_TP_CREATESJITTER = (1 << 1) }
	ast_channel_tech Properties More...
enum	{   AST_FLAG_DEFER_DTMF = (1 << 1), AST_FLAG_WRITE_INT = (1 << 2), AST_FLAG_BLOCKING = (1 << 3), AST_FLAG_ZOMBIE = (1 << 4),   AST_FLAG_EXCEPTION = (1 << 5), AST_FLAG_MOH = (1 << 6), AST_FLAG_SPYING = (1 << 7), AST_FLAG_NBRIDGE = (1 << 8),   AST_FLAG_IN_AUTOLOOP = (1 << 9), AST_FLAG_OUTGOING = (1 << 10), AST_FLAG_IN_DTMF = (1 << 12), AST_FLAG_EMULATE_DTMF = (1 << 13),   AST_FLAG_END_DTMF_ONLY = (1 << 14), AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15), AST_FLAG_MASQ_NOSTREAM = (1 << 16), AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),   AST_FLAG_BRIDGE_HANGUP_DONT = (1 << 18) }
	ast_channel flags More...
enum	{   AST_FEATURE_PLAY_WARNING = (1 << 0), AST_FEATURE_REDIRECT = (1 << 1), AST_FEATURE_DISCONNECT = (1 << 2), AST_FEATURE_ATXFER = (1 << 3),   AST_FEATURE_AUTOMON = (1 << 4), AST_FEATURE_PARKCALL = (1 << 5), AST_FEATURE_AUTOMIXMON = (1 << 6), AST_FEATURE_NO_H_EXTEN = (1 << 7),   AST_FEATURE_WARNING_ACTIVE = (1 << 8) }
	ast_bridge_config flags More...
enum	{ AST_CDR_TRANSFER = (1 << 0), AST_CDR_FORWARD = (1 << 1), AST_CDR_CALLWAIT = (1 << 2), AST_CDR_CONFERENCE = (1 << 3) }
enum	{   AST_SOFTHANGUP_DEV = (1 << 0), AST_SOFTHANGUP_ASYNCGOTO = (1 << 1), AST_SOFTHANGUP_SHUTDOWN = (1 << 2), AST_SOFTHANGUP_TIMEOUT = (1 << 3),   AST_SOFTHANGUP_APPUNLOAD = (1 << 4), AST_SOFTHANGUP_EXPLICIT = (1 << 5), AST_SOFTHANGUP_UNBRIDGE = (1 << 6) }
enum	ast_bridge_result { AST_BRIDGE_COMPLETE = 0, AST_BRIDGE_FAILED = -1, AST_BRIDGE_FAILED_NOWARN = -2, AST_BRIDGE_RETRY = -3 }
enum	ast_channel_adsicpe { AST_ADSI_UNKNOWN, AST_ADSI_AVAILABLE, AST_ADSI_UNAVAILABLE, AST_ADSI_OFFHOOKONLY }
enum	ast_channel_state {   AST_STATE_DOWN, AST_STATE_RESERVED, AST_STATE_OFFHOOK, AST_STATE_DIALING,   AST_STATE_RING, AST_STATE_RINGING, AST_STATE_UP, AST_STATE_BUSY,   AST_STATE_DIALING_OFFHOOK, AST_STATE_PRERING, AST_STATE_MUTE = (1 << 16) }
	ast_channel states More...
enum	ast_t38_state {   T38_STATE_UNAVAILABLE, T38_STATE_UNKNOWN, T38_STATE_NEGOTIATING, T38_STATE_REJECTED,   T38_STATE_NEGOTIATED }
	Possible T38 states on channels. More...
enum	channelreloadreason { CHANNEL_MODULE_LOAD, CHANNEL_MODULE_RELOAD, CHANNEL_CLI_RELOAD, CHANNEL_MANAGER_RELOAD }
	Channel reload reasons for manager events at load or reload of configuration. More...
Functions
int	__ast_answer (struct ast_channel *chan, unsigned int delay, int cdr_answer)
	Answer a channel, with a selectable delay before returning.
struct ast_channel *attribute_malloc	__ast_channel_alloc (int needqueue, int state, const char *cid_num, const char *cid_name, const char *acctcode, const char *exten, const char *context, const char *linkedid, const int amaflag, const char *file, int line, const char *function, const char *name_fmt,...)
	Create a channel structure.
struct ast_channel *	__ast_request_and_dial (const char *type, int format, const struct ast_channel *requestor, void *data, int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh)
	Request a channel of a given type, with data as optional information used by the low level module and attempt to place a call on it.
int	ast_activate_generator (struct ast_channel *chan, struct ast_generator *gen, void *params)
int	ast_active_channels (void)
	returns number of active/allocated channels
static int	ast_add_fd (struct pollfd *pfd, int fd)
	if fd is a valid descriptor, set *pfd with the descriptor
int	ast_answer (struct ast_channel *chan)
	Answer a channel.
int	ast_autoservice_start (struct ast_channel *chan)
	Automatically service a channel for us...
int	ast_autoservice_stop (struct ast_channel *chan)
	Stop servicing a channel for us...
void	ast_begin_shutdown (int hangup)
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 state) attribute_pure
	Gives the string form of a given cause code.
void	ast_change_name (struct ast_channel *chan, const char *newname)
	Change channel name.
int	ast_channel_bridge (struct ast_channel *c0, struct ast_channel *c1, struct ast_bridge_config *config, struct ast_frame **fo, struct ast_channel **rc)
	Bridge two channels together.
struct ast_channel *	ast_channel_callback (ao2_callback_data_fn *cb_fn, void *arg, void *data, int ao2_flags)
	Call a function with every active channel.
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 the settings of when to hang a channel up.
int	ast_channel_connected_line_macro (struct ast_channel *autoservice_chan, struct ast_channel *macro_chan, const void *connected_info, int caller, int frame)
	Run a connected line interception macro and update a channel's connected line information.
int	ast_channel_datastore_add (struct ast_channel *chan, struct ast_datastore *datastore)
	Add a datastore to a channel.
struct ast_datastore *attribute_malloc	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)
	Defers DTMF so that you only read things like hangups and audio.
int	ast_channel_early_bridge (struct ast_channel *c0, struct ast_channel *c1)
	Bridge two channels together (early).
static enum ast_t38_state	ast_channel_get_t38_state (struct ast_channel *chan)
	Retrieves the current T38 state of a channel.
void	ast_channel_inherit_variables (const struct ast_channel *parent, struct ast_channel *child)
	Inherits channel variable from parent to child channel.
int	ast_channel_make_compatible (struct ast_channel *c0, struct ast_channel *c1)
	Makes two channel formats compatible.
int	ast_channel_masquerade (struct ast_channel *original, struct ast_channel *clone)
	Weird function made for call transfers.
int	ast_channel_queryoption (struct ast_channel *channel, int option, void *data, int *datalen, int block)
	Checks the value of an option.
void	ast_channel_queue_connected_line_update (struct ast_channel *chan, const struct ast_party_connected_line *connected)
	Queue a connected line update frame on a channel.
void	ast_channel_queue_redirecting_update (struct ast_channel *chan, const struct ast_party_redirecting *redirecting)
	Queue a redirecting update frame on a channel.
const char *	ast_channel_reason2str (int reason)
	return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
int	ast_channel_register (const struct ast_channel_tech *tech)
	Register a channel technology (a new channel driver) Called by a channel module to register the kind of channels it supports.
struct ast_channel *	ast_channel_release (struct ast_channel *chan)
	Unlink and release reference to a channel.
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.
int	ast_channel_sendurl (struct ast_channel *channel, const char *url)
	Sends a URL on a given link Send URL on link.
void	ast_channel_set_connected_line (struct ast_channel *chan, const struct ast_party_connected_line *connected)
	Set the connected line information in the Asterisk channel.
void	ast_channel_set_fd (struct ast_channel *chan, int which, int fd)
void	ast_channel_set_linkgroup (struct ast_channel *chan, struct ast_channel *peer)
	propagate the linked id between chan and peer
void	ast_channel_set_redirecting (struct ast_channel *chan, const struct ast_party_redirecting *redirecting)
	Set the redirecting id information in the Asterisk channel.
int	ast_channel_setoption (struct ast_channel *channel, int option, void *data, int datalen, int block)
	Sets an option on a channel.
void	ast_channel_setwhentohangup (struct ast_channel *chan, time_t offset)
	Set when to hang a channel up.
void	ast_channel_setwhentohangup_tv (struct ast_channel *chan, struct timeval offset)
	Set when to hang a channel up.
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 *channel)
	Checks for HTML support on a channel.
void	ast_channel_undefer_dtmf (struct ast_channel *chan)
	Unset defer DTMF flag on channel.
void	ast_channel_unregister (const struct ast_channel_tech *tech)
	Unregister a channel technology.
void	ast_channel_update_connected_line (struct ast_channel *chan, const struct ast_party_connected_line *connected)
	Indicate that the connected line information has changed.
void	ast_channel_update_redirecting (struct ast_channel *chan, const struct ast_party_redirecting *redirecting)
	Indicate that the redirecting id has changed.
struct ast_variable *	ast_channeltype_list (void)
	return an ast_variable list of channeltypes
int	ast_check_hangup (struct ast_channel *chan)
	Check to see if a channel is needing hang up.
int	ast_check_hangup_locked (struct ast_channel *chan)
int	ast_connected_line_build_data (unsigned char *data, size_t datalen, const struct ast_party_connected_line *connected)
	Build the connected line information data frame.
void	ast_connected_line_copy_from_caller (struct ast_party_connected_line *dest, const struct ast_callerid *src)
	Copy the caller information to the connected line information.
void	ast_connected_line_copy_to_caller (struct ast_callerid *dest, const struct ast_party_connected_line *src)
	Copy the connected line information to the caller information.
int	ast_connected_line_parse_data (const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected)
	Parse connected line indication frame data.
void	ast_deactivate_generator (struct ast_channel *chan)
int	ast_do_masquerade (struct ast_channel *chan)
	Start masquerading a channel.
struct ast_channel *	ast_dummy_channel_alloc (void)
	Create a fake channel structure.
static int	ast_fdisset (struct pollfd *pfds, int fd, int maximum, int *start)
	Helper function for migrating select to poll.
struct ast_channel_tech *	ast_get_channel_tech (const char *name)
	Get a channel technology structure by name.
ast_group_t	ast_get_group (const char *s)
int	ast_hangup (struct ast_channel *chan)
	Hang up a channel.
int	ast_indicate (struct ast_channel *chan, int condition)
	Indicates condition of channel.
int	ast_indicate_data (struct ast_channel *chan, int condition, const void *data, size_t datalen)
	Indicates condition of channel, with payload.
int	ast_internal_timing_enabled (struct ast_channel *chan)
	Check if the channel can run in internal timing mode.
void	ast_party_caller_copy (struct ast_callerid *dest, const struct ast_callerid *src)
	Copy the source caller information to the destination caller.
void	ast_party_caller_init (struct ast_party_caller *init)
	Initialize the given caller structure.
void	ast_party_connected_line_collect_caller (struct ast_party_connected_line *connected, struct ast_callerid *cid)
	Collect the caller party information into a connected line structure.
void	ast_party_connected_line_copy (struct ast_party_connected_line *dest, const struct ast_party_connected_line *src)
	Copy the source connected line information to the destination connected line.
void	ast_party_connected_line_free (struct ast_party_connected_line *doomed)
	Destroy the connected line information contents.
void	ast_party_connected_line_init (struct ast_party_connected_line *init)
	Initialize the given connected line structure.
void	ast_party_connected_line_set (struct ast_party_connected_line *dest, const struct ast_party_connected_line *src)
	Set the connected line information based on another connected line source.
void	ast_party_connected_line_set_init (struct ast_party_connected_line *init, const struct ast_party_connected_line *guide)
	Initialize the given connected line structure using the given guide for a set update operation.
void	ast_party_redirecting_copy (struct ast_party_redirecting *dest, const struct ast_party_redirecting *src)
	Copy the source redirecting information to the destination redirecting.
void	ast_party_redirecting_free (struct ast_party_redirecting *doomed)
	Destroy the redirecting information contents.
void	ast_party_redirecting_set_init (struct ast_party_redirecting *init, const struct ast_party_redirecting *guide)
	Initialize the given redirecting id structure using the given guide for a set update operation.
void	ast_party_subaddress_copy (struct ast_party_subaddress *dest, const struct ast_party_subaddress *src)
	Copy the source party subaddress information to the destination party subaddress.
void	ast_party_subaddress_free (struct ast_party_subaddress *doomed)
	Destroy the party subaddress contents.
void	ast_party_subaddress_init (struct ast_party_subaddress *init)
	Initialize the given subaddress structure.
void	ast_party_subaddress_set (struct ast_party_subaddress *dest, const struct ast_party_subaddress *src)
	Set the source party subaddress information into the destination party subaddress.
void	ast_party_subaddress_set_init (struct ast_party_subaddress *init, const struct ast_party_subaddress *guide)
	Initialize the given party subadress structure using the given guide for a set update operation.
void	ast_poll_channel_add (struct ast_channel *chan0, struct ast_channel *chan1)
void	ast_poll_channel_del (struct ast_channel *chan0, struct ast_channel *chan1)
char *	ast_print_group (char *buf, int buflen, ast_group_t group)
	print call- and pickup groups into buffer
int	ast_prod (struct ast_channel *chan)
	Send empty audio to prime a channel driver.
int	ast_queue_control (struct ast_channel *chan, enum ast_control_frame_type control)
	Queue a control frame with payload.
int	ast_queue_control_data (struct ast_channel *chan, enum ast_control_frame_type control, const void *data, size_t datalen)
	Queue a control frame with payload.
int	ast_queue_frame (struct ast_channel *chan, struct ast_frame *f)
	Queue one or more frames to a channel's frame queue.
int	ast_queue_frame_head (struct ast_channel *chan, struct ast_frame *f)
	Queue one or more frames to the head of a channel's frame queue.
int	ast_queue_hangup (struct ast_channel *chan)
	Queue a hangup frame.
int	ast_queue_hangup_with_cause (struct ast_channel *chan, int cause)
	Queue a hangup frame with hangupcause set.
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.
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 rtimeout, char *enders)
	Reads multiple digits.
int	ast_readstring_full (struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd)
int	ast_recvchar (struct ast_channel *chan, int timeout)
	Receives a text character from a channel.
char *	ast_recvtext (struct ast_channel *chan, int timeout)
	Receives a text string from a channel Read a string of text from a channel.
int	ast_redirecting_build_data (unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting)
	Build the redirecting id data frame.
int	ast_redirecting_parse_data (const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting)
	Parse redirecting indication frame data.
struct ast_channel *	ast_request (const char *type, int format, const struct ast_channel *requestor, void *data, int *status)
	Requests a channel.
struct ast_channel *	ast_request_and_dial (const char *type, int format, const struct ast_channel *requestor, void *data, int timeout, int *reason, const char *cid_num, const char *cid_name)
	Request a channel of a given type, with data as optional information used by the low level module and attempt to place a call on it.
int	ast_safe_sleep (struct ast_channel *chan, int ms)
	Wait for a specified amount of time, looking for hangups.
int	ast_safe_sleep_conditional (struct ast_channel *chan, int ms, int(*cond)(void *), void *data)
	Wait for a specified amount of time, looking for hangups and a condition argument.
static int	ast_select (int nfds, fd_set *rfds, fd_set *wfds, fd_set *efds, struct timeval *tvp)
	Waits for activity on a group of channels.
int	ast_senddigit (struct ast_channel *chan, char digit, unsigned int duration)
	Send a DTMF digit to a channel.
int	ast_senddigit_begin (struct ast_channel *chan, char digit)
	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.
void	ast_set_hangupsource (struct ast_channel *chan, const char *source, int force)
	Set the source of the hangup in this channel and it's bridge.
int	ast_set_read_format (struct ast_channel *chan, int format)
	Sets read format on channel chan Set read format for channel to whichever component of "format" is best.
void	ast_set_variables (struct ast_channel *chan, struct ast_variable *vars)
	adds a list of channel variables to a channel
int	ast_set_write_format (struct ast_channel *chan, int format)
	Sets write format on channel chan Set write format for channel to whichever component of "format" is best.
int	ast_setstate (struct ast_channel *chan, enum ast_channel_state)
	Change the state of a channel.
int	ast_settimeout (struct ast_channel *c, 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 reason)
	Softly hangup up a channel.
int	ast_softhangup_nolock (struct ast_channel *chan, int reason)
	Softly hangup up a channel (no channel lock).
const char *	ast_state2str (enum ast_channel_state)
	Gives the string form of a given channel state.
int	ast_str2cause (const char *name) attribute_pure
	Convert the string form of a cause code to a number.
int	ast_tonepair (struct ast_channel *chan, int freq1, int freq2, int duration, int vol)
int	ast_tonepair_start (struct ast_channel *chan, int freq1, int freq2, int duration, int vol)
void	ast_tonepair_stop (struct ast_channel *chan)
int	ast_transfer (struct ast_channel *chan, char *dest)
	Transfer a channel (if supported).
char *	ast_transfercapability2str (int transfercapability) attribute_const
	Gives the string form of a given transfer capability.
int	ast_waitfor (struct ast_channel *chan, int ms)
	Wait for input on a channel.
struct ast_channel *	ast_waitfor_n (struct ast_channel **chan, int n, int *ms)
	Waits for input on a group of channels Wait for input on an array of channels for a given # of milliseconds.
int	ast_waitfor_n_fd (int *fds, int n, int *ms, int *exception)
	Waits for input on an fd.
struct ast_channel *	ast_waitfor_nandfds (struct ast_channel **chan, int n, int *fds, int nfds, int *exception, int *outfd, int *ms)
	Waits for activity on a group of channels.
int	ast_waitfordigit (struct ast_channel *c, int ms)
	Waits for a digit.
int	ast_waitfordigit_full (struct ast_channel *c, int ms, int audiofd, int ctrlfd)
	Wait for a digit Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
int	ast_write (struct ast_channel *chan, struct ast_frame *frame)
	Write a frame to a channel This function writes the given frame to the indicated channel.
int	ast_write_text (struct ast_channel *chan, struct ast_frame *frame)
	Write text frame to a channel This function writes the given frame to the indicated channel.
int	ast_write_video (struct ast_channel *chan, struct ast_frame *frame)
	Write video frame to a channel This function writes the given frame to the indicated channel.
const char *	channelreloadreason2txt (enum channelreloadreason reason)
	Convert enum channelreloadreason to text string for manager event.
static void	timersub (struct timeval *tvend, struct timeval *tvstart, struct timeval *tvdiff)
struct ast_channel *	ast_channel_get_by_exten (const char *exten, const char *context)
	Find a channel by extension and context.
struct ast_channel *	ast_channel_get_by_name (const char *name)
	Find a channel by name.
struct ast_channel *	ast_channel_get_by_name_prefix (const char *name, size_t name_len)
	Find a channel by a name prefix.
struct ast_channel_iterator *	ast_channel_iterator_all_new (void)
	Create a new channel iterator.
struct ast_channel_iterator *	ast_channel_iterator_by_exten_new (const char *exten, const char *context)
	Create a new channel iterator based on extension.
struct ast_channel_iterator *	ast_channel_iterator_by_name_new (const char *name, size_t name_len)
	Create a new channel iterator based on name.
struct ast_channel_iterator *	ast_channel_iterator_destroy (struct ast_channel_iterator *i)
	Destroy a channel iterator.
struct ast_channel *	ast_channel_iterator_next (struct ast_channel_iterator *i)
	Get the next channel for a channel iterator.
Variables
unsigned long	global_fin
unsigned long	global_fout

---

Detailed Description

General Asterisk PBX channel definitions.

See also:

• Asterisk Channels
• Module: Asterisk Channel Drivers

Definition in file channel.h.

---

Define Documentation

#define AST_AGENT_FD   (AST_MAX_FDS-3)

used by agents for pass through

Definition at line 161 of file channel.h.

Referenced by agent_read().

#define AST_ALERT_FD   (AST_MAX_FDS-1)

used for alertpipe

Definition at line 159 of file channel.h.

Referenced by __ast_channel_alloc_ap().

#define AST_BRIDGE_DTMF_CHANNEL_0   (1 << 0)

Report DTMF on channel 0.

Definition at line 1705 of file channel.h.

Referenced by ast_generic_bridge(), ast_rtp_instance_bridge(), dahdi_bridge(), iax2_bridge(), local_bridge_loop(), misdn_bridge(), remote_bridge_loop(), and set_config_flags().

#define AST_BRIDGE_DTMF_CHANNEL_1   (1 << 1)

Report DTMF on channel 1.

Definition at line 1707 of file channel.h.

Referenced by ast_generic_bridge(), ast_rtp_instance_bridge(), dahdi_bridge(), iax2_bridge(), local_bridge_loop(), misdn_bridge(), remote_bridge_loop(), and set_config_flags().

#define AST_BRIDGE_IGNORE_SIGS   (1 << 4)

Ignore all signal frames except NULL.

Definition at line 1713 of file channel.h.

Referenced by ast_generic_bridge(), iax2_bridge(), local_bridge_loop(), and remote_bridge_loop().

#define AST_BRIDGE_REC_CHANNEL_0   (1 << 2)

Return all voice frames on channel 0.

Definition at line 1709 of file channel.h.

#define AST_BRIDGE_REC_CHANNEL_1   (1 << 3)

Return all voice frames on channel 1.

Definition at line 1711 of file channel.h.

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

Value:

__ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, linkedid, amaflag, \
             __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)

Definition at line 990 of file channel.h.

Referenced by __oh323_new(), action_bridge(), agent_new(), alsa_new(), ast_async_goto(), ast_iax2_new(), ast_pbx_outgoing_exten(), bridge_exec(), bridge_request(), builtin_atxfer(), check_goto_on_transfer(), console_new(), dahdi_new(), do_notify(), gtalk_new(), iax_park(), jingle_new(), local_new(), masq_park_call(), mgcp_new(), misdn_new(), multicast_rtp_request(), nbs_new(), oss_new(), phone_new(), sip_new(), sip_park(), skinny_new(), unistim_new(), and usbradio_new().

#define ast_channel_lock

(

chan

)

ao2_lock(chan)

Definition at line 2192 of file channel.h.

Referenced by __ast_answer(), __ast_queue_frame(), __ast_read(), __oh323_destroy(), __sip_destroy(), _macro_exec(), _while_exec(), acf_odbc_read(), action_add_agi_cmd(), action_coreshowchannels(), action_hangup(), action_redirect(), action_sendtext(), action_status(), action_timeout(), add_features_datastores(), add_to_agi(), agent_hangup(), agent_indicate(), array_insert(), array_remove(), ast_activate_generator(), ast_async_goto(), ast_audiohook_attach(), ast_audiohook_detach_source(), ast_audiohook_remove(), ast_autochan_destroy(), ast_autochan_setup(), ast_autoservice_start(), ast_autoservice_stop(), ast_bridge_call(), ast_bridge_timelimit(), ast_call(), ast_call_forward(), ast_cel_report_event(), ast_change_name(), ast_channel_cmp_cb(), ast_channel_connected_line_macro(), ast_channel_destructor(), ast_channel_masquerade(), ast_channel_set_connected_line(), ast_channel_set_redirecting(), ast_check_hangup_locked(), ast_complete_channels(), ast_deactivate_generator(), ast_dial_join(), ast_do_masquerade(), ast_eivr_getvariable(), ast_explicit_goto(), ast_hangup(), ast_indicate_data(), ast_odbc_retrieve_transaction_obj(), ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_raw_answer(), ast_read_generator_actions(), ast_rtp_instance_bridge(), ast_rtp_instance_early_bridge(), ast_rtp_instance_early_bridge_make_compatible(), ast_rtp_instance_make_compatible(), ast_set_callerid(), ast_set_hangupsource(), ast_settimeout(), ast_softhangup(), ast_stopstream(), ast_str_retrieve_variable(), ast_transfer(), ast_udptl_bridge(), ast_var_channel_bridge(), ast_var_channels_table(), ast_waitfor_nandfds(), ast_write(), bridge_play_sounds(), builtin_atxfer(), builtin_automixmonitor(), calendar_event_read(), calendar_query_exec(), calendar_query_result_exec(), callerid_read(), callerid_write(), change_t38_state(), channel_set_debug(), channel_spy(), common_exec(), conf_run(), conf_start_moh(), confbridge_exec(), connectedline_read(), connectedline_write(), crement_function_read(), dahdi_bridge(), dahdi_call(), dahdi_handle_dtmfup(), dial_exec_full(), dialog_unlink_all(), disable_jack_hook(), do_forward(), dundi_query_read(), dundi_result_read(), enable_jack_hook(), end_bridge_callback(), enum_query_read(), enum_result_read(), feature_interpret(), feature_request_and_dial(), find_by_mark(), find_calling_channel(), find_conf_realtime(), find_transaction(), func_channel_read(), func_channel_write(), func_channels_read(), func_header_read(), func_inheritance_write(), func_mute_write(), function_sipchaninfo_read(), generator_force(), get_agi_cmd(), get_cid_name(), handle_chanlist(), handle_cli_mixmonitor(), handle_invite_replaces(), handle_request_bye(), handle_request_invite(), handle_showchan(), handle_softhangup(), import_ch(), import_helper(), init_jack_data(), jack_hook_callback(), leave_voicemail(), linkedid_match(), listfilter(), local_attended_transfer(), local_call(), local_hangup(), local_read(), login_exec(), lua_get_state(), manage_parkinglot(), manager_mutestream(), manager_park(), mark_transaction_active(), minivm_delete_exec(), minivm_notify_exec(), misdn_answer(), misdn_hangup(), morsecode_exec(), mute_callback(), my_handle_dtmfup(), notify_new_message(), park_call_full(), park_exec_full(), park_space_reserve(), pbx_builtin_getvar_helper(), pbx_builtin_pushvar_helper(), pbx_builtin_serialize_variables(), pbx_builtin_setvar_helper(), peek_read(), pickup_by_exten(), pickup_by_mark(), pickup_by_name_cb(), pickup_do(), queue_exec(), redirecting_read(), redirecting_write(), release_transaction(), retrydial_exec(), ring_entry(), run_agi(), sendtext_exec(), set_ext_pri(), set_format(), setup_inheritance_datastore(), setup_mixmonitor_ds(), setup_transfer_datastore(), shared_read(), shared_write(), sip_addheader(), sip_dtmfmode(), sip_removeheader(), smdi_msg_read(), smdi_msg_retrieve_read(), softhangup_exec(), speech_background(), speex_read(), speex_write(), start_monitor_action(), state_notify_build_xml(), transmit_invite(), try_calling(), update_bridge_vars(), and wait_for_answer().

#define ast_channel_lock_both	(	chan1,
		chan2		)

Lock two channels.

Definition at line 2199 of file channel.h.

Referenced by ast_pickup_call(), and do_bridge_masquerade().

#define AST_CHANNEL_NAME   80

Max length of an ast_channel name

Definition at line 137 of file channel.h.

Referenced by ast_channel_destructor(), ast_do_masquerade(), ast_parse_device_state(), ast_setstate(), common_exec(), create_jb(), fast_originate(), page_exec(), park_call_full(), softhangup_exec(), and wait_for_answer().

#define ast_channel_ref

(

c

)

({ ao2_ref(c, +1); (c); })

Increase channel reference count.

Parameters:

c

the channel

Return values:

c

always

Since:

1.6.3

Definition at line 2217 of file channel.h.

Referenced by ast_autochan_new_channel(), ast_autochan_setup(), ast_cel_report_event(), handle_getvariablefull(), handle_invite_replaces(), local_attended_transfer(), and try_suggested_sip_codec().

#define ast_channel_trylock

(

chan

)

ao2_trylock(chan)

Definition at line 2194 of file channel.h.

Referenced by __analog_handle_event(), __oh323_rtp_create(), agent_indicate(), agent_logoff(), ast_call_forward(), ast_channel_masquerade(), ast_do_masquerade(), ast_queue_hangup(), ast_queue_hangup_with_cause(), ast_rtp_instance_bridge(), ast_rtp_instance_early_bridge(), ast_rtp_instance_early_bridge_make_compatible(), ast_udptl_bridge(), ast_write(), auto_congest(), bridge_queue_hangup(), bridge_write(), check_bridge(), check_rtp_timeout(), cleanup_connection(), dahdi_bridge(), dahdi_handle_event(), dahdi_queue_frame(), dahdi_softhangup_all(), dial_exec_full(), do_forward(), get_sip_pvt_byid_locked(), grab_owner(), handle_request_bye(), handle_request_do(), handle_request_refer(), hangup_connection(), iax2_destroy(), iax2_queue_control_data(), iax2_queue_frame(), iax2_queue_hangup(), local_call(), local_hangup(), local_queue_frame(), manager_park(), mgcp_queue_frame(), mgcp_queue_hangup(), oh323_rtp_read(), oh323_simulate_dtmf_end(), proc_session_timer(), receive_digit(), remote_hold(), retrans_pkt(), ring_entry(), scheduler_process_request_queue(), set_hangup_source_and_cause(), setup_rtp_connection(), sip_hangup(), sip_park(), socket_process(), try_suggested_sip_codec(), update_state(), wait_for_answer(), and wakeup_sub().

#define ast_channel_unlock

(

chan

)

ao2_unlock(chan)

Definition at line 2193 of file channel.h.

Referenced by __analog_handle_event(), __ast_answer(), __ast_queue_frame(), __ast_read(), __oh323_destroy(), __oh323_rtp_create(), __sip_destroy(), _macro_exec(), _while_exec(), acf_odbc_read(), action_add_agi_cmd(), action_coreshowchannels(), action_hangup(), action_redirect(), action_sendtext(), action_status(), action_timeout(), add_features_datastores(), add_to_agi(), agent_hangup(), agent_indicate(), agent_logoff(), alsa_call(), analog_attempt_transfer(), array_insert(), array_remove(), ast_activate_generator(), ast_async_goto(), ast_audiohook_attach(), ast_audiohook_detach_source(), ast_audiohook_remove(), ast_autochan_destroy(), ast_autochan_setup(), ast_autoservice_start(), ast_autoservice_stop(), ast_bridge_call(), ast_bridge_timelimit(), ast_call(), ast_call_forward(), ast_cel_report_event(), ast_change_name(), ast_channel_cmp_cb(), ast_channel_connected_line_macro(), ast_channel_destructor(), ast_channel_masquerade(), ast_channel_set_connected_line(), ast_channel_set_redirecting(), ast_check_hangup_locked(), ast_complete_channels(), ast_deactivate_generator(), ast_dial_join(), ast_do_masquerade(), ast_eivr_getvariable(), ast_explicit_goto(), ast_hangup(), ast_indicate_data(), ast_odbc_retrieve_transaction_obj(), ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_pickup_call(), ast_queue_hangup(), ast_queue_hangup_with_cause(), ast_raw_answer(), ast_read_generator_actions(), ast_rtp_instance_bridge(), ast_rtp_instance_early_bridge(), ast_rtp_instance_early_bridge_make_compatible(), ast_rtp_instance_make_compatible(), ast_set_callerid(), ast_set_hangupsource(), ast_settimeout(), ast_softhangup(), ast_stopstream(), ast_str_retrieve_variable(), ast_transfer(), ast_udptl_bridge(), ast_var_channel_bridge(), ast_var_channels_table(), ast_waitfor_nandfds(), ast_write(), attempt_transfer(), auto_congest(), bridge_exec(), bridge_play_sounds(), bridge_queue_hangup(), bridge_write(), builtin_atxfer(), builtin_automixmonitor(), calendar_event_read(), calendar_query_exec(), calendar_query_result_exec(), callerid_read(), callerid_write(), change_t38_state(), channel_set_debug(), channel_spy(), check_bridge(), check_rtp_timeout(), cleanup_connection(), common_exec(), conf_run(), conf_start_moh(), confbridge_exec(), connectedline_read(), connectedline_write(), console_answer(), console_hangup(), console_sendtext(), crement_function_read(), dahdi_bridge(), dahdi_call(), dahdi_handle_dtmfup(), dahdi_handle_event(), dahdi_queue_frame(), dahdi_softhangup_all(), dial_exec_full(), dialog_unlink_all(), disable_jack_hook(), do_bridge_masquerade(), do_forward(), dundi_query_read(), dundi_result_read(), enable_jack_hook(), end_bridge_callback(), enum_query_read(), enum_result_read(), fast_originate(), feature_interpret(), feature_request_and_dial(), find_by_mark(), find_calling_channel(), find_conf_realtime(), find_transaction(), func_channel_read(), func_channel_write(), func_channels_read(), func_header_read(), func_inheritance_write(), func_mute_write(), function_sipchaninfo_read(), generator_force(), get_agi_cmd(), get_cid_name(), handle_chanlist(), handle_cli_agi_add_cmd(), handle_cli_mixmonitor(), handle_invite_replaces(), handle_request_bye(), handle_request_do(), handle_request_invite(), handle_request_refer(), handle_showchan(), handle_softhangup(), hangup_connection(), iax2_destroy(), iax2_queue_control_data(), iax2_queue_frame(), iax2_queue_hangup(), import_ch(), import_helper(), init_jack_data(), jack_hook_callback(), leave_voicemail(), linkedid_match(), listfilter(), local_attended_transfer(), local_bridge_loop(), local_call(), local_hangup(), local_queue_frame(), local_read(), login_exec(), lua_get_state(), manage_parkinglot(), manager_mutestream(), manager_park(), mark_transaction_active(), mgcp_queue_frame(), mgcp_queue_hangup(), minivm_delete_exec(), minivm_notify_exec(), misdn_answer(), misdn_hangup(), morsecode_exec(), mute_callback(), my_handle_dtmfup(), notify_new_message(), oh323_rtp_read(), oh323_simulate_dtmf_end(), park_call_full(), park_exec_full(), park_space_reserve(), pbx_builtin_getvar_helper(), pbx_builtin_pushvar_helper(), pbx_builtin_serialize_variables(), pbx_builtin_setvar_helper(), peek_read(), pickup_by_channel(), pickup_by_exten(), pickup_by_mark(), pickup_by_name_cb(), pickup_do(), proc_session_timer(), queue_exec(), receive_digit(), redirecting_read(), redirecting_write(), release_transaction(), remote_bridge_loop(), remote_hold(), retrans_pkt(), retrydial_exec(), ring_entry(), run_agi(), scheduler_process_request_queue(), sendtext_exec(), set_ext_pri(), set_format(), set_hangup_source_and_cause(), setup_inheritance_datastore(), setup_mixmonitor_ds(), setup_rtp_connection(), setup_transfer_datastore(), shared_read(), shared_write(), sip_addheader(), sip_dtmfmode(), sip_hangup(), sip_park(), sip_removeheader(), smdi_msg_read(), smdi_msg_retrieve_read(), socket_process(), softhangup_exec(), speech_background(), speex_read(), speex_write(), start_monitor_action(), state_notify_build_xml(), transmit_invite(), try_calling(), try_suggested_sip_codec(), update_bridge_vars(), update_state(), wait_for_answer(), and wakeup_sub().

#define ast_channel_unref

(

c

)

({ ao2_ref(c, -1); (struct ast_channel *) (NULL); })

Decrease channel reference count.

Parameters:

c

the channel

Return values:

NULL

always

Since:

1.6.3

Definition at line 2228 of file channel.h.

Referenced by __ast_channel_alloc_ap(), action_add_agi_cmd(), action_atxfer(), action_bridge(), action_coreshowchannels(), action_getvar(), action_hangup(), action_redirect(), action_sendtext(), action_setvar(), action_status(), action_timeout(), ast_async_goto_by_name(), ast_autochan_destroy(), ast_autochan_new_channel(), ast_bridge_call(), ast_cel_check_retire_linkedid(), ast_cel_report_event(), ast_channel_release(), ast_complete_channels(), ast_dummy_channel_alloc(), ast_parse_device_state(), ast_pickup_call(), ast_var_channel_bridge(), ast_var_channel_types_table(), ast_var_channels_table(), asyncgoto_exec(), bridge_exec(), change_monitor_action(), common_exec(), do_pause_or_unpause(), func_channels_read(), func_mchan_read(), func_mchan_write(), handle_chanlist(), handle_channelstatus(), handle_cli_agi_add_cmd(), handle_cli_mixmonitor(), handle_core_set_debug_channel(), handle_getvariablefull(), handle_hangup(), handle_invite_replaces(), handle_redirect(), handle_set_chanvar(), handle_show_chanvar(), handle_showchan(), handle_softhangup(), import_helper(), local_attended_transfer(), manager_mutestream(), manager_park(), manager_play_dtmf(), park_call_full(), pbx_builtin_importvar(), pickup_by_channel(), pickup_by_exten(), pickup_by_mark(), shared_read(), shared_write(), softhangup_exec(), start_monitor_action(), state_notify_build_xml(), stop_monitor_action(), and try_suggested_sip_codec().

#define AST_GENERATOR_FD   (AST_MAX_FDS-4)

used by generator

Definition at line 162 of file channel.h.

Referenced by __ast_read(), ast_deactivate_generator(), and ast_do_masquerade().

#define AST_MAX_CONTEXT   80

Max length of a context

Definition at line 136 of file channel.h.

Referenced by _macro_exec(), cleanup_stale_contexts(), common_exec(), conf_run(), config_parse_variables(), dial_transfer(), do_magic_pickup(), gtalk_load_config(), handle_gosub(), handle_request_invite(), reload_config(), and try_calling().

#define AST_MAX_EXTENSION   80

Max length of an extension

Definition at line 135 of file channel.h.

Referenced by __analog_ss_thread(), add_extensions(), advanced_options(), analog_ss_thread(), ast_device_state_changed(), ast_devstate_changed(), ast_ivr_menu_run_internal(), begin_dial_channel(), build_device(), conf_run(), destroy_station(), dial_exec_full(), dial_transfer(), disa_exec(), do_forward(), do_magic_pickup(), dundi_lookup_local(), feature_attended_transfer(), feature_blind_transfer(), find_conf_realtime(), forward_message(), function_enum(), get_destination(), handle_gosub(), handle_request_invite(), handle_statechange(), load_module(), log_exec(), manager_show_dialplan_helper(), mgcp_ss(), phone_check_exception(), process_dahdi(), realtime_switch_common(), search_directory_sub(), show_dialplan_helper(), skinny_extensionstate_cb(), skinny_ss(), sla_build_station(), speech_background(), state_notify_build_xml(), try_calling(), vm_authenticate(), and vmauthenticate().

#define AST_MAX_FDS   10

Definition at line 154 of file channel.h.

Referenced by __ast_channel_alloc_ap(), ast_channel_destructor(), ast_do_masquerade(), ast_poll_channel_add(), ast_poll_channel_del(), ast_waitfor_nandfds(), and manage_parkinglot().

#define AST_TIMING_FD   (AST_MAX_FDS-2)

used for timingfd

Definition at line 160 of file channel.h.

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

#define CHECK_BLOCKING

(

c

)

Definition at line 2153 of file channel.h.

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

#define DATASTORE_INHERIT_FOREVER   INT_MAX

Definition at line 152 of file channel.h.

Referenced by _macro_exec(), acf_iaxvar_write(), add_features_datastores(), ast_channel_datastore_inherit(), ast_iax2_new(), authenticate_reply(), calendar_query_exec(), dial_exec_full(), do_notify(), socket_process(), and try_calling().

#define DEBUGCHAN_FLAG   0x80000000

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

Definition at line 525 of file channel.h.

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

#define FRAMECOUNT_INC

(

x

)

( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )

Definition at line 528 of file channel.h.

Referenced by __ast_read(), and ast_write().

#define MAX_LANGUAGE   20

Max length of the language setting

Definition at line 138 of file channel.h.

#define MAX_MUSICCLASS   80

Max length of the music class setting

Definition at line 139 of file channel.h.

---

Typedef Documentation

typedef unsigned long long ast_group_t

Definition at line 171 of file channel.h.

---

Enumeration Type Documentation

anonymous enum

ast_channel_tech Properties

Enumerator:

AST_CHAN_TP_WANTSJITTER	Channels have this property if they can accept input with jitter; i.e. most VoIP channels.
AST_CHAN_TP_CREATESJITTER	Channels have this property if they can create jitter; i.e. most VoIP channels.

Definition at line 773 of file channel.h.

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

anonymous enum

ast_channel flags

Enumerator:

AST_FLAG_DEFER_DTMF	Queue incoming DTMF, to be released when this flag is turned off
AST_FLAG_WRITE_INT	write should be interrupt generator
AST_FLAG_BLOCKING	a thread is blocking on this channel
AST_FLAG_ZOMBIE	This is a zombie channel
AST_FLAG_EXCEPTION	There is an exception pending
AST_FLAG_MOH	Listening to moh XXX anthm promises me this will disappear XXX
AST_FLAG_SPYING	This channel is spying on another channel
AST_FLAG_NBRIDGE	This channel is in a native bridge
AST_FLAG_IN_AUTOLOOP	the channel is in an auto-incrementing dialplan processor, so when ->priority is set, it will get incremented before finding the next priority to run
AST_FLAG_OUTGOING	This is an outgoing call
AST_FLAG_IN_DTMF	A DTMF_BEGIN frame has been read from this channel, but not yet an END
AST_FLAG_EMULATE_DTMF	A DTMF_END was received when not IN_DTMF, so the length of the digit is currently being emulated
AST_FLAG_END_DTMF_ONLY	This is set to tell the channel not to generate DTMF begin frames, and to instead only generate END frames.
AST_FLAG_ANSWERED_ELSEWHERE	Flag to show channels that this call is hangup due to the fact that the call was indeed answered, but in another channel
AST_FLAG_MASQ_NOSTREAM	This flag indicates that on a masquerade, an active stream should not be carried over
AST_FLAG_BRIDGE_HANGUP_RUN	This flag indicates that the hangup exten was run when the bridge terminated, a message aimed at preventing a subsequent hangup exten being run at the pbx_run level
AST_FLAG_BRIDGE_HANGUP_DONT	This flag indicates that the hangup exten should NOT be run when the bridge terminates, this will allow the hangup in the pbx loop to be run instead.

Definition at line 787 of file channel.h.

     {
   /*! Queue incoming DTMF, to be released when this flag is turned off */
   AST_FLAG_DEFER_DTMF =    (1 << 1),
   /*! write should be interrupt generator */
   AST_FLAG_WRITE_INT =     (1 << 2),
   /*! a thread is blocking on this channel */
   AST_FLAG_BLOCKING =      (1 << 3),
   /*! This is a zombie channel */
   AST_FLAG_ZOMBIE =        (1 << 4),
   /*! There is an exception pending */
   AST_FLAG_EXCEPTION =     (1 << 5),
   /*! Listening to moh XXX anthm promises me this will disappear XXX */
   AST_FLAG_MOH =           (1 << 6),
   /*! This channel is spying on another channel */
   AST_FLAG_SPYING =        (1 << 7),
   /*! This channel is in a native bridge */
   AST_FLAG_NBRIDGE =       (1 << 8),
   /*! the channel is in an auto-incrementing dialplan processor,
    *  so when ->priority is set, it will get incremented before
    *  finding the next priority to run */
   AST_FLAG_IN_AUTOLOOP =   (1 << 9),
   /*! This is an outgoing call */
   AST_FLAG_OUTGOING =      (1 << 10),
   /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
   AST_FLAG_IN_DTMF =       (1 << 12),
   /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is
    *  currently being emulated */
   AST_FLAG_EMULATE_DTMF =  (1 << 13),
   /*! This is set to tell the channel not to generate DTMF begin frames, and
    *  to instead only generate END frames. */
   AST_FLAG_END_DTMF_ONLY = (1 << 14),
   /*! Flag to show channels that this call is hangup due to the fact that the call
       was indeed answered, but in another channel */
   AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15),
   /*! This flag indicates that on a masquerade, an active stream should not
    *  be carried over */
   AST_FLAG_MASQ_NOSTREAM = (1 << 16),
   /*! This flag indicates that the hangup exten was run when the bridge terminated,
    *  a message aimed at preventing a subsequent hangup exten being run at the pbx_run
    *  level */
   AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
   /*! This flag indicates that the hangup exten should NOT be run when the
    *  bridge terminates, this will allow the hangup in the pbx loop to be run instead.
    *  */
   AST_FLAG_BRIDGE_HANGUP_DONT = (1 << 18),
};

anonymous enum

ast_bridge_config flags

Enumerator:

AST_FEATURE_PLAY_WARNING
AST_FEATURE_REDIRECT
AST_FEATURE_DISCONNECT
AST_FEATURE_ATXFER
AST_FEATURE_AUTOMON
AST_FEATURE_PARKCALL
AST_FEATURE_AUTOMIXMON
AST_FEATURE_NO_H_EXTEN
AST_FEATURE_WARNING_ACTIVE

Definition at line 835 of file channel.h.

     {
   AST_FEATURE_PLAY_WARNING = (1 << 0),
   AST_FEATURE_REDIRECT =     (1 << 1),
   AST_FEATURE_DISCONNECT =   (1 << 2),
   AST_FEATURE_ATXFER =       (1 << 3),
   AST_FEATURE_AUTOMON =      (1 << 4),
   AST_FEATURE_PARKCALL =     (1 << 5),
   AST_FEATURE_AUTOMIXMON =   (1 << 6),
   AST_FEATURE_NO_H_EXTEN =   (1 << 7),
   AST_FEATURE_WARNING_ACTIVE = (1 << 8),
};

anonymous enum

Enumerator:

AST_CDR_TRANSFER
AST_CDR_FORWARD
AST_CDR_CALLWAIT
AST_CDR_CONFERENCE

Definition at line 883 of file channel.h.

     {
   AST_CDR_TRANSFER =   (1 << 0),
   AST_CDR_FORWARD =    (1 << 1),
   AST_CDR_CALLWAIT =   (1 << 2),
   AST_CDR_CONFERENCE = (1 << 3),
};

anonymous enum

Enumerator:

AST_SOFTHANGUP_DEV	Soft hangup by device
AST_SOFTHANGUP_ASYNCGOTO	Soft hangup for async goto
AST_SOFTHANGUP_SHUTDOWN
AST_SOFTHANGUP_TIMEOUT
AST_SOFTHANGUP_APPUNLOAD
AST_SOFTHANGUP_EXPLICIT
AST_SOFTHANGUP_UNBRIDGE

Definition at line 890 of file channel.h.

     {
   /*! Soft hangup by device */
   AST_SOFTHANGUP_DEV =       (1 << 0),
   /*! Soft hangup for async goto */
   AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
   AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
   AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
   AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
   AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
   AST_SOFTHANGUP_UNBRIDGE =  (1 << 6),
};

enum ast_bridge_result

Enumerator:

AST_BRIDGE_COMPLETE
AST_BRIDGE_FAILED
AST_BRIDGE_FAILED_NOWARN
AST_BRIDGE_RETRY

Definition at line 164 of file channel.h.

                       {
   AST_BRIDGE_COMPLETE = 0,
   AST_BRIDGE_FAILED = -1,
   AST_BRIDGE_FAILED_NOWARN = -2,
   AST_BRIDGE_RETRY = -3,
};

enum ast_channel_adsicpe

Enumerator:

AST_ADSI_UNKNOWN
AST_ADSI_AVAILABLE
AST_ADSI_UNAVAILABLE
AST_ADSI_OFFHOOKONLY

Definition at line 536 of file channel.h.

                         {
   AST_ADSI_UNKNOWN,
   AST_ADSI_AVAILABLE,
   AST_ADSI_UNAVAILABLE,
   AST_ADSI_OFFHOOKONLY,
};

enum ast_channel_state

ast_channel states

Note:

Bits 0-15 of state are reserved for the state (up/down) of the line Bits 16-32 of state are reserved for flags

Enumerator:

AST_STATE_DOWN	Channel is down and available
AST_STATE_RESERVED	Channel is down, but reserved
AST_STATE_OFFHOOK	Channel is off hook
AST_STATE_DIALING	Digits (or equivalent) have been dialed
AST_STATE_RING	Line is ringing
AST_STATE_RINGING	Remote end is ringing
AST_STATE_UP	Line is up
AST_STATE_BUSY	Line is busy
AST_STATE_DIALING_OFFHOOK	Digits (or equivalent) have been dialed while offhook
AST_STATE_PRERING	Channel has detected an incoming call and is waiting for ring
AST_STATE_MUTE	Do not transmit voice data

Definition at line 549 of file channel.h.

                       {
   AST_STATE_DOWN,         /*!< Channel is down and available */
   AST_STATE_RESERVED,     /*!< Channel is down, but reserved */
   AST_STATE_OFFHOOK,      /*!< Channel is off hook */
   AST_STATE_DIALING,      /*!< Digits (or equivalent) have been dialed */
   AST_STATE_RING,         /*!< Line is ringing */
   AST_STATE_RINGING,      /*!< Remote end is ringing */
   AST_STATE_UP,        /*!< Line is up */
   AST_STATE_BUSY,         /*!< Line is busy */
   AST_STATE_DIALING_OFFHOOK, /*!< Digits (or equivalent) have been dialed while offhook */
   AST_STATE_PRERING,      /*!< Channel has detected an incoming call and is waiting for ring */

   AST_STATE_MUTE = (1 << 16),   /*!< Do not transmit voice data */
};

enum ast_t38_state

Possible T38 states on channels.

Enumerator:

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

Definition at line 567 of file channel.h.

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

enum channelreloadreason

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

Enumerator:

CHANNEL_MODULE_LOAD
CHANNEL_MODULE_RELOAD
CHANNEL_CLI_RELOAD
CHANNEL_MANAGER_RELOAD

Definition at line 904 of file channel.h.

                         {
   CHANNEL_MODULE_LOAD,
   CHANNEL_MODULE_RELOAD,
   CHANNEL_CLI_RELOAD,
   CHANNEL_MANAGER_RELOAD,
};

---

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 2314 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* attribute_malloc __ast_channel_alloc	(	int	needqueue,
		int	state,
		const char *	cid_num,
		const char *	cid_name,
		const char *	acctcode,
		const char *	exten,
		const char *	context,
		const char *	linkedid,
		const int	amaflag,
		const char *	file,
		int	line,
		const char *	function,
		const char *	name_fmt,
			...
	)			[read]

Create a channel structure.

Since:

1.6.3

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 1002 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,
               linkedid, amaflag, file, line, function, name_fmt, ap1, ap2);
   va_end(ap1);
   va_end(ap2);

   return result;
}

struct ast_channel* __ast_request_and_dial	(	const char *	type,
		int	format,
		const struct ast_channel *	requestor,
		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 4342 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_channel_set_connected_line(), AST_CONTROL_ANSWER, AST_CONTROL_BUSY, AST_CONTROL_CONGESTION, AST_CONTROL_CONNECTED_LINE, AST_CONTROL_HANGUP, AST_CONTROL_HOLD, AST_CONTROL_PROCEEDING, AST_CONTROL_PROGRESS, AST_CONTROL_REDIRECTING, 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_party_connected_line_set_init(), AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED, 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, cause, ast_channel::cdr, outgoing_helper::cid_name, outgoing_helper::cid_num, ast_channel::connected, ast_channel::context, outgoing_helper::context, ast_channel::exten, outgoing_helper::exten, f, ast_frame::frametype, handle_cause(), ast_channel::hangupcause, ast_party_connected_line::id, LOG_NOTICE, ast_party_id::name, ast_party_id::number, ast_party_id::number_presentation, 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;
   struct ast_party_connected_line connected;
   
   if (outstate)
      *outstate = 0;
   else
      outstate = &dummy_outstate;   /* make outstate always a valid pointer */

   chan = ast_request(type, format, requestor, 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);
   ast_party_connected_line_set_init(&connected, &chan->connected);
   connected.id.number = (char *) cid_num;
   connected.id.name = (char *) cid_name;
   connected.id.number_presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
   ast_channel_set_connected_line(chan, &connected);

   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 AST_CONTROL_CONNECTED_LINE:
            case AST_CONTROL_REDIRECTING:
            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;
}

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

Activate a given generator

Definition at line 2465 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 513 of file channel.c.

References ao2_container_count(), and channels.

Referenced by action_corestatus(), ast_var_channels(), ast_var_channels_table(), dahdi_restart(), handle_chanlist(), handle_show_settings(), and quit_handler().

{
   return channels ? ao2_container_count(channels) : 0;
}

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

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

Returns:

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

Definition at line 2065 of file channel.h.

Referenced by ast_waitfor_nandfds().

{
   pfd->fd = fd;
   pfd->events = POLLIN | POLLPRI;
   return fd >= 0;
}

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 2415 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);
}

int ast_autoservice_start

(

struct ast_channel *

chan

)

Automatically service a channel for us...

Return values:

	0	success
	-1	failure, or the channel is already being autoserviced

Definition at line 192 of file autoservice.c.

References as_cond, ast_calloc, ast_channel_lock, ast_channel_unlock, ast_cond_signal(), AST_FLAG_END_DTMF_ONLY, AST_LIST_EMPTY, AST_LIST_INSERT_HEAD, AST_LIST_LOCK, AST_LIST_REMOVE, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), ast_pthread_create_background, AST_PTHREADT_NULL, ast_set_flag, ast_test_flag, asthread, autoservice_run(), asent::chan, free, asent::list, LOG_WARNING, asent::orig_end_dtmf_flag, and asent::use_count.

Referenced by _macro_exec(), acf_curl_helper(), acf_jabberreceive_read(), acf_odbc_read(), acf_odbc_write(), ast_app_run_macro(), ast_dtmf_stream(), ast_get_enum(), ast_get_srv(), ast_get_txt(), bridge_playfile(), builtin_atxfer(), builtin_automixmonitor(), builtin_blindtransfer(), conf_play(), confbridge_exec(), dial_exec_full(), feature_exec_app(), function_realtime_read(), function_realtime_readdestroy(), function_realtime_store(), function_realtime_write(), leave_conference_bridge(), lock_read(), lua_autoservice_start(), lua_get_variable_value(), lua_pbx_exec(), lua_set_variable(), lua_set_variable_value(), originate_exec(), osplookup_exec(), pbx_find_extension(), play_message_in_bridged_call(), post_join_marked(), realtimefield_read(), shell_helper(), sla_station_exec(), smdi_msg_retrieve_read(), system_exec_helper(), try_calling(), and trylock_read().

{
   int res = 0;
   struct asent *as;

   AST_LIST_LOCK(&aslist);
   AST_LIST_TRAVERSE(&aslist, as, list) {
      if (as->chan == chan) {
         as->use_count++;
         break;
      }
   }
   AST_LIST_UNLOCK(&aslist);

   if (as) {
      /* Entry exists, autoservice is already handling this channel */
      return 0;
   }

   if (!(as = ast_calloc(1, sizeof(*as))))
      return -1;
   
   /* New entry created */
   as->chan = chan;
   as->use_count = 1;

   ast_channel_lock(chan);
   as->orig_end_dtmf_flag = ast_test_flag(chan, AST_FLAG_END_DTMF_ONLY) ? 1 : 0;
   if (!as->orig_end_dtmf_flag)
      ast_set_flag(chan, AST_FLAG_END_DTMF_ONLY);
   ast_channel_unlock(chan);

   AST_LIST_LOCK(&aslist);

   if (AST_LIST_EMPTY(&aslist) && asthread != AST_PTHREADT_NULL) {
      ast_cond_signal(&as_cond);
   }

   AST_LIST_INSERT_HEAD(&aslist, as, list);

   if (asthread == AST_PTHREADT_NULL) { /* need start the thread */
      if (ast_pthread_create_background(&asthread, NULL, autoservice_run, NULL)) {
         ast_log(LOG_WARNING, "Unable to create autoservice thread :(\n");
         /* There will only be a single member in the list at this point,
            the one we just added. */
         AST_LIST_REMOVE(&aslist, as, list);
         free(as);
         asthread = AST_PTHREADT_NULL;
         res = -1;
      } else {
         pthread_kill(asthread, SIGURG);
      }
   }

   AST_LIST_UNLOCK(&aslist);

   return res;
}

int ast_autoservice_stop

(

struct ast_channel *

chan

)

Stop servicing a channel for us...

Note:

if chan is locked prior to calling ast_autoservice_stop, it is likely that there will be a deadlock between the thread that calls ast_autoservice_stop and the autoservice thread. It is important that chan is not locked prior to this call

Return values:

	0	success
	-1	error, or the channel has been hungup

Definition at line 251 of file autoservice.c.

References ast_channel::_softhangup, as_chan_list_state, ast_channel_lock, ast_channel_unlock, ast_clear_flag, AST_FLAG_END_DTMF_ONLY, ast_frfree, AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_REMOVE_HEAD, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, AST_PTHREADT_NULL, ast_queue_frame_head(), asthread, asent::chan, asent::deferred_frames, f, ast_frame::frame_list, free, asent::list, asent::orig_end_dtmf_flag, and asent::use_count.

Referenced by _macro_exec(), acf_curl_helper(), acf_jabberreceive_read(), acf_odbc_read(), acf_odbc_write(), array(), ast_app_run_macro(), ast_dtmf_stream(), ast_get_enum(), ast_get_srv(), ast_get_txt(), ast_hangup(), bridge_playfile(), builtin_atxfer(), builtin_automixmonitor(), conf_play(), confbridge_exec(), dial_exec_full(), feature_exec_app(), finishup(), function_realtime_read(), function_realtime_readdestroy(), function_realtime_store(), function_realtime_write(), leave_conference_bridge(), lock_read(), lua_autoservice_stop(), lua_get_variable_value(), lua_pbx_exec(), lua_set_variable(), lua_set_variable_value(), originate_exec(), osplookup_exec(), pbx_find_extension(), play_message_in_bridged_call(), post_join_marked(), realtimefield_read(), shell_helper(), sla_station_exec(), smdi_msg_retrieve_read(), system_exec_helper(), try_calling(), and trylock_read().

{
   int res = -1;
   struct asent *as, *removed = NULL;
   struct ast_frame *f;
   int chan_list_state;

   AST_LIST_LOCK(&aslist);

   /* Save the autoservice channel list state.  We _must_ verify that the channel
    * list has been rebuilt before we return.  Because, after we return, the channel
    * could get destroyed and we don't want our poor autoservice thread to step on
    * it after its gone! */
   chan_list_state = as_chan_list_state;

   /* Find the entry, but do not free it because it still can be in the
      autoservice thread array */
   AST_LIST_TRAVERSE_SAFE_BEGIN(&aslist, as, list) {  
      if (as->chan == chan) {
         as->use_count--;
         if (as->use_count < 1) {
            AST_LIST_REMOVE_CURRENT(list);
            removed = as;
         }
         break;
      }
   }
   AST_LIST_TRAVERSE_SAFE_END;

   if (removed && asthread != AST_PTHREADT_NULL) {
      pthread_kill(asthread, SIGURG);
   }

   AST_LIST_UNLOCK(&aslist);

   if (!removed) {
      return 0;
   }

   /* Wait while autoservice thread rebuilds its list. */
   while (chan_list_state == as_chan_list_state) {
      usleep(1000);
   }

   /* Now autoservice thread should have no references to our entry
      and we can safely destroy it */

   if (!chan->_softhangup) {
      res = 0;
   }

   if (!as->orig_end_dtmf_flag) {
      ast_clear_flag(chan, AST_FLAG_END_DTMF_ONLY);
   }

   ast_channel_lock(chan);
   while ((f = AST_LIST_REMOVE_HEAD(&as->deferred_frames, frame_list))) {
      ast_queue_frame_head(chan, f);
      ast_frfree(f);
   }
   ast_channel_unlock(chan);

   free(as);

   return res;
}

void ast_begin_shutdown

(

int

hangup

)

Initiate system shutdown -- prevents new channels from being allocated.

Parameters:

hangup

If "hangup" is non-zero, all existing channels will receive soft hangups

Definition at line 503 of file channel.c.

References ao2_callback, ast_channel_softhangup_cb(), channels, OBJ_MULTIPLE, and OBJ_NODATA.

Referenced by quit_handler().

{
   shutting_down = 1;

   if (hangup) {
      ao2_callback(channels, OBJ_NODATA | OBJ_MULTIPLE, ast_channel_softhangup_cb, NULL);
   }
}

int ast_best_codec

(

int

fmts

)

Pick the best audio codec.

Pick the best codec Choose the best codec... Uhhh... Yah.

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 722 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_SIREN14, AST_FORMAT_SIREN7, 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(), bridge_make_compatible(), builtin_atxfer(), echo_exec(), findmeexec(), gtalk_new(), handle_open_receive_channel_ack_message(), iax2_request(), jingle_new(), local_new(), login_exec(), mgcp_new(), multicast_rtp_request(), set_format(), 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,
      AST_FORMAT_SIREN14,
      AST_FORMAT_SIREN7,
      /*! 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.

Note:

This function does _not_ return a reference to the bridged channel. The reason for this is mostly historical. It _should_ return a reference, but it will take a lot of work to make the code base account for that. So, for now, the old rules still apply for how to handle this function. If this function is being used from the channel thread that owns the channel, then a reference is already held, and channel locking is not required to guarantee that the channel will stay around. If this function is used outside of the associated channel thread, the channel parameter 'chan' MUST be locked before calling this function. Also, 'chan' must remain locked for the entire time that the result of this function is being used.

Parameters:

chan

Current channel

Returns:

A pointer to the bridged channel

Definition at line 5504 of file channel.c.

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

Referenced by __analog_handle_event(), __analog_ss_thread(), __dahdi_exception(), _skinny_show_lines(), action_agents(), action_coreshowchannels(), agents_show(), agents_show_online(), analog_attempt_transfer(), analog_exception(), analog_hangup(), analog_ss_thread(), ast_bridge_call(), ast_cel_report_event(), ast_channel_masquerade(), ast_channel_set_linkgroup(), ast_rtp_instance_set_stats_vars(), ast_set_hangupsource(), ast_var_channel_bridge(), ast_var_channels_table(), attempt_transfer(), cb_events(), channel_spy(), check_bridge(), common_exec(), console_transfer(), create_jb(), dahdi_handle_event(), dahdi_hangup(), export_aoc_vars(), func_channel_read(), 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(), my_get_sigpvt_bridged_channel(), park_call_full(), schedule_delivery(), sip_hangup(), sip_read(), sip_set_rtp_peer(), skinny_transfer(), socket_process(), 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:

-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 4542 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(), ast_call_forward(), attempt_reconnect(), begin_dial_channel(), connect_link(), dial_exec_full(), dial_transfer(), do_forward(), feature_request_and_dial(), findmeexec(), play_sound_file(), 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 4266 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_set_redirecting(), ast_channel_trylock, ast_channel_unlock, ast_channel_update_redirecting(), ast_copy_flags, ast_copy_string(), ast_hangup(), ast_log(), ast_party_caller_copy(), ast_party_connected_line_copy(), ast_request(), ast_set_callerid(), ast_set_variables(), ast_string_field_set, ast_strlen_zero(), ast_channel::call_forward, cause, ast_channel::cdr, CHANNEL_DEADLOCK_AVOIDANCE, ast_channel::cid, outgoing_helper::cid_name, outgoing_helper::cid_num, ast_channel::connected, ast_channel::context, handle_cause(), LOG_NOTICE, outgoing_helper::parent_channel, pbx_builtin_getvar_helper(), ast_channel::redirecting, S_OR, type, and outgoing_helper::vars.

Referenced by __ast_request_and_dial(), and feature_request_and_dial().

{
   char tmpchan[256];
   struct ast_channel *new = NULL;
   struct ast_party_redirecting *apr = &orig->redirecting;
   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, orig, 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;
   }

   ast_channel_set_redirecting(new, apr);

   /* 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_update_redirecting(oh->parent_channel, apr);
         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_update_redirecting(caller, apr);
      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);
   ast_party_caller_copy(&new->cid, &orig->cid);
   ast_party_connected_line_copy(&new->connected, &orig->connected);
   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 519 of file channel.c.

Referenced by handle_abort_shutdown().

{
   shutting_down = 0;
}

const char* ast_cause2str

(

int

cause

)

Gives the string form of a given cause code.

Parameters:

state

cause to get the description of

Returns:

the text form of the binary cause code given

Definition at line 640 of file channel.c.

References ARRAY_LEN, and causes.

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,
		const char *	newname
	)

Change channel name.

Precondition:

Absolutely all channels _MUST_ be unlocked before calling this function.

Parameters:

	chan	the channel to change the name of
	newname	the name to change to

Returns:

nothing

Note:

this function must _NEVER_ be used when any channels are locked regardless if it is the channel who's name is being changed or not because it invalidates our channel container locking order... lock container first, then the individual channels, never the other way around.

Definition at line 4841 of file channel.c.

References __ast_change_name_nolink(), ao2_link, ao2_unlink, ast_channel_lock, ast_channel_unlock, and channels.

Referenced by update_name().

{
   /* We must re-link, as the hash value will change here. */
   ao2_unlink(channels, chan);
   ast_channel_lock(chan);
   __ast_change_name_nolink(chan, newname);
   ast_channel_unlock(chan);
   ao2_link(channels, chan);
}

int ast_channel_bridge	(	struct ast_channel *	c0,
		struct ast_channel *	c1,
		struct ast_bridge_config *	config,
		struct ast_frame **	fo,
		struct ast_channel **	rc
	)

Bridge two channels together.

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 5836 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_set_owners_and_peers(), 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_start_time, ast_bridge_config::feature_timer, ast_bridge_config::features_callee, ast_bridge_config::features_caller, 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, S_OR, 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 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;

   if (ast_tvzero(config->start_time)) {
      config->start_time = ast_tvnow();
      if (config->start_sound) {
         if (caller_warning) {
            bridge_playfile(c0, c1, config->start_sound, config->timelimit / 1000);
         }
         if (callee_warning) {
            bridge_playfile(c1, c0, config->start_sound, config->timelimit / 1000);
         }
      }
   }

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

   ast_set_owners_and_peers(c0, c1);

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

   if (config->feature_timer && !ast_tvzero(config->nexteventts)) {
      config->nexteventts = ast_tvadd(config->feature_start_time, ast_samp2tv(config->feature_timer, 1000));
   } else if (config->timelimit) {
      time_left_ms = config->timelimit - ast_tvdiff_ms(ast_tvnow(), config->start_time);
      caller_warning = ast_test_flag(&config->features_caller, AST_FEATURE_PLAY_WARNING);
      callee_warning = ast_test_flag(&config->features_callee, AST_FEATURE_PLAY_WARNING);
      config->nexteventts = ast_tvadd(config->start_time, ast_samp2tv(config->timelimit, 1000));
      if ((caller_warning || callee_warning) && config->play_warning) {
         long next_warn = config->play_warning;
         if (time_left_ms < config->play_warning) {
            /* At least one warning was played, which means we are returning after feature */
            long warns_passed = (config->play_warning - time_left_ms) / config->warning_freq;
            /* It is 'warns_passed * warning_freq' NOT '(warns_passed + 1) * warning_freq',
               because nexteventts will be updated once again in the 'if (!to)' block */
            next_warn = config->play_warning - warns_passed * config->warning_freq;
         }
         config->nexteventts = ast_tvsub(config->nexteventts, ast_samp2tv(next_warn, 1000));
      }
   } else {
      config->nexteventts.tv_sec = 0;
      config->nexteventts.tv_usec = 0;
   }

   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) {
            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, S_OR(c0->cid.cid_num, "<unknown>"), S_OR(c1->cid.cid_num, "<unknown>"));

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

   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, S_OR(c0->cid.cid_num, "<unknown>"), S_OR(c1->cid.cid_num, "<unknown>"));
   ast_debug(1, "Bridge stops bridging channels %s and %s\n", c0->name, c1->name);

   return res;
}

struct ast_channel* ast_channel_callback	(	ao2_callback_data_fn *	cb_fn,
		void *	arg,
		void *	data,
		int	ao2_flags
	)			[read]

Call a function with every active channel.

This function executes a callback one time for each active channel on the system. The channel is provided as an argument to the function.

Since:

1.6.3

Definition at line 1230 of file channel.c.

References ao2_callback_data, and channels.

Referenced by ast_cel_check_retire_linkedid(), ast_pickup_call(), handle_core_set_debug_channel(), my_ast_get_channel_by_name_locked(), pickup_by_mark(), and state_notify_build_xml().

{
   return ao2_callback_data(channels, ao2_flags, cb_fn, arg, data);
}

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 560 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 the settings of when to hang a channel up.

Parameters:

	chan	channel on which to check for hangup
	offset	offset in seconds and microseconds 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.

Since:

1.6.1

Definition at line 545 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_connected_line_macro	(	struct ast_channel *	autoservice_chan,
		struct ast_channel *	macro_chan,
		const void *	connected_info,
		int	caller,
		int	frame
	)

Run a connected line interception macro and update a channel's connected line information.

Since:

1.6.3 Whenever we want to update a channel's connected line information, we may need to run a macro so that an administrator can manipulate the information before sending it out. This function both runs the macro and sends the update to the channel.

Parameters:

	autoservice_chan	Channel to place into autoservice while the macro is running. It is perfectly safe for this to be NULL
	macro_chan	The channel to run the macro on. Also the channel from which we determine which macro we need to run.
	connected_info	Either an ast_party_connected_line or ast_frame pointer of type AST_CONTROL_CONNECTED_LINE
	caller	If true, then run CONNECTED_LINE_CALLER_SEND_MACRO, otherwise run CONNECTED_LINE_CALLEE_SEND_MACRO
	frame	If true, then connected_info is an ast_frame pointer, otherwise it is an ast_party_connected_line pointer.

Return values:

	0	Success
	-1	Either the macro does not exist, or there was an error while attempting to run the macro

Todo:

Have multiple return codes based on the MACRO_RESULT

Todo:

Make constants so that caller and frame can be more expressive than just '1' and '0'

Definition at line 7366 of file channel.c.

References ast_app_run_macro(), ast_channel_lock, ast_channel_unlock, ast_channel_update_connected_line(), ast_connected_line_parse_data(), ast_party_connected_line_copy(), ast_strdupa, ast_strlen_zero(), ast_channel::connected, chanlist::connected, pbx_builtin_getvar_helper(), and S_OR.

Referenced by ast_bridge_call(), ast_generic_bridge(), ast_pickup_call(), builtin_atxfer(), builtin_blindtransfer(), feature_request_and_dial(), handle_frame(), pickup_do(), and wait_for_answer().

{
   const char *macro;
   const char *macro_args;
   union {
      const struct ast_frame *frame;
      const struct ast_party_connected_line *connected;
   } pointer;
   int retval;

   if (frame) {
      pointer.frame = connected_info;
   } else {
      pointer.connected = connected_info;
   }

   ast_channel_lock(macro_chan);
   macro = ast_strdupa(S_OR(pbx_builtin_getvar_helper(macro_chan, caller ? "CONNECTED_LINE_CALLER_SEND_MACRO" : "CONNECTED_LINE_CALLEE_SEND_MACRO"), ""));
   macro_args = ast_strdupa(S_OR(pbx_builtin_getvar_helper(macro_chan, caller ? "CONNECTED_LINE_CALLER_SEND_MACRO_ARGS" : "CONNECTED_LINE_CALLEE_SEND_MACRO_ARGS"), ""));
   ast_channel_unlock(macro_chan);

   if (ast_strlen_zero(macro)) {
      return -1;
   }

   if (frame) {
      ast_connected_line_parse_data(pointer.frame->data.ptr, pointer.frame->datalen, &macro_chan->connected);
   } else {
      ast_party_connected_line_copy(&macro_chan->connected, pointer.connected);
   }

   if (!(retval = ast_app_run_macro(autoservice_chan, macro_chan, macro, macro_args))) {
      ast_channel_update_connected_line(macro_chan, &macro_chan->connected);
   }

   return retval;
}

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

References AST_LIST_INSERT_HEAD, and ast_channel::datastores.

Referenced by _macro_exec(), acf_curlopt_write(), acf_iaxvar_write(), acf_odbc_read(), add_features_datastores(), add_to_agi(), ast_iax2_new(), audiohook_volume_get(), authenticate_reply(), calendar_query_exec(), dial_exec_full(), do_notify(), dundi_query_read(), enable_jack_hook(), enum_query_read(), find_transaction(), get_lock(), gosub_exec(), lua_get_state(), mute_add_audiohook(), pbx_builtin_raise_exception(), 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* attribute_malloc 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 1942 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 1983 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_curl_helper(), acf_curlopt_helper(), acf_curlopt_write(), acf_exception_read(), acf_fetch(), acf_iaxvar_read(), acf_iaxvar_write(), acf_odbc_read(), add_agi_cmd(), add_features_datastores(), add_to_agi(), ast_odbc_retrieve_transaction_obj(), attended_transfer_occurred(), audiohook_volume_callback(), audiohook_volume_get(), builtin_atxfer(), calendar_event_read(), calendar_query_exec(), calendar_query_result_exec(), dial_exec_full(), disable_jack_hook(), dundi_result_read(), enable_jack_hook(), enum_result_read(), exec_odbcfinish(), find_speech(), find_transaction(), func_inheritance_write(), func_mute_write(), get_agi_cmd(), get_lock(), gosub_exec(), iax2_call(), jack_hook_callback(), local_read(), local_write(), lock_fixup(), lua_get_state(), manage_parkinglot(), manager_mutestream(), mark_transaction_active(), mute_callback(), park_exec_full(), pbx_builtin_raise_exception(), pop_exec(), queue_transfer_fixup(), release_transaction(), 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 1947 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 1952 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(), begin_dial_channel(), 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 1978 of file channel.c.

References AST_LIST_REMOVE, and ast_channel::datastores.

Referenced by acf_fetch(), acf_odbc_read(), 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

)

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

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 5738 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);
}

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

Find a channel by extension and context.

• exten the extension to search for
• context the context to search for (optional)

Return a channel that is currently at the specified extension and context.

Return values:

	a	channel that is at the specified extension and context
	NULL	if no channel was found

Since:

1.6.3

Definition at line 1407 of file channel.c.

References ast_channel_get_full().

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

struct ast_channel* ast_channel_get_by_name

(

const char *

name

)

[read]

Find a channel by name.

Channel search functions

• name the name or uniqueid of the channel to search for

Find a channel that has the same name as the provided argument.

Return values:

	a	channel with the name specified by the argument
	NULL	if no channel was found

Since:

1.6.3

Definition at line 1397 of file channel.c.

References ast_channel_get_full().

Referenced by 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(), asyncgoto_exec(), change_monitor_action(), do_pause_or_unpause(), func_mchan_read(), func_mchan_write(), handle_channelstatus(), handle_cli_agi_add_cmd(), handle_core_set_debug_channel(), handle_getvariablefull(), handle_hangup(), handle_redirect(), handle_set_chanvar(), handle_show_chanvar(), handle_showchan(), handle_softhangup(), import_helper(), manager_mutestream(), manager_park(), manager_play_dtmf(), park_call_full(), pbx_builtin_importvar(), shared_read(), shared_write(), start_monitor_action(), and stop_monitor_action().

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

struct ast_channel* ast_channel_get_by_name_prefix	(	const char *	name,
		size_t	name_len
	)			[read]

Find a channel by a name prefix.

• name The channel name or uniqueid prefix to search for
• name_len Only search for up to this many characters from the name

Find a channel that has the same name prefix as specified by the arguments.

Return values:

	a	channel with the name prefix specified by the arguments
	NULL	if no channel was found

Since:

1.6.3

Definition at line 1402 of file channel.c.

References ast_channel_get_full().

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

{
   return ast_channel_get_full(name, name_len, NULL, NULL);
}

static enum ast_t38_state ast_channel_get_t38_state

(

struct ast_channel *

chan

)

[inline, static]

Retrieves the current T38 state of a channel.

Definition at line 2143 of file channel.h.

References ast_channel_queryoption(), AST_OPTION_T38_STATE, and T38_STATE_UNAVAILABLE.

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

{
   enum ast_t38_state state = T38_STATE_UNAVAILABLE;
   int datalen = sizeof(state);

   ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);

   return state;
}

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 4851 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(), ast_call_forward(), begin_dial_channel(), dial_exec_full(), dial_transfer(), do_forward(), feature_request_and_dial(), 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;
      }
   }
}

struct ast_channel_iterator* ast_channel_iterator_all_new

(

void

)

[read]

Create a new channel iterator.

After creating an iterator using this function, the ast_channel_iterator_next() function can be used to iterate through all channels that exist.

Return values:

	NULL	on failure
	a	new channel iterator

Since:

1.6.3

Definition at line 1297 of file channel.c.

References ast_channel_iterator::active_iterator, ao2_iterator_init(), ast_calloc, channels, and ast_channel_iterator::simple_iterator.

Referenced by action_coreshowchannels(), action_status(), ast_var_channel_bridge(), ast_var_channel_types_table(), ast_var_channels_table(), common_exec(), func_channels_read(), and handle_chanlist().

{
   struct ast_channel_iterator *i;

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

   i->simple_iterator = ao2_iterator_init(channels, 0);
   i->active_iterator = &i->simple_iterator;

   return i;
}

struct ast_channel_iterator* ast_channel_iterator_by_exten_new	(	const char *	exten,
		const char *	context
	)			[read]

Create a new channel iterator based on extension.

• exten The extension that channels must be in
• context The context that channels must be in (optional)

After creating an iterator using this function, the ast_channel_iterator_next() function can be used to iterate through all channels that are currently in the specified context and extension.

Return values:

	NULL	on failure
	a	new channel iterator based on the specified parameters

Since:

1.6.3

Definition at line 1287 of file channel.c.

References channel_iterator_search().

Referenced by common_exec(), and pickup_by_exten().

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

struct ast_channel_iterator* ast_channel_iterator_by_name_new	(	const char *	name,
		size_t	name_len
	)			[read]

Create a new channel iterator based on name.

• name channel name or channel uniqueid to match
• name_len number of characters in the channel name to match on. This would be used to match based on name prefix. If matching on the full channel name is desired, then this parameter should be 0.

After creating an iterator using this function, the ast_channel_iterator_next() function can be used to iterate through all channels that exist that have the specified name or name prefix.

Return values:

	NULL	on failure
	a	new channel iterator based on the specified parameters

Since:

1.6.3

Definition at line 1292 of file channel.c.

References channel_iterator_search().

Referenced by ast_complete_channels(), common_exec(), and softhangup_exec().

{
   return channel_iterator_search(name, name_len, NULL, NULL);
}

struct ast_channel_iterator* ast_channel_iterator_destroy

(

struct ast_channel_iterator *

i

)

[read]

Destroy a channel iterator.

• i the itereator to destroy

This function is used to destroy a channel iterator that was retrieved by using one of the channel_iterator_new() functions.

Returns:

NULL, for convenience to clear out the pointer to the iterator that was just destroyed.

Since:

1.6.3

Definition at line 1245 of file channel.c.

References ast_channel_iterator::active_iterator, ao2_iterator_destroy(), and ast_free.

Referenced by action_coreshowchannels(), action_status(), ast_complete_channels(), ast_var_channel_bridge(), ast_var_channel_types_table(), ast_var_channels_table(), common_exec(), func_channels_read(), handle_chanlist(), pickup_by_exten(), and softhangup_exec().

{
   ao2_iterator_destroy(i->active_iterator);
   ast_free(i);

   return NULL;
}

struct ast_channel* ast_channel_iterator_next

(

struct ast_channel_iterator *

i

)

[read]

Get the next channel for a channel iterator.

• i the channel iterator that was created using one of the channel_iterator_new() functions.

This function should be used to iterate through all channels that match a specified set of parameters that were provided when the iterator was created.

Return values:

	the	next channel that matches the parameters used when the iterator was created.
	NULL,if	no more channels match the iterator parameters.

Since:

1.6.3

Definition at line 1311 of file channel.c.

References ast_channel_iterator::active_iterator, and ao2_iterator_next.

Referenced by action_coreshowchannels(), action_status(), ast_complete_channels(), ast_var_channel_bridge(), ast_var_channel_types_table(), ast_var_channels_table(), func_channels_read(), handle_chanlist(), next_channel(), pickup_by_exten(), and softhangup_exec().

{
   return ao2_iterator_next(i->active_iterator);
}

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 4735 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(), multiplexed_bridge_join(), park_exec_full(), simple_bridge_join(), 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;
}

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 4752 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 analog_attempt_transfer(), 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 6112 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(), rcvfax_exec(), and sndfax_exec().

{
   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);
}

void ast_channel_queue_connected_line_update	(	struct ast_channel *	chan,
		const struct ast_party_connected_line *	connected
	)

Queue a connected line update frame on a channel.

Since:

1.6.3

Parameters:

	chan	Asterisk channel to indicate connected line information
	connected	Connected line information

Returns:

Nothing

Definition at line 6896 of file channel.c.

References ast_connected_line_build_data(), AST_CONTROL_CONNECTED_LINE, and ast_queue_control_data().

Referenced by ast_pickup_call(), handle_request_invite(), handle_request_update(), handle_response_invite(), local_attended_transfer(), misdn_queue_connected_line_update(), and pickup_do().

{
   unsigned char data[1024];  /* This should be large enough */
   size_t datalen;

   datalen = ast_connected_line_build_data(data, sizeof(data), connected);
   if (datalen == (size_t) -1) {
      return;
   }

   ast_queue_control_data(chan, AST_CONTROL_CONNECTED_LINE, data, datalen);
}

void ast_channel_queue_redirecting_update	(	struct ast_channel *	chan,
		const struct ast_party_redirecting *	redirecting
	)

Queue a redirecting update frame on a channel.

Since:

1.6.3

Parameters:

	chan	Asterisk channel to indicate redirecting id information
	redirecting	Redirecting id information

Returns:

Nothing

Definition at line 7353 of file channel.c.

References AST_CONTROL_REDIRECTING, ast_queue_control_data(), and ast_redirecting_build_data().

Referenced by cb_events(), handle_response_invite(), and misdn_facility_ie_handler().

{
   unsigned char data[1024];  /* This should be large enough */
   size_t datalen;

   datalen = ast_redirecting_build_data(data, sizeof(data), redirecting);
   if (datalen == (size_t) -1) {
      return;
   }

   ast_queue_control_data(chan, AST_CONTROL_REDIRECTING, 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 4230 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 channel technology (a new channel driver) Called by a channel module to register the kind of channels it supports.

Parameters:

tech

Structure defining channel technology or "type"

Returns:

Returns 0 on success, -1 on failure.

Definition at line 567 of file channel.c.

References ast_calloc, ast_debug, ast_log(), AST_RWLIST_INSERT_HEAD, AST_RWLIST_TRAVERSE, 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(&backends);

   AST_RWLIST_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(&backends);
         return -1;
      }
   }
   
   if (!(chan = ast_calloc(1, sizeof(*chan)))) {
      AST_RWLIST_UNLOCK(&backends);
      return -1;
   }
   chan->tech = tech;
   AST_RWLIST_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(&backends);

   return 0;
}

struct ast_channel* ast_channel_release

(

struct ast_channel *

chan

)

[read]

Unlink and release reference to a channel.

This function will unlink the channel from the global channels container if it is still there and also release the current reference to the channel.

Returns:

NULL, convenient for clearing invalid pointers

Since:

1.6.3

Definition at line 1456 of file channel.c.

References ao2_unlink, ast_channel_unref, and channels.

Referenced by acf_odbc_read(), acf_odbc_write(), action_getvar(), agent_cleanup(), agent_new(), ast_add_extension2_lockopt(), ast_cel_fabricate_channel_from_event(), ast_do_masquerade(), ast_hangup(), ast_iax2_new(), ast_pbx_outgoing_cdr_failed(), ast_str_substitute_variables_full(), bridge_request(), cli_odbc_read(), cli_odbc_write(), custom_log(), do_notify(), gtalk_newcall(), local_new(), make_email_file(), manager_log(), pbx_substitute_variables_helper_full(), rotate_file(), sendmail(), sendpage(), sqlite3_log(), and syslog_log().

{
   /* Safe, even if already unlinked. */
   ao2_unlink(channels, chan);
   return ast_channel_unref(chan);
}

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 4675 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 4682 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_connected_line	(	struct ast_channel *	chan,
		const struct ast_party_connected_line *	connected
	)

Set the connected line information in the Asterisk channel.

Since:

1.6.3

Parameters:

	chan	Asterisk channel to set connected line information
	connected	Connected line information

Returns:

Nothing

Note:

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

Definition at line 6643 of file channel.c.

References ast_channel_lock, ast_channel_unlock, ast_party_connected_line_set(), and ast_channel::connected.

Referenced by __ast_request_and_dial(), ast_indicate_data(), and connectedline_write().

{
   if (&chan->connected == connected) {
      /* Don't set to self */
      return;
   }

   ast_channel_lock(chan);
   ast_party_connected_line_set(&chan->connected, connected);
   ast_channel_unlock(chan);
}

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

Set the file descriptor on the channel

Definition at line 2011 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(), my_swap_subchannels(), 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;
}

void ast_channel_set_linkgroup	(	struct ast_channel *	chan,
		struct ast_channel *	peer
	)

propagate the linked id between chan and peer

Definition at line 4995 of file channel.c.

References ast_channel::_bridge, ast_bridged_channel(), ast_channel_change_linkedid(), ast_strdupa, ast_channel::linkedid, oldest_linkedid(), and ast_channel::uniqueid.

Referenced by ast_bridge_call(), and ast_do_masquerade().

{
   const char* linkedid=NULL;
   struct ast_channel *bridged;

   linkedid = oldest_linkedid(chan->linkedid, peer->linkedid);
   linkedid = oldest_linkedid(linkedid, chan->uniqueid);
   linkedid = oldest_linkedid(linkedid, peer->uniqueid);
   if (chan->_bridge) {
      bridged = ast_bridged_channel(chan);
      if (bridged != peer) {
         linkedid = oldest_linkedid(linkedid, bridged->linkedid);
         linkedid = oldest_linkedid(linkedid, bridged->uniqueid);
      }
   }
   if (peer->_bridge) {
      bridged = ast_bridged_channel(peer);
      if (bridged != chan) {
         linkedid = oldest_linkedid(linkedid, bridged->linkedid);
         linkedid = oldest_linkedid(linkedid, bridged->uniqueid);
      }
   }

   /* just in case setting a stringfield to itself causes problems */
   linkedid = ast_strdupa(linkedid);

   ast_channel_change_linkedid(chan, linkedid);
   ast_channel_change_linkedid(peer, linkedid);
   if (chan->_bridge) {
      bridged = ast_bridged_channel(chan);
      if (bridged != peer) {
         ast_channel_change_linkedid(bridged, linkedid);
      }
   }
   if (peer->_bridge) {
      bridged = ast_bridged_channel(peer);
      if (bridged != chan) {
         ast_channel_change_linkedid(bridged, linkedid);
      }
   }
}

void ast_channel_set_redirecting	(	struct ast_channel *	chan,
		const struct ast_party_redirecting *	redirecting
	)

Set the redirecting id information in the Asterisk channel.

Since:

1.6.3

Parameters:

	chan	Asterisk channel to set redirecting id information
	redirecting	Redirecting id information

Returns:

Nothing

Note:

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

Definition at line 6909 of file channel.c.

References ast_channel_lock, ast_channel_unlock, ast_free, ast_party_id_set(), ast_channel::cid, ast_callerid::cid_rdnis, ast_party_redirecting::count, ast_party_redirecting::from, ast_party_id::number, ast_party_redirecting::reason, ast_channel::redirecting, and ast_party_redirecting::to.

Referenced by ast_call_forward(), ast_indicate_data(), do_forward(), handle_request_invite(), handle_response(), misdn_copy_redirecting_to_ast(), redirecting_write(), and wait_for_answer().

{
   if (&chan->redirecting == redirecting) {
      /* Don't set to self */
      return;
   }

   ast_channel_lock(chan);

   ast_party_id_set(&chan->redirecting.from, &redirecting->from);
   if (redirecting->from.number
      && redirecting->from.number != chan->redirecting.from.number) {
      /*
       * Must move string to ast_channel.cid.cid_rdnis until it goes away.
       */
      if (chan->cid.cid_rdnis) {
         ast_free(chan->cid.cid_rdnis);
      }
      chan->cid.cid_rdnis = chan->redirecting.from.number;
      chan->redirecting.from.number = NULL;
   }

   ast_party_id_set(&chan->redirecting.to, &redirecting->to);
   chan->redirecting.reason = redirecting->reason;
   chan->redirecting.count = redirecting->count;

   ast_channel_unlock(chan);
}

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

Sets an option on a channel.

Parameters:

	channel	channel to set options on
	option	option to change
	data	data specific to option
	datalen	length of the data
	block	blocking or not

Set an option on a channel (see frame.h), optionally blocking awaiting the reply

Returns:

0 on success and -1 on failure

Definition at line 6099 of file channel.c.

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

Referenced by analog_hangup(), ast_bridge_call(), ast_channel_make_compatible_helper(), common_exec(), conf_run(), dahdi_hangup(), dial_exec_full(), func_channel_write(), handle_tddmode(), play_record_review(), rcvfax_exec(), reset_volumes(), rpt(), rpt_exec(), set_format(), set_listen_volume(), set_talk_volume(), sndfax_exec(), 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 538 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 hang a channel up.

Parameters:

	chan	channel on which to check for hang up
	offset	offset in seconds and useconds 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

Since:

1.6.1

Definition at line 531 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.

Note:

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 6448 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 6471 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 4670 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 1224 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 a channel technology.

Parameters:

tech

Structure defining channel technology or "type" that was previously registered

Returns:

No return value.

Definition at line 598 of file channel.c.

References ast_debug, ast_free, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_END, AST_RWLIST_TRAVERSE_SAFE_BEGIN, 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(&backends);

   AST_RWLIST_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(&backends);
}

void ast_channel_update_connected_line	(	struct ast_channel *	chan,
		const struct ast_party_connected_line *	connected
	)

Indicate that the connected line information has changed.

Since:

1.6.3

Parameters:

	chan	Asterisk channel to indicate connected line information
	connected	Connected line information

Returns:

Nothing

Definition at line 6883 of file channel.c.

References ast_connected_line_build_data(), AST_CONTROL_CONNECTED_LINE, and ast_indicate_data().

Referenced by ast_channel_connected_line_macro(), ast_pickup_call(), builtin_atxfer(), builtin_blindtransfer(), connectedline_write(), local_attended_transfer(), pickup_do(), and wait_for_answer().

{
   unsigned char data[1024];  /* This should be large enough */
   size_t datalen;

   datalen = ast_connected_line_build_data(data, sizeof(data), connected);
   if (datalen == (size_t) -1) {
      return;
   }

   ast_indicate_data(chan, AST_CONTROL_CONNECTED_LINE, data, datalen);
}

void ast_channel_update_redirecting	(	struct ast_channel *	chan,
		const struct ast_party_redirecting *	redirecting
	)

Indicate that the redirecting id has changed.

Since:

1.6.3

Parameters:

	chan	Asterisk channel to indicate redirecting id information
	redirecting	Redirecting id information

Returns:

Nothing

Definition at line 7340 of file channel.c.

References AST_CONTROL_REDIRECTING, ast_indicate_data(), and ast_redirecting_build_data().

Referenced by ast_call_forward(), do_forward(), redirecting_write(), and wait_for_answer().

{
   unsigned char data[1024];  /* This should be large enough */
   size_t datalen;

   datalen = ast_redirecting_build_data(data, sizeof(data), redirecting);
   if (datalen == (size_t) -1) {
      return;
   }

   ast_indicate_data(chan, AST_CONTROL_REDIRECTING, data, datalen);
}

struct ast_variable* ast_channeltype_list

(

void

)

[read]

return an ast_variable list of channeltypes

Definition at line 193 of file channel.c.

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_variable_new(), ast_channel_tech::description, chanlist::tech, ast_channel_tech::type, and var.

Referenced by ast_var_channel_types(), and ast_var_channel_types_table().

{
   struct chanlist *cl;
   struct ast_variable *var = NULL, *prev = NULL;

   AST_RWLIST_RDLOCK(&backends);
   AST_RWLIST_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;
      }
   }
   AST_RWLIST_UNLOCK(&backends);

   return var;
}

int ast_check_hangup

(

struct ast_channel *

chan

)

Check to see if a channel is needing hang up.

Parameters:

chan

channel on which to check for hang up This function determines if the channel is being requested to be hung up.

Returns:

Returns 0 if not, or 1 if hang up is requested (including time-out).

Definition at line 473 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(), agent_indicate(), agi_exec(), agi_handle_command(), announce_thread(), ast_bridge_call(), ast_call(), ast_channel_bridge(), ast_check_hangup_locked(), ast_indicate_data(), ast_raw_answer(), ast_readstring_full(), ast_recvtext(), ast_rtp_instance_bridge(), ast_sendtext(), ast_transfer(), ast_udptl_bridge(), ast_waitfordigit_full(), ast_write(), autoservice_run(), bridge_call_thread(), bridge_exec(), 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(), feature_request_and_dial(), findmeexec(), handle_sendimage(), iax2_bridge(), launch_asyncagi(), local_bridge_loop(), lua_check_hangup(), ospfinished_exec(), pbx_builtin_incomplete(), pbx_exec(), read_exec(), readexten_exec(), remote_bridge_loop(), 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;
}

int ast_check_hangup_locked

(

struct ast_channel *

chan

)

Definition at line 485 of file channel.c.

References ast_channel_lock, ast_channel_unlock, and ast_check_hangup().

Referenced by action_redirect(), and ast_channel_bridge().

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

int ast_connected_line_build_data	(	unsigned char *	data,
		size_t	datalen,
		const struct ast_party_connected_line *	connected
	)

Build the connected line information data frame.

Since:

1.6.3

Parameters:

	data	Buffer to fill with the frame data
	datalen	Size of the buffer to fill
	connected	Connected line information

Return values:

	-1	if error
	Amount	of data buffer used

Definition at line 6671 of file channel.c.

References AST_CONNECTED_LINE_NAME, AST_CONNECTED_LINE_NUMBER, AST_CONNECTED_LINE_NUMBER_PRESENTATION, AST_CONNECTED_LINE_NUMBER_TYPE, AST_CONNECTED_LINE_SOURCE, AST_CONNECTED_LINE_SUBADDRESS, AST_CONNECTED_LINE_SUBADDRESS_ODD_EVEN, AST_CONNECTED_LINE_SUBADDRESS_TYPE, AST_CONNECTED_LINE_SUBADDRESS_VALID, ast_log(), ast_party_connected_line::id, LOG_WARNING, ast_party_id::name, ast_party_id::number, ast_party_id::number_presentation, ast_party_id::number_type, ast_party_subaddress::odd_even_indicator, ast_party_connected_line::source, ast_party_subaddress::str, ast_party_id::subaddress, ast_party_subaddress::type, ast_party_subaddress::valid, and value.

Referenced by ast_channel_queue_connected_line_update(), ast_channel_update_connected_line(), and local_indicate().

{
   int32_t value;
   size_t length;
   size_t pos = 0;

   /*
    * The size of integer values must be fixed in case the frame is
    * shipped to another machine.
    */

   /* *************** Connected line party id *************** */
   if (connected->id.number) {
      length = strlen(connected->id.number);
      if (datalen < pos + (sizeof(data[0]) * 2) + length) {
         ast_log(LOG_WARNING, "No space left for connected line number\n");
         return -1;
      }
      data[pos++] = AST_CONNECTED_LINE_NUMBER;
      data[pos++] = length;
      memcpy(data + pos, connected->id.number, length);
      pos += length;
   }

   if (connected->id.name) {
      length = strlen(connected->id.name);
      if (datalen < pos + (sizeof(data[0]) * 2) + length) {
         ast_log(LOG_WARNING, "No space left for connected line name\n");
         return -1;
      }
      data[pos++] = AST_CONNECTED_LINE_NAME;
      data[pos++] = length;
      memcpy(data + pos, connected->id.name, length);
      pos += length;
   }

   if (datalen < pos + (sizeof(data[0]) * 2) + 1) {
      ast_log(LOG_WARNING, "No space left for connected line type of number\n");
      return -1;
   }
   data[pos++] = AST_CONNECTED_LINE_NUMBER_TYPE;
   data[pos++] = 1;
   data[pos++] = connected->id.number_type;

   if (datalen < pos + (sizeof(data[0]) * 2) + 1) {
      ast_log(LOG_WARNING, "No space left for connected line presentation\n");
      return -1;
   }
   data[pos++] = AST_CONNECTED_LINE_NUMBER_PRESENTATION;
   data[pos++] = 1;
   data[pos++] = connected->id.number_presentation;

   /* Connected line source */
   if (datalen < pos + (sizeof(data[0]) * 2) + sizeof(value)) {
      ast_log(LOG_WARNING, "No space left for connected line source\n");
      return -1;
   }
   data[pos++] = AST_CONNECTED_LINE_SOURCE;
   data[pos++] = sizeof(value);
   value = htonl(connected->source);
   memcpy(data + pos, &value, sizeof(value));
   pos += sizeof(value);

   /* Connected line Subaddress */
   if (connected->id.subaddress.str) {
      length = strlen(connected->id.subaddress.str);
      if (datalen < pos + (sizeof(data[0]) * 2) + length) {
         ast_log(LOG_WARNING, "No space left for connected line subaddress\n");
         return -1;
      }
      data[pos++] = AST_CONNECTED_LINE_SUBADDRESS;
      data[pos++] = length;
      memcpy(data + pos, connected->id.subaddress.str, length);
      pos += length;
   }
   /* Connected line Subaddress Type */
   if (datalen < pos + (sizeof(data[0]) * 2) + 1) {
      ast_log(LOG_WARNING, "No space left for connected line type of subaddress\n");
      return -1;
   }
   data[pos++] = AST_CONNECTED_LINE_SUBADDRESS_TYPE;
   data[pos++] = 1;
   data[pos++] = connected->id.subaddress.type;

   /* Connected line Subaddress Odd/Even indicator */
   if (datalen < pos + (sizeof(data[0]) * 2) + 1) {
      ast_log(LOG_WARNING,
         "No space left for connected line subaddress odd-even indicator\n");
      return -1;
   }
   data[pos++] = AST_CONNECTED_LINE_SUBADDRESS_ODD_EVEN;
   data[pos++] = 1;
   data[pos++] = connected->id.subaddress.odd_even_indicator;

   /* Connected line Subaddress Valid */
   if (datalen < pos + (sizeof(data[0]) * 2) + 1) {
      ast_log(LOG_WARNING, "No space left for connected line subaddress valid\n");
      return -1;
   }
   data[pos++] = AST_CONNECTED_LINE_SUBADDRESS_VALID;
   data[pos++] = 1;
   data[pos++] = connected->id.subaddress.valid;

   return pos;
}

void ast_connected_line_copy_from_caller	(	struct ast_party_connected_line *	dest,
		const struct ast_callerid *	src
	)

Copy the caller information to the connected line information.

Since:

1.6.3

Parameters:

	dest	Destination connected line information
	src	Source caller information

Returns:

Nothing

Note:

Assumes locks are already acquired

Definition at line 6559 of file channel.c.

References ast_party_connected_line::ani, ast_party_connected_line::ani2, ast_free, ast_party_id_copy(), ast_party_subaddress_copy(), ast_strdup, ast_callerid::cid_ani, ast_callerid::cid_ani2, ast_callerid::cid_name, ast_callerid::cid_num, ast_callerid::cid_pres, ast_callerid::cid_ton, ast_party_connected_line::id, ast_party_id::name, ast_party_id::number, ast_party_id::number_presentation, ast_party_id::number_type, ast_callerid::subaddress, and ast_party_id::subaddress.

Referenced by begin_dial_channel(), builtin_atxfer(), dial_exec_full(), feature_request_and_dial(), local_call(), pickup_do(), ring_entry(), and wait_for_answer().

{
#if 1
   /* Must manually fill in struct ast_party_id until struct ast_callerid goes away */
   if (dest->id.number) {
      ast_free(dest->id.number);
   }
   dest->id.number = ast_strdup(src->cid_num);

   if (dest->id.name) {
      ast_free(dest->id.name);
   }
   dest->id.name = ast_strdup(src->cid_name);

   dest->id.number_type = src->cid_ton;
   dest->id.number_presentation = src->cid_pres;


   if (dest->ani) {
      ast_free(dest->ani);
   }
   dest->ani = ast_strdup(src->cid_ani);

   dest->ani2 = src->cid_ani2;
   ast_party_subaddress_copy(&dest->id.subaddress, &src->subaddress);

#else

   /* The src parameter type will become a struct ast_party_caller ptr. */
   /* This is future code */

   ast_party_id_copy(&dest->id, &src->id);

   if (dest->ani) {
      ast_free(dest->ani);
   }
   dest->ani = ast_strdup(src->ani);

   dest->ani2 = src->ani2;
#endif
}

void ast_connected_line_copy_to_caller	(	struct ast_callerid *	dest,
		const struct ast_party_connected_line *	src
	)

Copy the connected line information to the caller information.

Since:

1.6.3

Parameters:

	dest	Destination caller information
	src	Source connected line information

Returns:

Nothing

Note:

Assumes locks are already acquired

Definition at line 6601 of file channel.c.

References ast_party_connected_line::ani, ast_party_connected_line::ani2, ast_free, ast_party_id_copy(), ast_party_subaddress_copy(), ast_strdup, ast_callerid::cid_ani, ast_callerid::cid_ani2, ast_callerid::cid_name, ast_callerid::cid_num, ast_callerid::cid_pres, ast_callerid::cid_ton, ast_party_connected_line::id, ast_party_id::name, ast_party_id::number, ast_party_id::number_presentation, ast_party_id::number_type, ast_party_id::subaddress, and ast_callerid::subaddress.

Referenced by local_call().

{
#if 1
   /* Must manually extract from struct ast_party_id until struct ast_callerid goes away */
   if (dest->cid_num) {
      ast_free(dest->cid_num);
   }
   dest->cid_num = ast_strdup(src->id.number);

   if (dest->cid_name) {
      ast_free(dest->cid_name);
   }
   dest->cid_name = ast_strdup(src->id.name);

   dest->cid_ton = src->id.number_type;
   dest->cid_pres = src->id.number_presentation;


   if (dest->cid_ani) {
      ast_free(dest->cid_ani);
   }
   dest->cid_ani = ast_strdup(src->ani);

   dest->cid_ani2 = src->ani2;
   ast_party_subaddress_copy(&dest->subaddress, &src->id.subaddress);

#else

   /* The dest parameter type will become a struct ast_party_caller ptr. */
   /* This is future code */

   ast_party_id_copy(&dest->id, &src->id);

   if (dest->ani) {
      ast_free(dest->ani);
   }
   dest->ani = ast_strdup(src->ani);

   dest->ani2 = src->ani2;
#endif
}

int ast_connected_line_parse_data	(	const unsigned char *	data,
		size_t	datalen,
		struct ast_party_connected_line *	connected
	)

Parse connected line indication frame data.

Since:

1.6.3

Parameters:

	data	Buffer with the frame data to parse
	datalen	Size of the buffer
	connected	Extracted connected line information

Return values:

	0	on success.
	-1	on error.

Note:

The filled in connected line structure needs to be initialized by ast_party_connected_line_set_init() before calling. If defaults are not required use ast_party_connected_line_init().

The filled in connected line structure needs to be destroyed by ast_party_connected_line_free() when it is no longer needed.

Definition at line 6777 of file channel.c.

References AST_CONNECTED_LINE_NAME, AST_CONNECTED_LINE_NUMBER, AST_CONNECTED_LINE_NUMBER_PRESENTATION, AST_CONNECTED_LINE_NUMBER_TYPE, AST_CONNECTED_LINE_SOURCE, AST_CONNECTED_LINE_SUBADDRESS, AST_CONNECTED_LINE_SUBADDRESS_ODD_EVEN, AST_CONNECTED_LINE_SUBADDRESS_TYPE, AST_CONNECTED_LINE_SUBADDRESS_VALID, ast_free, ast_log(), ast_malloc, ast_party_connected_line::id, LOG_DEBUG, LOG_WARNING, ast_party_id::name, ast_party_id::number, ast_party_id::number_presentation, ast_party_id::number_type, ast_party_subaddress::odd_even_indicator, ast_party_connected_line::source, ast_party_subaddress::str, ast_party_id::subaddress, ast_party_subaddress::type, ast_party_subaddress::valid, and value.

Referenced by ast_channel_connected_line_macro(), ast_indicate_data(), socket_process(), and wait_for_answer().

{
   size_t pos;
   unsigned char ie_len;
   unsigned char ie_id;
   int32_t value;

   for (pos = 0; pos < datalen; pos += ie_len) {
      if (datalen < pos + sizeof(ie_id) + sizeof(ie_len)) {
         ast_log(LOG_WARNING, "Invalid connected line update\n");
         return -1;
      }
      ie_id = data[pos++];
      ie_len = data[pos++];
      if (datalen < pos + ie_len) {
         ast_log(LOG_WARNING, "Invalid connected line update\n");
         return -1;
      }

      switch (ie_id) {
      case AST_CONNECTED_LINE_NUMBER:
         if (connected->id.number) {
            ast_free(connected->id.number);
         }
         connected->id.number = ast_malloc(ie_len + 1);
         if (connected->id.number) {
            memcpy(connected->id.number, data + pos, ie_len);
            connected->id.number[ie_len] = 0;
         }
         break;
      case AST_CONNECTED_LINE_NAME:
         if (connected->id.name) {
            ast_free(connected->id.name);
         }
         connected->id.name = ast_malloc(ie_len + 1);
         if (connected->id.name) {
            memcpy(connected->id.name, data + pos, ie_len);
            connected->id.name[ie_len] = 0;
         }
         break;
      case AST_CONNECTED_LINE_NUMBER_TYPE:
         if (ie_len != 1) {
            ast_log(LOG_WARNING, "Invalid connected line type of number (%u)\n", (unsigned) ie_len);
            break;
         }
         connected->id.number_type = data[pos];
         break;
      case AST_CONNECTED_LINE_NUMBER_PRESENTATION:
         if (ie_len != 1) {
            ast_log(LOG_WARNING, "Invalid connected line presentation (%u)\n", (unsigned) ie_len);
            break;
         }
         connected->id.number_presentation = data[pos];
         break;
      case AST_CONNECTED_LINE_SOURCE:
         if (ie_len != sizeof(value)) {
            ast_log(LOG_WARNING, "Invalid connected line source (%u)\n", (unsigned) ie_len);
            break;
         }
         memcpy(&value, data + pos, sizeof(value));
         connected->source = ntohl(value);
         break;
      case AST_CONNECTED_LINE_SUBADDRESS:
         if (connected->id.subaddress.str) {
            ast_free(connected->id.subaddress.str);
         }
         connected->id.subaddress.str = ast_malloc(ie_len + 1);
         if (connected->id.subaddress.str) {
            memcpy(connected->id.subaddress.str, data + pos, ie_len);
            connected->id.subaddress.str[ie_len] = 0;
         }
         break;
      case AST_CONNECTED_LINE_SUBADDRESS_TYPE:
         if (ie_len != 1) {
            ast_log(LOG_WARNING, "Invalid connected line type of subaddress (%u)\n",
               (unsigned) ie_len);
            break;
         }
         connected->id.subaddress.type = data[pos];
         break;
      case AST_CONNECTED_LINE_SUBADDRESS_ODD_EVEN:
         if (ie_len != 1) {
            ast_log(LOG_WARNING,
               "Invalid connected line subaddress odd-even indicator (%u)\n",
               (unsigned) ie_len);
            break;
         }
         connected->id.subaddress.odd_even_indicator = data[pos];
         break;
      case AST_CONNECTED_LINE_SUBADDRESS_VALID:
         if (ie_len != 1) {
            ast_log(LOG_WARNING, "Invalid connected line subaddress valid (%u)\n",
               (unsigned) ie_len);
            break;
         }
         connected->id.subaddress.valid = data[pos];
         break;
      default:
         ast_log(LOG_DEBUG, "Unknown connected line element: %u (%u)\n", (unsigned) ie_id, (unsigned) ie_len);
         break;
      }
   }

   return 0;
}

void ast_deactivate_generator

(

struct ast_channel *

chan

)

Deactivate an active generator

Definition at line 2420 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

)

Start masquerading a channel.

Note:

absolutely _NO_ channel locks should be held before calling this function.

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

Parameters:

chan

Channel to masquerade

Start masquerading a channel.

Note:

Assumes _NO_ channels and _NO_ channel pvt's are locked. If a channel is locked while calling this function, it invalidates our channel container locking order. All channels must be unlocked before it is permissible to lock the channels' ao2 container.

Definition at line 5100 of file channel.c.

References __ast_change_name_nolink(), ast_channel::_bridge, ast_channel::_softhangup, ast_channel::_state, ast_channel::accountcode, accountcode, ast_channel::adsicpe, ast_channel::alertpipe, ao2_link, ao2_lock(), ao2_unlink, ao2_unlock(), ast_app_group_update(), ast_autochan_new_channel(), ast_cause2str(), AST_CEL_BRIDGE_UPDATE, ast_cel_report_event(), ast_channel_lock, AST_CHANNEL_NAME, ast_channel_release(), ast_channel_set_fd(), ast_channel_set_linkgroup(), ast_channel_trylock, ast_channel_unlock, ast_copy_flags, 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, CHANNEL_DEADLOCK_AVOIDANCE, channels, ast_channel::cid, clone_variables(), ast_channel::connected, 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, LOG_WARNING, manager_event, ast_channel::masq, ast_channel::masqr, ast_channel::monitor, ast_channel::musicclass, musicclass, ast_channel::name, ast_channel::nativeformats, ast_channel::rawreadformat, ast_channel::rawwriteformat, ast_channel::readformat, ast_channel::readq, ast_channel::redirecting, report_new_callerid(), S_OR, 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(), local_attended_transfer(), 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;
   union {
      struct ast_callerid cid;
      struct ast_party_connected_line connected;
      struct ast_party_redirecting redirecting;
   } exchange;
   struct ast_channel *clonechan;
   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];

   /* 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 */

   /* The reasoning for the channels ao2_container lock here is complex.
    * 
    * In order to check for a race condition, the original channel must
    * be locked.  If it is determined that the masquerade should proceed
    * the original channel can absolutely not be unlocked until the end
    * of the function.  Since after determining the masquerade should
    * continue requires the channels to be unlinked from the ao2_container,
    * the container lock must be held first to achieve proper locking order.
    */
   ao2_lock(channels);

   /* lock the original channel to determine if the masquerade is require or not */
   ast_channel_lock(original);

   /* This checks to see if the masquerade has already happened or not.  There is a
    * race condition that exists for this function. Since all pvt and channel locks
    * must be let go before calling do_masquerade, it is possible that it could be
    * called multiple times for the same channel.  This check verifies whether
    * or not the masquerade has already been completed by another thread */
   if (!original->masq) {
      ast_channel_unlock(original);
      ao2_unlock(channels);
      return 0; /* masq already completed by another thread, or never needed to be done to begin with */
   }

   /* now that we have verified no race condition exists, set the clone channel */
   clonechan = original->masq;

   /* since this function already holds the global container lock, unlocking original
    * for deadlock avoidance will not result in any sort of masquerade race condition.
    * If masq is called by a different thread while this happens, it will be stuck waiting
    * until we unlock the container. */
   while (ast_channel_trylock(clonechan)) {
      CHANNEL_DEADLOCK_AVOIDANCE(original);
   }

   /* clear the masquerade channels */
   original->masq = NULL;
   clonechan->masqr = NULL;

   /* unlink from channels container as name (which is the hash value) will change */
   ao2_unlink(channels, original);
   ao2_unlink(channels, clonechan);

   /* now that both channels are locked and unlinked from the container, it is safe to unlock it */
   ao2_unlock(channels);

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

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

   /* 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);

   /* Mangle the name of the clone channel */
   __ast_change_name_nolink(clonechan, masqn);

   /* Copy the name from the clone channel */
   __ast_change_name_nolink(original, newn);

   /* share linked id's */
   ast_channel_set_linkgroup(original, clonechan);

   /* 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 && clonechan->tech->fixup(original, clonechan)) {
      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 && clonechan->tech->hangup(clonechan)) {
      ast_log(LOG_WARNING, "Hangup failed!  Strange things may happen!\n");
      res = -1;
      goto done;
   }

   /* Mangle the name of the clone channel */
   snprintf(zombn, sizeof(zombn), "%s<ZOMBIE>", orig); /* quick, hide the brains! */
   __ast_change_name_nolink(clonechan, zombn);

   /* 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);
   }

   ast_autochan_new_channel(clonechan, original);

   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_copy_flags(original, clonechan, AST_FLAG_EXCEPTION | AST_FLAG_OUTGOING);
   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.
    */
   exchange.cid = original->cid;
   original->cid = clonechan->cid;
   clonechan->cid = exchange.cid;
   report_new_callerid(original);

   exchange.connected = original->connected;
   original->connected = clonechan->connected;
   clonechan->connected = exchange.connected;
   exchange.redirecting = original->redirecting;
   original->redirecting = clonechan->redirecting;
   clonechan->redirecting = exchange.redirecting;

   /* 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);

   /* copy over accuntcode and set peeraccount across the bridge */
   ast_string_field_set(original, accountcode, S_OR(clonechan->accountcode, ""));
   if (original->_bridge) {
      /* XXX - should we try to lock original->_bridge here? */
      ast_string_field_set(original->_bridge, peeraccount, S_OR(clonechan->accountcode, ""));
      ast_cel_report_event(original, AST_CEL_BRIDGE_UPDATE, NULL, NULL, NULL);
   }

   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) {
      if (original->tech->fixup(clonechan, original)) {
         ast_log(LOG_WARNING, "Channel for type '%s' could not fixup channel %s\n",
            original->tech->type, original->name);
         res = -1;
         goto done;
      }
   } 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)
         );
      clonechan = ast_channel_release(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);
   }

   /* 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);

done:
   /* it is possible for the clone channel to disappear during this */
   if (clonechan) {
      ast_channel_unlock(original);
      ast_channel_unlock(clonechan);
      ao2_link(channels, clonechan);
      ao2_link(channels, original);
   } else {
      ast_channel_unlock(original);
      ao2_link(channels, original);
   }
   return 0;
}

struct ast_channel* ast_dummy_channel_alloc

(

void

)

[read]

Create a fake channel structure.

Return values:

	NULL	failure
	non-NULL	successfully allocated channel

Note:

This function should ONLY be used to create a fake channel that can then be populated with data for use in variable substitution when a real channel does not exist.

Definition at line 1027 of file channel.c.

References __ao2_alloc_debug(), ao2_alloc, ast_channel_unref, ast_dummy_channel_destructor(), AST_LIST_HEAD_INIT_NOLOCK, ast_string_field_init, and ast_channel::varshead.

Referenced by acf_odbc_read(), acf_odbc_write(), action_getvar(), ast_add_extension2_lockopt(), ast_cel_fabricate_channel_from_event(), ast_pbx_outgoing_cdr_failed(), ast_str_substitute_variables_full(), cli_odbc_read(), cli_odbc_write(), custom_log(), make_email_file(), manager_log(), pbx_substitute_variables_helper_full(), rotate_file(), sendmail(), sendpage(), sqlite3_log(), and syslog_log().

{
   struct ast_channel *tmp;
   struct varshead *headp;

#if defined(REF_DEBUG)
   if (!(tmp = __ao2_alloc_debug(sizeof(*tmp), ast_dummy_channel_destructor, "dummy channel", file, line, function, 1))) {
      return NULL;
   }
#elif defined(__AST_DEBUG_MALLOC)
   if (!(tmp = __ao2_alloc_debug(sizeof(*tmp), ast_dummy_channel_destructor, "dummy channel", file, line, function, 0))) {
      return NULL;
   }
#else
   if (!(tmp = ao2_alloc(sizeof(*tmp), ast_dummy_channel_destructor))) {
      return NULL;
   }
#endif

   if ((ast_string_field_init(tmp, 128))) {
      ast_channel_unref(tmp);
      return NULL;
   }

   headp = &tmp->varshead;
   AST_LIST_HEAD_INIT_NOLOCK(headp);

   return tmp;
}

static int ast_fdisset	(	struct pollfd *	pfds,
		int	fd,
		int	maximum,
		int *	start
	)			[inline, static]

Helper function for migrating select to poll.

Definition at line 2073 of file channel.h.

References dummy().

Referenced by do_monitor().

{
   int x;
   int dummy = 0;

   if (fd < 0)
      return 0;
   if (!start)
      start = &dummy;
   for (x = *start; x < maximum; x++)
      if (pfds[x].fd == fd) {
         if (x == *start)
            (*start)++;
         return pfds[x].revents;
      }
   return 0;
}

struct ast_channel_tech* ast_get_channel_tech

(

const char *

name

)

[read]

Get a channel technology structure by name.

Parameters:

name

name of technology to find

Returns:

a pointer to the structure, or NULL if no matching technology found

Definition at line 620 of file channel.c.

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

Referenced by _ast_device_state(), and ast_var_channel_types_table().

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

   AST_RWLIST_RDLOCK(&backends);

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

   AST_RWLIST_UNLOCK(&backends);
   
   return ret;
}

ast_group_t ast_get_group

(

const char *

s

)

Definition at line 6277 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(), config_parse_variables(), 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

)

Hang up a channel.

Note:

This function performs a hard hangup on a channel. Unlike the soft-hangup, this function performs all stream stopping, etc, on the channel that needs to end. chan is no longer valid after this call.

Parameters:

chan

channel to hang up

Returns:

Returns 0 on success, -1 on failure.

Definition at line 2143 of file channel.c.

References ao2_unlink, 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_CEL_HANGUP, ast_cel_report_event(), ast_channel_lock, ast_channel_release(), ast_channel_unlock, ast_closestream(), ast_debug, ast_do_masquerade(), AST_FLAG_BLOCKING, AST_FLAG_ZOMBIE, ast_log(), ast_set_flag, ast_test_flag, ast_channel::audiohooks, ast_channel::blocker, ast_channel::blockproc, ast_channel::cdr, channels, 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, ast_channel::hangupsource, LOG_WARNING, manager_event, ast_channel::masq, ast_channel::masqr, ast_channel::name, pbx_builtin_getvar_helper(), 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 __analog_handle_event(), __analog_ss_thread(), __ast_pbx_run(), __ast_request_and_dial(), __oh323_new(), action_bridge(), alsa_new(), analog_handle_init_event(), analog_ss_thread(), answer_exec_run(), app_exec(), ast_async_goto(), ast_call_forward(), ast_dial_destroy(), ast_dial_hangup(), ast_iax2_new(), ast_pbx_outgoing_app(), ast_pbx_outgoing_exten(), ast_pbx_run_app(), async_wait(), begin_dial_channel(), bridge_call_thread(), bridge_channel_thread(), 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(), destroy_conference_bridge(), dial_exec_full(), dial_transfer(), do_forward(), do_hang(), feature_attended_transfer(), feature_request_and_dial(), 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(), my_distinctive_ring(), my_handle_notify_message(), nbs_new(), oss_new(), park_exec_full(), parkandannounce_exec(), phone_new(), play_sound_file(), rpt(), rpt_call(), rpt_exec(), rpt_tele_thread(), sip_new(), sip_park(), sip_park_thread(), skinny_new(), skinny_ss(), try_calling(), unistim_new(), usbradio_new(), wait_for_answer(), and wait_for_winner().

{
   int res = 0;
   struct ast_cdr *cdr = NULL;
   char extra_str[64]; /* used for cel logging below */

   /* 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) {
      ast_channel_unlock(chan);
      if (ast_do_masquerade(chan)) {
         ast_log(LOG_WARNING, "Failed to perform masquerade\n");
      }
      ast_channel_lock(chan);
   }

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

   ao2_unlink(channels, chan);

   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;

   snprintf(extra_str, sizeof(extra_str), "%d,%s,%s", chan->hangupcause, chan->hangupsource, S_OR(pbx_builtin_getvar_helper(chan, "DIALSTATUS"), ""));
   ast_cel_report_event(chan, AST_CEL_HANGUP, NULL, extra_str, NULL);

   if (chan->cdr) {     /* End the CDR if it hasn't already */
      ast_cdr_end(chan->cdr);
      cdr = chan->cdr;
      chan->cdr = 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);
   }

   chan = ast_channel_release(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 3551 of file channel.c.

References ast_indicate_data().

Referenced by __ast_play_and_record(), agent_new(), alsa_call(), analog_attempt_transfer(), answer_trunk_chan(), ast_bridge_call(), ast_channel_bridge(), ast_do_masquerade(), ast_dtmf_stream(), ast_raw_answer(), attempt_transfer(), builtin_atxfer(), builtin_blindtransfer(), cli_console_answer(), conf_run(), console_call(), dial_exec_full(), disa_exec(), do_forward(), feature_request_and_dial(), finishup(), function_remote(), handle_callforward_button(), handle_frame(), handle_recordfile(), manage_parkinglot(), mgcp_ss(), monitor_dial(), oss_call(), park_call_full(), 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 3594 of file channel.c.

References ast_channel::_state, _XXX_AST_CONTROL_T38, ast_channel_lock, ast_channel_set_connected_line(), ast_channel_set_redirecting(), ast_channel_unlock, ast_check_hangup(), ast_connected_line_parse_data(), AST_CONTROL_ANSWER, AST_CONTROL_BUSY, AST_CONTROL_CONGESTION, AST_CONTROL_CONNECTED_LINE, 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_REDIRECTING, AST_CONTROL_RING, AST_CONTROL_RINGING, AST_CONTROL_SRCUPDATE, AST_CONTROL_T38_PARAMETERS, AST_CONTROL_TAKEOFFHOOK, AST_CONTROL_TRANSFER, AST_CONTROL_UNHOLD, AST_CONTROL_VIDUPDATE, AST_CONTROL_WINK, ast_debug, AST_FLAG_ZOMBIE, ast_get_indication_tone(), ast_log(), ast_party_connected_line_free(), ast_party_connected_line_set_init(), ast_party_redirecting_free(), ast_party_redirecting_set_init(), ast_playtones_start(), ast_playtones_stop(), ast_redirecting_parse_data(), AST_STATE_UP, ast_test_flag, ast_tone_zone_sound_unref(), ast_channel::connected, ast_tone_zone_sound::data, ast_channel_tech::indicate, is_visible_indication(), LOG_WARNING, ast_channel::name, ast_channel::redirecting, ast_channel::tech, ast_channel::visible_indication, and ast_channel::zone.

Referenced by agent_hangup(), ast_bridge_call(), ast_channel_update_connected_line(), ast_channel_update_redirecting(), ast_generic_bridge(), ast_indicate(), feature_request_and_dial(), handle_frame(), local_bridge_loop(), login_exec(), manage_parkinglot(), park_call_full(), pbx_builtin_waitexten(), remote_bridge_loop(), 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;
   struct ast_tone_zone_sound *ts = NULL;
   int res;

   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;
   }
   switch (condition) {
   case AST_CONTROL_CONNECTED_LINE:
      {
         struct ast_party_connected_line connected;

         ast_party_connected_line_set_init(&connected, &chan->connected);
         res = ast_connected_line_parse_data(data, datalen, &connected);
         if (!res) {
            ast_channel_set_connected_line(chan, &connected);
         }
         ast_party_connected_line_free(&connected);
      }
      break;

   case AST_CONTROL_REDIRECTING:
      {
         struct ast_party_redirecting redirecting;

         ast_party_redirecting_set_init(&redirecting, &chan->redirecting);
         res = ast_redirecting_parse_data(data, datalen, &redirecting);
         if (!res) {
            ast_channel_set_redirecting(chan, &redirecting);
         }
         ast_party_redirecting_free(&redirecting);
      }
      break;
   
   default:
      break;
   }

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

   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:
   case AST_CONTROL_TRANSFER:
   case AST_CONTROL_CONNECTED_LINE:
   case AST_CONTROL_REDIRECTING:
      /* Nothing left to do for these. */
      res = 0;
      break;
   }

   if (ts) {
      /* 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);
      ts = ast_tone_zone_sound_unref(ts);
      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;
}

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 3534 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_party_caller_copy	(	struct ast_callerid *	dest,
		const struct ast_callerid *	src
	)

Copy the source caller information to the destination caller.

Since:

1.6.3

Parameters:

	dest	Destination caller
	src	Source caller

Returns:

Nothing

Definition at line 1660 of file channel.c.

References ast_free, ast_party_id_copy(), ast_party_subaddress_copy(), ast_strdup, ast_callerid::cid_ani, ast_callerid::cid_ani2, ast_callerid::cid_name, ast_callerid::cid_num, ast_callerid::cid_pres, ast_callerid::cid_ton, and ast_callerid::subaddress.

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

{
   if (dest == src) {
      /* Don't copy to self */
      return;
   }

#if 1
   /* Copy caller-id specific information ONLY from struct ast_callerid */
   if (dest->cid_num)
   {
      ast_free(dest->cid_num);
   }
   dest->cid_num = ast_strdup(src->cid_num);

   if (dest->cid_name)
   {
      ast_free(dest->cid_name);
   }
   dest->cid_name = ast_strdup(src->cid_name);

   dest->cid_ton = src->cid_ton;
   dest->cid_pres = src->cid_pres;


   if (dest->cid_ani)
   {
      ast_free(dest->cid_ani);
   }
   dest->cid_ani = ast_strdup(src->cid_ani);

   dest->cid_ani2 = src->cid_ani2;

   ast_party_subaddress_copy(&dest->subaddress, &src->subaddress);

#else

   /* The src and dest parameter types will become struct ast_party_caller ptrs. */
   /* This is future code */

   ast_party_id_copy(&dest->id, &src->id);

   if (dest->ani) {
      ast_free(dest->ani);
   }
   dest->ani = ast_strdup(src->ani);

   dest->ani2 = src->ani2;
#endif
}

void ast_party_caller_init

(

struct ast_party_caller *

init

)

Initialize the given caller structure.

Since:

1.6.3

Parameters:

init

Caller structure to initialize.

Returns:

Nothing

Definition at line 1653 of file channel.c.

References ast_party_caller::ani, ast_party_caller::ani2, ast_party_id_init(), and ast_party_caller::id.

{
   ast_party_id_init(&init->id);
   init->ani = NULL;
   init->ani2 = 0;
}

void ast_party_connected_line_collect_caller	(	struct ast_party_connected_line *	connected,
		struct ast_callerid *	cid
	)

Collect the caller party information into a connected line structure.

Since:

1.6.3

Parameters:

	connected	Collected caller information for the connected line
	cid	Caller information.

Returns:

Nothing

Warning:

This is a shallow copy.

DO NOT call ast_party_connected_line_free() on the filled in connected line structure!

Definition at line 1760 of file channel.c.

References ast_party_connected_line::ani, ast_party_connected_line::ani2, AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN, ast_callerid::cid_ani, ast_callerid::cid_ani2, ast_callerid::cid_name, ast_callerid::cid_num, ast_callerid::cid_pres, ast_callerid::cid_ton, ast_party_connected_line::id, ast_party_id::name, ast_party_id::number, ast_party_id::number_presentation, ast_party_id::number_type, ast_party_connected_line::source, ast_callerid::subaddress, and ast_party_id::subaddress.

Referenced by ast_pickup_call().

{
   connected->id.number = cid->cid_num;
   connected->id.name = cid->cid_name;
   connected->id.number_type = cid->cid_ton;
   connected->id.number_presentation = cid->cid_pres;
   connected->id.subaddress = cid->subaddress;

   connected->ani = cid->cid_ani;
   connected->ani2 = cid->cid_ani2;
   connected->source = AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN;
}

void ast_party_connected_line_copy	(	struct ast_party_connected_line *	dest,
		const struct ast_party_connected_line *	src
	)

Copy the source connected line information to the destination connected line.

Since:

1.6.3

Parameters:

	dest	Destination connected line
	src	Source connected line

Returns:

Nothing

Definition at line 1719 of file channel.c.

References ast_party_connected_line::ani, ast_party_connected_line::ani2, ast_free, ast_party_id_copy(), ast_strdup, ast_party_connected_line::id, and ast_party_connected_line::source.

Referenced by ast_call_forward(), ast_channel_connected_line_macro(), builtin_atxfer(), dial_exec_full(), do_forward(), local_attended_transfer(), pickup_do(), try_calling(), and wait_for_answer().

{
   if (dest == src) {
      /* Don't copy to self */
      return;
   }

   ast_party_id_copy(&dest->id, &src->id);

   if (dest->ani) {
      ast_free(dest->ani);
   }
   dest->ani = ast_strdup(src->ani);

   dest->ani2 = src->ani2;
   dest->source = src->source;
}

void ast_party_connected_line_free

(

struct ast_party_connected_line *

doomed

)

Destroy the connected line information contents.

Since:

1.6.3

Parameters:

doomed

The connected line information to destroy.

Returns:

Nothing

Definition at line 1773 of file channel.c.

References ast_party_connected_line::ani, ast_free, ast_party_id_free(), and ast_party_connected_line::id.

Referenced by ast_channel_destructor(), ast_indicate_data(), builtin_atxfer(), chanlist_free(), hanguptree(), local_attended_transfer(), pickup_do(), socket_process(), and wait_for_answer().

{
   ast_party_id_free(&doomed->id);

   if (doomed->ani) {
      ast_free(doomed->ani);
      doomed->ani = NULL;
   }
}

void ast_party_connected_line_init

(

struct ast_party_connected_line *

init

)

Initialize the given connected line structure.

Since:

1.6.3

Parameters:

init

Connected line structure to initialize.

Returns:

Nothing

Definition at line 1711 of file channel.c.

References ast_party_connected_line::ani, ast_party_connected_line::ani2, AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN, ast_party_id_init(), ast_party_connected_line::id, and ast_party_connected_line::source.

Referenced by builtin_atxfer(), handle_request_invite(), handle_request_update(), handle_response_invite(), local_attended_transfer(), misdn_queue_connected_line_update(), pickup_do(), socket_process(), and wait_for_answer().

{
   ast_party_id_init(&init->id);
   init->ani = NULL;
   init->ani2 = 0;
   init->source = AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN;
}

void ast_party_connected_line_set	(	struct ast_party_connected_line *	dest,
		const struct ast_party_connected_line *	src
	)

Set the connected line information based on another connected line source.

Since:

1.6.3 This is similar to ast_party_connected_line_copy, except that NULL values for strings in the src parameter indicate not to update the corresponding dest values.

Parameters:

	src	The source connected line to use as a guide to set the dest
	dest	The connected line one wishes to update

Returns:

Nada

Definition at line 1745 of file channel.c.

References ast_party_connected_line::ani, ast_party_connected_line::ani2, ast_free, ast_party_id_set(), ast_strdup, ast_party_connected_line::id, and ast_party_connected_line::source.

Referenced by ast_channel_set_connected_line(), and wait_for_answer().

{
   ast_party_id_set(&dest->id, &src->id);

   if (src->ani && src->ani != dest->ani) {
      if (dest->ani) {
         ast_free(dest->ani);
      }
      dest->ani = ast_strdup(src->ani);
   }

   dest->ani2 = src->ani2;
   dest->source = src->source;
}

void ast_party_connected_line_set_init	(	struct ast_party_connected_line *	init,
		const struct ast_party_connected_line *	guide
	)

Initialize the given connected line structure using the given guide for a set update operation.

Since:

1.6.3

The initialization is needed to allow a set operation to know if a value needs to be updated. Simple integers need the guide's original value in case the set operation is not trying to set a new value. String values are simply set to NULL pointers if they are not going to be updated.

Parameters:

	init	Connected line structure to initialize.
	guide	Source connected line to use as a guide in initializing.

Returns:

Nothing

Definition at line 1737 of file channel.c.

References ast_party_connected_line::ani, ast_party_connected_line::ani2, ast_party_id_set_init(), ast_party_connected_line::id, and ast_party_connected_line::source.

Referenced by __ast_request_and_dial(), ast_indicate_data(), connectedline_write(), and wait_for_answer().

{
   ast_party_id_set_init(&init->id, &guide->id);
   init->ani = NULL;
   init->ani2 = guide->ani2;
   init->source = guide->source;
}

void ast_party_redirecting_copy	(	struct ast_party_redirecting *	dest,
		const struct ast_party_redirecting *	src
	)

Copy the source redirecting information to the destination redirecting.

Since:

1.6.3

Parameters:

	dest	Destination redirecting
	src	Source redirecting

Returns:

Nothing

Definition at line 1783 of file channel.c.

References ast_party_id_copy(), ast_party_redirecting::count, ast_party_redirecting::from, ast_party_redirecting::reason, and ast_party_redirecting::to.

Referenced by begin_dial_channel(), dial_exec_full(), local_call(), and ring_entry().

{
   if (dest == src) {
      /* Don't copy to self */
      return;
   }

   ast_party_id_copy(&dest->from, &src->from);
   ast_party_id_copy(&dest->to, &src->to);
   dest->count = src->count;
   dest->reason = src->reason;
}

void ast_party_redirecting_free

(

struct ast_party_redirecting *

doomed

)

Destroy the redirecting information contents.

Since:

1.6.3

Parameters:

doomed

The redirecting information to destroy.

Returns:

Nothing

Definition at line 1804 of file channel.c.

References ast_party_id_free(), ast_party_redirecting::from, and ast_party_redirecting::to.

Referenced by ast_channel_destructor(), ast_indicate_data(), and redirecting_write().

{
   ast_party_id_free(&doomed->from);
   ast_party_id_free(&doomed->to);
}

void ast_party_redirecting_set_init	(	struct ast_party_redirecting *	init,
		const struct ast_party_redirecting *	guide
	)

Initialize the given redirecting id structure using the given guide for a set update operation.

Since:

1.6.3

The initialization is needed to allow a set operation to know if a value needs to be updated. Simple integers need the guide's original value in case the set operation is not trying to set a new value. String values are simply set to NULL pointers if they are not going to be updated.

Parameters:

	init	Redirecting id structure to initialize.
	guide	Source redirecting id to use as a guide in initializing.

Returns:

Nothing

Definition at line 1796 of file channel.c.

References ast_party_id_set_init(), ast_party_redirecting::count, ast_party_redirecting::from, ast_party_redirecting::reason, and ast_party_redirecting::to.

Referenced by ast_indicate_data(), misdn_copy_redirecting_to_ast(), and redirecting_write().

{
   ast_party_id_set_init(&init->from, &guide->from);
   ast_party_id_set_init(&init->to, &guide->to);
   init->count = guide->count;
   init->reason = guide->reason;
}

void ast_party_subaddress_copy	(	struct ast_party_subaddress *	dest,
		const struct ast_party_subaddress *	src
	)

Copy the source party subaddress information to the destination party subaddress.

Since:

1.6.3

Parameters:

	dest	Destination party subaddress
	src	Source party subaddress

Returns:

Nothing

Definition at line 1471 of file channel.c.

References ast_free, ast_strdup, ast_party_subaddress::odd_even_indicator, ast_party_subaddress::str, ast_party_subaddress::type, and ast_party_subaddress::valid.

Referenced by ast_connected_line_copy_from_caller(), ast_connected_line_copy_to_caller(), ast_party_caller_copy(), and ast_party_id_copy().

{
   if (dest == src) {
      /* Don't copy to self */
      return;
   }

   if (dest->str) {
      ast_free(dest->str);
   }
   dest->str = ast_strdup(src->str);
   dest->type = src->type;
   dest->odd_even_indicator = src->odd_even_indicator;
   dest->valid = src->valid;
}

void ast_party_subaddress_free

(

struct ast_party_subaddress *

doomed

)

Destroy the party subaddress contents.

Since:

1.6.3

Parameters:

doomed

The party subaddress to destroy.

Returns:

Nothing

Definition at line 1514 of file channel.c.

References ast_free, and ast_party_subaddress::str.

Referenced by ast_party_id_free(), and free_cid().

{
   if (doomed->str) {
      ast_free(doomed->str);
      doomed->str = NULL;
   }
}

void ast_party_subaddress_init

(

struct ast_party_subaddress *

init

)

Initialize the given subaddress structure.

Since:

1.6.3

Parameters:

init

Subaddress structure to initialize.

Returns:

Nothing

Definition at line 1463 of file channel.c.

References ast_party_subaddress::odd_even_indicator, ast_party_subaddress::str, ast_party_subaddress::type, and ast_party_subaddress::valid.

Referenced by ast_party_id_init().

{
   init->str = NULL;
   init->type = 0;
   init->odd_even_indicator = 0;
   init->valid = 0;
}

void ast_party_subaddress_set	(	struct ast_party_subaddress *	dest,
		const struct ast_party_subaddress *	src
	)

Set the source party subaddress information into the destination party subaddress.

Since:

1.6.3

Parameters:

	dest	Destination party subaddress
	src	Source party subaddress

Returns:

Nothing

Definition at line 1495 of file channel.c.

References ast_free, ast_strdup, ast_party_subaddress::odd_even_indicator, ast_party_subaddress::str, ast_party_subaddress::type, and ast_party_subaddress::valid.

Referenced by ast_party_id_set().

{
   if (dest == src) {
      /* Don't set to self */
      return;
   }

   if (src->str && src->str != dest->str) {
      if (dest->str) {
         ast_free(dest->str);
      }
      dest->str = ast_strdup(src->str);
   }

   dest->type = src->type;
   dest->odd_even_indicator = src->odd_even_indicator;
   dest->valid = src->valid;
}

void ast_party_subaddress_set_init	(	struct ast_party_subaddress *	init,
		const struct ast_party_subaddress *	guide
	)

Initialize the given party subadress structure using the given guide for a set update operation.

Since:

1.6.3

The initialization is needed to allow a set operation to know if a value needs to be updated. Simple integers need the guide's original value in case the set operation is not trying to set a new value. String values are simply set to NULL pointers if they are not going to be updated.

Parameters:

	init	Party Subaddress structure to initialize.
	guide	Source party subaddress to use as a guide in initializing.

Returns:

Nothing

Definition at line 1487 of file channel.c.

References ast_party_subaddress::odd_even_indicator, ast_party_subaddress::str, ast_party_subaddress::type, and ast_party_subaddress::valid.

Referenced by ast_party_id_set_init().

{
   init->str = NULL;
   init->type = guide->type;
   init->odd_even_indicator = guide->odd_even_indicator;
   init->valid = guide->valid;
}

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

Add a channel to an optimized waitfor

Definition at line 2045 of file channel.c.

References AST_MAX_FDS, and ast_channel::fds.

Referenced by ast_generic_bridge(), begin_dial_channel(), feature_request_and_dial(), local_bridge_loop(), remote_bridge_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 2068 of file channel.c.

References AST_MAX_FDS, and ast_channel::fds.

Referenced by ast_generic_bridge(), feature_request_and_dial(), local_bridge_loop(), monitor_dial(), remote_bridge_loop(), 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- and pickup groups into buffer

Definition at line 6375 of file channel.c.

References first, and num.

Referenced by _sip_show_peer(), _skinny_show_line(), func_channel_read(), function_sippeer(), 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 3862 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 with payload.

Parameters:

	chan	channel to queue frame onto
	control	type of control frame

Note:

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

Return values:

	zero	on success
	non-zero	on failure

Definition at line 1189 of file channel.c.

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

Referenced by __analog_handle_event(), __analog_ss_thread(), __dahdi_exception(), __oh323_update_info(), analog_attempt_transfer(), analog_call(), analog_exception(), analog_hangup(), analog_ss_thread(), 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(), misdn_facility_ie_handler(), multicast_rtp_call(), nbs_call(), phone_call(), pickup_do(), process_sdp(), receive_digit(), remote_hold(), send_cause2ast(), setup_rtp_connection(), skinny_call(), skinny_transfer(), skinny_unhold(), 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 1199 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 __analog_handle_event(), analog_hangup(), ast_channel_queue_connected_line_update(), ast_channel_queue_redirecting_update(), change_t38_state(), dahdi_handle_event(), dahdi_hangup(), handle_request_notify(), handle_response_refer(), iax2_queue_control_data(), iax2_transfer(), process_sdp(), sip_sipredirect(), 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 1146 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(), bridge_write(), 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 1151 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.

Note:

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

Definition at line 1157 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 bridge_queue_hangup(), 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 with hangupcause set.

Note:

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

Parameters:

[in]	chan	channel to queue frame onto
[in]	cause	the hangup cause

Returns:

0 on success, -1 on error

Since:

1.6.1

Definition at line 1169 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 __analog_handle_event(), __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 2261 of file channel.c.

References ast_channel::_state, ast_channel_tech::answer, ast_cdr_answer(), AST_CEL_ANSWER,