channel.h File Reference

General Asterisk PBX channel definitions. More...

#include "asterisk/alertpipe.h"
#include "asterisk/abstract_jb.h"
#include "asterisk/astobj2.h"
#include "asterisk/poll-compat.h"
#include "asterisk/frame.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 "asterisk/format_cap.h"
#include "asterisk/channelstate.h"
#include "asterisk/ccss.h"
#include "asterisk/framehook.h"
#include "asterisk/stasis.h"
#include "asterisk/endpoints.h"

Include dependency graph for channel.h:

Go to the source code of this file.

Data Structures
struct	ast_assigned_ids
	Structure to pass both assignedid values to channel drivers. More...
struct	ast_autochan_list
struct	ast_bridge_config
	bridge configuration More...
struct	ast_chan_write_info_t
	Structure to handle passing func_channel_write info to channels via setoption. More...
struct	ast_channel_initializers
	Helper struct for initializing additional channel information on channel creation. More...
struct	ast_channel_tech
	Structure to describe a channel "technology", ie a channel driver See for examples: More...
struct	ast_datastore_list
struct	ast_generator
struct	ast_group_info
	channel group info More...
struct	ast_hangup_handler
struct	ast_hangup_handler_list
struct	ast_party_caller
	Caller Party information. More...
struct	ast_party_connected_line
	Connected Line/Party information. More...
struct	ast_party_dialed
	Dialed/Called Party information. More...
struct	ast_party_id
	Information needed to identify an endpoint in a call. More...
struct	ast_party_name
	Information needed to specify a name in a call. More...
struct	ast_party_number
	Information needed to specify a number 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_redirecting_reason
	Redirecting reason information. More...
struct	ast_party_subaddress
	Information needed to specify a subaddress in a call. More...
struct	ast_readq_list
struct	ast_set_party_caller
	Indicate what information in ast_party_caller should be set. More...
struct	ast_set_party_connected_line
	Indicate what information in ast_party_connected_line should be set. More...
struct	ast_set_party_id
	Indicate what information in ast_party_id should be set. More...
struct	ast_set_party_redirecting
	Indicate what information in ast_party_redirecting should be set. More...
struct	outgoing_helper

Macros
#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. More...
#define	AST_BRIDGE_DTMF_CHANNEL_1   (1 << 1)
	Report DTMF on channel 1. More...
#define	AST_CHAN_WRITE_INFO_T_VERSION   1
	ast_chan_write_info_t version. Must be incremented if structure is changed More...
#define	ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, assignedids, requestor, amaflag, ...)
	Create a channel structure. More...
#define	ast_channel_alloc_with_endpoint(needqueue, state, cid_num, cid_name, acctcode, exten, context, assignedids, requestor, amaflag, endpoint, ...)
#define	ast_channel_alloc_with_initializers(needqueue, state, cid_num, cid_name, acctcode, exten, context, assignedids, requestor, amaflag, endpoint, initializers, ...)
#define	ast_channel_cleanup(c)   ({ ao2_cleanup(c); (struct ast_channel *) (NULL); })
	Cleanup a channel reference. More...
#define	ast_channel_has_tech_function(chan, function)    (ast_channel_tech(chan) ? ast_channel_tech(chan)->function != NULL : 0)
	Checks if a channel's technology implements a particular callback function. More...
#define	AST_CHANNEL_INITIALIZERS_VERSION   1
	struct ABI version More...
#define	ast_channel_lock(chan)   ao2_lock(chan)
#define	ast_channel_lock_both(chan1, chan2)
	Lock two channels. More...
#define	AST_CHANNEL_NAME   80
#define	ast_channel_ref(c)   ({ ao2_ref(c, +1); (c); })
	Increase channel reference count. More...
#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. More...
#define	ast_dummy_channel_alloc()   __ast_dummy_channel_alloc(__FILE__, __LINE__, __PRETTY_FUNCTION__)
	Create a fake channel structure. More...
#define	AST_EXTENDED_FDS   12
#define	AST_FEATURE_DTMF_MASK
#define	AST_GENERATOR_FD   (AST_MAX_FDS-4)
#define	AST_JITTERBUFFER_FD   (AST_MAX_FDS-5)
#define	AST_MAX_ACCOUNT_CODE   80
#define	AST_MAX_CONTEXT   80
#define	AST_MAX_EXTENSION   80
#define	AST_MAX_FDS   11
#define	AST_MAX_PUBLIC_UNIQUEID   149
#define	AST_MAX_TENANT_ID   64
#define	AST_MAX_UNIQUEID   (AST_MAX_PUBLIC_UNIQUEID + 2 + 1)
#define	AST_MAX_USER_FIELD   256
#define	AST_MUTE_DIRECTION_READ   (1 << 0)
#define	AST_MUTE_DIRECTION_WRITE   (1 << 1)
#define	AST_NUM_CHANNEL_BUCKETS   1567
#define	AST_TIMING_FD   (AST_MAX_FDS-2)
#define	CHECK_BLOCKING(c)
	Set the blocking indication on the channel. More...
#define	DATASTORE_INHERIT_FOREVER   INT_MAX
#define	DEBUGCHAN_FLAG   0x80000000
#define	DECLARE_STRINGFIELD_SETTERS_FOR(field)
#define	FRAMECOUNT_INC(x)   ( ((x) & DEBUGCHAN_FLAG) | (((x)+1) & ~DEBUGCHAN_FLAG) )
#define	MAX_LANGUAGE   40
#define	MAX_MUSICCLASS   80

Typedefs
typedef int(*	ast_acf_read2_fn_t) (struct ast_channel *chan, const char *cmd, char *data, struct ast_str **str, ssize_t len)
	Typedef for a custom read2 function. More...
typedef int(*	ast_acf_read_fn_t) (struct ast_channel *chan, const char *function, char *data, char *buf, size_t len)
	Typedef for a custom read function. More...
typedef int(*	ast_acf_write_fn_t) (struct ast_channel *chan, const char *function, char *data, const char *value)
	Typedef for a custom write function. More...
typedef unsigned long long	ast_group_t
typedef int(*	ast_timing_func_t) (const void *data)

Enumerations
enum	{ AST_CHAN_TP_WANTSJITTER = (1 << 0) , AST_CHAN_TP_CREATESJITTER = (1 << 1) , AST_CHAN_TP_INTERNAL = (1 << 2) , AST_CHAN_TP_SEND_TEXT_DATA = (1 << 3) }
	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_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_MASQ_NOSTREAM = (1 << 16) , AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17) , AST_FLAG_DISABLE_WORKAROUNDS = (1 << 20) , AST_FLAG_DISABLE_DEVSTATE_CACHE = (1 << 21) ,   AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT = (1 << 22) , AST_FLAG_ORIGINATED = (1 << 23) , AST_FLAG_DEAD = (1 << 24) , AST_FLAG_SNAPSHOT_STAGE = (1 << 25) ,   AST_FLAG_TIMINGDATA_IS_AO2_OBJ = (1 << 26) , AST_FLAG_SUBROUTINE_EXEC = (1 << 27) }
	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_bridge_config flags More...
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_HANGUP_EXEC = (1 << 7) , AST_SOFTHANGUP_ALL = (0xFFFFFFFF) }
enum	ama_flags { AST_AMA_NONE = 0 , AST_AMA_OMIT , AST_AMA_BILLING , AST_AMA_DOCUMENTATION }
	Channel AMA Flags. More...
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_error { AST_CHANNEL_ERROR_UNKNOWN , AST_CHANNEL_ERROR_ID_EXISTS }
enum	ast_channel_requestor_relationship { AST_CHANNEL_REQUESTOR_BRIDGE_PEER , AST_CHANNEL_REQUESTOR_REPLACEMENT }
enum	AST_MONITORING_STATE { AST_MONITOR_RUNNING , AST_MONITOR_PAUSED }
enum	AST_PARTY_CHAR_SET {   AST_PARTY_CHAR_SET_UNKNOWN = 0 , AST_PARTY_CHAR_SET_ISO8859_1 = 1 , AST_PARTY_CHAR_SET_WITHDRAWN = 2 , AST_PARTY_CHAR_SET_ISO8859_2 = 3 ,   AST_PARTY_CHAR_SET_ISO8859_3 = 4 , AST_PARTY_CHAR_SET_ISO8859_4 = 5 , AST_PARTY_CHAR_SET_ISO8859_5 = 6 , AST_PARTY_CHAR_SET_ISO8859_7 = 7 ,   AST_PARTY_CHAR_SET_ISO10646_BMPSTRING = 8 , AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING = 9 }
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_ACL_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)
	Answer a channel, with a selectable delay before returning. More...
struct ast_channel *	__ast_channel_alloc (int needqueue, int state, const char *cid_num, const char *cid_name, const char *acctcode, const char *exten, const char *context, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, enum ama_flags amaflag, struct ast_endpoint *endpoint, const char *file, int line, const char *function, const char *name_fmt,...)
	Create a channel structure. More...
struct ast_channel *	__ast_channel_alloc_with_initializers (int needqueue, int state, const char *cid_num, const char *cid_name, const char *acctcode, const char *exten, const char *context, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, enum ama_flags amaflag, struct ast_endpoint *endpoint, struct ast_channel_initializers *initializers, const char *file, int line, const char *function, const char *name_fmt,...)
	Create a channel structure. More...
struct ast_channel *	__ast_dummy_channel_alloc (const char *file, int line, const char *function)
struct ast_channel *	__ast_request_and_dial (const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr, 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. More...
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 More...
static int	ast_add_fd (struct pollfd *pfd, int fd)
	if fd is a valid descriptor, set *pfd with the descriptor More...
int	ast_answer (struct ast_channel *chan)
	Answer a channel. More...
int	ast_auto_answer (struct ast_channel *chan)
	Answer a channel, if it's not already answered. More...
void	ast_autoservice_chan_hangup_peer (struct ast_channel *chan, struct ast_channel *peer)
	Put chan into autoservice while hanging up peer. More...
int	ast_autoservice_ignore (struct ast_channel *chan, enum ast_frame_type ftype)
	Ignore certain frame types. More...
int	ast_autoservice_start (struct ast_channel *chan)
	Automatically service a channel for us... More...
int	ast_autoservice_stop (struct ast_channel *chan)
	Stop servicing a channel for us... More...
int	ast_call (struct ast_channel *chan, const char *addr, int timeout)
	Make a call. More...
struct ast_channel *	ast_call_forward (struct ast_channel *caller, struct ast_channel *orig, int *timeout, struct ast_format_cap *cap, 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. More...
const char *	ast_cause2str (int cause) attribute_pure
	Gives the string form of a given cause code. More...
void	ast_change_name (struct ast_channel *chan, const char *newname)
	Change channel name. More...
struct ast_channel *	ast_channel__bridge (const struct ast_channel *chan)
void	ast_channel__bridge_set (struct ast_channel *chan, struct ast_channel *value)
const char *	ast_channel_accountcode (const struct ast_channel *chan)
enum ast_channel_adsicpe	ast_channel_adsicpe (const struct ast_channel *chan)
void	ast_channel_adsicpe_set (struct ast_channel *chan, enum ast_channel_adsicpe value)
int	ast_channel_alert_writable (struct ast_channel *chan)
int	ast_channel_alert_write (struct ast_channel *chan)
enum ama_flags	ast_channel_amaflags (const struct ast_channel *chan)
const char *	ast_channel_amaflags2string (enum ama_flags flags)
	Convert the enum representation of an AMA flag to a string representation. More...
void	ast_channel_amaflags_set (struct ast_channel *chan, enum ama_flags value)
struct timeval	ast_channel_answertime (struct ast_channel *chan)
void	ast_channel_answertime_set (struct ast_channel *chan, struct timeval *value)
const char *	ast_channel_appl (const struct ast_channel *chan)
void	ast_channel_appl_set (struct ast_channel *chan, const char *value)
struct ast_audiohook_list *	ast_channel_audiohooks (const struct ast_channel *chan)
void	ast_channel_audiohooks_set (struct ast_channel *chan, struct ast_audiohook_list *value)
struct ast_autochan_list *	ast_channel_autochans (struct ast_channel *chan)
pthread_t	ast_channel_blocker (const struct ast_channel *chan)
void	ast_channel_blocker_set (struct ast_channel *chan, pthread_t value)
int	ast_channel_blocker_tid (const struct ast_channel *chan)
void	ast_channel_blocker_tid_set (struct ast_channel *chan, int tid)
const char *	ast_channel_blockproc (const struct ast_channel *chan)
void	ast_channel_blockproc_set (struct ast_channel *chan, const char *value)
struct ast_channel *	ast_channel_bridge_peer (struct ast_channel *chan)
	Get the channel's bridge peer only if the bridge is two-party. More...
const char *	ast_channel_call_forward (const struct ast_channel *chan)
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. More...
struct ast_party_caller *	ast_channel_caller (struct ast_channel *chan)
void	ast_channel_caller_set (struct ast_channel *chan, struct ast_party_caller *value)
ast_group_t	ast_channel_callgroup (const struct ast_channel *chan)
void	ast_channel_callgroup_set (struct ast_channel *chan, ast_group_t value)
ast_callid	ast_channel_callid (const struct ast_channel *chan)
void	ast_channel_callid_cleanup (struct ast_channel *chan)
void	ast_channel_callid_set (struct ast_channel *chan, ast_callid value)
int	ast_channel_cc_params_init (struct ast_channel *chan, const struct ast_cc_config_params *base_params)
	Set up datastore with CCSS parameters for a channel. More...
struct ast_cdr *	ast_channel_cdr (const struct ast_channel *chan)
void	ast_channel_cdr_set (struct ast_channel *chan, struct ast_cdr *value)
void	ast_channel_clear_flag (struct ast_channel *chan, unsigned int flag)
	Clear a flag on a channel. More...
void	ast_channel_clear_softhangup (struct ast_channel *chan, int flag)
	Clear a set of softhangup flags from a channel. More...
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. More...
struct ast_party_connected_line *	ast_channel_connected (struct ast_channel *chan)
struct ast_party_id	ast_channel_connected_effective_id (struct ast_channel *chan)
struct ast_party_connected_line *	ast_channel_connected_indicated (struct ast_channel *chan)
int	ast_channel_connected_line_sub (struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *connected_info, int frame)
	Run a connected line interception subroutine and update a channel's connected line information. More...
void	ast_channel_connected_set (struct ast_channel *chan, struct ast_party_connected_line *value)
const char *	ast_channel_context (const struct ast_channel *chan)
void	ast_channel_context_set (struct ast_channel *chan, const char *value)
struct timeval	ast_channel_creationtime (struct ast_channel *chan)
void	ast_channel_creationtime_set (struct ast_channel *chan, struct timeval *value)
const char *	ast_channel_data (const struct ast_channel *chan)
void	ast_channel_data_set (struct ast_channel *chan, const char *value)
int	ast_channel_datastore_add (struct ast_channel *chan, struct ast_datastore *datastore)
	Add a datastore to a channel. More...
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. More...
int	ast_channel_datastore_inherit (struct ast_channel *from, struct ast_channel *to)
	Inherit datastores from a parent to a child. More...
int	ast_channel_datastore_remove (struct ast_channel *chan, struct ast_datastore *datastore)
	Remove a datastore from a channel. More...
struct ast_datastore_list *	ast_channel_datastores (struct ast_channel *chan)
int	ast_channel_defer_dtmf (struct ast_channel *chan)
	Defers DTMF so that you only read things like hangups and audio. More...
const char *	ast_channel_dialcontext (const struct ast_channel *chan)
struct ast_party_dialed *	ast_channel_dialed (struct ast_channel *chan)
int	ast_channel_dialed_causes_add (const struct ast_channel *chan, const struct ast_control_pvt_cause_code *cause_code, int datalen)
	Add cause code information to the channel. More...
struct ast_str *	ast_channel_dialed_causes_channels (const struct ast_channel *chan)
	Retrieve a comma-separated list of channels for which dialed cause information is available. More...
void	ast_channel_dialed_causes_clear (const struct ast_channel *chan)
	Clear all cause information from the channel. More...
struct ast_control_pvt_cause_code *	ast_channel_dialed_causes_find (const struct ast_channel *chan, const char *chan_name)
	Retrieve a ref-counted cause code information structure. More...
void	ast_channel_dialed_set (struct ast_channel *chan, struct ast_party_dialed *value)
char	ast_channel_dtmf_digit_to_emulate (const struct ast_channel *chan)
void	ast_channel_dtmf_digit_to_emulate_set (struct ast_channel *chan, char value)
struct timeval *	ast_channel_dtmf_tv (struct ast_channel *chan)
void	ast_channel_dtmf_tv_set (struct ast_channel *chan, struct timeval *value)
struct ast_frame *	ast_channel_dtmff (struct ast_channel *chan)
void	ast_channel_dtmff_set (struct ast_channel *chan, struct ast_frame *value)
int	ast_channel_early_bridge (struct ast_channel *c0, struct ast_channel *c1)
	Bridge two channels together (early) More...
unsigned int	ast_channel_emulate_dtmf_duration (const struct ast_channel *chan)
void	ast_channel_emulate_dtmf_duration_set (struct ast_channel *chan, unsigned int value)
void	ast_channel_end_dtmf (struct ast_channel *chan, char digit, struct timeval start, const char *why)
	Simulate a DTMF end on a broken bridge channel. More...
int	ast_channel_epfd (const struct ast_channel *chan)
void	ast_channel_epfd_set (struct ast_channel *chan, int value)
enum ast_channel_error	ast_channel_errno (void)
	Get error code for latest channel operation. More...
const char *	ast_channel_exten (const struct ast_channel *chan)
void	ast_channel_exten_set (struct ast_channel *chan, const char *value)
int	ast_channel_fd (const struct ast_channel *chan, int which)
int	ast_channel_fd_add (struct ast_channel *chan, int value)
	Add a file descriptor to the channel without a fixed position. More...
int	ast_channel_fd_count (const struct ast_channel *chan)
	Retrieve the number of file decriptor positions present on the channel. More...
int	ast_channel_fd_isset (const struct ast_channel *chan, int which)
int	ast_channel_fdno (const struct ast_channel *chan)
void	ast_channel_fdno_set (struct ast_channel *chan, int value)
int	ast_channel_feature_hooks_append (struct ast_channel *chan, struct ast_bridge_features *features)
	Appends to the channel-attached features a channel has access to upon being bridged. More...
struct ast_bridge_features *	ast_channel_feature_hooks_get (struct ast_channel *chan)
	Gets the channel-attached features a channel has access to upon being bridged. More...
int	ast_channel_feature_hooks_replace (struct ast_channel *chan, struct ast_bridge_features *features)
	Sets the channel-attached features a channel has access to upon being bridged. More...
unsigned int	ast_channel_fin (const struct ast_channel *chan)
void	ast_channel_fin_set (struct ast_channel *chan, unsigned int value)
struct ast_flags *	ast_channel_flags (struct ast_channel *chan)
int	ast_channel_forward_endpoint (struct ast_channel *chan, struct ast_endpoint *endpoint)
	Forward channel stasis messages to the given endpoint. More...
unsigned int	ast_channel_fout (const struct ast_channel *chan)
void	ast_channel_fout_set (struct ast_channel *chan, unsigned int value)
struct ast_framehook_list *	ast_channel_framehooks (const struct ast_channel *chan)
void	ast_channel_framehooks_set (struct ast_channel *chan, struct ast_framehook_list *value)
struct ast_generator *	ast_channel_generator (const struct ast_channel *chan)
void	ast_channel_generator_set (struct ast_channel *chan, struct ast_generator *value)
void *	ast_channel_generatordata (const struct ast_channel *chan)
void	ast_channel_generatordata_set (struct ast_channel *chan, void *value)
struct varshead *	ast_channel_get_ari_vars (struct ast_channel *chan)
	Gets the variables for a given channel, as specified by ast_channel_set_ari_vars(). More...
struct ast_bridge *	ast_channel_get_bridge (const struct ast_channel *chan)
	Get the bridge associated with a channel. More...
struct ast_bridge_channel *	ast_channel_get_bridge_channel (struct ast_channel *chan)
	Get a reference to the channel's bridge pointer. More...
int	ast_channel_get_cc_agent_type (struct ast_channel *chan, char *agent_type, size_t size)
	Find the appropriate CC agent type to use given a channel. More...
struct ast_cc_config_params *	ast_channel_get_cc_config_params (struct ast_channel *chan)
	Get the CCSS parameters from a channel. More...
struct ast_stream *	ast_channel_get_default_stream (struct ast_channel *chan, enum ast_media_type type)
	Retrieve the default stream of a specific media type on a channel. More...
int	ast_channel_get_device_name (struct ast_channel *chan, char *device_name, size_t name_buffer_length)
	Get a device name given its channel structure. More...
int	ast_channel_get_duration (struct ast_channel *chan)
	Obtain how long the channel since the channel was created. More...
int64_t	ast_channel_get_duration_ms (struct ast_channel *chan)
	Obtain how long it's been, in milliseconds, since the channel was created. More...
int	ast_channel_get_intercept_mode (void)
	Am I currently running an intercept dialplan routine. More...
struct varshead *	ast_channel_get_manager_vars (struct ast_channel *chan)
	Gets the variables for a given channel, as specified by ast_channel_set_manager_vars(). More...
struct ast_stream_topology *	ast_channel_get_stream_topology (const struct ast_channel *chan)
	Retrieve the topology of streams on a channel. More...
void *	ast_channel_get_stream_topology_change_source (struct ast_channel *chan)
	Retrieve the source that initiated the last stream topology change. More...
static enum ast_t38_state	ast_channel_get_t38_state (struct ast_channel *chan)
	Retrieves the current T38 state of a channel. More...
int	ast_channel_get_up_time (struct ast_channel *chan)
	Obtain how long it has been since the channel was answered. More...
int64_t	ast_channel_get_up_time_ms (struct ast_channel *chan)
	Obtain how long it has been since the channel was answered in ms. More...
struct varshead *	ast_channel_get_vars (struct ast_channel *chan)
	Gets the variables for a given channel, as set using pbx_builtin_setvar_helper(). More...
struct ast_hangup_handler_list *	ast_channel_hangup_handlers (struct ast_channel *chan)
int	ast_channel_hangupcause (const struct ast_channel *chan)
void	ast_channel_hangupcause_hash_set (struct ast_channel *chan, const struct ast_control_pvt_cause_code *cause_code, int datalen)
	Sets the HANGUPCAUSE hash and optionally the SIP_CAUSE hash on the given channel. More...
void	ast_channel_hangupcause_set (struct ast_channel *chan, int value)
const char *	ast_channel_hangupsource (const struct ast_channel *chan)
int	ast_channel_has_ari_vars (void)
	Return whether or not any ARI variables have been set. More...
int	ast_channel_has_audio_frame_or_monitor (struct ast_channel *chan)
	Check if the channel has active audiohooks, active framehooks, or a monitor. More...
int	ast_channel_has_hook_requiring_audio (struct ast_channel *chan)
	Check if the channel has any active hooks that require audio. More...
int	ast_channel_has_manager_vars (void)
	Return whether or not any manager variables have been set. More...
int	ast_channel_hold_state (const struct ast_channel *chan)
void	ast_channel_hold_state_set (struct ast_channel *chan, int value)
void	ast_channel_inherit_variables (const struct ast_channel *parent, struct ast_channel *child)
	Inherits channel variable from parent to child channel. More...
unsigned long	ast_channel_insmpl (const struct ast_channel *chan)
void	ast_channel_insmpl_set (struct ast_channel *chan, unsigned long value)
ast_alert_status_t	ast_channel_internal_alert_flush (struct ast_channel *chan)
ast_alert_status_t	ast_channel_internal_alert_read (struct ast_channel *chan)
int	ast_channel_internal_alert_readable (struct ast_channel *chan)
int	ast_channel_internal_alert_readfd (struct ast_channel *chan)
void	ast_channel_internal_alertpipe_clear (struct ast_channel *chan)
void	ast_channel_internal_alertpipe_close (struct ast_channel *chan)
int	ast_channel_internal_alertpipe_init (struct ast_channel *chan)
void	ast_channel_internal_alertpipe_swap (struct ast_channel *chan1, struct ast_channel *chan2)
	Swap the interal alertpipe between two channels. More...
struct ast_bridge *	ast_channel_internal_bridge (const struct ast_channel *chan)
struct ast_bridge_channel *	ast_channel_internal_bridge_channel (const struct ast_channel *chan)
void	ast_channel_internal_bridge_channel_set (struct ast_channel *chan, struct ast_bridge_channel *value)
void	ast_channel_internal_bridge_set (struct ast_channel *chan, struct ast_bridge *value)
struct ast_channel *	ast_channel_internal_bridged_channel (const struct ast_channel *chan)
void	ast_channel_internal_bridged_channel_set (struct ast_channel *chan, struct ast_channel *value)
void	ast_channel_internal_copy_linkedid (struct ast_channel *dest, struct ast_channel *source)
	Copy the full linkedid channel id structure from one channel to another. More...
void	ast_channel_internal_fd_clear (struct ast_channel *chan, int which)
void	ast_channel_internal_fd_clear_all (struct ast_channel *chan)
void	ast_channel_internal_fd_set (struct ast_channel *chan, int which, int value)
struct ast_channel *	ast_channel_internal_oldest_linkedid (struct ast_channel *a, struct ast_channel *b)
	Determine which channel has an older linkedid. More...
void	ast_channel_internal_set_fake_ids (struct ast_channel *chan, const char *uniqueid, const char *linkedid)
	Set uniqueid and linkedid string value only (not time) More...
void	ast_channel_internal_swap_endpoint_forward (struct ast_channel *a, struct ast_channel *b)
	Swap endpoint_forward between two channels. More...
void	ast_channel_internal_swap_snapshots (struct ast_channel *a, struct ast_channel *b)
	Swap snapshots beteween two channels. More...
void	ast_channel_internal_swap_topics (struct ast_channel *a, struct ast_channel *b)
	Swap topics beteween two channels. More...
void	ast_channel_internal_swap_uniqueid_and_linkedid (struct ast_channel *a, struct ast_channel *b)
	Swap uniqueid and linkedid beteween two channels. More...
int	ast_channel_is_bridged (const struct ast_channel *chan)
	Determine if a channel is in a bridge. More...
int	ast_channel_is_leaving_bridge (struct ast_channel *chan)
	Determine if a channel is leaving a bridge, but not hung up. More...
int	ast_channel_is_multistream (struct ast_channel *chan)
	Determine if a channel is multi-stream capable. More...
int	ast_channel_is_t38_active (struct ast_channel *chan)
	This function will check if T.38 is active on the channel. More...
int	ast_channel_is_t38_active_nolock (struct ast_channel *chan)
	ast_channel_is_t38_active variant. Use this if the channel is already locked prior to calling. More...
struct ast_jb *	ast_channel_jb (struct ast_channel *chan)
void	ast_channel_jb_set (struct ast_channel *chan, struct ast_jb *value)
const char *	ast_channel_language (const struct ast_channel *chan)
const char *	ast_channel_lastcontext (const struct ast_channel *chan)
const char *	ast_channel_lastexten (const struct ast_channel *chan)
const char *	ast_channel_latest_musicclass (const struct ast_channel *chan)
const char *	ast_channel_linkedid (const struct ast_channel *chan)
int	ast_channel_make_compatible (struct ast_channel *chan, struct ast_channel *peer)
	Make the frame formats of two channels compatible. More...
struct ast_channel *	ast_channel_masq (const struct ast_channel *chan)
void	ast_channel_masq_set (struct ast_channel *chan, struct ast_channel *value)
struct ast_channel *	ast_channel_masqr (const struct ast_channel *chan)
void	ast_channel_masqr_set (struct ast_channel *chan, struct ast_channel *value)
int	ast_channel_move (struct ast_channel *dest, struct ast_channel *source)
	Move a channel from its current location to a new location. More...
void *	ast_channel_music_state (const struct ast_channel *chan)
void	ast_channel_music_state_set (struct ast_channel *chan, void *value)
const char *	ast_channel_musicclass (const struct ast_channel *chan)
const char *	ast_channel_name (const struct ast_channel *chan)
void	ast_channel_name_to_dial_string (char *channel_name)
	Removes the trailing identifiers from a channel name string. More...
struct ast_namedgroups *	ast_channel_named_callgroups (const struct ast_channel *chan)
void	ast_channel_named_callgroups_set (struct ast_channel *chan, struct ast_namedgroups *value)
struct ast_namedgroups *	ast_channel_named_pickupgroups (const struct ast_channel *chan)
void	ast_channel_named_pickupgroups_set (struct ast_channel *chan, struct ast_namedgroups *value)
struct ast_format_cap *	ast_channel_nativeformats (const struct ast_channel *chan)
void	ast_channel_nativeformats_set (struct ast_channel *chan, struct ast_format_cap *value)
const char *	ast_channel_oldest_linkedid (const char *a, const char *b)
	Return the oldest linkedid between two channels. More...
struct ast_format *	ast_channel_oldwriteformat (struct ast_channel *chan)
unsigned long	ast_channel_outsmpl (const struct ast_channel *chan)
void	ast_channel_outsmpl_set (struct ast_channel *chan, unsigned long value)
const char *	ast_channel_parkinglot (const struct ast_channel *chan)
struct ast_pbx *	ast_channel_pbx (const struct ast_channel *chan)
void	ast_channel_pbx_set (struct ast_channel *chan, struct ast_pbx *value)
const char *	ast_channel_peeraccount (const struct ast_channel *chan)
ast_group_t	ast_channel_pickupgroup (const struct ast_channel *chan)
void	ast_channel_pickupgroup_set (struct ast_channel *chan, ast_group_t value)
int	ast_channel_priority (const struct ast_channel *chan)
void	ast_channel_priority_set (struct ast_channel *chan, int value)
int	ast_channel_queryoption (struct ast_channel *channel, int option, void *data, int *datalen, int block)
	Checks the value of an option. More...
void	ast_channel_queue_connected_line_update (struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update)
	Queue a connected line update frame on a channel. More...
void	ast_channel_queue_redirecting_update (struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update)
	Queue a redirecting update frame on a channel. More...
struct ast_format *	ast_channel_rawreadformat (struct ast_channel *chan)
struct ast_format *	ast_channel_rawwriteformat (struct ast_channel *chan)
struct ast_format *	ast_channel_readformat (struct ast_channel *chan)
struct ast_readq_list *	ast_channel_readq (struct ast_channel *chan)
struct ast_trans_pvt *	ast_channel_readtrans (const struct ast_channel *chan)
void	ast_channel_readtrans_set (struct ast_channel *chan, struct ast_trans_pvt *value)
const char *	ast_channel_reason2str (int reason)
	return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument More...
struct ast_party_redirecting *	ast_channel_redirecting (struct ast_channel *chan)
struct ast_party_id	ast_channel_redirecting_effective_from (struct ast_channel *chan)
struct ast_party_id	ast_channel_redirecting_effective_orig (struct ast_channel *chan)
struct ast_party_id	ast_channel_redirecting_effective_to (struct ast_channel *chan)
void	ast_channel_redirecting_set (struct ast_channel *chan, struct ast_party_redirecting *value)
int	ast_channel_redirecting_sub (struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *redirecting_info, int is_frame)
	Run a redirecting interception subroutine and update a channel's redirecting information. More...
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. More...
struct ast_channel *	ast_channel_release (struct ast_channel *chan)
	Unlink and release reference to a channel. More...
void	ast_channel_req_accountcodes (struct ast_channel *chan, const struct ast_channel *requestor, enum ast_channel_requestor_relationship relationship)
	Setup new channel accountcodes from the requestor channel after ast_request(). More...
void	ast_channel_req_accountcodes_precious (struct ast_channel *chan, const struct ast_channel *requestor, enum ast_channel_requestor_relationship relationship)
	Setup new channel accountcodes from the requestor channel after ast_request(). More...
int	ast_channel_request_stream_topology_change (struct ast_channel *chan, struct ast_stream_topology *topology, void *change_source)
	Request that the stream topology of a channel change. More...
int	ast_channel_rings (const struct ast_channel *chan)
void	ast_channel_rings_set (struct ast_channel *chan, int value)
struct ast_sched_context *	ast_channel_sched (const struct ast_channel *chan)
void	ast_channel_sched_set (struct ast_channel *chan, struct ast_sched_context *value)
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. More...
char	ast_channel_sending_dtmf_digit (const struct ast_channel *chan)
void	ast_channel_sending_dtmf_digit_set (struct ast_channel *chan, char value)
struct timeval	ast_channel_sending_dtmf_tv (const struct ast_channel *chan)
void	ast_channel_sending_dtmf_tv_set (struct ast_channel *chan, struct timeval value)
int	ast_channel_sendurl (struct ast_channel *channel, const char *url)
	Sends a URL on a given link Send URL on link. More...
void	ast_channel_set_ari_vars (size_t varc, char **vars)
	Sets the variables to be stored in the ari_vars field of all snapshots. More...
void	ast_channel_set_caller (struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update)
	Set the caller id information in the Asterisk channel. More...
void	ast_channel_set_caller_event (struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update)
	Set the caller id information in the Asterisk channel and generate an AMI event if the caller id name or number changed. More...
void	ast_channel_set_connected_line (struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update)
	Set the connected line information in the Asterisk channel. More...
void	ast_channel_set_fd (struct ast_channel *chan, int which, int fd)
void	ast_channel_set_flag (struct ast_channel *chan, unsigned int flag)
	Set a flag on a channel. More...
void	ast_channel_set_is_t38_active (struct ast_channel *chan, int is_t38_active)
	Sets the is_t38_active flag. More...
void	ast_channel_set_is_t38_active_nolock (struct ast_channel *chan, int is_t38_active)
	Variant of ast_channel_set_is_t38_active. Use this if the channel is already locked prior to calling. More...
void	ast_channel_set_manager_vars (size_t varc, char **vars)
	Sets the variables to be stored in the manager_vars field of all snapshots. More...
void	ast_channel_set_oldwriteformat (struct ast_channel *chan, struct ast_format *format)
void	ast_channel_set_rawreadformat (struct ast_channel *chan, struct ast_format *format)
void	ast_channel_set_rawwriteformat (struct ast_channel *chan, struct ast_format *format)
void	ast_channel_set_readformat (struct ast_channel *chan, struct ast_format *format)
void	ast_channel_set_redirecting (struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update)
	Set the redirecting id information in the Asterisk channel. More...
struct ast_stream_topology *	ast_channel_set_stream_topology (struct ast_channel *chan, struct ast_stream_topology *topology)
	Set the topology of streams on a channel. More...
void	ast_channel_set_unbridged (struct ast_channel *chan, int value)
	Sets the unbridged flag and queues a NULL frame on the channel to trigger a check by bridge_channel_wait. More...
void	ast_channel_set_unbridged_nolock (struct ast_channel *chan, int value)
	Variant of ast_channel_set_unbridged. Use this if the channel is already locked prior to calling. More...
void	ast_channel_set_writeformat (struct ast_channel *chan, struct ast_format *format)
int	ast_channel_setoption (struct ast_channel *channel, int option, void *data, int datalen, int block)
	Sets an option on a channel. More...
void	ast_channel_setwhentohangup_tv (struct ast_channel *chan, struct timeval offset)
	Set when to hang a channel up. More...
struct ast_channel_snapshot *	ast_channel_snapshot (const struct ast_channel *chan)
struct ast_flags *	ast_channel_snapshot_segment_flags (struct ast_channel *chan)
void	ast_channel_snapshot_set (struct ast_channel *chan, struct ast_channel_snapshot *snapshot)
int	ast_channel_softhangup_internal_flag (struct ast_channel *chan)
void	ast_channel_softhangup_internal_flag_add (struct ast_channel *chan, int value)
void	ast_channel_softhangup_internal_flag_clear (struct ast_channel *chan, int value)
void	ast_channel_softhangup_internal_flag_set (struct ast_channel *chan, int value)
void	ast_channel_softhangup_withcause_locked (struct ast_channel *chan, int causecode)
	Lock the given channel, then request softhangup on the channel with the given causecode. More...
struct ast_silence_generator *	ast_channel_start_silence_generator (struct ast_channel *chan)
	Starts a silence generator on the given channel. More...
enum ast_channel_state	ast_channel_state (const struct ast_channel *chan)
void	ast_channel_state_set (struct ast_channel *chan, enum ast_channel_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. More...
struct ast_filestream *	ast_channel_stream (const struct ast_channel *chan)
void	ast_channel_stream_set (struct ast_channel *chan, struct ast_filestream *value)
int	ast_channel_stream_topology_changed (struct ast_channel *chan, struct ast_stream_topology *topology)
	Provide notice to a channel that the stream topology has changed. More...
int	ast_channel_stream_topology_changed_externally (struct ast_channel *chan)
	Provide notice from a channel that the topology has changed on it as a result of the remote party renegotiating. More...
int	ast_channel_streamid (const struct ast_channel *chan)
void	ast_channel_streamid_set (struct ast_channel *chan, int value)
enum ama_flags	ast_channel_string2amaflag (const char *flag)
	Convert a string to a detail record AMA flag. More...
int	ast_channel_supports_html (struct ast_channel *channel)
	Checks for HTML support on a channel. More...
int	ast_channel_suppress (struct ast_channel *chan, unsigned int direction, enum ast_frame_type frametype)
	Suppress passing of a frame type on a channel. More...
const struct ast_channel_tech *	ast_channel_tech (const struct ast_channel *chan)
void *	ast_channel_tech_pvt (const struct ast_channel *chan)
void	ast_channel_tech_pvt_set (struct ast_channel *chan, void *value)
void	ast_channel_tech_set (struct ast_channel *chan, const struct ast_channel_tech *value)
const char *	ast_channel_tenantid (const struct ast_channel *chan)
void	ast_channel_tenantid_set (struct ast_channel *chan, const char *value)
struct ast_timer *	ast_channel_timer (const struct ast_channel *chan)
void	ast_channel_timer_set (struct ast_channel *chan, struct ast_timer *value)
void *	ast_channel_timingdata (const struct ast_channel *chan)
void	ast_channel_timingdata_set (struct ast_channel *chan, void *value)
int	ast_channel_timingfd (const struct ast_channel *chan)
void	ast_channel_timingfd_set (struct ast_channel *chan, int value)
ast_timing_func_t	ast_channel_timingfunc (const struct ast_channel *chan)
void	ast_channel_timingfunc_set (struct ast_channel *chan, ast_timing_func_t value)
struct stasis_topic *	ast_channel_topic (struct ast_channel *chan)
	A topic which publishes the events for a particular channel. More...
unsigned short	ast_channel_transfercapability (const struct ast_channel *chan)
void	ast_channel_transfercapability_set (struct ast_channel *chan, unsigned short value)
int	ast_channel_unbridged (struct ast_channel *chan)
	This function will check if the bridge needs to be re-evaluated due to external changes. More...
int	ast_channel_unbridged_nolock (struct ast_channel *chan)
	ast_channel_unbridged variant. Use this if the channel is already locked prior to calling. More...
void	ast_channel_undefer_dtmf (struct ast_channel *chan)
	Unset defer DTMF flag on channel. More...
const char *	ast_channel_uniqueid (const struct ast_channel *chan)
void	ast_channel_unlink (struct ast_channel *chan)
	Remove a channel from the global channels container. More...
void	ast_channel_unregister (const struct ast_channel_tech *tech)
	Unregister a channel technology. More...
int	ast_channel_unsuppress (struct ast_channel *chan, unsigned int direction, enum ast_frame_type frametype)
	Stop suppressing of a frame type on a channel. More...
void	ast_channel_update_connected_line (struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update)
	Indicate that the connected line information has changed. More...
void	ast_channel_update_redirecting (struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update)
	Indicate that the redirecting id has changed. More...
const char *	ast_channel_userfield (const struct ast_channel *chan)
struct varshead *	ast_channel_varshead (struct ast_channel *chan)
void	ast_channel_varshead_set (struct ast_channel *chan, struct varshead *value)
int	ast_channel_visible_indication (const struct ast_channel *chan)
void	ast_channel_visible_indication_set (struct ast_channel *chan, int value)
struct ast_filestream *	ast_channel_vstream (const struct ast_channel *chan)
void	ast_channel_vstream_set (struct ast_channel *chan, struct ast_filestream *value)
int	ast_channel_vstreamid (const struct ast_channel *chan)
void	ast_channel_vstreamid_set (struct ast_channel *chan, int value)
struct timeval *	ast_channel_whentohangup (struct ast_channel *chan)
void	ast_channel_whentohangup_set (struct ast_channel *chan, struct timeval *value)
struct ast_format *	ast_channel_writeformat (struct ast_channel *chan)
struct ast_trans_pvt *	ast_channel_writetrans (const struct ast_channel *chan)
void	ast_channel_writetrans_set (struct ast_channel *chan, struct ast_trans_pvt *value)
struct ast_channel *	ast_channel_yank (struct ast_channel *yankee)
	Gain control of a channel in the system. More...
struct ast_tone_zone *	ast_channel_zone (const struct ast_channel *chan)
void	ast_channel_zone_set (struct ast_channel *chan, struct ast_tone_zone *value)
struct ast_variable *	ast_channeltype_list (void)
	return an ast_variable list of channeltypes More...
int	ast_check_hangup (struct ast_channel *chan)
	Check to see if a channel is needing hang up. More...
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, const struct ast_set_party_connected_line *update)
	Build the connected line information data frame. More...
void	ast_connected_line_copy_from_caller (struct ast_party_connected_line *dest, const struct ast_party_caller *src)
	Copy the caller information to the connected line information. More...
void	ast_connected_line_copy_to_caller (struct ast_party_caller *dest, const struct ast_party_connected_line *src)
	Copy the connected line information to the caller information. More...
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. More...
void	ast_deactivate_generator (struct ast_channel *chan)
static int	ast_fdisset (struct pollfd *pfds, int fd, int maximum, int *start)
	Helper function for migrating select to poll. More...
const struct ast_channel_tech *	ast_get_channel_tech (const char *name)
	Get a channel technology structure by name. More...
ast_group_t	ast_get_group (const char *s)
struct ast_namedgroups *	ast_get_namedgroups (const char *s)
	Create an ast_namedgroups set with group names from comma separated string. More...
void	ast_hangup (struct ast_channel *chan)
	Hang up a channel. More...
int	ast_indicate (struct ast_channel *chan, int condition)
	Indicates condition of channel. More...
int	ast_indicate_data (struct ast_channel *chan, int condition, const void *data, size_t datalen)
	Indicates condition of channel, with payload. More...
int	ast_is_deferrable_frame (const struct ast_frame *frame)
	Should we keep this frame for later? More...
int	ast_namedgroups_intersect (struct ast_namedgroups *a, struct ast_namedgroups *b)
	Return TRUE if group a and b contain at least one common groupname. More...
void	ast_party_caller_copy (struct ast_party_caller *dest, const struct ast_party_caller *src)
	Copy the source caller information to the destination caller. More...
void	ast_party_caller_free (struct ast_party_caller *doomed)
	Destroy the caller party contents. More...
void	ast_party_caller_init (struct ast_party_caller *init)
	Initialize the given caller structure. More...
void	ast_party_caller_set (struct ast_party_caller *dest, const struct ast_party_caller *src, const struct ast_set_party_caller *update)
	Set the caller information based on another caller source. More...
void	ast_party_caller_set_init (struct ast_party_caller *init, const struct ast_party_caller *guide)
	Initialize the given caller structure using the given guide for a set update operation. More...
void	ast_party_connected_line_collect_caller (struct ast_party_connected_line *connected, struct ast_party_caller *caller)
	Collect the caller party information into a connected line structure. More...
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. More...
void	ast_party_connected_line_free (struct ast_party_connected_line *doomed)
	Destroy the connected line information contents. More...
void	ast_party_connected_line_init (struct ast_party_connected_line *init)
	Initialize the given connected line structure. More...
void	ast_party_connected_line_set (struct ast_party_connected_line *dest, const struct ast_party_connected_line *src, const struct ast_set_party_connected_line *update)
	Set the connected line information based on another connected line source. More...
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. More...
void	ast_party_dialed_copy (struct ast_party_dialed *dest, const struct ast_party_dialed *src)
	Copy the source dialed party information to the destination dialed party. More...
void	ast_party_dialed_free (struct ast_party_dialed *doomed)
	Destroy the dialed party contents. More...
void	ast_party_dialed_init (struct ast_party_dialed *init)
	Initialize the given dialed structure. More...
void	ast_party_dialed_set (struct ast_party_dialed *dest, const struct ast_party_dialed *src)
	Set the dialed information based on another dialed source. More...
void	ast_party_dialed_set_init (struct ast_party_dialed *init, const struct ast_party_dialed *guide)
	Initialize the given dialed structure using the given guide for a set update operation. More...
void	ast_party_id_copy (struct ast_party_id *dest, const struct ast_party_id *src)
	Copy the source party id information to the destination party id. More...
void	ast_party_id_free (struct ast_party_id *doomed)
	Destroy the party id contents. More...
void	ast_party_id_init (struct ast_party_id *init)
	Initialize the given party id structure. More...
void	ast_party_id_invalidate (struct ast_party_id *id)
	Invalidate all components of the given party id. More...
struct ast_party_id	ast_party_id_merge (struct ast_party_id *base, struct ast_party_id *overlay)
	Merge a given party id into another given party id. More...
void	ast_party_id_merge_copy (struct ast_party_id *dest, struct ast_party_id *base, struct ast_party_id *overlay)
	Copy a merge of a given party id into another given party id to a given destination party id. More...
int	ast_party_id_presentation (const struct ast_party_id *id)
	Determine the overall presentation value for the given party. More...
void	ast_party_id_reset (struct ast_party_id *id)
	Destroy and initialize the given party id structure. More...
void	ast_party_id_set (struct ast_party_id *dest, const struct ast_party_id *src, const struct ast_set_party_id *update)
	Set the source party id information into the destination party id. More...
void	ast_party_id_set_init (struct ast_party_id *init, const struct ast_party_id *guide)
	Initialize the given party id structure using the given guide for a set update operation. More...
void	ast_party_name_copy (struct ast_party_name *dest, const struct ast_party_name *src)
	Copy the source party name information to the destination party name. More...
void	ast_party_name_free (struct ast_party_name *doomed)
	Destroy the party name contents. More...
void	ast_party_name_init (struct ast_party_name *init)
	Initialize the given name structure. More...
void	ast_party_name_set (struct ast_party_name *dest, const struct ast_party_name *src)
	Set the source party name information into the destination party name. More...
void	ast_party_name_set_init (struct ast_party_name *init, const struct ast_party_name *guide)
	Initialize the given party name structure using the given guide for a set update operation. More...
void	ast_party_number_copy (struct ast_party_number *dest, const struct ast_party_number *src)
	Copy the source party number information to the destination party number. More...
void	ast_party_number_free (struct ast_party_number *doomed)
	Destroy the party number contents. More...
void	ast_party_number_init (struct ast_party_number *init)
	Initialize the given number structure. More...
void	ast_party_number_set (struct ast_party_number *dest, const struct ast_party_number *src)
	Set the source party number information into the destination party number. More...
void	ast_party_number_set_init (struct ast_party_number *init, const struct ast_party_number *guide)
	Initialize the given party number structure using the given guide for a set update operation. More...
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. More...
void	ast_party_redirecting_free (struct ast_party_redirecting *doomed)
	Destroy the redirecting information contents. More...
void	ast_party_redirecting_init (struct ast_party_redirecting *init)
	Initialize the given redirecting structure. More...
void	ast_party_redirecting_reason_copy (struct ast_party_redirecting_reason *dest, const struct ast_party_redirecting_reason *src)
	Copy the source redirecting reason information to the destination redirecting reason. More...
void	ast_party_redirecting_reason_free (struct ast_party_redirecting_reason *doomed)
	Destroy the redirecting reason contents. More...
void	ast_party_redirecting_reason_init (struct ast_party_redirecting_reason *init)
	Initialize the given redirecting reason structure. More...
void	ast_party_redirecting_reason_set (struct ast_party_redirecting_reason *dest, const struct ast_party_redirecting_reason *src)
	Set the redirecting reason information based on another redirecting reason source. More...
void	ast_party_redirecting_reason_set_init (struct ast_party_redirecting_reason *init, const struct ast_party_redirecting_reason *guide)
	Initialize the given redirecting reason structure using the given guide for a set update operation. More...
void	ast_party_redirecting_set (struct ast_party_redirecting *dest, const struct ast_party_redirecting *src, const struct ast_set_party_redirecting *update)
	Set the redirecting information based on another redirecting source. More...
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. More...
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. More...
void	ast_party_subaddress_free (struct ast_party_subaddress *doomed)
	Destroy the party subaddress contents. More...
void	ast_party_subaddress_init (struct ast_party_subaddress *init)
	Initialize the given subaddress structure. More...
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. More...
void	ast_party_subaddress_set_init (struct ast_party_subaddress *init, const struct ast_party_subaddress *guide)
	Initialize the given party subaddress structure using the given guide for a set update operation. More...
int	ast_pre_call (struct ast_channel *chan, const char *sub_args)
	Execute a Gosub call on the channel before a call is placed. More...
char *	ast_print_group (char *buf, int buflen, ast_group_t group)
	Print call and pickup groups into buffer. More...
char *	ast_print_namedgroups (struct ast_str **buf, struct ast_namedgroups *groups)
	Print named call groups and named pickup groups. More...
int	ast_prod (struct ast_channel *chan)
	Send empty audio to prime a channel driver. More...
int	ast_queue_answer (struct ast_channel *chan, const struct ast_stream_topology *topology)
	Queue an ANSWER control frame with topology. More...
int	ast_queue_control (struct ast_channel *chan, enum ast_control_frame_type control)
	Queue a control frame without payload. More...
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. More...
int	ast_queue_frame (struct ast_channel *chan, struct ast_frame *f)
	Queue one or more frames to a channel's frame queue. More...
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. More...
int	ast_queue_hangup (struct ast_channel *chan)
	Queue a hangup frame. More...
int	ast_queue_hangup_with_cause (struct ast_channel *chan, int cause)
	Queue a hangup frame with hangupcause set. More...
int	ast_queue_hold (struct ast_channel *chan, const char *musicclass)
	Queue a hold frame. More...
int	ast_queue_unhold (struct ast_channel *chan)
	Queue an unhold frame. More...
int	ast_raw_answer (struct ast_channel *chan)
	Answer a channel. More...
int	ast_raw_answer_with_stream_topology (struct ast_channel *chan, struct ast_stream_topology *topology)
	Answer a channel passing in a stream topology. More...
struct ast_frame *	ast_read (struct ast_channel *chan)
	Reads a frame. More...
struct ast_frame *	ast_read_noaudio (struct ast_channel *chan)
	Reads a frame, returning AST_FRAME_NULL frame if audio. More...
struct ast_frame *	ast_read_stream (struct ast_channel *chan)
	Reads a frame, but does not filter to just the default streams. More...
struct ast_frame *	ast_read_stream_noaudio (struct ast_channel *chan)
	Reads a frame, but does not filter to just the default streams, returning AST_FRAME_NULL frame if audio. More...
int	ast_readstring (struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders)
	Reads multiple digits. More...
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. More...
char *	ast_recvtext (struct ast_channel *chan, int timeout)
	Receives a text string from a channel Read a string of text from a channel. More...
int	ast_redirecting_build_data (unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update)
	Build the redirecting id data frame. More...
int	ast_redirecting_parse_data (const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting)
	Parse redirecting indication frame data. More...
struct ast_namedgroups *	ast_ref_namedgroups (struct ast_namedgroups *groups)
struct ast_channel *	ast_request (const char *type, struct ast_format_cap *request_cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr, int *cause)
	Requests a channel. More...
struct ast_channel *	ast_request_and_dial (const char *type, struct ast_format_cap *cap, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr, 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. More...
struct ast_channel *	ast_request_with_stream_topology (const char *type, struct ast_stream_topology *topology, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr, int *cause)
	Requests a channel (specifying stream topology) More...
int	ast_safe_sleep (struct ast_channel *chan, int ms)
	Wait for a specified amount of time, looking for hangups. More...
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. More...
int	ast_safe_sleep_without_silence (struct ast_channel *chan, int ms)
	Wait for a specified amount of time, looking for hangups, and do not generate silence. More...
int	ast_senddigit (struct ast_channel *chan, char digit, unsigned int duration)
	Send a DTMF digit to a channel. More...
int	ast_senddigit_begin (struct ast_channel *chan, char digit)
	Send a DTMF digit to a channel. More...
int	ast_senddigit_end (struct ast_channel *chan, char digit, unsigned int duration)
	Send a DTMF digit to a channel. More...
int	ast_senddigit_external (struct ast_channel *chan, char digit, unsigned int duration)
	Send a DTMF digit to a channel from an external thread. More...
int	ast_senddigit_mf (struct ast_channel *chan, char digit, unsigned int duration, unsigned int durationkp, unsigned int durationst, int is_external)
	Send an MF digit to a channel. More...
int	ast_senddigit_mf_begin (struct ast_channel *chan, char digit)
	Send an MF digit to a channel. More...
int	ast_senddigit_mf_end (struct ast_channel *chan)
	End sending an MF digit to a channel. More...
int	ast_sendtext (struct ast_channel *chan, const char *text)
	Sends text to a channel. More...
int	ast_sendtext_data (struct ast_channel *chan, struct ast_msg_data *msg)
	Sends text to a channel in an ast_msg_data structure wrapper with ast_sendtext as fallback. More...
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 and generate AMI event. More...
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. More...
void	ast_set_party_id_all (struct ast_set_party_id *update_id)
	Set the update marker to update all information of a corresponding party id. More...
int	ast_set_read_format (struct ast_channel *chan, struct ast_format *format)
	Sets read format on channel chan. More...
int	ast_set_read_format_from_cap (struct ast_channel *chan, struct ast_format_cap *formats)
	Sets read format on channel chan from capabilities Set read format for channel to whichever component of "format" is best. More...
int	ast_set_read_format_path (struct ast_channel *chan, struct ast_format *raw_format, struct ast_format *core_format)
	Set specific read path on channel. More...
void	ast_set_variables (struct ast_channel *chan, struct ast_variable *vars)
	adds a list of channel variables to a channel More...
int	ast_set_write_format (struct ast_channel *chan, struct ast_format *format)
	Sets write format on channel chan. More...
int	ast_set_write_format_from_cap (struct ast_channel *chan, struct ast_format_cap *formats)
	Sets write format on channel chan Set write format for channel to whichever component of "format" is best. More...
int	ast_set_write_format_interleaved_stereo (struct ast_channel *chan, struct ast_format *format)
	Sets write format for a channel. All internal data will than be handled in an interleaved format. (needed by binaural opus) More...
int	ast_set_write_format_path (struct ast_channel *chan, struct ast_format *core_format, struct ast_format *raw_format)
	Set specific write path on channel. More...
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. More...
int	ast_settimeout_full (struct ast_channel *c, unsigned int rate, int(*func)(const void *data), void *data, unsigned int is_ao2_obj)
int	ast_softhangup (struct ast_channel *chan, int cause)
	Softly hangup up a channel. More...
void	ast_softhangup_all (void)
	Soft hangup all active channels. More...
int	ast_softhangup_nolock (struct ast_channel *chan, int cause)
	Softly hangup up a channel (no channel lock) More...
const char *	ast_state2str (enum ast_channel_state state)
	Gives the string form of a given channel state. More...
int	ast_str2cause (const char *name) attribute_pure
	Convert the string form of a cause code to a number. More...
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). More...
int	ast_transfer_protocol (struct ast_channel *chan, char *dest, int *protocol)
	Transfer a channel (if supported) receieve protocol result. More...
char *	ast_transfercapability2str (int transfercapability) attribute_const
	Gives the string form of a given transfer capability. More...
int	ast_undestroyed_channels (void)
struct ast_namedgroups *	ast_unref_namedgroups (struct ast_namedgroups *groups)
int	ast_waitfor (struct ast_channel *chan, int ms)
	Wait for input on a channel. More...
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. More...
int	ast_waitfor_n_fd (int *fds, int n, int *ms, int *exception)
	Waits for input on an fd. More...
struct ast_channel *	ast_waitfor_nandfds (struct ast_channel **c, int n, int *fds, int nfds, int *exception, int *outfd, int *ms)
	Waits for activity on a group of channels. More...
int	ast_waitfordigit (struct ast_channel *c, int ms)
	Waits for a digit. More...
int	ast_waitfordigit_full (struct ast_channel *c, int ms, const char *breakon, 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. More...
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. More...
int	ast_write_stream (struct ast_channel *chan, int stream_num, struct ast_frame *frame)
	Write a frame to a stream This function writes the given frame to the indicated stream on the channel. More...
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. More...
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. More...
	DECLARE_STRINGFIELD_SETTERS_FOR (accountcode)
	DECLARE_STRINGFIELD_SETTERS_FOR (call_forward)
	DECLARE_STRINGFIELD_SETTERS_FOR (dialcontext)
	DECLARE_STRINGFIELD_SETTERS_FOR (hangupsource)
	DECLARE_STRINGFIELD_SETTERS_FOR (language)
	DECLARE_STRINGFIELD_SETTERS_FOR (latest_musicclass)
	DECLARE_STRINGFIELD_SETTERS_FOR (linkedid)
	DECLARE_STRINGFIELD_SETTERS_FOR (musicclass)
	DECLARE_STRINGFIELD_SETTERS_FOR (name)
	DECLARE_STRINGFIELD_SETTERS_FOR (parkinglot)
	DECLARE_STRINGFIELD_SETTERS_FOR (peeraccount)
	DECLARE_STRINGFIELD_SETTERS_FOR (uniqueid)
	DECLARE_STRINGFIELD_SETTERS_FOR (userfield)
struct ast_channel_iterator *	ast_channel_iterator_all_new (void)
	Create a new channel iterator. More...
struct ast_channel_iterator *	ast_channel_iterator_by_exten_new (const char *exten, const char *context)
	Create a new channel iterator based on extension. More...
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. More...
struct ast_channel_iterator *	ast_channel_iterator_destroy (struct ast_channel_iterator *i)
	Destroy a channel iterator. More...
struct ast_channel *	ast_channel_iterator_next (struct ast_channel_iterator *i)
	Get the next channel for a channel iterator. More...
struct ast_channel *	ast_channel_get_by_exten (const char *exten, const char *context)
	Find a channel by extension and context. More...
struct ast_channel *	ast_channel_get_by_name (const char *name)
	Find a channel by name. More...
struct ast_channel *	ast_channel_get_by_name_prefix (const char *name, size_t name_len)
	Find a channel by a name prefix. More...

Variables
const struct ast_channel_tech	ast_kill_tech
	Kill the channel channel driver technology descriptor. More...
static const char	ast_stream_topology_changed_external [] = "external"
	Set as the change source reason when a channel stream topology has been changed externally as a result of the remote side renegotiating. More...
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.

Macro Definition Documentation

AST_AGENT_FD

#define AST_AGENT_FD   (AST_MAX_FDS-3)

used by agents for pass through

Definition at line 204 of file channel.h.

AST_ALERT_FD

#define AST_ALERT_FD   (AST_MAX_FDS-1)

used for alertpipe

Definition at line 202 of file channel.h.

AST_BRIDGE_DTMF_CHANNEL_0

#define AST_BRIDGE_DTMF_CHANNEL_0   (1 << 0)

Report DTMF on channel 0.

Definition at line 2416 of file channel.h.

AST_BRIDGE_DTMF_CHANNEL_1

#define AST_BRIDGE_DTMF_CHANNEL_1   (1 << 1)

Report DTMF on channel 1.

Definition at line 2418 of file channel.h.

AST_CHAN_WRITE_INFO_T_VERSION

#define AST_CHAN_WRITE_INFO_T_VERSION   1

ast_chan_write_info_t version. Must be incremented if structure is changed

Definition at line 593 of file channel.h.

ast_channel_alloc

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

Value:

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

Create a channel structure.

Return values

NULL	failure
non-NULL	successfully allocated channel

Note

Absolutely NO channel locks should be held before calling this function.

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

Since 12.0.0 this function returns with the newly created channel locked.

Definition at line 1299 of file channel.h.

ast_channel_alloc_with_endpoint

#define ast_channel_alloc_with_endpoint	(		needqueue,
			state,
			cid_num,
			cid_name,
			acctcode,
			exten,
			context,
			assignedids,
			requestor,
			amaflag,
			endpoint,
			...
	)

Value:

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

Definition at line 1303 of file channel.h.

ast_channel_alloc_with_initializers

#define ast_channel_alloc_with_initializers	(		needqueue,
			state,
			cid_num,
			cid_name,
			acctcode,
			exten,
			context,
			assignedids,
			requestor,
			amaflag,
			endpoint,
			initializers,
			...
	)

Value:

    __ast_channel_alloc_with_initializers((needqueue), (state), (cid_num), (cid_name), (acctcode), (exten), (context), (assignedids), (requestor), (amaflag), (endpoint), \
        (initializers), __FILE__, __LINE__, __FUNCTION__, __VA_ARGS__)

Definition at line 1307 of file channel.h.

ast_channel_cleanup

#define ast_channel_cleanup

(

c

)

({ ao2_cleanup(c); (struct ast_channel *) (NULL); })

Cleanup a channel reference.

Parameters

c	the channel (NULL tolerant)

Return values

NULL

always

Since

12.0.0

Definition at line 3015 of file channel.h.

ast_channel_has_tech_function

#define ast_channel_has_tech_function	(		chan,
			function
	)		(ast_channel_tech(chan) ? ast_channel_tech(chan)->function != NULL : 0)

Checks if a channel's technology implements a particular callback function.

Since

18.0.0

Parameters

chan	The channel
function	The function to look for

Return values

1	if the channel has a technology set and it implements the function
0	if the channel doesn't have a technology set or it doesn't implement the function

Definition at line 4996 of file channel.h.

AST_CHANNEL_INITIALIZERS_VERSION

#define AST_CHANNEL_INITIALIZERS_VERSION   1

struct ABI version

Note

This must be incremented when the struct changes.

Definition at line 620 of file channel.h.

ast_channel_lock

#define ast_channel_lock

(

chan

)

ao2_lock(chan)

Definition at line 2968 of file channel.h.

ast_channel_lock_both

#define ast_channel_lock_both	(		chan1,
			chan2
	)

Lock two channels.

Definition at line 2975 of file channel.h.

AST_CHANNEL_NAME

#define AST_CHANNEL_NAME   80

Max length of an ast_channel name

Definition at line 173 of file channel.h.

ast_channel_ref

#define ast_channel_ref

(

c

)

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

Increase channel reference count.

Parameters

c	the channel

Return values

c

always

Since

1.8

Definition at line 2993 of file channel.h.

ast_channel_trylock

#define ast_channel_trylock

(

chan

)

ao2_trylock(chan)

Definition at line 2970 of file channel.h.

ast_channel_unlock

#define ast_channel_unlock

(

chan

)

ao2_unlock(chan)

Definition at line 2969 of file channel.h.

ast_channel_unref

#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.8

Definition at line 3004 of file channel.h.

ast_dummy_channel_alloc

#define ast_dummy_channel_alloc

(

)

__ast_dummy_channel_alloc(__FILE__, __LINE__, __PRETTY_FUNCTION__)

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.

The created dummy channel should be destroyed by ast_channel_unref(). Using ast_channel_release() needlessly grabs the channel container lock and can cause a deadlock as a result. Also grabbing the channel container lock reduces system performance.

Definition at line 1328 of file channel.h.

AST_EXTENDED_FDS

#define AST_EXTENDED_FDS   12

the start of extended file descriptor positions

Definition at line 197 of file channel.h.

AST_FEATURE_DTMF_MASK

#define AST_FEATURE_DTMF_MASK

Value:

    (AST_FEATURE_REDIRECT | AST_FEATURE_DISCONNECT |\
    AST_FEATURE_ATXFER | AST_FEATURE_AUTOMON | AST_FEATURE_PARKCALL | AST_FEATURE_AUTOMIXMON)

Definition at line 1092 of file channel.h.

AST_GENERATOR_FD

#define AST_GENERATOR_FD   (AST_MAX_FDS-4)

used by generator

Definition at line 205 of file channel.h.

AST_JITTERBUFFER_FD

#define AST_JITTERBUFFER_FD   (AST_MAX_FDS-5)

used by generator

Definition at line 206 of file channel.h.

AST_MAX_ACCOUNT_CODE

#define AST_MAX_ACCOUNT_CODE   80

Max length of an account code

Definition at line 172 of file channel.h.

AST_MAX_CONTEXT

#define AST_MAX_CONTEXT   80

Max length of a context

Definition at line 135 of file channel.h.

AST_MAX_EXTENSION

#define AST_MAX_EXTENSION   80

Max length of an extension

Definition at line 134 of file channel.h.

AST_MAX_FDS

#define AST_MAX_FDS   11

original maximum number of file descriptors

Definition at line 196 of file channel.h.

AST_MAX_PUBLIC_UNIQUEID

#define AST_MAX_PUBLIC_UNIQUEID   149

Max length of a channel uniqueid reported to the outside world.

149 = 127 (max systemname) + "-" + 10 (epoch timestamp)

• "." + 10 (monotonically incrementing integer).

Note

If this value is ever changed, MAX_CHANNEL_ID should be updated in rtp_engine.h.

Definition at line 147 of file channel.h.

AST_MAX_TENANT_ID

#define AST_MAX_TENANT_ID   64

Max length of a channel tenant_id

Definition at line 149 of file channel.h.

AST_MAX_UNIQUEID

#define AST_MAX_UNIQUEID   (AST_MAX_PUBLIC_UNIQUEID + 2 + 1)

Maximum size of an internal Asterisk channel unique ID.

Add two for the Local;2 channel to append a ';2' if needed plus nul terminator.

Note

If this value is ever changed, MAX_CHANNEL_ID should be updated in rtp_engine.h.

Definition at line 170 of file channel.h.

AST_MAX_USER_FIELD

#define AST_MAX_USER_FIELD   256

Max length of the channel user field

Definition at line 176 of file channel.h.

AST_MUTE_DIRECTION_READ

#define AST_MUTE_DIRECTION_READ   (1 << 0)

Definition at line 4760 of file channel.h.

AST_MUTE_DIRECTION_WRITE

#define AST_MUTE_DIRECTION_WRITE   (1 << 1)

Definition at line 4761 of file channel.h.

AST_NUM_CHANNEL_BUCKETS

#define AST_NUM_CHANNEL_BUCKETS   1567

The number of buckets to store channels or channel information

Definition at line 157 of file channel.h.

AST_TIMING_FD

#define AST_TIMING_FD   (AST_MAX_FDS-2)

used for timingfd

Definition at line 203 of file channel.h.

CHECK_BLOCKING

#define CHECK_BLOCKING

(

c

)

Set the blocking indication on the channel.

Indicate that the thread handling the channel is about to do a blocking operation to wait for media on the channel. (poll, read, or write)

Masquerading and ast_queue_frame() use this indication to wake up the thread.

Precondition

The channel needs to be locked

Definition at line 2917 of file channel.h.

DATASTORE_INHERIT_FOREVER

#define DATASTORE_INHERIT_FOREVER   INT_MAX

Definition at line 194 of file channel.h.

DEBUGCHAN_FLAG

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

DECLARE_STRINGFIELD_SETTERS_FOR

#define DECLARE_STRINGFIELD_SETTERS_FOR

(

field

)

Value:

    void ast_channel_##field##_set(struct ast_channel *chan, const char *field); \
    void ast_channel_##field##_build_va(struct ast_channel *chan, const char *fmt, va_list ap) __attribute__((format(printf, 2, 0))); \
    void ast_channel_##field##_build(struct ast_channel *chan, const char *fmt, ...) __attribute__((format(printf, 2, 3)))

Definition at line 4084 of file channel.h.

FRAMECOUNT_INC

#define FRAMECOUNT_INC

(

x

)

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

Definition at line 880 of file channel.h.

MAX_LANGUAGE

#define MAX_LANGUAGE   40

Max length of the language setting

Definition at line 174 of file channel.h.

MAX_MUSICCLASS

#define MAX_MUSICCLASS   80

Max length of the music class setting

Definition at line 175 of file channel.h.

Typedef Documentation

ast_acf_read2_fn_t

typedef int(* ast_acf_read2_fn_t) (struct ast_channel *chan, const char *cmd, char *data, struct ast_str **str, ssize_t len)

Typedef for a custom read2 function.

Note

data should be treated as const char *.

Definition at line 582 of file channel.h.

ast_acf_read_fn_t

typedef int(* ast_acf_read_fn_t) (struct ast_channel *chan, const char *function, char *data, char *buf, size_t len)

Typedef for a custom read function.

Note

data should be treated as const char *.

Definition at line 576 of file channel.h.

ast_acf_write_fn_t

typedef int(* ast_acf_write_fn_t) (struct ast_channel *chan, const char *function, char *data, const char *value)

Typedef for a custom write function.

Note

data should be treated as const char *.

Definition at line 588 of file channel.h.

ast_group_t

typedef unsigned long long ast_group_t

Definition at line 215 of file channel.h.

ast_timing_func_t

typedef int(* ast_timing_func_t) (const void *data)

Definition at line 919 of file channel.h.

Enumeration Type Documentation

anonymous enum

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.
AST_CHAN_TP_INTERNAL	Channels with this particular technology are an implementation detail of Asterisk and should generally not be exposed or manipulated by the outside world.
AST_CHAN_TP_SEND_TEXT_DATA	Channels have this property if they implement send_text_data.

Definition at line 975 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),
    /*!
     * \brief Channels with this particular technology are an implementation detail of
     * Asterisk and should generally not be exposed or manipulated by the outside
     * world
     */
    AST_CHAN_TP_INTERNAL = (1 << 2),
    /*!
     * \brief Channels have this property if they implement send_text_data
     */
    AST_CHAN_TP_SEND_TEXT_DATA = (1 << 3),
};

anonymous enum

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_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_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_DISABLE_WORKAROUNDS	Disable certain workarounds. This reintroduces certain bugs, but allows some non-traditional dialplans (like AGI) to continue to function.
AST_FLAG_DISABLE_DEVSTATE_CACHE	Disable device state event caching. This allows channel drivers to selectively prevent device state events from being cached by certain channels such as anonymous calls which have no persistent represenatation that can be tracked.
AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT	This flag indicates that a dual channel redirect is in progress. The bridge needs to wait until the flag is cleared to continue.
AST_FLAG_ORIGINATED	This flag indicates that the channel was originated.
AST_FLAG_DEAD	The channel is well and truly dead. Once this is set and published, no further actions should be taken upon the channel, and no further publications should occur.
AST_FLAG_SNAPSHOT_STAGE	Channel snapshot should not be published, it is being staged for an explicit publish.
AST_FLAG_TIMINGDATA_IS_AO2_OBJ	The data on chan->timingdata is an astobj2 object.
AST_FLAG_SUBROUTINE_EXEC	The channel is executing a subroutine or macro

Definition at line 999 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),
    /*! 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),
    /* OBSOLETED in favor of AST_CAUSE_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_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),
    /*! Disable certain workarounds.  This reintroduces certain bugs, but allows
     *  some non-traditional dialplans (like AGI) to continue to function.
     */
    AST_FLAG_DISABLE_WORKAROUNDS = (1 << 20),
    /*!
     * Disable device state event caching.  This allows channel
     * drivers to selectively prevent device state events from being
     * cached by certain channels such as anonymous calls which have
     * no persistent represenatation that can be tracked.
     */
    AST_FLAG_DISABLE_DEVSTATE_CACHE = (1 << 21),
    /*!
     * This flag indicates that a dual channel redirect is in
     * progress.  The bridge needs to wait until the flag is cleared
     * to continue.
     */
    AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT = (1 << 22),
    /*!
     * This flag indicates that the channel was originated.
     */
    AST_FLAG_ORIGINATED = (1 << 23),
    /*!
     * The channel is well and truly dead. Once this is set and published, no further
     * actions should be taken upon the channel, and no further publications should
     * occur.
     */
    AST_FLAG_DEAD = (1 << 24),
    /*!
     * Channel snapshot should not be published, it is being staged for an explicit
     * publish.
     */
    AST_FLAG_SNAPSHOT_STAGE = (1 << 25),
    /*!
     * The data on chan->timingdata is an astobj2 object.
     */
    AST_FLAG_TIMINGDATA_IS_AO2_OBJ = (1 << 26),
    /*!
     * The channel is executing a subroutine or macro
     */
    AST_FLAG_SUBROUTINE_EXEC = (1 << 27),
};

anonymous enum

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

Definition at line 1082 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),
};

anonymous enum

anonymous enum

Enumerator
AST_SOFTHANGUP_DEV	Soft hangup requested by device or other internal reason. Actual hangup needed.
AST_SOFTHANGUP_ASYNCGOTO	Used to break the normal frame flow so an async goto can be done instead of actually hanging up.
AST_SOFTHANGUP_SHUTDOWN	Soft hangup requested by system shutdown. Actual hangup needed.
AST_SOFTHANGUP_TIMEOUT	Used to break the normal frame flow after a timeout so an implicit async goto can be done to the 'T' exten if it exists instead of actually hanging up. If the exten does not exist then actually hangup.
AST_SOFTHANGUP_APPUNLOAD	Soft hangup requested by application/channel-driver being unloaded. Actual hangup needed.
AST_SOFTHANGUP_EXPLICIT	Soft hangup requested by non-associated party. Actual hangup needed.
AST_SOFTHANGUP_HANGUP_EXEC	Used to indicate that the channel is currently executing hangup logic in the dialplan. The channel has been hungup when this is set.
AST_SOFTHANGUP_ALL	All softhangup flags. This can be used as an argument to ast_channel_clear_softhangup() to clear all softhangup flags from a channel.

Definition at line 1136 of file channel.h.

     {
    /*!
     * Soft hangup requested by device or other internal reason.
     * Actual hangup needed.
     */
    AST_SOFTHANGUP_DEV =       (1 << 0),
    /*!
     * Used to break the normal frame flow so an async goto can be
     * done instead of actually hanging up.
     */
    AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
    /*!
     * Soft hangup requested by system shutdown.  Actual hangup
     * needed.
     */
    AST_SOFTHANGUP_SHUTDOWN =  (1 << 2),
    /*!
     * Used to break the normal frame flow after a timeout so an
     * implicit async goto can be done to the 'T' exten if it exists
     * instead of actually hanging up.  If the exten does not exist
     * then actually hangup.
     */
    AST_SOFTHANGUP_TIMEOUT =   (1 << 3),
    /*!
     * Soft hangup requested by application/channel-driver being
     * unloaded.  Actual hangup needed.
     */
    AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
    /*!
     * Soft hangup requested by non-associated party.  Actual hangup
     * needed.
     */
    AST_SOFTHANGUP_EXPLICIT =  (1 << 5),
    /*!
     * Used to indicate that the channel is currently executing hangup
     * logic in the dialplan. The channel has been hungup when this is
     * set.
     */
    AST_SOFTHANGUP_HANGUP_EXEC = (1 << 7),
    /*!
     * \brief All softhangup flags.
     *
     * This can be used as an argument to ast_channel_clear_softhangup()
     * to clear all softhangup flags from a channel.
     */
    AST_SOFTHANGUP_ALL =       (0xFFFFFFFF)
};

ama_flags

enum ama_flags

Channel AMA Flags.

Enumerator
AST_AMA_NONE
AST_AMA_OMIT
AST_AMA_BILLING
AST_AMA_DOCUMENTATION

Definition at line 1197 of file channel.h.

               {
    AST_AMA_NONE = 0,
    AST_AMA_OMIT,
    AST_AMA_BILLING,
    AST_AMA_DOCUMENTATION,
};

ast_bridge_result

enum ast_bridge_result

Enumerator
AST_BRIDGE_COMPLETE
AST_BRIDGE_FAILED
AST_BRIDGE_FAILED_NOWARN
AST_BRIDGE_RETRY

Definition at line 208 of file channel.h.

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

ast_channel_adsicpe

enum ast_channel_adsicpe

Enumerator
AST_ADSI_UNKNOWN
AST_ADSI_AVAILABLE
AST_ADSI_UNAVAILABLE
AST_ADSI_OFFHOOKONLY

Definition at line 888 of file channel.h.

                         {
    AST_ADSI_UNKNOWN,
    AST_ADSI_AVAILABLE,
    AST_ADSI_UNAVAILABLE,
    AST_ADSI_OFFHOOKONLY,
};

ast_channel_error

enum ast_channel_error

Enumerator
AST_CHANNEL_ERROR_UNKNOWN
AST_CHANNEL_ERROR_ID_EXISTS

Definition at line 4841 of file channel.h.

                       {
    /* Unable to determine what error occurred. */
    AST_CHANNEL_ERROR_UNKNOWN,
    /* Channel with this ID already exists */
    AST_CHANNEL_ERROR_ID_EXISTS,
};

ast_channel_requestor_relationship

enum ast_channel_requestor_relationship

Enumerator
AST_CHANNEL_REQUESTOR_BRIDGE_PEER	The requestor is the future bridge peer of the channel.
AST_CHANNEL_REQUESTOR_REPLACEMENT	The requestor is to be replaced by the channel.

Definition at line 1521 of file channel.h.

                                        {
    /*! The requestor is the future bridge peer of the channel. */
    AST_CHANNEL_REQUESTOR_BRIDGE_PEER,
    /*! The requestor is to be replaced by the channel. */
    AST_CHANNEL_REQUESTOR_REPLACEMENT,
};

AST_MONITORING_STATE

enum AST_MONITORING_STATE

Enumerator
AST_MONITOR_RUNNING
AST_MONITOR_PAUSED

Definition at line 4077 of file channel.h.

                          {
    AST_MONITOR_RUNNING,
    AST_MONITOR_PAUSED
};

AST_PARTY_CHAR_SET

enum AST_PARTY_CHAR_SET

Party name character set enumeration values (values from Q.SIG)

Enumerator
AST_PARTY_CHAR_SET_UNKNOWN
AST_PARTY_CHAR_SET_ISO8859_1
AST_PARTY_CHAR_SET_WITHDRAWN
AST_PARTY_CHAR_SET_ISO8859_2
AST_PARTY_CHAR_SET_ISO8859_3
AST_PARTY_CHAR_SET_ISO8859_4
AST_PARTY_CHAR_SET_ISO8859_5
AST_PARTY_CHAR_SET_ISO8859_7
AST_PARTY_CHAR_SET_ISO10646_BMPSTRING
AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING

Definition at line 244 of file channel.h.

                        {
    AST_PARTY_CHAR_SET_UNKNOWN = 0,
    AST_PARTY_CHAR_SET_ISO8859_1 = 1,
    AST_PARTY_CHAR_SET_WITHDRAWN = 2,/* ITU withdrew this enum value. */
    AST_PARTY_CHAR_SET_ISO8859_2 = 3,
    AST_PARTY_CHAR_SET_ISO8859_3 = 4,
    AST_PARTY_CHAR_SET_ISO8859_4 = 5,
    AST_PARTY_CHAR_SET_ISO8859_5 = 6,
    AST_PARTY_CHAR_SET_ISO8859_7 = 7,
    AST_PARTY_CHAR_SET_ISO10646_BMPSTRING = 8,
    AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING = 9,
};

ast_t38_state

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

channelreloadreason

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
CHANNEL_ACL_RELOAD

Definition at line 1186 of file channel.h.

                         {
    CHANNEL_MODULE_LOAD,
    CHANNEL_MODULE_RELOAD,
    CHANNEL_CLI_RELOAD,
    CHANNEL_MANAGER_RELOAD,
    CHANNEL_ACL_RELOAD,
};

Function Documentation

__ast_answer()

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

Answer a channel, with a selectable delay before returning.

Parameters

chan	channel to answer
delay	maximum amount of time to wait for incoming media

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

{
    int res = 0;
    enum ast_channel_state old_state;
    SCOPE_TRACE(1, "%s\n", ast_channel_name(chan));
 
    old_state = ast_channel_state(chan);
    if ((res = ast_raw_answer(chan))) {
        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;
            struct ast_frame *new_frame;
            int timeout_ms = MAX(delay, 500);
            unsigned int done = 0;
            struct timeval start;
 
            AST_LIST_HEAD_INIT_NOLOCK(&frames);
 
            start = ast_tvnow();
            for (;;) {
                int ms = ast_remaining_ms(start, timeout_ms);
                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", ast_channel_name(chan), strerror(errno));
                    res = -1;
                    break;
                }
                if (ms == 0) {
                    ast_debug(2, "Didn't receive a media frame from %s within %u ms of answering. Continuing anyway\n", ast_channel_name(chan), MAX(delay, 500));
                    break;
                }
                cur = ast_read(chan);
                if (!cur || ((cur->frametype == AST_FRAME_CONTROL) &&
                         (cur->subclass.integer == AST_CONTROL_HANGUP))) {
                    if (cur) {
                        ast_frfree(cur);
                    }
                    res = -1;
                    ast_debug(2, "Hangup of channel %s detected in answer routine\n", ast_channel_name(chan));
                    break;
                }
 
                if ((new_frame = ast_frisolate(cur)) != cur) {
                    ast_frfree(cur);
                }
 
                AST_LIST_INSERT_HEAD(&frames, new_frame, 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_frame->frametype) {
                    /* all of these frametypes qualify as 'media' */
                case AST_FRAME_VOICE:
                case AST_FRAME_VIDEO:
                case AST_FRAME_TEXT:
                case AST_FRAME_TEXT_DATA:
                case AST_FRAME_DTMF_BEGIN:
                case AST_FRAME_DTMF_END:
                case AST_FRAME_IMAGE:
                case AST_FRAME_HTML:
                case AST_FRAME_MODEM:
                case AST_FRAME_RTCP:
                    done = 1;
                    break;
                case AST_FRAME_CONTROL:
                case AST_FRAME_IAX:
                case AST_FRAME_BRIDGE_ACTION:
                case AST_FRAME_BRIDGE_ACTION_SYNC:
                case AST_FRAME_NULL:
                case AST_FRAME_CNG:
                    break;
                }
 
                if (done) {
                    break;
                }
            }
 
            ast_channel_lock(chan);
            while ((cur = AST_LIST_REMOVE_HEAD(&frames, frame_list))) {
                if (res == 0) {
                    ast_queue_frame_head(chan, cur);
                }
                ast_frfree(cur);
            }
            ast_channel_unlock(chan);
        } while (0);
        break;
    default:
        break;
    }
 
    return res;
}

References ast_channel_lock, ast_channel_name(), ast_channel_unlock, AST_CONTROL_HANGUP, ast_debug, AST_FRAME_BRIDGE_ACTION, AST_FRAME_BRIDGE_ACTION_SYNC, 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_RTCP, AST_FRAME_TEXT, AST_FRAME_TEXT_DATA, 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_remaining_ms(), AST_STATE_RING, AST_STATE_RINGING, ast_tvnow(), ast_waitfor(), done, errno, frames, ast_frame::frametype, ast_frame_subclass::integer, LOG_WARNING, MAX, SCOPE_TRACE, and ast_frame::subclass.

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

__ast_channel_alloc()

struct ast_channel * __ast_channel_alloc	(	int	needqueue,
		int	state,
		const char *	cid_num,
		const char *	cid_name,
		const char *	acctcode,
		const char *	exten,
		const char *	context,
		const struct ast_assigned_ids *	assignedids,
		const struct ast_channel *	requestor,
		enum ama_flags	amaflag,
		struct ast_endpoint *	endpoint,
		const char *	file,
		int	line,
		const char *	function,
		const char *	name_fmt,
			...
	)

Create a channel structure.

Since

1.8

Return values

NULL	failure
non-NULL	successfully allocated channel

Note

Absolutely NO channel locks should be held before calling this function.

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

Since 12.0.0 this function returns with the newly created channel locked.

Definition at line 954 of file channel.c.

{
    va_list ap;
    struct ast_channel *result;
 
    va_start(ap, name_fmt);
    result = __ast_channel_alloc_ap(needqueue, state, cid_num, cid_name, acctcode, exten, context,
                    assignedids, requestor, amaflag, endpoint, NULL, file, line, function, name_fmt, ap);
    va_end(ap);
 
    return result;
}

References __ast_channel_alloc_ap(), voicemailpwcheck::context, ast_channel::exten, make_ari_stubs::file, NULL, and result.

__ast_channel_alloc_with_initializers()

struct ast_channel * __ast_channel_alloc_with_initializers	(	int	needqueue,
		int	state,
		const char *	cid_num,
		const char *	cid_name,
		const char *	acctcode,
		const char *	exten,
		const char *	context,
		const struct ast_assigned_ids *	assignedids,
		const struct ast_channel *	requestor,
		enum ama_flags	amaflag,
		struct ast_endpoint *	endpoint,
		struct ast_channel_initializers *	initializers,
		const char *	file,
		int	line,
		const char *	function,
		const char *	name_fmt,
			...
	)

Create a channel structure.

Since

18.25.0

Return values

NULL	failure
non-NULL	successfully allocated channel

Note

Absolutely NO channel locks should be held before calling this function.

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

Same as __ast_channel_alloc but with ast_channel_initializers struct.

Definition at line 973 of file channel.c.

{
    va_list ap;
    struct ast_channel *result;
 
    va_start(ap, name_fmt);
    result = __ast_channel_alloc_ap(needqueue, state, cid_num, cid_name, acctcode, exten, context,
                    assignedids, requestor, amaflag, endpoint, initializers, file, line, function, name_fmt, ap);
    va_end(ap);
 
    return result;
}

References __ast_channel_alloc_ap(), voicemailpwcheck::context, ast_channel::exten, make_ari_stubs::file, and result.

__ast_dummy_channel_alloc()

struct ast_channel * __ast_dummy_channel_alloc	(	const char *	file,
		int	line,
		const char *	function
	)

Definition at line 994 of file channel.c.

{
    struct ast_channel *tmp;
    struct varshead *headp;
 
    tmp = __ast_channel_internal_alloc(ast_dummy_channel_destructor, NULL, NULL,
        file, line, function);
    if (!tmp) {
        /* Dummy channel structure allocation failure. */
        return NULL;
    }
 
    ast_pbx_hangup_handler_init(tmp);
    AST_LIST_HEAD_INIT_NOLOCK(ast_channel_datastores(tmp));
 
    /*
     * Init file descriptors to unopened state just in case
     * autoservice is called on the channel or something tries to
     * read a frame from it.
     */
    ast_channel_timingfd_set(tmp, -1);
    ast_channel_internal_alertpipe_clear(tmp);
    ast_channel_internal_fd_clear_all(tmp);
 
    ast_channel_hold_state_set(tmp, AST_CONTROL_UNHOLD);
 
    ast_channel_internal_setup_topics(tmp);
 
    headp = ast_channel_varshead(tmp);
    AST_LIST_HEAD_INIT_NOLOCK(headp);
 
    return tmp;
}

References __ast_channel_internal_alloc(), ast_channel_datastores(), ast_channel_hold_state_set(), ast_channel_internal_alertpipe_clear(), ast_channel_internal_fd_clear_all(), ast_channel_internal_setup_topics(), ast_channel_timingfd_set(), ast_channel_varshead(), AST_CONTROL_UNHOLD, ast_dummy_channel_destructor(), AST_LIST_HEAD_INIT_NOLOCK, ast_pbx_hangup_handler_init(), make_ari_stubs::file, NULL, and tmp().

__ast_request_and_dial()

struct ast_channel * __ast_request_and_dial	(	const char *	type,
		struct ast_format_cap *	cap,
		const struct ast_assigned_ids *	assignedids,
		const struct ast_channel *	requestor,
		const char *	addr,
		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.

Parameters

type	type of channel to request
cap	format capabilities for requested channel
assignedids	Unique Id to assign to channel
requestor	channel requesting data
addr	destination of the call
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 5995 of file channel.c.

{
    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, cap, assignedids, requestor, addr, &cause);
    if (!chan) {
        ast_log(LOG_NOTICE, "Unable to request channel %s/%s\n", type, addr);
        handle_cause(cause, outstate);
        return NULL;
    }
 
    if (oh) {
        if (oh->vars) {
            ast_channel_lock(chan);
            ast_set_variables(chan, oh->vars);
            ast_channel_unlock(chan);
        }
        if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name)) {
            /*
             * Use the oh values instead of the function parameters for the
             * outgoing CallerID.
             */
            cid_num = oh->cid_num;
            cid_name = oh->cid_name;
        }
        if (oh->parent_channel) {
            /* Safely inherit variables and datastores from the parent channel. */
            ast_channel_lock_both(oh->parent_channel, chan);
            ast_channel_inherit_variables(oh->parent_channel, chan);
            ast_channel_datastore_inherit(oh->parent_channel, chan);
            ast_max_forwards_decrement(chan);
            ast_channel_unlock(oh->parent_channel);
            ast_channel_unlock(chan);
        }
        if (!ast_strlen_zero(oh->account)) {
            ast_channel_lock(chan);
            ast_channel_stage_snapshot(chan);
            ast_channel_accountcode_set(chan, oh->account);
            ast_channel_peeraccount_set(chan, oh->account);
            ast_channel_stage_snapshot_done(chan);
            ast_channel_unlock(chan);
        }
    }
 
    /*
     * It seems strange to set the CallerID on an outgoing call leg
     * to whom we are calling, but this function's callers are doing
     * various Originate methods.  This call leg goes to the local
     * user.  Once the local user answers, the dialplan needs to be
     * able to access the CallerID from the CALLERID function as if
     * the local user had placed this call.
     */
    ast_set_callerid(chan, cid_num, cid_name, cid_num);
 
    ast_channel_lock(chan);
    ast_set_flag(ast_channel_flags(chan), AST_FLAG_ORIGINATED);
    ast_channel_unlock(chan);
    ast_party_connected_line_set_init(&connected, ast_channel_connected(chan));
    if (cid_num) {
        connected.id.number.valid = 1;
        connected.id.number.str = (char *) cid_num;
        connected.id.number.presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
    }
    if (cid_name) {
        connected.id.name.valid = 1;
        connected.id.name.str = (char *) cid_name;
        connected.id.name.presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
    }
    ast_channel_set_connected_line(chan, &connected, NULL);
    if (requestor) {
        ast_channel_lock_both(chan, (struct ast_channel *) requestor);
        ast_channel_req_accountcodes(chan, requestor, AST_CHANNEL_REQUESTOR_BRIDGE_PEER);
        ast_channel_unlock(chan);
        ast_channel_unlock((struct ast_channel *) requestor);
    }
 
    if (ast_call(chan, addr, 0)) {  /* ast_call failed... */
        ast_log(LOG_NOTICE, "Unable to call channel %s/%s\n", type, addr);
    } else {
        struct timeval start = ast_tvnow();
        res = 1;    /* mark success in case chan->_state is already AST_STATE_UP */
        while (timeout && ast_channel_state(chan) != AST_STATE_UP) {
            struct ast_frame *f;
            int ms = ast_remaining_ms(start, timeout);
 
            res = ast_waitfor(chan, ms);
            if (res == 0) { /* timeout, treat it like ringing */
                *outstate = AST_CONTROL_RINGING;
                break;
            }
            if (res < 0) /* error or done */
                break;
            if (!ast_strlen_zero(ast_channel_call_forward(chan))) {
                if (!(chan = ast_call_forward(NULL, chan, NULL, cap, 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.integer) {
                case AST_CONTROL_RINGING:   /* record but keep going */
                    *outstate = f->subclass.integer;
                    break;
 
                case AST_CONTROL_BUSY:
                    *outstate = f->subclass.integer;
                    timeout = 0;
                    break;
 
                case AST_CONTROL_INCOMPLETE:
                    *outstate = AST_CONTROL_CONGESTION;
                    timeout = 0;
                    break;
 
                case AST_CONTROL_CONGESTION:
                    *outstate = f->subclass.integer;
                    timeout = 0;
                    break;
 
                case AST_CONTROL_ANSWER:
                    *outstate = f->subclass.integer;
                    timeout = 0;        /* trick to force exit from the while() */
                    break;
 
                case AST_CONTROL_PVT_CAUSE_CODE:
                    ast_channel_hangupcause_hash_set(chan, f->data.ptr, f->datalen);
                    break;
 
                case AST_CONTROL_PROGRESS:
                    if (oh && oh->connect_on_early_media) {
                        *outstate = f->subclass.integer;
                        timeout = 0;        /* trick to force exit from the while() */
                        break;
                    }
                    /* Fallthrough */
                /* Ignore these */
                case AST_CONTROL_PROCEEDING:
                case AST_CONTROL_HOLD:
                case AST_CONTROL_UNHOLD:
                case AST_CONTROL_VIDUPDATE:
                case AST_CONTROL_SRCUPDATE:
                case AST_CONTROL_SRCCHANGE:
                case AST_CONTROL_CONNECTED_LINE:
                case AST_CONTROL_REDIRECTING:
                case AST_CONTROL_CC:
                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.integer);
                }
                last_subclass = f->subclass.integer;
            }
            ast_frfree(f);
        }
    }
 
    /* Final fixups */
    if (oh) {
        if (!ast_strlen_zero(oh->context))
            ast_channel_context_set(chan, oh->context);
        if (!ast_strlen_zero(oh->exten))
            ast_channel_exten_set(chan, oh->exten);
        if (oh->priority)
            ast_channel_priority_set(chan, oh->priority);
    }
    if (ast_channel_state(chan) == AST_STATE_UP)
        *outstate = AST_CONTROL_ANSWER;
 
    if (res <= 0) {
        ast_channel_lock(chan);
        if (AST_CONTROL_RINGING == last_subclass) {
            ast_channel_hangupcause_set(chan, AST_CAUSE_NO_ANSWER);
        }
        ast_channel_unlock(chan);
        ast_hangup(chan);
        chan = NULL;
    }
    return chan;
}

References outgoing_helper::account, ast_call(), ast_call_forward(), AST_CAUSE_NO_ANSWER, ast_channel_call_forward(), ast_channel_connected(), ast_channel_context_set(), ast_channel_datastore_inherit(), ast_channel_exten_set(), ast_channel_flags(), ast_channel_hangupcause_hash_set(), ast_channel_hangupcause_set(), ast_channel_inherit_variables(), ast_channel_lock, ast_channel_lock_both, ast_channel_priority_set(), ast_channel_req_accountcodes(), AST_CHANNEL_REQUESTOR_BRIDGE_PEER, ast_channel_set_connected_line(), ast_channel_stage_snapshot(), ast_channel_stage_snapshot_done(), ast_channel_unlock, AST_CONTROL_ANSWER, AST_CONTROL_BUSY, AST_CONTROL_CC, AST_CONTROL_CONGESTION, AST_CONTROL_CONNECTED_LINE, AST_CONTROL_HANGUP, AST_CONTROL_HOLD, AST_CONTROL_INCOMPLETE, AST_CONTROL_PROCEEDING, AST_CONTROL_PROGRESS, AST_CONTROL_PVT_CAUSE_CODE, AST_CONTROL_REDIRECTING, AST_CONTROL_RINGING, AST_CONTROL_SRCCHANGE, AST_CONTROL_SRCUPDATE, AST_CONTROL_UNHOLD, AST_CONTROL_VIDUPDATE, AST_FLAG_ORIGINATED, AST_FRAME_CONTROL, ast_frfree, ast_hangup(), ast_log, ast_max_forwards_decrement(), ast_party_connected_line_set_init(), AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED, ast_read(), ast_remaining_ms(), ast_request(), ast_set_callerid(), ast_set_flag, ast_set_variables(), AST_STATE_UP, ast_strlen_zero(), ast_tvnow(), ast_waitfor(), outgoing_helper::cid_name, outgoing_helper::cid_num, outgoing_helper::connect_on_early_media, connected, outgoing_helper::context, ast_frame::data, ast_frame::datalen, outgoing_helper::exten, ast_frame::frametype, handle_cause(), ast_frame_subclass::integer, LOG_NOTICE, NULL, outgoing_helper::parent_channel, outgoing_helper::priority, ast_frame::ptr, ast_frame::subclass, type, and outgoing_helper::vars.

Referenced by announce_to_dial(), and ast_request_and_dial().

ast_activate_generator()

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

Activate a given generator

Definition at line 2970 of file channel.c.

{
    int res = 0;
    void *generatordata = NULL;
 
    ast_channel_lock(chan);
    if (ast_channel_generatordata(chan)) {
        struct ast_generator *generator_old = ast_channel_generator(chan);
 
        if (generator_old && generator_old->release) {
            generator_old->release(chan, ast_channel_generatordata(chan));
        }
    }
    if (gen->alloc && !(generatordata = gen->alloc(chan, params))) {
        res = -1;
    }
    ast_channel_generatordata_set(chan, generatordata);
    if (!res) {
        ast_settimeout(chan, 50, generator_force, chan);
        ast_channel_generator_set(chan, gen);
    }
    ast_channel_unlock(chan);
 
    ast_prod(chan);
 
    return res;
}

References ast_generator::alloc, ast_channel_generator(), ast_channel_generator_set(), ast_channel_generatordata(), ast_channel_generatordata_set(), ast_channel_lock, ast_channel_unlock, ast_prod(), ast_settimeout(), gen, generator_force(), ast_channel::generatordata, NULL, and ast_generator::release.

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

ast_active_channels()

int ast_active_channels

(

void

)

returns number of active/allocated channels

Returns

number of channels available for lookup

Definition at line 499 of file channel.c.

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

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

ast_add_fd()

static int ast_add_fd ( struct pollfd *  pfd, int  fd  )

inlinestatic

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

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

Referenced by ast_waitfor_nandfds().

ast_answer()

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

{
    SCOPE_TRACE(1, "%s\n", ast_channel_name(chan));
    return __ast_answer(chan, 0);
}

References __ast_answer(), ast_channel_name(), and SCOPE_TRACE.

Referenced by agent_login_exec(), agi_exec_full(), alarmreceiver_exec(), announce_request(), app_exec(), ast_auto_answer(), ast_bridge_add_channel(), ast_do_pickup(), ast_pickup_call(), auth_exec(), background_detect_exec(), bridge_channel_handle_control(), bridge_parking_push(), bridgeadd_exec(), bridgewait_exec(), common_exec(), conf_exec(), conf_start_record(), confbridge_exec(), count_exec(), dial_exec_full(), dictate_exec(), directory_exec(), disa_exec(), eivr_comm(), handle_answer(), leave_voicemail(), local_call(), media_request_helper(), minivm_accmess_exec(), minivm_greet_exec(), minivm_record_exec(), old_milliwatt_exec(), park_app_exec(), parked_call_app_exec(), pbx_builtin_background(), playback_exec(), privacy_exec(), read_exec(), readexten_exec(), receivefax_exec(), record_exec(), sayunixtime_exec(), send_waveform_to_channel(), sendfax_exec(), setup_privacy_args(), skel_exec(), sla_station_exec(), speech_background(), testclient_exec(), testserver_exec(), vm_exec(), vm_execmain(), vm_playmsgexec(), waitfor_exec(), and zapateller_exec().

ast_auto_answer()

int ast_auto_answer ( struct ast_channel *  chan )

inline

Answer a channel, if it's not already answered.

Parameters

chan	channel to answer

See ast_answer()

Return values

0	on success
non-zero	on failure

Definition at line 2830 of file channel.c.

{
    if (ast_channel_state(chan) == AST_STATE_UP) {
        /* Already answered */
        return 0;
    }
    return ast_answer(chan);
}

References ast_answer(), and AST_STATE_UP.

Referenced by record_file(), and senddtmf_exec().

ast_autoservice_chan_hangup_peer()

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

Put chan into autoservice while hanging up peer.

Since

11.0

Parameters

chan	Chan to put into autoservice.
peer	Chan to run hangup handlers and hangup.

Definition at line 349 of file autoservice.c.

{
    if (chan && !ast_autoservice_start(chan)) {
        ast_hangup(peer);
        ast_autoservice_stop(chan);
    } else {
        ast_hangup(peer);
    }
}

References ast_autoservice_start(), ast_autoservice_stop(), and ast_hangup().

Referenced by app_exec(), bridge_failed_peer_goto(), dial_exec_full(), and try_calling().

ast_autoservice_ignore()

int ast_autoservice_ignore	(	struct ast_channel *	chan,
		enum ast_frame_type	ftype
	)

Ignore certain frame types.

Note

Normally, we cache DTMF, IMAGE, HTML, TEXT, and CONTROL frames while a channel is in autoservice and queue them up when taken out of autoservice. When this is not desireable, this API may be used to cause the channel to ignore those frametypes after the channel is put into autoservice, but before autoservice is stopped.

Return values

0	success
-1	channel is not in autoservice

Definition at line 359 of file autoservice.c.

{
    struct asent *as;
    int res = -1;
 
    AST_LIST_LOCK(&aslist);
    AST_LIST_TRAVERSE(&aslist, as, list) {
        if (as->chan == chan) {
            res = 0;
            as->ignore_frame_types |= (1 << ftype);
            break;
        }
    }
    AST_LIST_UNLOCK(&aslist);
    return res;
}

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, asent::chan, asent::ignore_frame_types, and asent::list.

ast_autoservice_start()

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 200 of file autoservice.c.

{
    int res = 0;
    struct asent *as;
 
    if (ast_thread_is_user_interface()) {
        /* User interface threads do not handle channel media. */
        ast_debug(1, "Thread is a user interface, not putting channel %s into autoservice\n",
            ast_channel_name(chan));
        return 0;
    }
 
    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(ast_channel_flags(chan), AST_FLAG_END_DTMF_ONLY) ? 1 : 0;
    if (!as->orig_end_dtmf_flag)
        ast_set_flag(ast_channel_flags(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);
            ast_free(as);
            asthread = AST_PTHREADT_NULL;
            res = -1;
        } else {
            pthread_kill(asthread, SIGURG);
        }
    }
 
    AST_LIST_UNLOCK(&aslist);
 
    return res;
}

References as_cond, ast_calloc, ast_channel_flags(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_cond_signal, ast_debug, AST_FLAG_END_DTMF_ONLY, ast_free, 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, ast_thread_is_user_interface(), asthread, autoservice_run(), asent::chan, asent::list, LOG_WARNING, NULL, asent::orig_end_dtmf_flag, and asent::use_count.

Referenced by acf_curl_helper(), acf_jabberreceive_read(), acf_odbc_read(), acf_odbc_write(), action_toggle_mute_participants(), app_exec(), ast_app_exec_sub(), ast_audiosocket_connect(), ast_autoservice_chan_hangup_peer(), ast_dtmf_stream(), ast_get_enum(), ast_get_srv(), ast_get_txt(), ast_mf_stream(), ast_sf_stream(), begin_dial_prerun(), conf_play(), confbridge_exec(), dial_exec_full(), exec(), findmeexec(), function_realtime_read(), function_realtime_readdestroy(), function_realtime_store(), function_realtime_write(), join_conference_bridge(), lock_read(), lua_autoservice_start(), lua_get_variable_value(), lua_pbx_exec(), lua_set_variable(), lua_set_variable_value(), mf_stream(), originate_exec(), pbx_find_extension(), playback_common(), post_join_play_begin(), push_announcer(), realtimefield_read(), reload_exec(), ring_one(), sf_stream(), shell_helper(), smdi_msg_retrieve_read(), srv_datastore_setup(), system_exec_helper(), try_calling(), and trylock_read().

ast_autoservice_stop()

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

Parameters

chan

Return values

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

Definition at line 266 of file autoservice.c.

{
    int res = -1;
    struct asent *as, *removed = NULL;
    struct ast_frame *f;
    int chan_list_state;
 
    if (ast_thread_is_user_interface()) {
        /* User interface threads do not handle channel media. */
        ast_debug(1, "Thread is a user interface, not removing channel %s from autoservice\n",
            ast_channel_name(chan));
        return 0;
    }
 
    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;
    }
 
    if (asthread != AST_PTHREADT_NULL && pthread_equal(pthread_self(), asthread)) {
        /* Do not sleep if ast_autoservice_stop is called within the autoservice thread,
           otherwise the thread will be stuck in an endless sleep. */
        ast_debug(1, "ast_autoservice_stop is called within the autoservice thread, channel %s\n",
            ast_channel_name(chan));
    } else {
        /* 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 (!ast_channel_softhangup_internal_flag(chan)) {
        res = 0;
    }
 
    ast_channel_lock(chan);
    if (!as->orig_end_dtmf_flag) {
        ast_clear_flag(ast_channel_flags(chan), AST_FLAG_END_DTMF_ONLY);
    }
 
    while ((f = AST_LIST_REMOVE_HEAD(&as->deferred_frames, frame_list))) {
        if (!((1 << f->frametype) & as->ignore_frame_types)) {
            ast_queue_frame_head(chan, f);
        }
        ast_frfree(f);
    }
    ast_channel_unlock(chan);
 
    ast_free(as);
 
    return res;
}

References as_chan_list_state, ast_channel_flags(), ast_channel_lock, ast_channel_name(), ast_channel_softhangup_internal_flag(), ast_channel_unlock, ast_clear_flag, ast_debug, AST_FLAG_END_DTMF_ONLY, ast_free, 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(), ast_thread_is_user_interface(), asthread, asent::chan, asent::deferred_frames, ast_frame::frametype, asent::ignore_frame_types, NULL, asent::orig_end_dtmf_flag, and asent::use_count.

Referenced by acf_curl_helper(), acf_jabberreceive_read(), acf_odbc_read(), acf_odbc_write(), action_toggle_mute_participants(), app_exec(), array(), ast_app_exec_sub(), ast_audiosocket_connect(), ast_autoservice_chan_hangup_peer(), ast_dtmf_stream(), ast_get_enum(), ast_get_srv(), ast_get_txt(), ast_hangup(), ast_mf_stream(), ast_sf_stream(), begin_dial_prerun(), conf_play(), confbridge_exec(), dial_exec_full(), exec(), findmeexec(), function_realtime_read(), function_realtime_readdestroy(), function_realtime_store(), function_realtime_write(), hangup_playback(), join_conference_bridge(), lock_read(), lua_autoservice_stop(), lua_get_variable_value(), lua_pbx_exec(), lua_set_variable(), lua_set_variable_value(), mf_stream(), originate_exec(), pbx_find_extension(), playback_common(), post_join_play_begin(), realtimefield_read(), reload_exec(), ring_one(), sf_stream(), shell_helper(), smdi_msg_retrieve_read(), srv_datastore_setup(), system_exec_helper(), try_calling(), and trylock_read().

ast_call()

int ast_call	(	struct ast_channel *	chan,
		const char *	addr,
		int	timeout
	)

Make a call.

Note

Absolutely NO channel locks should be held before calling this function.

Parameters

chan	which channel to make the call on
addr	destination of the call
timeout	time to wait on for connect (Doesn't seem to be used.)

Place a call, take no longer than timeout ms.

Return values

0	on success
-1	on failure

Definition at line 6480 of file channel.c.

{
    /* 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(ast_channel_flags(chan), AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
        if (ast_channel_tech(chan)->call)
            res = ast_channel_tech(chan)->call(chan, addr, timeout);
        ast_set_flag(ast_channel_flags(chan), AST_FLAG_OUTGOING);
    }
    ast_channel_unlock(chan);
    return res;
}

References ast_channel_flags(), ast_channel_lock, ast_channel_tech(), ast_channel_unlock, ast_check_hangup(), AST_FLAG_OUTGOING, AST_FLAG_ZOMBIE, ast_set_flag, ast_test_flag, call(), and ast_channel_tech::call.

Referenced by __ast_request_and_dial(), app_control_dial(), ast_call_forward(), attended_transfer_bridge(), begin_dial_channel(), blind_transfer_bridge(), dial_exec_full(), do_forward(), feature_attended_transfer(), findmeexec(), park_local_transfer(), retransfer_enter(), ring_entry(), and wait_for_answer().

ast_call_forward()

struct ast_channel * ast_call_forward	(	struct ast_channel *	caller,
		struct ast_channel *	orig,
		int *	timeout,
		struct ast_format_cap *	cap,
		struct outgoing_helper *	oh,
		int *	outstate
	)

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

Parameters

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

Returns

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

Definition at line 5917 of file channel.c.

{
    char tmpchan[256];
    char forwarder[AST_CHANNEL_NAME];
    struct ast_channel *new_chan = NULL;
    char *data, *type;
    int cause = 0;
    int res;
 
    /* gather data and request the new forward channel */
    ast_copy_string(tmpchan, ast_channel_call_forward(orig), sizeof(tmpchan));
    ast_copy_string(forwarder, ast_channel_name(orig), sizeof(forwarder));
    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", ast_channel_call_forward(orig), S_OR(forward_context, ast_channel_context(orig)));
        ast_channel_unlock(orig);
        data = tmpchan;
        type = "Local";
    }
    if (!(new_chan = ast_request(type, cap, NULL, 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;
    }
 
    /* Copy/inherit important information into new channel */
    if (oh) {
        if (oh->vars) {
            ast_channel_lock(new_chan);
            ast_set_variables(new_chan, oh->vars);
            ast_channel_unlock(new_chan);
        }
        if (oh->parent_channel) {
            call_forward_inherit(new_chan, oh->parent_channel, orig);
        }
        if (!ast_strlen_zero(oh->account)) {
            ast_channel_lock(new_chan);
            ast_channel_stage_snapshot(new_chan);
            ast_channel_accountcode_set(new_chan, oh->account);
            ast_channel_peeraccount_set(new_chan, oh->account);
            ast_channel_stage_snapshot_done(new_chan);
            ast_channel_unlock(new_chan);
        }
    } else if (caller) { /* no outgoing helper so use caller if available */
        call_forward_inherit(new_chan, caller, orig);
    }
 
    ast_channel_lock_both(orig, new_chan);
    ast_channel_set_flag(new_chan, AST_FLAG_ORIGINATED);
    pbx_builtin_setvar_helper(new_chan, "FORWARDERNAME", forwarder);
    ast_party_connected_line_copy(ast_channel_connected(new_chan), ast_channel_connected(orig));
    ast_party_redirecting_copy(ast_channel_redirecting(new_chan), ast_channel_redirecting(orig));
    ast_channel_req_accountcodes(new_chan, orig, AST_CHANNEL_REQUESTOR_REPLACEMENT);
    ast_channel_unlock(new_chan);
    ast_channel_unlock(orig);
 
    /* call new channel */
    res = ast_call(new_chan, data, 0);
    if (timeout) {
        *timeout = res;
    }
    if (res) {
        ast_log(LOG_NOTICE, "Unable to call forward to channel %s/%s\n", type, (char *)data);
        ast_hangup(orig);
        ast_hangup(new_chan);
        return NULL;
    }
    ast_hangup(orig);
 
    return new_chan;
}

References outgoing_helper::account, ast_call(), ast_channel_call_forward(), ast_channel_connected(), ast_channel_context(), ast_channel_lock, ast_channel_lock_both, AST_CHANNEL_NAME, ast_channel_name(), ast_channel_redirecting(), ast_channel_req_accountcodes(), AST_CHANNEL_REQUESTOR_REPLACEMENT, ast_channel_set_flag(), ast_channel_stage_snapshot(), ast_channel_stage_snapshot_done(), ast_channel_unlock, ast_copy_string(), AST_FLAG_ORIGINATED, ast_hangup(), ast_log, ast_party_connected_line_copy(), ast_party_redirecting_copy(), ast_request(), ast_set_variables(), ast_strlen_zero(), call_forward_inherit(), ast_channel::caller, ast_channel::data, handle_cause(), LOG_NOTICE, NULL, outgoing_helper::parent_channel, pbx_builtin_getvar_helper(), pbx_builtin_setvar_helper(), S_OR, type, and outgoing_helper::vars.

Referenced by __ast_request_and_dial().

ast_cause2str()

const char * ast_cause2str

(

int

cause

)

Gives the string form of a given cause code.

Parameters

cause

cause to get the description of

Returns

the text form of the binary cause code given

Gives the string form of a given cause code.

Definition at line 612 of file channel.c.

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

References ARRAY_LEN, causes, and causes_map::desc.

Referenced by bridge_dissolve(), channel_destroyed_event(), channel_state_change(), dial_exec_full(), findmeexec(), hangupcause_read(), and rfc3326_add_reason_header().

ast_change_name()

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

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

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

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

ast_channel__bridge()

struct ast_channel * ast_channel__bridge

(

const struct ast_channel *

chan

)

ast_channel__bridge_set()

void ast_channel__bridge_set	(	struct ast_channel *	chan,
		struct ast_channel *	value
	)

ast_channel_accountcode()

const char * ast_channel_accountcode

(

const struct ast_channel *

chan

)

Referenced by action_dahdishowchannels(), ast_channel_log(), ast_channel_yank(), ast_unreal_call_setup(), ast_var_channels_table(), channel_do_masquerade(), channel_fill_empty_accountcode(), channel_fill_empty_peeraccount(), channel_req_accountcodes(), channel_snapshot_base_create(), channel_update_peeraccount(), func_channel_read(), and setup_env().

ast_channel_adsicpe()

enum ast_channel_adsicpe ast_channel_adsicpe

(

const struct ast_channel *

chan

)

Definition at line 782 of file channel_internal_api.c.

{
    return chan->adsicpe;
}

References ast_channel::adsicpe.

ast_channel_adsicpe_set()

void ast_channel_adsicpe_set	(	struct ast_channel *	chan,
		enum ast_channel_adsicpe	value
	)

Definition at line 786 of file channel_internal_api.c.

{
    chan->adsicpe = value;
}

References ast_channel::adsicpe, and value.

Referenced by __adsi_transmit_messages(), adsi_begin(), adsi_transmit_message_full(), ast_ari_channels_dial(), ast_iax2_new(), AST_TEST_DEFINE(), begin_dial_prerun(), chan_pjsip_new(), channel_do_masquerade(), dahdi_new(), dial_exec_full(), jingle_new(), ooh323_new(), ring_entry(), and unistim_new().

ast_channel_alert_writable()

int ast_channel_alert_writable

(

struct ast_channel *

chan

)

Definition at line 1126 of file channel_internal_api.c.

{
    return ast_alertpipe_writable(chan->alertpipe);
}

References ast_channel::alertpipe, and ast_alertpipe_writable().

Referenced by __ast_queue_frame().

ast_channel_alert_write()

int ast_channel_alert_write

(

struct ast_channel *

chan

)

Definition at line 1111 of file channel_internal_api.c.

{
    return ast_alertpipe_write(chan->alertpipe);
}

References ast_channel::alertpipe, and ast_alertpipe_write().

Referenced by __ast_queue_frame(), __ast_read(), and channel_do_masquerade().

ast_channel_amaflags()

enum ama_flags ast_channel_amaflags

(

const struct ast_channel *

chan

)

Definition at line 420 of file channel_internal_api.c.

{
    return chan->amaflags;
}

References ast_channel::amaflags.

Referenced by ast_channel_log(), ast_channel_snapshot_create(), ast_channel_yank(), ast_var_channels_table(), and func_channel_read().

ast_channel_amaflags2string()

const char * ast_channel_amaflags2string

(

enum ama_flags

flags

)

Convert the enum representation of an AMA flag to a string representation.

Since

12

Parameters

flags

integer flag

Return values

A	string representation of the flag

Definition at line 4392 of file channel.c.

{
    switch (flag) {
    case AST_AMA_OMIT:
        return "OMIT";
    case AST_AMA_BILLING:
        return "BILLING";
    case AST_AMA_DOCUMENTATION:
        return "DOCUMENTATION";
    default:
        return "Unknown";
    }
}

References AST_AMA_BILLING, AST_AMA_DOCUMENTATION, and AST_AMA_OMIT.

Referenced by ast_cdr_format_var(), beanstalk_put(), build_csv_record(), build_radius_record(), cdr_read_callback(), cel_bs_put(), handle_cli_ooh323_show_config(), handle_cli_ooh323_show_peer(), handle_cli_ooh323_show_user(), manager_log(), and tds_log().

ast_channel_amaflags_set()

void ast_channel_amaflags_set	(	struct ast_channel *	chan,
		enum ama_flags	value
	)

Precondition

chan is locked

Definition at line 425 of file channel_internal_api.c.

{
    if (chan->amaflags == value) {
        return;
    }
    chan->amaflags = value;
    ast_channel_publish_snapshot(chan);
}

References ast_channel::amaflags, ast_channel_publish_snapshot(), and value.

Referenced by __ast_channel_alloc_ap(), ast_cel_fabricate_channel_from_event(), ast_iax2_new(), AST_TEST_DEFINE(), cdr_write(), dahdi_new(), func_channel_write_real(), and ooh323_new().

ast_channel_answertime()

struct timeval ast_channel_answertime

(

struct ast_channel *

chan

)

Definition at line 987 of file channel_internal_api.c.

{
    return chan->answertime;
}

Referenced by ast_channel_get_up_time_ms(), and set_channel_answer_time().

ast_channel_answertime_set()

void ast_channel_answertime_set	(	struct ast_channel *	chan,
		struct timeval *	value
	)

Definition at line 992 of file channel_internal_api.c.

{
    chan->answertime = *value;
}

References ast_channel::answertime, and value.

Referenced by set_channel_answer_time().

ast_channel_appl()

const char * ast_channel_appl

(

const struct ast_channel *

chan

)

Definition at line 331 of file channel_internal_api.c.

{
    return chan->appl;
}

References ast_channel::appl.

Referenced by __analog_handle_event(), ast_bridge_transfer_attended(), ast_channel_log(), ast_var_channels_table(), attended_transfer_bridge(), channel_snapshot_dialplan_create(), func_channel_read(), generate_status(), handle_showchan(), pbx_exec(), realtime_exec(), and serialize_showchan().

ast_channel_appl_set()

void ast_channel_appl_set	(	struct ast_channel *	chan,
		const char *	value
	)

Definition at line 335 of file channel_internal_api.c.

{
    chan->appl = value;
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN);
}

References ast_channel::appl, AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN, ast_channel_snapshot_invalidate_segment(), and value.

Referenced by ast_cel_fabricate_channel_from_event(), AST_TEST_DEFINE(), begin_dial_prerun(), dial_exec_full(), do_forward(), pbx_exec(), realtime_exec(), and ring_entry().

ast_channel_audiohooks()

struct ast_audiohook_list * ast_channel_audiohooks

(

const struct ast_channel *

chan

)

Definition at line 590 of file channel_internal_api.c.

{
    return chan->audiohooks;
}

References ast_channel::audiohooks.

Referenced by __ast_read(), ast_audiohook_attach(), ast_audiohook_detach_source(), ast_audiohook_move_all(), ast_audiohook_move_by_source(), ast_audiohook_remove(), ast_audiohook_set_mute(), ast_audiohook_set_mute_all(), ast_channel_audiohook_count_by_source(), ast_channel_audiohook_count_by_source_running(), ast_channel_has_audio_frame_or_monitor(), ast_channel_has_hook_requiring_audio(), ast_write_stream(), conf_run(), and destroy_hooks().

ast_channel_audiohooks_set()

void ast_channel_audiohooks_set	(	struct ast_channel *	chan,
		struct ast_audiohook_list *	value
	)

Definition at line 594 of file channel_internal_api.c.

{
    chan->audiohooks = value;
}

References ast_channel::audiohooks, and value.

Referenced by __ast_read(), ast_audiohook_attach(), ast_write_stream(), and destroy_hooks().

ast_channel_autochans()

struct ast_autochan_list * ast_channel_autochans

(

struct ast_channel *

chan

)

Definition at line 873 of file channel_internal_api.c.

{
    return &chan->autochans;
}

References ast_channel::autochans.

Referenced by __ast_channel_alloc_ap(), ast_autochan_destroy(), ast_autochan_new_channel(), and ast_autochan_setup().

ast_channel_blocker()

pthread_t ast_channel_blocker

(

const struct ast_channel *

chan

)

Definition at line 1214 of file channel_internal_api.c.

{
    return chan->blocker;
}

References ast_channel::blocker.

Referenced by __ast_queue_frame(), ast_softhangup_nolock(), and channel_do_masquerade().

ast_channel_blocker_set()

void ast_channel_blocker_set	(	struct ast_channel *	chan,
		pthread_t	value
	)

Definition at line 1218 of file channel_internal_api.c.

{
    chan->blocker = value;
}

References ast_channel::blocker, and value.

ast_channel_blocker_tid()

int ast_channel_blocker_tid

(

const struct ast_channel *

chan

)

Definition at line 1223 of file channel_internal_api.c.

{
    return chan->blocker_tid;
}

References ast_channel::blocker_tid.

Referenced by ast_hangup().

ast_channel_blocker_tid_set()

void ast_channel_blocker_tid_set	(	struct ast_channel *	chan,
		int	tid
	)

Definition at line 1227 of file channel_internal_api.c.

{
    chan->blocker_tid = value;
}

References ast_channel::blocker_tid, and value.

ast_channel_blockproc()

const char * ast_channel_blockproc

(

const struct ast_channel *

chan

)

Definition at line 340 of file channel_internal_api.c.

{
    return chan->blockproc;
}

References ast_channel::blockproc.

Referenced by ast_hangup(), and serialize_showchan().

ast_channel_blockproc_set()

void ast_channel_blockproc_set	(	struct ast_channel *	chan,
		const char *	value
	)

Definition at line 344 of file channel_internal_api.c.

{
    chan->blockproc = value;
}

References ast_channel::blockproc, and value.

ast_channel_bridge_peer()

struct ast_channel * ast_channel_bridge_peer

(

struct ast_channel *

chan

)

Get the channel's bridge peer only if the bridge is two-party.

Since

12.0.0

Parameters

chan	Channel desiring the bridge peer channel.

Note

The returned peer channel is the current peer in the bridge when called.

Absolutely NO channel locks should be held when calling this function.

Return values

NULL	Channel not in a bridge or the bridge is not two-party.
non-NULL	Reffed peer channel at time of calling.

Definition at line 10586 of file channel.c.

{
    struct ast_channel *peer;
    struct ast_bridge *bridge;
 
    /* Get the bridge the channel is in. */
    ast_channel_lock(chan);
    bridge = ast_channel_get_bridge(chan);
    ast_channel_unlock(chan);
    if (!bridge) {
        return NULL;
    }
 
    peer = ast_bridge_peer(bridge, chan);
    ao2_ref(bridge, -1);
    return peer;
}

References ao2_ref, ast_bridge_peer(), ast_channel_get_bridge(), ast_channel_lock, ast_channel_unlock, and NULL.

Referenced by analog_ss_thread(), ast_rtp_instance_set_stats_vars(), ast_set_hangupsource(), ast_unreal_queryoption(), ast_var_channels_table(), attach_barge(), channel_do_masquerade(), create_jb(), fax_detect_framehook(), fax_gateway_framehook(), func_channel_read(), handle_incoming_request(), manager_park(), my_get_sigpvt_bridged_channel(), and spandsp_fax_gateway_start().

ast_channel_call_forward()

const char * ast_channel_call_forward

(

const struct ast_channel *

chan

)

Referenced by __ast_request_and_dial(), ast_call_forward(), ast_var_channels_table(), bridge_handle_trip(), do_forward(), handle_call_forward(), monitor_dial(), unistim_call(), and wait_for_answer().

ast_channel_callback()

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.

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

Note

Absolutely NO channel locks should be held before calling this function.

Since

1.8

Definition at line 1297 of file channel.c.

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

References ao2_callback_data, channels, and ast_channel::data.

Referenced by ast_channel_get_by_exten(), ast_channel_get_by_name_prefix(), ast_channel_iterator_by_exten_new(), ast_channel_iterator_by_name_new(), ast_pickup_find_by_group(), does_id_conflict(), find_by_channel(), find_by_part(), handle_core_set_debug_channel(), and pickup_by_mark().

ast_channel_caller()

struct ast_party_caller * ast_channel_caller

(

struct ast_channel *

chan

)

Definition at line 889 of file channel_internal_api.c.

{
    return &chan->caller;
}

References ast_channel::caller.

Referenced by __analog_handle_event(), __analog_ss_thread(), __ast_channel_alloc_ap(), __ast_goto_if_exists(), __ast_pbx_run(), acf_isexten_exec(), action_meetmelist(), after_bridge_move_channel(), agent_request_exec(), analog_ss_thread(), app_exec(), ast_app_dtget(), ast_ari_channels_dial(), ast_bridge_setup_after_goto(), ast_cel_fabricate_channel_from_event(), ast_channel_destructor(), ast_channel_set_caller(), ast_channel_set_caller_event(), ast_do_pickup(), ast_dummy_channel_destructor(), ast_iax2_new(), ast_pbx_h_exten_run(), ast_set_callerid(), ast_str_retrieve_variable(), AST_TEST_DEFINE(), ast_unreal_call_setup(), ast_var_channels_table(), background_detect_exec(), begin_dial_prerun(), blacklist_read(), bridge_reconfigured_connected_line_update(), callerid_read(), callerid_write(), cc_generic_agent_init(), chan_pjsip_cng_tone_detected(), chan_pjsip_new(), channel_do_masquerade(), channel_snapshot_caller_create(), collect_digits(), console_call(), copy_caller_data(), copy_message(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_new(), dial_exec_full(), dial_trunk(), dialog_info_generate_body_content(), disa_exec(), do_forward(), fax_detect_framehook(), find_matching_endif(), find_matching_endwhile(), findmeexec(), forward_message(), gosub_exec(), gosub_run(), grab_transfer(), handle_cli_confbridge_list_item(), handle_gosub(), handle_setpriority(), handle_showchan(), incoming_in_dialog_request(), isAnsweringMachine(), isexten_function_read(), launch_monitor_thread(), leave_voicemail(), local_call(), manager_queues_status(), meetme_show_cmd(), minivm_greet_exec(), minivm_notify_exec(), my_get_callerid(), my_handle_dtmf(), onModeChanged(), ooh323_rtp_read(), originate_exec(), park_local_transfer(), pbx_builtin_background(), pbx_builtin_waitexten(), pbx_outgoing_attempt(), pbx_parse_location(), privacy_exec(), queue_connected_line_update(), queue_exec(), readexten_exec(), recalling_enter(), ring_entry(), run_externnotify(), serialize_showchan(), setup_env(), setup_privacy_args(), sla_ring_station(), sms_exec(), socket_process_helper(), start_automixmonitor(), try_calling(), unistim_new(), unreal_colp_redirect_indicate(), update_connected_line_from_peer(), update_initial_connected_line(), valid_exit(), vm_authenticate(), wait_for_answer(), waitstream_core(), write_metadata(), and zapateller_exec().

ast_channel_caller_set()

void ast_channel_caller_set	(	struct ast_channel *	chan,
		struct ast_party_caller *	value
	)

Definition at line 945 of file channel_internal_api.c.

{
    chan->caller = *value;
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER);
}

References AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER, ast_channel_snapshot_invalidate_segment(), ast_channel::caller, and value.

Referenced by channel_do_masquerade(), dial_trunk(), and sla_ring_station().

ast_channel_callgroup()

ast_group_t ast_channel_callgroup

(

const struct ast_channel *

chan

)

Definition at line 1075 of file channel_internal_api.c.

{
    return chan->callgroup;
}

References ast_channel::callgroup.

Referenced by ast_var_channels_table(), find_channel_by_group(), func_channel_read(), generate_status(), handle_showchan(), and serialize_showchan().

ast_channel_callgroup_set()

void ast_channel_callgroup_set	(	struct ast_channel *	chan,
		ast_group_t	value
	)

Precondition

chan is locked

Definition at line 1079 of file channel_internal_api.c.

{
    chan->callgroup = value;
}

References ast_channel::callgroup, and value.

Referenced by chan_pjsip_new(), dahdi_new(), func_channel_write_real(), jingle_new(), and unistim_new().

ast_channel_callid()

ast_callid ast_channel_callid

(

const struct ast_channel *

chan

)

Definition at line 794 of file channel_internal_api.c.

{
    return chan->callid;
}

References ast_channel::callid.

Referenced by __analog_ss_thread(), __ast_pbx_run(), ast_channel_destructor(), ast_unreal_channel_push_to_bridge(), attended_transfer_monitor_thread(), autoservice_run(), bridge_channel_control_thread(), func_channel_read(), handle_showchan(), and request_channel().

ast_channel_callid_cleanup()

void ast_channel_callid_cleanup

(

struct ast_channel *

chan

)

Definition at line 1069 of file channel_internal_api.c.

{
    chan->callid = 0;
}

References ast_channel::callid.

Referenced by ast_channel_destructor().

ast_channel_callid_set()

void ast_channel_callid_set	(	struct ast_channel *	chan,
		ast_callid	value
	)

Precondition

chan is locked

Definition at line 798 of file channel_internal_api.c.

{
    char call_identifier_from[AST_CALLID_BUFFER_LENGTH];
    char call_identifier_to[AST_CALLID_BUFFER_LENGTH];
    call_identifier_from[0] = '\0';
    ast_callid_strnprint(call_identifier_to, sizeof(call_identifier_to), callid);
    if (chan->callid) {
        ast_callid_strnprint(call_identifier_from, sizeof(call_identifier_from), chan->callid);
        ast_debug(3, "Channel Call ID changing from %s to %s\n", call_identifier_from, call_identifier_to);
    }
 
    chan->callid = callid;
 
    ast_test_suite_event_notify("CallIDChange",
        "State: CallIDChange\r\n"
        "Channel: %s\r\n"
        "CallID: %s\r\n"
        "PriorCallID: %s",
        ast_channel_name(chan),
        call_identifier_to,
        call_identifier_from);
}

References AST_CALLID_BUFFER_LENGTH, ast_callid_strnprint(), ast_channel_name(), ast_debug, ast_test_suite_event_notify, and ast_channel::callid.

Referenced by __ast_pbx_run(), ast_iax2_new(), ast_unreal_channel_push_to_bridge(), ast_unreal_new_channels(), common_recall_channel_setup(), dahdi_new(), iax2_request(), jingle_new(), and request_channel().

ast_channel_cc_params_init()

int ast_channel_cc_params_init	(	struct ast_channel *	chan,
		const struct ast_cc_config_params *	base_params
	)

Set up datastore with CCSS parameters for a channel.

Since

1.8

Note

If base_params is NULL, the channel will get the default values for all CCSS parameters.

This function makes use of datastore operations on the channel, so it is important to lock the channel before calling this function.

Parameters

chan	The channel to create the datastore on
base_params	CCSS parameters we wish to copy into the channel

Return values

0	Success
-1	Failure

Definition at line 10473 of file channel.c.

{
    struct ast_cc_config_params *cc_params;
    struct ast_datastore *cc_datastore;
 
    if (!(cc_params = ast_cc_config_params_init())) {
        return -1;
    }
 
    if (!(cc_datastore = ast_datastore_alloc(&cc_channel_datastore_info, NULL))) {
        ast_cc_config_params_destroy(cc_params);
        return -1;
    }
 
    if (base_params) {
        ast_cc_copy_config_params(cc_params, base_params);
    }
    cc_datastore->data = cc_params;
    ast_channel_datastore_add(chan, cc_datastore);
    return 0;
}

References ast_cc_config_params_destroy(), ast_cc_config_params_init, ast_cc_copy_config_params(), ast_channel_datastore_add(), ast_datastore_alloc, cc_channel_datastore_info, ast_datastore::data, and NULL.

Referenced by ast_channel_get_cc_config_params(), ast_unreal_call_setup(), ast_unreal_new_channels(), and dahdi_new().

ast_channel_cdr()

struct ast_cdr * ast_channel_cdr

(

const struct ast_channel *

chan

)

Definition at line 598 of file channel_internal_api.c.

{
    return chan->cdr;
}

References ast_channel::cdr.

Referenced by ast_channel_destructor(), ast_channel_log(), ast_dummy_channel_destructor(), cdr_read_callback(), and cdr_retrieve_time().

ast_channel_cdr_set()

void ast_channel_cdr_set	(	struct ast_channel *	chan,
		struct ast_cdr *	value
	)

Definition at line 602 of file channel_internal_api.c.

{
    chan->cdr = value;
}

References ast_channel::cdr, and value.

Referenced by ast_channel_destructor(), ast_dummy_channel_destructor(), custom_log(), manager_log(), and write_cdr().

ast_channel_clear_flag()

void ast_channel_clear_flag	(	struct ast_channel *	chan,
		unsigned int	flag
	)

Clear a flag on a channel.

Since

13.17.0

Parameters

chan	The channel to clear the flag from
flag	The flag to clear

Note

This will lock the channel internally. If the channel is already locked it is still safe to call.

Definition at line 11056 of file channel.c.

{
    ast_channel_lock(chan);
    ast_clear_flag(ast_channel_flags(chan), flag);
    ast_channel_unlock(chan);
}

References ast_channel_flags(), ast_channel_lock, ast_channel_unlock, and ast_clear_flag.

Referenced by action_redirect(), ast_bridge_setup_after_goto(), ast_channel_undefer_dtmf(), ast_waitfordigit_full(), bridge_channel_internal_pull(), channel_spy(), common_exec(), dial_exec_full(), disa_exec(), do_broadcast(), handle_exec(), and waitstream_core().

ast_channel_clear_softhangup()

void ast_channel_clear_softhangup	(	struct ast_channel *	chan,
		int	flag
	)

Clear a set of softhangup flags from a channel.

Never clear a softhangup flag from a channel directly. Instead, use this function. This ensures that all aspects of the softhangup process are aborted.

Parameters

chan	the channel to clear the flag on
flag	the flag or flags to clear

Definition at line 2451 of file channel.c.

{
    ast_channel_lock(chan);
 
    ast_channel_softhangup_internal_flag_clear(chan, flag);
 
    if (!ast_channel_softhangup_internal_flag(chan)) {
        struct ast_frame *fr;
 
        /* If we have completely cleared the softhangup flag,
         * then we need to fully abort the hangup process.  This requires
         * pulling the END_OF_Q frame out of the channel frame queue if it
         * still happens to be there. */
 
        fr = AST_LIST_LAST(ast_channel_readq(chan));
        if (fr && fr->frametype == AST_FRAME_CONTROL &&
                fr->subclass.integer == AST_CONTROL_END_OF_Q) {
            AST_LIST_REMOVE(ast_channel_readq(chan), fr, frame_list);
            ast_frfree(fr);
        }
    }
 
    ast_channel_unlock(chan);
}

References ast_channel_lock, ast_channel_readq(), ast_channel_softhangup_internal_flag(), ast_channel_softhangup_internal_flag_clear(), ast_channel_unlock, AST_CONTROL_END_OF_Q, AST_FRAME_CONTROL, ast_frfree, AST_LIST_LAST, AST_LIST_REMOVE, ast_frame::frametype, ast_frame_subclass::integer, and ast_frame::subclass.

Referenced by __ast_pbx_run(), ast_bridge_setup_after_goto(), chan_cleanup(), collect_digits(), gosub_run(), and stasis_app_exec().

ast_channel_cmpwhentohangup_tv()

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

Return values

1
0
-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

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

Definition at line 523 of file channel.c.

{
    struct timeval whentohangup;
 
    if (ast_tvzero(*ast_channel_whentohangup(chan)))
        return ast_tvzero(offset) ? 0 : -1;
 
    if (ast_tvzero(offset))
        return 1;
 
    whentohangup = ast_tvadd(offset, ast_tvnow());
 
    return ast_tvdiff_ms(whentohangup, *ast_channel_whentohangup(chan));
}

References ast_channel_whentohangup(), ast_tvadd(), ast_tvdiff_ms(), ast_tvnow(), and ast_tvzero().

ast_channel_connected()

struct ast_party_connected_line * ast_channel_connected

(

struct ast_channel *

chan

)

Definition at line 893 of file channel_internal_api.c.

{
    return &chan->connected;
}

References ast_channel::connected.

Referenced by __ast_channel_alloc_ap(), __ast_read(), __ast_request_and_dial(), action_meetmelist(), after_bridge_move_channel(), agent_login_channel_config(), analog_call(), ari_channels_handle_originate_with_id(), ast_ari_channels_dial(), ast_call_forward(), ast_channel_connected_line_sub(), ast_channel_destructor(), ast_channel_set_connected_line(), ast_do_pickup(), ast_dummy_channel_destructor(), ast_unreal_call_setup(), attended_transfer_properties_alloc(), begin_dial_prerun(), channel_do_masquerade(), channel_snapshot_connected_create(), connectedline_read(), connectedline_write(), copy_caller_data(), dahdi_call(), dial_exec_full(), dialog_info_generate_body_content(), do_forward(), findmeexec(), handle_showchan(), iax2_call(), indicate_connected_line(), launch_monitor_thread(), manager_queues_status(), ooh323_call(), ooh323_indicate(), park_local_transfer(), pbx_outgoing_attempt(), recalling_enter(), retransfer_enter(), ring_entry(), send_callerid_screen(), serialize_showchan(), try_calling(), unistim_indicate(), unreal_colp_redirect_indicate(), and wait_for_answer().

ast_channel_connected_effective_id()

struct ast_party_id ast_channel_connected_effective_id

(

struct ast_channel *

chan

)

Definition at line 901 of file channel_internal_api.c.

{
    return ast_party_id_merge(&chan->connected.id, &chan->connected.priv);
}

References ast_party_id_merge().

Referenced by caller_id_outgoing_request(), caller_id_outgoing_response(), generate_status(), handle_showchan(), is_colp_update_allowed(), set_from_header(), and stir_shaken_outgoing_request().

ast_channel_connected_indicated()

struct ast_party_connected_line * ast_channel_connected_indicated

(

struct ast_channel *

chan

)

Definition at line 897 of file channel_internal_api.c.

{
    return &chan->connected_indicated;
}

References ast_channel::connected_indicated.

Referenced by __ast_channel_alloc_ap(), after_bridge_move_channel(), ast_channel_destructor(), ast_dummy_channel_destructor(), and indicate_connected_line().

ast_channel_connected_line_sub()

int ast_channel_connected_line_sub	(	struct ast_channel *	autoservice_chan,
		struct ast_channel *	sub_chan,
		const void *	connected_info,
		int	frame
	)

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

Since

11

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

Parameters

autoservice_chan	Channel to place into autoservice while the sub is running. It is perfectly safe for this to be NULL
sub_chan	The channel to run the subroutine on. Also the channel from which we determine which subroutine we need to run.
connected_info	Either an ast_party_connected_line or ast_frame pointer of type AST_CONTROL_CONNECTED_LINE
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 subroutine does not exist, or there was an error while attempting to run the subroutine

Definition at line 10360 of file channel.c.

{
    const char *sub;
    const char *sub_args;
    int retval;
 
    ast_channel_lock(sub_chan);
    sub = pbx_builtin_getvar_helper(sub_chan, "CONNECTED_LINE_SEND_SUB");
    sub = ast_strdupa(S_OR(sub, ""));
    sub_args = pbx_builtin_getvar_helper(sub_chan, "CONNECTED_LINE_SEND_SUB_ARGS");
    sub_args = ast_strdupa(S_OR(sub_args, ""));
 
    if (ast_strlen_zero(sub)) {
        ast_channel_unlock(sub_chan);
        return -1;
    }
 
    if (is_frame) {
        const struct ast_frame *frame = connected_info;
 
        ast_connected_line_parse_data(frame->data.ptr, frame->datalen, ast_channel_connected(sub_chan));
    } else {
        const struct ast_party_connected_line *connected = connected_info;
 
        ast_party_connected_line_copy(ast_channel_connected(sub_chan), connected);
    }
    ast_channel_unlock(sub_chan);
 
    channel_set_intercept_mode(1);
    retval = ast_app_run_sub(autoservice_chan, sub_chan, sub, sub_args, 0);
    channel_set_intercept_mode(0);
    if (!retval) {
        struct ast_party_connected_line saved_connected;
 
        ast_party_connected_line_init(&saved_connected);
        ast_channel_lock(sub_chan);
        ast_party_connected_line_copy(&saved_connected, ast_channel_connected(sub_chan));
        ast_channel_unlock(sub_chan);
        ast_channel_update_connected_line(sub_chan, &saved_connected, NULL);
        ast_party_connected_line_free(&saved_connected);
    }
 
    return retval;
}

References ast_app_run_sub(), ast_channel_connected(), ast_channel_lock, ast_channel_unlock, ast_channel_update_connected_line(), ast_connected_line_parse_data(), ast_party_connected_line_copy(), ast_party_connected_line_free(), ast_party_connected_line_init(), ast_strdupa, ast_strlen_zero(), channel_set_intercept_mode(), connected, ast_frame::data, ast_frame::datalen, NULL, pbx_builtin_getvar_helper(), ast_frame::ptr, retval, S_OR, and sub.

Referenced by __ast_read(), app_exec(), ast_do_pickup(), bridge_channel_handle_control(), dial_exec_full(), handle_frame(), update_connected_line_from_peer(), and wait_for_answer().

ast_channel_connected_set()

void ast_channel_connected_set	(	struct ast_channel *	chan,
		struct ast_party_connected_line *	value
	)

Definition at line 950 of file channel_internal_api.c.

{
    chan->connected = *value;
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CONNECTED);
}

References AST_CHANNEL_SNAPSHOT_INVALIDATE_CONNECTED, ast_channel_snapshot_invalidate_segment(), ast_channel::connected, and value.

Referenced by channel_do_masquerade().

ast_channel_context()

const char * ast_channel_context

(

const struct ast_channel *

chan

)

Definition at line 358 of file channel_internal_api.c.

{
    return chan->context;
}

References ast_channel::context.

Referenced by __analog_ss_thread(), __ast_goto_if_exists(), __ast_pbx_run(), _while_exec(), acf_isexten_exec(), action_blind_transfer(), action_bridge(), action_dialplan_exec(), analog_ss_thread(), ast_bridge_setup_after_goto(), ast_call_forward(), ast_cc_call_init(), ast_channel_by_exten_cb(), ast_channel_log(), ast_channel_yank(), ast_pbx_h_exten_run(), ast_str_retrieve_variable(), AST_TEST_DEFINE(), ast_var_channels_table(), ast_waitstream_exten(), background_detect_exec(), blind_transfer_exec(), bridge_exec(), cc_generic_agent_init(), cc_interfaces_datastore_init(), chan_pjsip_cng_tone_detected(), channel_snapshot_dialplan_create(), collect_digits(), common_exec(), conf_run(), dahdi_handle_dtmf(), dial_exec_full(), dialout(), do_forward(), eval_exten_read(), expand_gosub_args(), extenspy_exec(), fax_detect_framehook(), feature_blind_transfer(), find_matching_endif(), find_matching_endwhile(), forward_message(), func_channel_read(), func_channel_write_real(), get_cid_name(), get_transfer_context(), gosub_exec(), gosub_run(), goto_exten(), goto_parser(), handle_call_forward(), handle_gosub(), handle_setpriority(), handle_showchan(), iax2_call(), if_helper(), launch_monitor_thread(), leave_voicemail(), log_exec(), lua_pbx_exec(), minivm_greet_exec(), my_handle_dtmf(), onedigit_goto(), onModeChanged(), ooh323_rtp_read(), pbx_builtin_background(), pbx_builtin_goto(), pbx_builtin_setvar_multiple(), pbx_builtin_waitexten(), pbx_extension_helper(), pbx_parse_location(), pickup_exec(), raise_exception(), readexten_exec(), realtime_exec(), ring_entry(), serialize_showchan(), setup_env(), setup_peer_after_bridge_goto(), try_calling(), vm_authenticate(), vm_execmain(), vmauthenticate(), and wait_for_answer().

ast_channel_context_set()

void ast_channel_context_set	(	struct ast_channel *	chan,
		const char *	value
	)

Definition at line 366 of file channel_internal_api.c.

{
    if (!*chan->lastcontext || strcmp(value, chan->context)) {
        /* only copy to last context when it changes, unless it's empty to begin with */
        ast_copy_string(chan->lastcontext, chan->context, sizeof(chan->lastcontext));
    }
    ast_copy_string(chan->context, value, sizeof(chan->context));
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN);
}

References AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN, ast_channel_snapshot_invalidate_segment(), ast_copy_string(), ast_channel::context, ast_channel::lastcontext, and value.

Referenced by __ast_channel_alloc_ap(), __ast_request_and_dial(), action_dialplan_exec(), analog_ss_thread(), ari_originate_dial(), ast_add_extension2_lockopt(), ast_bridge_setup_after_goto(), ast_cel_fabricate_channel_from_event(), ast_explicit_goto(), ast_iax2_new(), ast_pbx_h_exten_run(), AST_TEST_DEFINE(), dahdi_new(), dial_exec_full(), dialout(), do_notify(), forward_message(), generic_recall(), gosub_exec(), gosub_run(), handle_gosub(), handle_setcontext(), iax2_call(), jingle_new(), leave_voicemail(), minivm_greet_exec(), my_distinctive_ring(), ooh323_new(), pbx_builtin_background(), pbx_extension_helper(), pbx_outgoing_exec(), and return_exec().

ast_channel_creationtime()

struct timeval ast_channel_creationtime

(

struct ast_channel *

chan

)

Definition at line 977 of file channel_internal_api.c.

{
    return chan->creationtime;
}

Referenced by ast_channel_get_duration_ms(), ast_pickup_find_by_group(), AST_TEST_DEFINE(), channel_snapshot_base_create(), find_ringing_channel(), generate_status(), get_device_state_causing_channels(), handle_showchan(), and wait_for_answer().

ast_channel_creationtime_set()

void ast_channel_creationtime_set	(	struct ast_channel *	chan,
		struct timeval *	value
	)

Definition at line 981 of file channel_internal_api.c.

{
    chan->creationtime = *value;
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_BASE);
}

References AST_CHANNEL_SNAPSHOT_INVALIDATE_BASE, ast_channel_snapshot_invalidate_segment(), ast_channel::creationtime, and value.

Referenced by __ast_channel_alloc_ap().

ast_channel_data()

const char * ast_channel_data

(

const struct ast_channel *

chan

)

Definition at line 348 of file channel_internal_api.c.

{
    return chan->data;
}

References ast_channel::data.

Referenced by ast_channel_log(), ast_var_channels_table(), channel_snapshot_dialplan_create(), func_channel_read(), generate_status(), handle_showchan(), handle_verbose(), pbx_exec(), realtime_exec(), and serialize_showchan().

ast_channel_data_set()

void ast_channel_data_set	(	struct ast_channel *	chan,
		const char *	value
	)

Definition at line 352 of file channel_internal_api.c.

{
    chan->data = value;
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN);
}

References AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN, ast_channel_snapshot_invalidate_segment(), ast_channel::data, and value.

Referenced by ast_cel_fabricate_channel_from_event(), AST_TEST_DEFINE(), begin_dial_prerun(), dial_exec_full(), do_forward(), pbx_exec(), realtime_exec(), retrydial_exec(), and ring_entry().

ast_channel_datastore_add()

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

{
    int res = 0;
 
    AST_LIST_INSERT_HEAD(ast_channel_datastores(chan), datastore, entry);
 
    return res;
}

References ast_channel_datastores(), and AST_LIST_INSERT_HEAD.

Referenced by __after_bridge_set_goto(), acf_curlopt_write(), acf_iaxvar_write(), acf_odbc_read(), add_eprofile_to_channel(), add_features_datastore(), add_masquerade_store(), add_to_agi(), after_bridge_cb_setup(), apply_plc(), ast_cel_fabricate_channel_from_event(), ast_channel_cc_params_init(), ast_channel_suppress(), ast_do_pickup(), ast_iax2_new(), ast_jb_create_framehook(), ast_setup_cc_recall_datastore(), ast_stir_shaken_add_result_to_channel(), attach_framehook(), audiohook_volume_get(), authenticate_reply(), bridge_channel_impart_add(), bridge_features_ds_set_full(), calendar_query_exec(), cc_interfaces_datastore_init(), chan_cleanup(), channel_feature_hooks_set_full(), command_prestart_queue_command(), create_msg_q_chan(), create_parked_subscription_full(), create_transaction(), detect_write(), dial_exec_full(), dial_masquerade_datastore_add(), do_notify(), dtmfstore_exec(), dundi_query_read(), enable_jack_hook(), enum_query_read(), find_or_create_details(), frame_drop_helper(), frame_trace_helper(), func_channel_write_real(), func_confbridge_helper(), geoloc_profile_write(), get_feature_ds(), get_lock(), get_replace_channel_store(), gosub_exec(), handle_remb_set(), init_hook(), lua_get_state(), max_forwards_datastore_alloc(), msg_datastore_find_or_create(), pitchshift_helper(), raise_exception(), save_dialstring(), scramble_write(), set_hold_intercept(), set_internal_datastore(), set_talk_detect(), set_timeout(), setup_async_playback_datastore(), setup_bridge_roles_datastore(), setup_mixmonitor_ds(), setup_park_common_datastore(), shared_write(), smdi_msg_retrieve_read(), socket_process_helper(), speech_create(), speex_write(), srv_datastore_setup(), stasis_app_channel_set_stasis_end_published(), t38_attach_framehook(), unicast_rtp_request(), and volume_write().

ast_channel_datastore_find()

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.

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

{
    struct ast_datastore *datastore = NULL;
 
    if (info == NULL)
        return NULL;
 
    AST_LIST_TRAVERSE(ast_channel_datastores(chan), 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;
        }
    }
 
    return datastore;
}

References ast_channel_datastores(), AST_LIST_TRAVERSE, sip_to_pjsip::info(), ast_datastore::info, NULL, and ast_datastore::uid.

Referenced by 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_datastore(), add_masquerade_store(), add_to_agi(), after_bridge_cb_find(), after_bridge_cb_setup(), after_bridge_goto_remove(), apply_plc(), ast_bridge_features_ds_get(), ast_bridge_read_after_goto(), ast_can_pickup(), ast_cc_agent_set_interfaces_chanvar(), ast_cc_call_init(), ast_cc_completed(), ast_cc_extension_monitor_add_dialstring(), ast_cc_get_current_core_id(), ast_cc_is_recall(), ast_cc_offer(), ast_channel_feature_hooks_get(), ast_channel_get_cc_config_params(), ast_channel_suppress(), ast_channel_unsuppress(), ast_geoloc_datastore_find(), ast_handle_cc_control_frame(), ast_ignore_cc(), ast_jb_create_framehook(), ast_odbc_retrieve_transaction_obj(), ast_set_cc_interfaces_chanvar(), async_play_sound_ready(), attach_framehook(), audiohook_volume_callback(), audiohook_volume_get(), balance_stack(), bridge_channel_impart_add(), bridge_channel_impart_signal(), bridge_features_ds_set_full(), bridge_timeout(), calendar_event_read(), calendar_query_exec(), calendar_query_result_exec(), cc_build_payload(), chan_cleanup(), chan_rtp_get_rtp_peer(), channel_feature_hooks_set_full(), command_prestart_get_container(), command_prestart_queue_command(), conf_find_bridge_profile(), conf_find_user_profile(), conf_set_menu_to_user(), create_transaction(), detect_callback(), detect_read(), detect_write(), dial_exec_full(), dial_masquerade_datastore_find(), dialplan_handle_msg_cb(), disable_jack_hook(), dtmfstore_exec(), dundi_result_read(), enable_jack_hook(), enum_result_read(), exec_odbcfinish(), fetch_bridge_roles_datastore(), find_details(), find_speech(), find_transaction(), fixup_callback(), frame_drop_helper(), frame_trace_helper(), func_channel_read(), func_channel_write_real(), func_confbridge_helper(), func_mixmonitor_read(), get_agi_cmd(), get_feature_chan_ds(), get_feature_ds(), get_lock(), get_park_common_datastore_copy(), get_replace_channel_store(), gosub_exec(), gosub_run(), handle_gosub(), handle_remb_set(), has_masquerade_store(), hook_off(), hook_re_enable(), iax2_call(), jack_hook_callback(), local_read(), local_write(), lock_fixup(), lua_get_state(), mark_transaction_active(), max_forwards_datastore_find_or_alloc(), mixmonitor_ds_remove_and_free(), msg_data_func_read(), msg_datastore_find_or_create(), msg_func_read(), msg_send_exec(), mute_mixmonitor_instance(), pitchshift_cb(), pitchshift_helper(), pop_exec(), raise_exception(), remb_hook_event_cb(), remove_detect(), remove_dtmf_store(), remove_framehook(), remove_hold_intercept(), remove_masquerade_store(), remove_scrambler(), remove_stasis_end_published(), remove_talk_detect(), restore_dialstring(), return_exec(), scramble_callback(), scramble_write(), set_hold_intercept(), set_internal_datastore(), set_interval_hook(), set_security_requirements(), set_talk_detect(), setup_async_playback_datastore(), shared_read(), shared_write(), smdi_msg_read(), speech_datastore_destroy(), speex_callback(), speex_read(), speex_write(), srv_query_read(), srv_result_read(), stackpeek_read(), stasis_app_channel_is_internal(), stasis_app_channel_is_stasis_end_published(), stop_mixmonitor_full(), t38_attach_framehook(), talk_detect_audiohook_cb(), unlock_read(), volume_callback(), volume_read(), volume_write(), wait_for_initiator(), wipe_park_common_datastore(), and wipe_subscription_datastore().

ast_channel_datastore_inherit()

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

Inherit datastores from a parent to a child.

Note

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

Definition at line 2387 of file channel.c.

{
    struct ast_datastore *datastore = NULL, *datastore2;
 
    AST_LIST_TRAVERSE(ast_channel_datastores(from), 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(ast_channel_datastores(to), datastore2, entry);
            }
        }
    }
    return 0;
}

References ast_channel_datastores(), ast_datastore_alloc, AST_LIST_INSERT_TAIL, AST_LIST_TRAVERSE, ast_datastore::data, DATASTORE_INHERIT_FOREVER, ast_datastore_info::duplicate, ast_datastore::info, ast_datastore::inheritance, NULL, and ast_datastore::uid.

Referenced by __ast_request_and_dial(), ast_ari_channels_dial(), ast_unreal_call_setup(), begin_dial_prerun(), call_forward_inherit(), common_recall_channel_setup(), copy_caller_data(), dial_exec_full(), do_forward(), findmeexec(), park_local_transfer(), ring_entry(), and wait_for_answer().

ast_channel_datastore_remove()

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

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

References ast_channel_datastores(), and AST_LIST_REMOVE.

Referenced by acf_fetch(), acf_odbc_read(), adjust_frame_for_plc(), after_bridge_goto_remove(), ast_channel_unsuppress(), ast_do_pickup(), ast_jb_create_framehook(), bridge_timeout(), chan_cleanup(), dial_masquerade_fixup(), disable_jack_hook(), exec_odbcfinish(), fixup_callback(), frame_drop_helper(), frame_trace_helper(), func_confbridge_helper(), lua_get_state(), mixmonitor_ds_remove_and_free(), remove_detect(), remove_dial_masquerade(), remove_dial_masquerade_caller(), remove_dtmf_store(), remove_framehook(), remove_hold_intercept(), remove_masquerade_store(), remove_scrambler(), remove_stasis_end_published(), remove_talk_detect(), set_dial_masquerade(), speech_datastore_destroy(), speex_write(), srv_query_read(), stop_mixmonitor_full(), wipe_park_common_datastore(), and wipe_subscription_datastore().

ast_channel_datastores()

struct ast_datastore_list * ast_channel_datastores

(

struct ast_channel *

chan

)

Definition at line 869 of file channel_internal_api.c.

{
    return &chan->datastores;
}

References ast_channel::datastores.

Referenced by __ast_channel_alloc_ap(), __ast_dummy_channel_alloc(), ast_channel_datastore_add(), ast_channel_datastore_find(), ast_channel_datastore_inherit(), ast_channel_datastore_remove(), ast_channel_destructor(), ast_dummy_channel_destructor(), chan_cleanup(), channel_do_masquerade(), func_read(), and handle_cli_mixmonitor().

ast_channel_defer_dtmf()

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

Defers DTMF so that you only read things like hangups and audio.

Definition at line 1276 of file channel.c.

{
    int pre = 0;
 
    if (chan) {
        ast_channel_lock(chan);
        pre = ast_test_flag(ast_channel_flags(chan), AST_FLAG_DEFER_DTMF);
        ast_set_flag(ast_channel_flags(chan), AST_FLAG_DEFER_DTMF);
        ast_channel_unlock(chan);
    }
    return pre;
}

References ast_channel_flags(), ast_channel_lock, ast_channel_unlock, AST_FLAG_DEFER_DTMF, ast_set_flag, and ast_test_flag.

Referenced by __adsi_transmit_messages().

ast_channel_dialcontext()

const char * ast_channel_dialcontext

(

const struct ast_channel *

chan

)

Referenced by ast_channel_log().

ast_channel_dialed()

struct ast_party_dialed * ast_channel_dialed

(

struct ast_channel *

chan

)

Definition at line 905 of file channel_internal_api.c.

{
    return &chan->dialed;
}

References ast_channel::dialed.

Referenced by __ast_channel_alloc_ap(), ast_ari_channels_dial(), ast_cel_fabricate_channel_from_event(), ast_channel_destructor(), ast_dummy_channel_destructor(), ast_iax2_new(), ast_str_retrieve_variable(), AST_TEST_DEFINE(), ast_unreal_call_setup(), ast_var_channels_table(), begin_dial_prerun(), callerid_read(), callerid_write(), chan_pjsip_new(), channel_do_masquerade(), channel_snapshot_caller_create(), dahdi_new(), dial_exec_full(), do_forward(), generate_status(), handle_showchan(), iax2_call(), ring_entry(), serialize_showchan(), setup_env(), and wait_for_answer().

ast_channel_dialed_causes_add()

int ast_channel_dialed_causes_add	(	const struct ast_channel *	chan,
		const struct ast_control_pvt_cause_code *	cause_code,
		int	datalen
	)

Add cause code information to the channel.

Since

11

This function makes use of datastore operations on the channel, so it is important to lock the channel before calling this function. The passed in data is copied and so is still owned by the caller.

Parameters

chan	The channel on which to add information
cause_code	The cause information to be added to the channel
datalen	The total length of the structure since its length is variable

Return values

0	on success
-1	on error

Definition at line 1294 of file channel_internal_api.c.

{
    struct ast_control_pvt_cause_code *ao2_cause_code;
    ao2_find(chan->dialed_causes, cause_code->chan_name, OBJ_KEY | OBJ_UNLINK | OBJ_NODATA);
    ao2_cause_code = ao2_alloc(datalen, NULL);
 
    if (ao2_cause_code) {
        memcpy(ao2_cause_code, cause_code, datalen);
        ao2_link(chan->dialed_causes, ao2_cause_code);
        ao2_ref(ao2_cause_code, -1);
        return 0;
    } else {
        return -1;
    }
}

References ao2_alloc, ao2_find, ao2_link, ao2_ref, ast_control_pvt_cause_code::chan_name, ast_channel::dialed_causes, NULL, OBJ_KEY, OBJ_NODATA, and OBJ_UNLINK.

Referenced by ast_channel_hangupcause_hash_set().

ast_channel_dialed_causes_channels()

struct ast_str * ast_channel_dialed_causes_channels

(

const struct ast_channel *

chan

)

Retrieve a comma-separated list of channels for which dialed cause information is available.

Since

11

This function makes use of datastore operations on the channel, so it is important to lock the channel before calling this function.

Parameters

chan	The channel from which to retrieve information

Return values

NULL	on allocation failure
Pointer	to an ast_str object containing the desired information which must be freed

Definition at line 1276 of file channel_internal_api.c.

{
    struct ast_str *chanlist = ast_str_create(128);
 
    if (!chanlist) {
        return NULL;
    }
 
    ao2_callback(chan->dialed_causes, 0, collect_names_cb, &chanlist);
 
    return chanlist;
}

References ao2_callback, ast_str_create, collect_names_cb(), ast_channel::dialed_causes, and NULL.

Referenced by hangupcause_keys_read().

ast_channel_dialed_causes_clear()

void ast_channel_dialed_causes_clear

(

const struct ast_channel *

chan

)

Clear all cause information from the channel.

Since

11

This function makes use of datastore operations on the channel, so it is important to lock the channel before calling this function.

Parameters

chan	The channel from which to clear information

Definition at line 1310 of file channel_internal_api.c.

{
    ao2_callback(chan->dialed_causes, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL);
}

References ao2_callback, ast_channel::dialed_causes, NULL, OBJ_MULTIPLE, OBJ_NODATA, and OBJ_UNLINK.

Referenced by hangupcause_clear_exec().

ast_channel_dialed_causes_find()

struct ast_control_pvt_cause_code * ast_channel_dialed_causes_find	(	const struct ast_channel *	chan,
		const char *	chan_name
	)

Retrieve a ref-counted cause code information structure.

Since

11

This function makes use of datastore operations on the channel, so it is important to lock the channel before calling this function. This function increases the ref count of the returned object, so the calling function must decrease the reference count when it is finished with the object.

Parameters

chan	The channel from which to retrieve information
chan_name	The name of the channel about which to retrieve information

Return values

NULL	on search failure
Pointer	to a ref-counted ast_control_pvt_cause_code object containing the desired information

Definition at line 1289 of file channel_internal_api.c.

{
    return ao2_find(chan->dialed_causes, chan_name, OBJ_KEY);
}

References ao2_find, ast_control_pvt_cause_code::chan_name, ast_channel::dialed_causes, and OBJ_KEY.

Referenced by hangupcause_read().

ast_channel_dialed_set()

void ast_channel_dialed_set	(	struct ast_channel *	chan,
		struct ast_party_dialed *	value
	)

Definition at line 955 of file channel_internal_api.c.

{
    chan->dialed = *value;
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER);
}

References AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER, ast_channel_snapshot_invalidate_segment(), ast_channel::dialed, and value.

Referenced by channel_do_masquerade().

ast_channel_dtmf_digit_to_emulate()

char ast_channel_dtmf_digit_to_emulate

(

const struct ast_channel *

chan

)

Definition at line 393 of file channel_internal_api.c.

{
    return chan->dtmf_digit_to_emulate;
}

References ast_channel::dtmf_digit_to_emulate.

Referenced by __ast_read().

ast_channel_dtmf_digit_to_emulate_set()

void ast_channel_dtmf_digit_to_emulate_set	(	struct ast_channel *	chan,
		char	value
	)

Definition at line 397 of file channel_internal_api.c.

{
    chan->dtmf_digit_to_emulate = value;
}

References ast_channel::dtmf_digit_to_emulate, and value.

Referenced by __ast_read().

ast_channel_dtmf_tv()

struct timeval * ast_channel_dtmf_tv

(

struct ast_channel *

chan

)

Definition at line 925 of file channel_internal_api.c.

{
    return &chan->dtmf_tv;
}

References ast_channel::dtmf_tv.

Referenced by __ast_read(), should_skip_dtmf(), and should_trigger_dtmf_emulating().

ast_channel_dtmf_tv_set()

void ast_channel_dtmf_tv_set	(	struct ast_channel *	chan,
		struct timeval *	value
	)

Definition at line 965 of file channel_internal_api.c.

{
    chan->dtmf_tv = *value;
}

References ast_channel::dtmf_tv, and value.

Referenced by __ast_read().

ast_channel_dtmff()

struct ast_frame * ast_channel_dtmff

(

struct ast_channel *

chan

)

Definition at line 881 of file channel_internal_api.c.

{
    return &chan->dtmff;
}

References ast_channel::dtmff.

Referenced by __ast_read(), and queue_dtmf_readq().

ast_channel_dtmff_set()

void ast_channel_dtmff_set	(	struct ast_channel *	chan,
		struct ast_frame *	value
	)

Definition at line 937 of file channel_internal_api.c.

{
    chan->dtmff = *value;
}

References ast_channel::dtmff, and value.

ast_channel_early_bridge()

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

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

References ast_channel_tech(), and ast_channel_tech::early_bridge.

Referenced by dial_exec_full(), and wait_for_answer().

ast_channel_emulate_dtmf_duration()

unsigned int ast_channel_emulate_dtmf_duration

(

const struct ast_channel *

chan

)

Definition at line 515 of file channel_internal_api.c.

{
    return chan->emulate_dtmf_duration;
}

References ast_channel::emulate_dtmf_duration.

Referenced by __ast_read().

ast_channel_emulate_dtmf_duration_set()

void ast_channel_emulate_dtmf_duration_set	(	struct ast_channel *	chan,
		unsigned int	value
	)

Definition at line 519 of file channel_internal_api.c.

{
    chan->emulate_dtmf_duration = value;
}

References ast_channel::emulate_dtmf_duration, and value.

Referenced by __ast_read().

ast_channel_end_dtmf()

void ast_channel_end_dtmf	(	struct ast_channel *	chan,
		char	digit,
		struct timeval	start,
		const char *	why
	)

Simulate a DTMF end on a broken bridge channel.

Parameters

chan	Channel sending DTMF that has not ended.
digit	DTMF digit to stop.
start	DTMF digit start time.
why	Reason bridge broken.

Definition at line 10891 of file channel.c.

{
    int dead;
    long duration;
 
    ast_channel_lock(chan);
    dead = ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE)
        || (ast_channel_softhangup_internal_flag(chan)
            & ~AST_SOFTHANGUP_ASYNCGOTO);
    ast_channel_unlock(chan);
    if (dead) {
        /* Channel is a zombie or a real hangup. */
        return;
    }
 
    duration = ast_tvdiff_ms(ast_tvnow(), start);
    if (duration < option_dtmfminduration) {
        duration = option_dtmfminduration;
    }
    ast_senddigit_end(chan, digit, duration);
    ast_log(LOG_DTMF, "DTMF end '%c' simulated on %s due to %s, duration %ld ms\n",
        digit, ast_channel_name(chan), why, duration);
}

References ast_channel_flags(), ast_channel_lock, ast_channel_name(), ast_channel_softhangup_internal_flag(), ast_channel_unlock, AST_FLAG_ZOMBIE, ast_log, ast_senddigit_end(), ast_test_flag, ast_tvdiff_ms(), ast_tvnow(), digit, LOG_DTMF, and option_dtmfminduration.

Referenced by bridge_channel_internal_join(), and channel_do_masquerade().

ast_channel_epfd()

int ast_channel_epfd

(

const struct ast_channel *

chan

)

ast_channel_epfd_set()

void ast_channel_epfd_set	(	struct ast_channel *	chan,
		int	value
	)

ast_channel_errno()

enum ast_channel_error ast_channel_errno

(

void

)

Get error code for latest channel operation.

Definition at line 10983 of file channel.c.

{
    return ast_channel_internal_errno();
}

References ast_channel_internal_errno().

Referenced by ari_channels_handle_originate_with_id(), and ast_ari_channels_create().

ast_channel_exten()

const char * ast_channel_exten

(

const struct ast_channel *

chan

)

Definition at line 375 of file channel_internal_api.c.

{
    return chan->exten;
}

References ast_channel::exten.

Referenced by __ast_goto_if_exists(), __ast_pbx_run(), _while_exec(), action_bridge(), action_dialplan_exec(), ast_bridge_setup_after_goto(), ast_cc_call_init(), ast_channel_by_exten_cb(), ast_channel_log(), ast_channel_yank(), ast_pbx_h_exten_run(), ast_str_retrieve_variable(), AST_TEST_DEFINE(), ast_var_channels_table(), bridge_exec(), cc_generic_agent_init(), cc_interfaces_datastore_init(), chan_pjsip_cng_tone_detected(), channel_snapshot_dialplan_create(), dahdi_handle_dtmf(), dial_exec_full(), do_forward(), eval_exten_read(), expand_gosub_args(), fax_detect_framehook(), feature_blind_transfer(), find_matching_endif(), find_matching_endwhile(), forward_message(), func_channel_read(), func_channel_write_real(), get_cid_name(), gosub_exec(), gosub_run(), goto_parser(), handle_frame(), handle_gosub(), handle_setpriority(), handle_showchan(), if_helper(), launch_monitor_thread(), leave_voicemail(), log_exec(), lua_pbx_exec(), my_handle_dtmf(), onModeChanged(), ooh323_rtp_read(), pbx_builtin_goto(), pbx_builtin_setvar_multiple(), pbx_builtin_waitexten(), pbx_extension_helper(), pbx_parse_location(), raise_exception(), realtime_exec(), ring_entry(), serialize_showchan(), setup_env(), setup_peer_after_bridge_goto(), setup_privacy_args(), try_calling(), and wait_for_answer().

ast_channel_exten_set()

void ast_channel_exten_set	(	struct ast_channel *	chan,
		const char *	value
	)

Definition at line 383 of file channel_internal_api.c.

{
    if (!*chan->lastexten || strcmp(value, chan->exten)) {
        /* only copy to last exten when it changes, unless it's empty to begin with */
        ast_copy_string(chan->lastexten, chan->exten, sizeof(chan->lastexten));
    }
    ast_copy_string(chan->exten, value, sizeof(chan->exten));
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN);
}

References AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN, ast_channel_snapshot_invalidate_segment(), ast_copy_string(), ast_channel::exten, ast_channel::lastexten, and value.

Referenced by __analog_ss_thread(), __ast_channel_alloc_ap(), __ast_request_and_dial(), action_dialplan_exec(), analog_ss_thread(), ari_originate_dial(), ast_add_extension2_lockopt(), ast_bridge_setup_after_goto(), ast_cel_fabricate_channel_from_event(), ast_explicit_goto(), ast_iax2_new(), ast_pbx_h_exten_run(), AST_TEST_DEFINE(), dahdi_new(), dial_exec_full(), dialout(), do_monitor_headset(), do_notify(), forward_message(), generic_recall(), gosub_exec(), gosub_run(), handle_gosub(), handle_response_cmgr(), handle_setextension(), jingle_new(), leave_voicemail(), minivm_greet_exec(), ooh323_new(), pbx_builtin_background(), pbx_extension_helper(), pbx_outgoing_exec(), return_exec(), ring_entry(), select_entry(), set_ext_pri(), unistim_ss(), and wait_for_answer().

ast_channel_fd()

int ast_channel_fd	(	const struct ast_channel *	chan,
		int	which
	)

Definition at line 1187 of file channel_internal_api.c.

{
    return (which >= AST_VECTOR_SIZE(&chan->fds)) ? -1 : AST_VECTOR_GET(&chan->fds, which);
}

References AST_VECTOR_GET, AST_VECTOR_SIZE, and ast_channel::fds.

Referenced by __dahdi_exception(), analog_exception(), ast_channel_fd_isset(), AST_TEST_DEFINE(), ast_waitfor_nandfds(), build_conf(), channel_do_masquerade(), conf_run(), flash_exec(), fxo_pvt(), meetme_menu_admin_extended(), native_chan_changed(), native_start(), serialize_showchan(), and swap_subs().

ast_channel_fd_add()

int ast_channel_fd_add	(	struct ast_channel *	chan,
		int	value
	)

Add a file descriptor to the channel without a fixed position.

Since

15

Parameters

chan	The channel to add the file descriptor to
value	The file descriptor

Precondition

chan is locked

Returns

The position of the file descriptor

Definition at line 1201 of file channel_internal_api.c.

{
    int pos = AST_EXTENDED_FDS;
 
    while (ast_channel_fd_isset(chan, pos)) {
        pos += 1;
    }
 
    AST_VECTOR_REPLACE(&chan->fds, pos, value);
 
    return pos;
}

References ast_channel_fd_isset(), AST_EXTENDED_FDS, AST_VECTOR_REPLACE, ast_channel::fds, and value.

Referenced by AST_TEST_DEFINE().

ast_channel_fd_count()

int ast_channel_fd_count

(

const struct ast_channel *

chan

)

Retrieve the number of file decriptor positions present on the channel.

Since

15

Parameters

chan	The channel to get the count of

Precondition

chan is locked

Returns

The number of file descriptor positions

Definition at line 1196 of file channel_internal_api.c.

{
    return AST_VECTOR_SIZE(&chan->fds);
}

References AST_VECTOR_SIZE, and ast_channel::fds.

Referenced by AST_TEST_DEFINE(), ast_waitfor_nandfds(), and channel_do_masquerade().

ast_channel_fd_isset()

int ast_channel_fd_isset	(	const struct ast_channel *	chan,
		int	which
	)

Definition at line 1191 of file channel_internal_api.c.

{
    return ast_channel_fd(chan, which) > -1;
}

References ast_channel_fd().

Referenced by __ast_read(), and ast_channel_fd_add().

ast_channel_fdno()

int ast_channel_fdno

(

const struct ast_channel *

chan

)

Definition at line 433 of file channel_internal_api.c.

{
    return chan->fdno;
}

References ast_channel::fdno.

Referenced by __ast_read(), ast_settimeout_full(), chan_pjsip_read_stream(), channel_do_masquerade(), hook_event_cb(), jingle_read(), ooh323_rtp_read(), rtp_read(), stasis_app_control_execute_until_exhausted(), stasis_app_exec(), and unistim_rtp_read().

ast_channel_fdno_set()

void ast_channel_fdno_set	(	struct ast_channel *	chan,
		int	value
	)

Definition at line 437 of file channel_internal_api.c.

{
    chan->fdno = value;
}

References ast_channel::fdno, and value.

Referenced by __ast_read(), ast_settimeout_full(), ast_waitfor_nandfds(), channel_do_masquerade(), and read_test().

ast_channel_feature_hooks_append()

int ast_channel_feature_hooks_append	(	struct ast_channel *	chan,
		struct ast_bridge_features *	features
	)

Appends to the channel-attached features a channel has access to upon being bridged.

Note

The channel must be locked when calling this function.

Parameters

chan	Which channel to set features for
features	The feature set to append to the channel's features

Return values

0	on success
-1	on failure

Definition at line 10973 of file channel.c.

{
    return channel_feature_hooks_set_full(chan, features, 0);
}

References channel_feature_hooks_set_full().

Referenced by AST_TEST_DEFINE().

ast_channel_feature_hooks_get()

struct ast_bridge_features * ast_channel_feature_hooks_get

(

struct ast_channel *

chan

)

Gets the channel-attached features a channel has access to upon being bridged.

Note

The channel must be locked when calling this function.

Parameters

chan	Which channel to get features for

Return values

non-NULL	The features currently set for this channel
NULL	if the features have not been set

Definition at line 10925 of file channel.c.

{
    struct ast_datastore *datastore;
 
    datastore = ast_channel_datastore_find(chan, &bridge_features_info, NULL);
    if (!datastore) {
        return NULL;
    }
    return datastore->data;
}

References ast_channel_datastore_find(), bridge_features_info, ast_datastore::data, and NULL.

Referenced by bridge_channel_internal_join().

ast_channel_feature_hooks_replace()

int ast_channel_feature_hooks_replace	(	struct ast_channel *	chan,
		struct ast_bridge_features *	features
	)

Sets the channel-attached features a channel has access to upon being bridged.

Note

The channel must be locked when calling this function.

Parameters

chan	Which channel to set features for
features	The feature set with which to replace the channel's features

Return values

0	on success
-1	on failure

Definition at line 10978 of file channel.c.

{
    return channel_feature_hooks_set_full(chan, features, 1);
}

References channel_feature_hooks_set_full().

ast_channel_fin()

unsigned int ast_channel_fin

(

const struct ast_channel *

chan

)

Definition at line 523 of file channel_internal_api.c.

{
    return chan->fin;
}

References ast_channel::fin.

Referenced by __ast_read(), channel_set_debug(), and serialize_showchan().

ast_channel_fin_set()

void ast_channel_fin_set	(	struct ast_channel *	chan,
		unsigned int	value
	)

Definition at line 527 of file channel_internal_api.c.

{
    chan->fin = value;
}

References ast_channel::fin, and value.

Referenced by __ast_channel_alloc_ap(), __ast_read(), and channel_set_debug().

ast_channel_flags()

struct ast_flags * ast_channel_flags

(

struct ast_channel *

chan

)

Definition at line 1261 of file channel_internal_api.c.

{
    return &chan->flags;
}

References ast_channel::flags.

Referenced by __analog_ss_thread(), __ast_pbx_run(), __ast_queue_frame(), __ast_read(), __ast_request_and_dial(), action_bridge(), action_redirect(), agent_request_exec(), analog_ss_thread(), ari_channels_handle_originate_with_id(), ast_async_goto(), ast_audiohook_attach(), ast_autoservice_start(), ast_autoservice_stop(), ast_bridge_channel_playfile(), ast_bridge_join(), ast_bridge_setup_after_goto(), ast_call(), ast_can_pickup(), ast_channel_clear_flag(), ast_channel_defer_dtmf(), ast_channel_destructor(), ast_channel_end_dtmf(), ast_channel_move(), ast_channel_publish_snapshot(), ast_channel_set_flag(), ast_channel_snapshot_create(), ast_channel_stage_snapshot(), ast_channel_stage_snapshot_done(), ast_channel_yank(), ast_explicit_goto(), ast_hangup(), ast_iax2_new(), ast_indicate_data(), ast_pbx_h_exten_run(), ast_raw_answer_with_stream_topology(), ast_readstring_full(), ast_sendtext_data(), ast_setstate(), ast_settimeout_full(), ast_softhangup_nolock(), ast_streamfile(), AST_TEST_DEFINE(), ast_transfer_protocol(), ast_unreal_new_channels(), ast_var_channels_table(), ast_waitfor_nandfds(), ast_waitfordigit_full(), ast_write_stream(), bridge_channel_internal_join(), bridge_channel_internal_pull(), bridge_impart_internal(), bridge_reconfigured_connected_line_update(), call_forward_inherit(), channel_do_masquerade(), channel_spy(), common_exec(), dahdi_new(), dahdi_read(), deactivate_generator_nolock(), dial_exec_full(), eivr_comm(), gosub_exec(), gosub_run(), handle_exec(), handle_gosub(), limits_interval_playback(), linear_alloc(), local_ast_moh_start(), local_ast_moh_stop(), optimize_lock_chan_stack(), optimize_lock_peer_stack(), pbx_builtin_background(), pbx_outgoing_attempt(), playtones_alloc(), retrydial_exec(), return_exec(), serialize_showchan(), should_skip_dtmf(), should_trigger_dtmf_emulating(), tonepair_alloc(), and waitstream_core().

ast_channel_forward_endpoint()

int ast_channel_forward_endpoint	(	struct ast_channel *	chan,
		struct ast_endpoint *	endpoint
	)

Forward channel stasis messages to the given endpoint.

Since

12

Parameters

chan	The channel to forward from
endpoint	The endpoint to forward to

Return values

0	Success
non-zero	Failure

Definition at line 1540 of file channel_internal_api.c.

{
    ast_assert(chan != NULL);
    ast_assert(endpoint != NULL);
 
    chan->endpoint_forward =
        stasis_forward_all(ast_channel_topic(chan),
            ast_endpoint_topic(endpoint));
    if (!chan->endpoint_forward) {
        return -1;
    }
 
    return 0;
}

References ast_assert, ast_channel_topic(), ast_endpoint_topic(), ast_channel::endpoint_forward, NULL, and stasis_forward_all().

Referenced by ast_endpoint_add_channel().

ast_channel_fout()

unsigned int ast_channel_fout

(

const struct ast_channel *

chan

)

Definition at line 531 of file channel_internal_api.c.

{
    return chan->fout;
}

References ast_channel::fout.

Referenced by ast_write_stream(), channel_set_debug(), and serialize_showchan().

ast_channel_fout_set()

void ast_channel_fout_set	(	struct ast_channel *	chan,
		unsigned int	value
	)

Definition at line 535 of file channel_internal_api.c.

{
    chan->fout = value;
}

References ast_channel::fout, and value.

Referenced by __ast_channel_alloc_ap(), ast_write_stream(), and channel_set_debug().

ast_channel_framehooks()

struct ast_framehook_list * ast_channel_framehooks

(

const struct ast_channel *

chan

)

Definition at line 706 of file channel_internal_api.c.

{
    return chan->framehooks;
}

References ast_channel::framehooks.

Referenced by __ast_read(), ast_channel_has_audio_frame_or_monitor(), ast_channel_has_hook_requiring_audio(), ast_framehook_attach(), ast_framehook_detach(), ast_framehook_list_destroy(), ast_framehook_list_fixup(), ast_indicate_data(), and ast_write_stream().

ast_channel_framehooks_set()

void ast_channel_framehooks_set	(	struct ast_channel *	chan,
		struct ast_framehook_list *	value
	)

Definition at line 710 of file channel_internal_api.c.

{
    chan->framehooks = value;
}

References ast_channel::framehooks, and value.

Referenced by ast_framehook_attach(), and ast_framehook_list_destroy().

ast_channel_generator()

struct ast_generator * ast_channel_generator

(

const struct ast_channel *

chan

)

Definition at line 714 of file channel_internal_api.c.

{
    return chan->generator;
}

References ast_channel::generator.

Referenced by __ast_read(), ast_activate_generator(), ast_hangup(), ast_openstream_full(), ast_read_generator_actions(), ast_senddigit_end(), ast_senddigit_mf_end(), deactivate_generator_nolock(), deactivate_silence_generator(), generator_force(), generator_write_format_change(), and unreal_queue_frame().

ast_channel_generator_set()

void ast_channel_generator_set	(	struct ast_channel *	chan,
		struct ast_generator *	value
	)

Definition at line 718 of file channel_internal_api.c.

{
    chan->generator = value;
}

References ast_channel::generator, and value.

Referenced by ast_activate_generator(), ast_hangup(), and deactivate_generator_nolock().

ast_channel_generatordata()

void * ast_channel_generatordata

(

const struct ast_channel *

chan

)

Definition at line 555 of file channel_internal_api.c.

{
    return chan->generatordata;
}

References ast_channel::generatordata.

Referenced by __ast_read(), ast_activate_generator(), ast_hangup(), ast_read_generator_actions(), ast_tonepair(), ast_write_stream(), deactivate_generator_nolock(), deactivate_silence_generator(), generator_force(), generator_write_format_change(), safe_sleep_conditional(), and set_format().

ast_channel_generatordata_set()

void ast_channel_generatordata_set	(	struct ast_channel *	chan,
		void *	value
	)

Definition at line 559 of file channel_internal_api.c.

{
    chan->generatordata = value;
}

References ast_channel::generatordata, and value.

Referenced by __ast_read(), ast_activate_generator(), ast_hangup(), ast_read_generator_actions(), deactivate_generator_nolock(), and generator_force().

ast_channel_get_ari_vars()

struct varshead * ast_channel_get_ari_vars

(

struct ast_channel *

chan

)

Gets the variables for a given channel, as specified by ast_channel_set_ari_vars().

Since

14.2.0

The returned variable list is an AO2 object, so ao2_cleanup() to free it.

Parameters

chan	Channel to get variables for.

Returns

List of channel variables.

Return values

NULL

on error

Definition at line 8010 of file channel.c.

{
    return channel_get_external_vars(&ari_vars, chan);
}

References ari_vars, and channel_get_external_vars().

Referenced by ast_channel_snapshot_create().

ast_channel_get_bridge()

struct ast_bridge * ast_channel_get_bridge

(

const struct ast_channel *

chan

)

Get the bridge associated with a channel.

Since

12.0.0

Parameters

chan	The channel whose bridge we want

The bridge returned has its reference count incremented. Use ao2_cleanup() or ao2_ref() in order to decrement the reference count when you are finished with the bridge.

Note

This function expects the channel to be locked prior to being called and will not grab the channel lock.

Return values

NULL	No bridge present on the channel
non-NULL	The bridge the channel is in

Definition at line 10556 of file channel.c.

{
    struct ast_bridge *bridge;
 
    bridge = ast_channel_internal_bridge(chan);
    if (bridge) {
        ao2_ref(bridge, +1);
    }
    return bridge;
}

References ao2_ref, and ast_channel_internal_bridge().

Referenced by ast_bridge_add_channel(), ast_bridge_transfer_acquire_bridge(), ast_channel_bridge_peer(), bridgeadd_exec(), channel_snapshot_bridge_create(), generate_status(), get_transfer_parties(), handle_showchan(), manager_bridge_kick(), native_rtp_framehook(), and serialize_showchan().

ast_channel_get_bridge_channel()

struct ast_bridge_channel * ast_channel_get_bridge_channel

(

struct ast_channel *

chan

)

Get a reference to the channel's bridge pointer.

Since

12.0.0

Parameters

chan	The channel whose bridge channel is desired

Note

This increases the reference count of the bridge_channel. Use ao2_ref() or ao2_cleanup() to decrement the refcount when you are finished with it.

It is expected that the channel is locked prior to placing this call.

Return values

NULL	The channel has no bridge_channel
non-NULL	A reference to the bridge_channel

Definition at line 10604 of file channel.c.

{
    struct ast_bridge_channel *bridge_channel;
 
    bridge_channel = ast_channel_internal_bridge_channel(chan);
    if (bridge_channel) {
        ao2_ref(bridge_channel, +1);
    }
    return bridge_channel;
}

References ao2_ref, ast_channel_internal_bridge_channel(), and ast_bridge_channel::chan.

Referenced by __analog_ss_thread(), agent_bridge_channel_get_lock(), analog_ss_thread(), ast_bridge_add_channel(), ast_bridge_notify_masquerade(), ast_bridge_transfer_attended(), ast_bridge_transfer_blind(), bridge_channel_internal_queue_attended_transfer(), bridge_channel_internal_queue_blind_transfer(), bridge_move(), dial_bridge_after_cb(), hold(), internal_bridge_after_cb(), manager_park_bridged(), parker_parked_call_message_response(), play_sound(), recall_pull(), ringing(), send_message(), set_interval_hook(), transfer_pull(), try_parking(), and unhold().

ast_channel_get_by_exten()

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

Find a channel by extension and context.

Parameters

exten	the extension to search for
context	the context to search for

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

Definition at line 1478 of file channel.c.

{
    char *l_exten = (char *) exten;
    char *l_context = (char *) context;
 
    return ast_channel_callback(ast_channel_by_exten_cb, l_context, l_exten, 0);
}

References ast_channel_by_exten_cb(), ast_channel_callback(), voicemailpwcheck::context, and ast_channel::exten.

ast_channel_get_by_name()

struct ast_channel * ast_channel_get_by_name

(

const char *

name

)

Find a channel by name.

Channel search functions

Parameters

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

Definition at line 1473 of file channel.c.

{
    return ast_channel_get_by_name_prefix(name, 0);
}

References ast_channel_get_by_name_prefix(), and name.

Referenced by action_add_agi_cmd(), action_aocmessage(), action_atxfer(), action_blind_transfer(), action_cancel_atxfer(), action_getvar(), action_redirect(), action_sendtext(), action_setvar(), action_status(), action_timeout(), ari_channels_handle_originate_with_id(), ari_channels_handle_snoop_channel(), assign_uuid(), ast_ari_channels_create(), ast_ari_channels_dial(), ast_ari_channels_get_channel_var(), ast_ari_channels_hangup(), ast_ari_channels_rtpstatistics(), ast_async_goto_by_name(), ast_manager_hangup_helper(), asyncgoto_exec(), bridge_channel_attended_transfer(), call_forwarded_handler(), channel_find(), cli_channelstats_print_body(), common_exec(), controlplayback_manager(), do_broadcast(), find_control(), func_chan_exists_read(), func_export_write(), func_mchan_read(), func_mchan_write(), handle_cli_agi_add_cmd(), handle_core_set_debug_channel(), handle_dump_frames(), handle_getvariablefull(), handle_hangup(), handle_redirect(), handle_remb_set(), handle_set_chanvar(), handle_show_chanvar(), handle_show_hangup_channel(), handle_showchan(), handle_softhangup(), import_helper(), inherit_channel_vars_from_id(), manager_bridge_kick(), manager_mixmonitor(), manager_mute_mixmonitor(), manager_mutestream(), manager_optimize_away(), manager_park(), manager_play_dtmf(), manager_play_mf(), manager_send_flash(), manager_stop_mixmonitor(), moh_channel_thread(), parker_parked_call_message_response(), parking_park_bridge_channel(), push_notify_channel(), refer_progress_bridge(), rtp_check_timeout(), senddtmf_exec(), sendmf_exec(), sendsf_exec(), shared_read(), shared_write(), stasis_app_bridge_moh_channel(), stasis_app_bridge_moh_stop(), and stasis_app_bridge_playback_channel_find().

ast_channel_get_by_name_prefix()

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

Find a channel by a name prefix.

Parameters

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

Definition at line 1453 of file channel.c.

{
    struct ast_channel *chan;
    char *l_name = (char *) name;
 
    if (ast_strlen_zero(l_name)) {
        /* We didn't have a name to search for so quit. */
        return NULL;
    }
 
    chan = ast_channel_callback(ast_channel_by_name_cb, l_name, &name_len,
        (name_len == 0) /* optimize if it is a complete name match */ ? OBJ_KEY : 0);
    if (chan) {
        return chan;
    }
 
    /* Now try a search for uniqueid. */
    return ast_channel_callback(ast_channel_by_uniqueid_cb, l_name, &name_len, 0);
}

References ast_channel_by_name_cb(), ast_channel_by_uniqueid_cb(), ast_channel_callback(), ast_strlen_zero(), name, NULL, and OBJ_KEY.

Referenced by action_aocmessage(), action_bridge(), ast_channel_get_by_name(), ast_parse_device_state(), bridge_exec(), bridgeadd_exec(), cc_generic_agent_stop_ringing(), common_exec(), handle_bridge_kick_channel(), handle_cli_mixmonitor(), shared_read(), and shared_write().

ast_channel_get_cc_agent_type()

int ast_channel_get_cc_agent_type	(	struct ast_channel *	chan,
		char *	agent_type,
		size_t	size
	)

Find the appropriate CC agent type to use given a channel.

Since

1.8

During call completion, we will need to create a call completion agent structure. To figure out the type of agent to construct, we need to ask the channel driver for the appropriate type.

Prior to adding this function, the call completion core attempted to figure this out for itself by stripping the technology off the channel's name. However, in the case of chan_dahdi, there are multiple agent types registered, and so simply searching for an agent type called "DAHDI" is not possible. In a case where multiple agent types are defined, the channel driver must have a queryoption callback defined in its channel_tech, and the queryoption callback must handle AST_OPTION_CC_AGENT_TYPE

If a channel driver does not have a queryoption callback or if the queryoption callback does not handle AST_OPTION_CC_AGENT_TYPE, then the old behavior of using the technology portion of the channel name is used instead. This is perfectly suitable for channel drivers whose channel technologies are a one-to-one match with the agent types defined within.

Note that this function is only called when the agent policy on a given channel is set to "native." Generic agents' type can be determined automatically by the core.

Parameters

	chan	The channel for which we wish to retrieve the agent type
[out]	agent_type	The type of agent the channel driver wants us to use
	size	The size of the buffer to write to

Definition at line 10535 of file channel.c.

{
    int len = size;
    char *slash;
 
    if (!ast_channel_queryoption(chan, AST_OPTION_CC_AGENT_TYPE, agent_type, &len, 0)) {
        return 0;
    }
 
    ast_copy_string(agent_type, ast_channel_name(chan), size);
    if ((slash = strchr(agent_type, '/'))) {
        *slash = '\0';
    }
    return 0;
}

References agent_type, ast_channel_name(), ast_channel_queryoption(), ast_copy_string(), AST_OPTION_CC_AGENT_TYPE, and len().

Referenced by find_agent_callbacks().

ast_channel_get_cc_config_params()

struct ast_cc_config_params * ast_channel_get_cc_config_params

(

struct ast_channel *

chan

)

Get the CCSS parameters from a channel.

Since

1.8

This function makes use of datastore operations on the channel, so it is important to lock the channel before calling this function.

Parameters

chan	Channel to retrieve parameters from

Return values

NULL	Failure
non-NULL	The parameters desired

Definition at line 10496 of file channel.c.

{
    struct ast_datastore *cc_datastore;
 
    if (!(cc_datastore = ast_channel_datastore_find(chan, &cc_channel_datastore_info, NULL))) {
        /* If we can't find the datastore, it almost definitely means that the channel type being
         * used has not had its driver modified to parse CC config parameters. The best action
         * to take here is to create the parameters on the spot with the defaults set.
         */
        if (ast_channel_cc_params_init(chan, NULL)) {
            return NULL;
        }
        if (!(cc_datastore = ast_channel_datastore_find(chan, &cc_channel_datastore_info, NULL))) {
            /* Should be impossible */
            return NULL;
        }
    }
 
    ast_assert(cc_datastore->data != NULL);
    return cc_datastore->data;
}

References ast_assert, ast_channel_cc_params_init(), ast_channel_datastore_find(), cc_channel_datastore_info, ast_datastore::data, and NULL.

Referenced by acf_cc_read(), acf_cc_write(), analog_call(), ast_cc_call_failed(), ast_cc_call_init(), ast_queue_cc_frame(), ast_unreal_call_setup(), ast_unreal_new_channels(), cc_agent_init(), cc_core_init_instance(), and find_agent_callbacks().

ast_channel_get_default_stream()

struct ast_stream * ast_channel_get_default_stream	(	struct ast_channel *	chan,
		enum ast_media_type	type
	)

Retrieve the default stream of a specific media type on a channel.

Parameters

chan	The channel to get the stream from
type	The media type of the default stream

Precondition

chan is locked

Return values

non-NULL	success
NULL	failure

Definition at line 1648 of file channel_internal_api.c.

{
    ast_assert(chan != NULL);
    ast_assert(type < AST_MEDIA_TYPE_END);
 
    return chan->default_streams[type];
}

References ast_assert, AST_MEDIA_TYPE_END, ast_channel::default_streams, NULL, and type.

Referenced by __ast_read(), ast_unreal_write_stream(), ast_write_stream(), and stream_echo_write_error().

ast_channel_get_device_name()

int ast_channel_get_device_name	(	struct ast_channel *	chan,
		char *	device_name,
		size_t	name_buffer_length
	)

Get a device name given its channel structure.

Since

1.8

A common practice in Asterisk is to determine the device being talked to by dissecting the channel name. For certain channel types, this is not accurate. For instance, an ISDN channel is named based on what B channel is used, not the device being communicated with.

This function interfaces with a channel tech's queryoption callback to retrieve the name of the device being communicated with. If the channel does not implement this specific option, then the traditional method of using the channel name is used instead.

Parameters

	chan	The channel to retrieve the information from
[out]	device_name	The buffer to place the device's name into
	name_buffer_length	The allocated space for the device_name

Returns

0 always

Definition at line 10518 of file channel.c.

{
    int len = name_buffer_length;
    char *dash;
    if (!ast_channel_queryoption(chan, AST_OPTION_DEVICE_NAME, device_name, &len, 0)) {
        return 0;
    }
 
    /* Dang. Do it the old-fashioned way */
    ast_copy_string(device_name, ast_channel_name(chan), name_buffer_length);
    if ((dash = strrchr(device_name, '-'))) {
        *dash = '\0';
    }
 
    return 0;
}

References ast_channel_name(), ast_channel_queryoption(), ast_copy_string(), AST_OPTION_DEVICE_NAME, and len().

Referenced by ast_cc_call_failed(), ast_cc_is_recall(), ast_queue_cc_frame(), cc_core_init_instance(), cccancel_exec(), ccreq_exec(), chan_pjsip_indicate(), dial_exec_full(), and func_channel_read().

ast_channel_get_duration()

int ast_channel_get_duration

(

struct ast_channel *

chan

)

Obtain how long the channel since the channel was created.

Since

12

Parameters

chan	The channel object

Return values

0	if the time value cannot be computed (or you called this really fast)
The	number of seconds the channel has been up

Definition at line 2849 of file channel.c.

{
    return (ast_channel_get_duration_ms(chan) / 1000);
}

References ast_channel_get_duration_ms().

Referenced by end_bridge_callback(), and serialize_showchan().

ast_channel_get_duration_ms()

int64_t ast_channel_get_duration_ms

(

struct ast_channel *

chan

)

Obtain how long it's been, in milliseconds, since the channel was created.

Since

13.27.0

16.4.0

Parameters

chan	The channel object

Return values

0	if the time value cannot be computed (or you called this really fast)
The	number of milliseconds since channel creation

Definition at line 2839 of file channel.c.

{
    ast_assert(NULL != chan);
 
    if (ast_tvzero(ast_channel_creationtime(chan))) {
        return 0;
    }
    return ast_tvdiff_ms(ast_tvnow(), ast_channel_creationtime(chan));
}

References ast_assert, ast_channel_creationtime(), ast_tvdiff_ms(), ast_tvnow(), ast_tvzero(), and NULL.

Referenced by ast_channel_get_duration(), and end_bridge_callback().

ast_channel_get_intercept_mode()

int ast_channel_get_intercept_mode

(

void

)

Am I currently running an intercept dialplan routine.

Since

13.14.0

A dialplan intercept routine is equivalent to an interrupt routine. As such, the routine must be done quickly and you do not have access to the media stream. These restrictions are necessary because the media stream is the responsibility of some other code and interfering with or delaying that processing is bad.

Return values

0	Not in an intercept routine.
1	In an intercept routine.

Definition at line 10355 of file channel.c.

{
    return ast_threadstorage_get_ptr(&in_intercept_routine) ? 1 : 0;
}

References ast_threadstorage_get_ptr().

Referenced by run_agi().

ast_channel_get_manager_vars()

struct varshead * ast_channel_get_manager_vars

(

struct ast_channel *

chan

)

Gets the variables for a given channel, as specified by ast_channel_set_manager_vars().

Since

12

The returned variable list is an AO2 object, so ao2_cleanup() to free it.

Parameters

chan	Channel to get variables for.

Returns

List of channel variables.

Return values

NULL

on error

Definition at line 8005 of file channel.c.

{
    return channel_get_external_vars(&ami_vars, chan);
}

References ami_vars, and channel_get_external_vars().

Referenced by append_channel_vars(), and ast_channel_snapshot_create().

ast_channel_get_stream_topology()

struct ast_stream_topology * ast_channel_get_stream_topology

(

const struct ast_channel *

chan

)

Retrieve the topology of streams on a channel.

Parameters

chan	The channel to get the stream topology of

Precondition

chan is locked

Return values

non-NULL	success
NULL	failure

Definition at line 1612 of file channel_internal_api.c.

{
    ast_assert(chan != NULL);
 
    return chan->stream_topology;
}

References ast_assert, NULL, and ast_channel::stream_topology.

Referenced by __ast_read(), ast_bridge_channel_stream_map(), ast_channel_request_stream_topology_change(), AST_TEST_DEFINE(), ast_unreal_indicate(), ast_write_stream(), dial_exec_full(), do_forward(), handle_showchan(), map_source_to_destinations(), native_rtp_bridge_join(), native_rtp_stream_topology_changed(), sfu_topologies_on_join(), sfu_topologies_on_source_change(), simple_bridge_join(), simple_bridge_stream_topology_changed(), softmix_bridge_stream_sources_update(), softmix_bridge_stream_topology_changed(), stream_echo_exec(), stream_echo_write(), and stream_echo_write_error().

ast_channel_get_stream_topology_change_source()

void * ast_channel_get_stream_topology_change_source

(

struct ast_channel *

chan

)

Retrieve the source that initiated the last stream topology change.

Parameters

chan	The channel

Return values

The	channel's stream topology change source

Definition at line 673 of file channel_internal_api.c.

{
    return chan->stream_topology_change_source;
}

References ast_channel::stream_topology_change_source.

Referenced by native_rtp_stream_topology_changed(), and simple_bridge_stream_topology_changed().

ast_channel_get_t38_state()

static enum ast_t38_state ast_channel_get_t38_state ( struct ast_channel *  chan )

inlinestatic

Retrieves the current T38 state of a channel.

Note

Absolutely NO channel locks should be held before calling this function.

Definition at line 2896 of file channel.h.

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

References ast_channel_queryoption(), AST_OPTION_T38_STATE, state, and T38_STATE_UNAVAILABLE.

Referenced by fax_gateway_detect_t38(), fax_gateway_detect_v21(), fax_gateway_framehook(), generic_fax_exec(), receivefax_exec(), receivefax_t38_init(), sendfax_exec(), sendfax_t38_init(), set_fax_t38_caps(), and spandsp_fax_gateway_start().

ast_channel_get_up_time()

int ast_channel_get_up_time

(

struct ast_channel *

chan

)

Obtain how long it has been since the channel was answered.

Since

12

Parameters

chan	The channel object

Return values

0	if the channel isn't answered (or you called this really fast)
The	number of seconds the channel has been up

Definition at line 2864 of file channel.c.

{
    return (ast_channel_get_up_time_ms(chan) / 1000);
}

References ast_channel_get_up_time_ms().

Referenced by action_confbridgelist_item(), chan_pjsip_read_stream(), dahdi_read(), and end_bridge_callback().

ast_channel_get_up_time_ms()

int64_t ast_channel_get_up_time_ms

(

struct ast_channel *

chan

)

Obtain how long it has been since the channel was answered in ms.

Since

13.27.0

16.4.0

Parameters

chan	The channel object

Return values

0	if the channel isn't answered (or you called this really fast)
The	number of milliseconds the channel has been up

Definition at line 2854 of file channel.c.

{
    ast_assert(NULL != chan);
 
    if (ast_tvzero(ast_channel_answertime(chan))) {
        return 0;
    }
    return ast_tvdiff_ms(ast_tvnow(), ast_channel_answertime(chan));
}

References ast_assert, ast_channel_answertime(), ast_tvdiff_ms(), ast_tvnow(), ast_tvzero(), and NULL.

Referenced by ast_channel_get_up_time(), and end_bridge_callback().

ast_channel_get_vars()

struct varshead * ast_channel_get_vars

(

struct ast_channel *

chan

)

Gets the variables for a given channel, as set using pbx_builtin_setvar_helper().

Since

12

The returned variable list is an AO2 object, so ao2_cleanup() to free it.

Parameters

chan	Channel to get variables for

Returns

List of channel variables.

Return values

NULL

on error

Definition at line 7933 of file channel.c.

{
    RAII_VAR(struct varshead *, ret, NULL, ao2_cleanup);
    struct ast_var_t *cv;
 
    ret = ao2_alloc(sizeof(*ret), varshead_dtor);
 
    if (!ret) {
        return NULL;
    }
 
    AST_LIST_TRAVERSE(ast_channel_varshead(chan), cv, entries) {
        struct ast_var_t *var = ast_var_assign(ast_var_name(cv), ast_var_value(cv));
 
        if (!var) {
            return NULL;
        }
 
        AST_LIST_INSERT_TAIL(ret, var, entries);
    }
 
    ao2_ref(ret, +1);
    return ret;
}

References ao2_alloc, ao2_cleanup, ao2_ref, ast_channel_varshead(), AST_LIST_INSERT_TAIL, AST_LIST_TRAVERSE, ast_var_assign, ast_var_name(), ast_var_value(), ast_var_t::entries, NULL, RAII_VAR, var, and varshead_dtor().

ast_channel_hangup_handlers()

struct ast_hangup_handler_list * ast_channel_hangup_handlers

(

struct ast_channel *

chan

)

Definition at line 865 of file channel_internal_api.c.

{
    return &chan->hangup_handlers;
}

References ast_channel::hangup_handlers.

Referenced by ast_pbx_hangup_handler_destroy(), ast_pbx_hangup_handler_init(), ast_pbx_hangup_handler_pop(), ast_pbx_hangup_handler_push(), ast_pbx_hangup_handler_run(), ast_pbx_hangup_handler_show(), and channel_do_masquerade().

ast_channel_hangupcause()

int ast_channel_hangupcause

(

const struct ast_channel *

chan

)

Definition at line 441 of file channel_internal_api.c.

{
    return chan->hangupcause;
}

References ast_channel::hangupcause.

Referenced by ast_cc_call_failed(), ast_channel_softhangup_withcause_locked(), ast_queue_hangup_with_cause(), ast_str_retrieve_variable(), ast_unreal_call_setup(), ast_unreal_hangup(), ast_var_channels_table(), bridge_channel_dissolve_check(), chan_pjsip_hangup(), chan_pjsip_session_end(), channel_set_cause(), channel_snapshot_hangup_create(), dahdi_hangup(), dahdi_indicate(), dial_bridge_after_cb(), dial_exec_full(), iax2_hangup(), jingle_hangup(), monitor_dial(), ooh323_hangup(), pbx_builtin_hangup(), rfc3326_add_reason_header(), session_inv_on_tsx_state_changed(), try_calling(), unistim_hangup(), and wait_for_answer().

ast_channel_hangupcause_hash_set()

void ast_channel_hangupcause_hash_set	(	struct ast_channel *	chan,
		const struct ast_control_pvt_cause_code *	cause_code,
		int	datalen
	)

Sets the HANGUPCAUSE hash and optionally the SIP_CAUSE hash on the given channel.

Parameters

chan	channel on which to set the cause information
cause_code	ast_control_pvt_cause_code structure containing cause information
datalen	total length of the structure since it may vary

Definition at line 4365 of file channel.c.

{
    char causevar[256];
 
    if (ast_channel_dialed_causes_add(chan, cause_code, datalen)) {
        ast_log(LOG_WARNING, "Unable to store hangup cause for %s on %s\n", cause_code->chan_name, ast_channel_name(chan));
    }
 
    if (cause_code->emulate_sip_cause) {
        snprintf(causevar, sizeof(causevar), "HASH(SIP_CAUSE,%s)", cause_code->chan_name);
        ast_func_write(chan, causevar, cause_code->code);
    }
}

References ast_channel_dialed_causes_add(), ast_channel_name(), ast_func_write(), ast_log, ast_control_pvt_cause_code::chan_name, ast_control_pvt_cause_code::code, ast_frame::datalen, ast_control_pvt_cause_code::emulate_sip_cause, and LOG_WARNING.

Referenced by __analog_handle_event(), __ast_request_and_dial(), chan_pjsip_incoming_response_update_cause(), indicate_data_internal(), jingle_action_session_terminate(), and socket_process_helper().

ast_channel_hangupcause_set()

void ast_channel_hangupcause_set	(	struct ast_channel *	chan,
		int	value
	)

Definition at line 445 of file channel_internal_api.c.

{
    chan->hangupcause = value;
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_HANGUP);
}

References AST_CHANNEL_SNAPSHOT_INVALIDATE_HANGUP, ast_channel_snapshot_invalidate_segment(), ast_channel::hangupcause, and value.

Referenced by __ast_read(), __ast_request_and_dial(), __attempt_transmit(), agent_run(), ast_ari_channels_hangup(), ast_channel_softhangup_withcause_locked(), ast_do_pickup(), AST_TEST_DEFINE(), ast_unreal_call_setup(), ast_unreal_hangup(), call_pickup_incoming_request(), channel_set_cause(), console_new(), dahdi_indicate(), dial_exec_full(), disa_exec(), eivr_comm(), handle_call_outgoing(), hangupcalls(), hanguptree(), iax2_call(), indicate_busy(), indicate_congestion(), jingle_indicate(), mbl_queue_hangup(), onCallCleared(), pbx_builtin_hangup(), pbx_start_incoming_request(), receive_dtmf_digits(), refer_incoming_invite_request(), rfc3326_use_reason_header(), ring_entry(), rtp_check_timeout(), session_inv_on_media_update(), set_hangup_source_and_cause(), socket_process_helper(), wait_for_answer(), and wait_for_winner().

ast_channel_hangupsource()

const char * ast_channel_hangupsource

(

const struct ast_channel *

chan

)

Referenced by ast_set_hangupsource(), channel_snapshot_hangup_create(), and func_channel_read().

ast_channel_has_ari_vars()

int ast_channel_has_ari_vars

(

void

)

Return whether or not any ARI variables have been set.

Since

14.2.0

Return values

0	if no ARI variables are expected
1	if ARI variables are expected

Definition at line 7882 of file channel.c.

{
    return channel_has_external_vars(&ari_vars);
}

References ari_vars, and channel_has_external_vars().

ast_channel_has_audio_frame_or_monitor()

int ast_channel_has_audio_frame_or_monitor

(

struct ast_channel *

chan

)

Check if the channel has active audiohooks, active framehooks, or a monitor.

Since

12.0.0

Parameters

chan	The channel to check.

Return values

non-zero

if channel has active audiohooks, framehooks, or monitor.

Definition at line 2537 of file channel.c.

{
    return !ast_audiohook_write_list_empty(ast_channel_audiohooks(chan))
        || !ast_framehook_list_contains_no_active(ast_channel_framehooks(chan));
}

References ast_audiohook_write_list_empty(), ast_channel_audiohooks(), ast_channel_framehooks(), and ast_framehook_list_contains_no_active().

Referenced by native_bridge_is_capable(), optimize_lock_chan_stack(), and optimize_lock_peer_stack().

ast_channel_has_hook_requiring_audio()

int ast_channel_has_hook_requiring_audio

(

struct ast_channel *

chan

)

Check if the channel has any active hooks that require audio.

Since

12.3.0

Parameters

chan	The channel to check.

Return values

non-zero

if channel has active audiohooks, audio framehooks, or monitor.

Definition at line 2543 of file channel.c.

{
    return !ast_audiohook_write_list_empty(ast_channel_audiohooks(chan))
        || !ast_framehook_list_contains_no_active_of_type(ast_channel_framehooks(chan), AST_FRAME_VOICE);
}

References ast_audiohook_write_list_empty(), ast_channel_audiohooks(), ast_channel_framehooks(), AST_FRAME_VOICE, and ast_framehook_list_contains_no_active_of_type().

Referenced by native_rtp_bridge_capable().

ast_channel_has_manager_vars()

int ast_channel_has_manager_vars

(

void

)

Return whether or not any manager variables have been set.

Since

12.4.0

Return values

0	if no manager variables are expected
1	if manager variables are expected

Definition at line 7877 of file channel.c.

{
    return channel_has_external_vars(&ami_vars);
}

References ami_vars, and channel_has_external_vars().

Referenced by ast_channel_publish_varset().

ast_channel_hold_state()

int ast_channel_hold_state

(

const struct ast_channel *

chan

)

Definition at line 491 of file channel_internal_api.c.

{
    return chan->hold_state;
}

References ast_channel::hold_state.

Referenced by ast_parse_device_state(), bridge_channel_internal_join(), channel_do_masquerade(), func_channel_read(), simple_bridge_join(), and softmix_bridge_join().

ast_channel_hold_state_set()

void ast_channel_hold_state_set	(	struct ast_channel *	chan,
		int	value
	)

Definition at line 495 of file channel_internal_api.c.

{
    chan->hold_state = value;
}

References ast_channel::hold_state, and value.

Referenced by __ast_channel_alloc_ap(), __ast_dummy_channel_alloc(), and indicate_data_internal().

ast_channel_inherit_variables()

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

{
    struct ast_var_t *current;
    struct ast_var_t *newvar;
    const char *varname;
    int vartype;
 
    AST_LIST_TRAVERSE(ast_channel_varshead((struct ast_channel *) parent), current, entries) {
        varname = ast_var_full_name(current);
        if (!varname) {
            continue;
        }
 
        vartype = 0;
        if (varname[0] == '_') {
            vartype = 1;
            if (varname[1] == '_') {
                vartype = 2;
            }
        }
 
        switch (vartype) {
        case 1:
            newvar = ast_var_assign(&varname[1], ast_var_value(current));
            break;
        case 2:
            newvar = ast_var_assign(varname, ast_var_value(current));
            break;
        default:
            continue;
        }
        if (newvar) {
            ast_debug(1, "Inheriting variable %s from %s to %s.\n",
                ast_var_full_name(newvar), ast_channel_name(parent),
                ast_channel_name(child));
            AST_LIST_INSERT_TAIL(ast_channel_varshead(child), newvar, entries);
            ast_channel_publish_varset(child, ast_var_full_name(newvar),
                ast_var_value(newvar));
        }
    }
}

References ast_channel_name(), ast_channel_publish_varset(), ast_channel_varshead(), ast_debug, AST_LIST_INSERT_TAIL, AST_LIST_TRAVERSE, ast_var_assign, ast_var_full_name(), ast_var_value(), current, and ast_var_t::entries.

Referenced by __ast_request_and_dial(), ast_ari_channels_dial(), begin_dial_prerun(), call_forward_inherit(), common_recall_channel_setup(), copy_caller_data(), dial_exec_full(), do_forward(), findmeexec(), park_local_transfer(), ring_entry(), and wait_for_answer().

ast_channel_insmpl()

unsigned long ast_channel_insmpl

(

const struct ast_channel *

chan

)

Definition at line 539 of file channel_internal_api.c.

{
    return chan->insmpl;
}

References ast_channel::insmpl.

ast_channel_insmpl_set()

void ast_channel_insmpl_set	(	struct ast_channel *	chan,
		unsigned long	value
	)

Definition at line 543 of file channel_internal_api.c.

{
    chan->insmpl = value;
}

References ast_channel::insmpl, and value.

ast_channel_internal_alert_flush()

ast_alert_status_t ast_channel_internal_alert_flush

(

struct ast_channel *

chan

)

Definition at line 1116 of file channel_internal_api.c.

{
    return ast_alertpipe_flush(chan->alertpipe);
}

References ast_channel::alertpipe, and ast_alertpipe_flush().

Referenced by chan_cleanup().

ast_channel_internal_alert_read()

ast_alert_status_t ast_channel_internal_alert_read

(

struct ast_channel *

chan

)

Definition at line 1121 of file channel_internal_api.c.

{
    return ast_alertpipe_read(chan->alertpipe);
}

References ast_channel::alertpipe, and ast_alertpipe_read().

Referenced by __ast_queue_frame(), and __ast_read().

ast_channel_internal_alert_readable()

int ast_channel_internal_alert_readable

(

struct ast_channel *

chan

)

Definition at line 1131 of file channel_internal_api.c.

{
    return ast_alertpipe_readable(chan->alertpipe);
}

References ast_channel::alertpipe, and ast_alertpipe_readable().

ast_channel_internal_alert_readfd()

int ast_channel_internal_alert_readfd

(

struct ast_channel *

chan

)

Definition at line 1151 of file channel_internal_api.c.

{
    return ast_alertpipe_readfd(chan->alertpipe);
}

References ast_channel::alertpipe, and ast_alertpipe_readfd().

Referenced by __ast_channel_alloc_ap().

ast_channel_internal_alertpipe_clear()

void ast_channel_internal_alertpipe_clear

(

struct ast_channel *

chan

)

Definition at line 1136 of file channel_internal_api.c.

{
    ast_alertpipe_clear(chan->alertpipe);
}

References ast_channel::alertpipe, and ast_alertpipe_clear().

Referenced by __ast_channel_alloc_ap(), and __ast_dummy_channel_alloc().

ast_channel_internal_alertpipe_close()

void ast_channel_internal_alertpipe_close

(

struct ast_channel *

chan

)

Definition at line 1141 of file channel_internal_api.c.

{
    ast_alertpipe_close(chan->alertpipe);
}

References ast_channel::alertpipe, and ast_alertpipe_close().

Referenced by ast_channel_destructor().

ast_channel_internal_alertpipe_init()

int ast_channel_internal_alertpipe_init

(

struct ast_channel *

chan

)

Definition at line 1146 of file channel_internal_api.c.

{
    return ast_alertpipe_init(chan->alertpipe);
}

References ast_channel::alertpipe, and ast_alertpipe_init().

Referenced by __ast_channel_alloc_ap().

ast_channel_internal_alertpipe_swap()

void ast_channel_internal_alertpipe_swap	(	struct ast_channel *	chan1,
		struct ast_channel *	chan2
	)

Swap the interal alertpipe between two channels.

Note

Handle all of the necessary locking before calling this

Definition at line 1156 of file channel_internal_api.c.

{
    ast_alertpipe_swap(chan1->alertpipe, chan2->alertpipe);
}

References ast_channel::alertpipe, and ast_alertpipe_swap().

Referenced by channel_do_masquerade().

ast_channel_internal_bridge()

struct ast_bridge * ast_channel_internal_bridge

(

const struct ast_channel *

chan

)

Definition at line 1241 of file channel_internal_api.c.

{
    return chan->bridge;
}

References ast_channel::bridge.

Referenced by ast_channel_get_bridge(), ast_channel_is_bridged(), ast_unreal_fixup(), bridge_channel_internal_join(), and try_merge_optimize_out().

ast_channel_internal_bridge_channel()

struct ast_bridge_channel * ast_channel_internal_bridge_channel

(

const struct ast_channel *

chan

)

Definition at line 1252 of file channel_internal_api.c.

{
    return chan->bridge_channel;
}

References ast_channel::bridge_channel, and ast_bridge_channel::chan.

Referenced by ast_bridge_depart(), ast_bridge_unreal_optimize_out(), ast_channel_get_bridge_channel(), bridge_channel_depart(), optimize_lock_chan_stack(), optimize_lock_peer_stack(), and stasis_app_exec().

ast_channel_internal_bridge_channel_set()

void ast_channel_internal_bridge_channel_set	(	struct ast_channel *	chan,
		struct ast_bridge_channel *	value
	)

Definition at line 1256 of file channel_internal_api.c.

{
    chan->bridge_channel = value;
}

References ast_channel::bridge_channel, ast_bridge_channel::chan, and value.

Referenced by ast_bridge_depart(), ast_bridge_join(), bridge_channel_ind_thread(), and bridge_impart_internal().

ast_channel_internal_bridge_set()

void ast_channel_internal_bridge_set	(	struct ast_channel *	chan,
		struct ast_bridge *	value
	)

Precondition

chan is locked

Definition at line 1245 of file channel_internal_api.c.

{
    chan->bridge = value;
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_BRIDGE);
    ast_channel_publish_snapshot(chan);
}

References ast_channel_publish_snapshot(), AST_CHANNEL_SNAPSHOT_INVALIDATE_BRIDGE, ast_channel_snapshot_invalidate_segment(), ast_channel::bridge, and value.

Referenced by bridge_channel_change_bridge(), and bridge_channel_internal_join().

ast_channel_internal_bridged_channel()

struct ast_channel * ast_channel_internal_bridged_channel

(

const struct ast_channel *

chan

)

ast_channel_internal_bridged_channel_set()

void ast_channel_internal_bridged_channel_set	(	struct ast_channel *	chan,
		struct ast_channel *	value
	)

ast_channel_internal_copy_linkedid()

void ast_channel_internal_copy_linkedid	(	struct ast_channel *	dest,
		struct ast_channel *	source
	)

Copy the full linkedid channel id structure from one channel to another.

Parameters

dest	Destination to copy linkedid to
source	Source channel to copy linkedid from

Definition at line 1433 of file channel_internal_api.c.

{
    if (dest->linkedid.creation_time == source->linkedid.creation_time
        && dest->linkedid.creation_unique == source->linkedid.creation_unique
        && !strcmp(dest->linkedid.unique_id, source->linkedid.unique_id)) {
        return;
    }
    dest->linkedid = source->linkedid;
    ast_channel_snapshot_invalidate_segment(dest, AST_CHANNEL_SNAPSHOT_INVALIDATE_PEER);
    ast_channel_publish_snapshot(dest);
}

References ast_channel_publish_snapshot(), AST_CHANNEL_SNAPSHOT_INVALIDATE_PEER, ast_channel_snapshot_invalidate_segment(), ast_channel_id::creation_time, ast_channel_id::creation_unique, ast_channel::linkedid, and ast_channel_id::unique_id.

Referenced by ast_bridge_channel_update_linkedids().

ast_channel_internal_fd_clear()

void ast_channel_internal_fd_clear	(	struct ast_channel *	chan,
		int	which
	)

Definition at line 1175 of file channel_internal_api.c.

{
    if (which >= AST_VECTOR_SIZE(&chan->fds)) {
        return;
    }
 
    AST_VECTOR_REPLACE(&chan->fds, which, -1);
}

References AST_VECTOR_REPLACE, AST_VECTOR_SIZE, and ast_channel::fds.

Referenced by handle_negotiated_sdp().

ast_channel_internal_fd_clear_all()

void ast_channel_internal_fd_clear_all

(

struct ast_channel *

chan

)

Definition at line 1183 of file channel_internal_api.c.

{
    AST_VECTOR_RESET(&chan->fds, AST_VECTOR_ELEM_CLEANUP_NOOP);
}

References AST_VECTOR_ELEM_CLEANUP_NOOP, AST_VECTOR_RESET, and ast_channel::fds.

Referenced by __ast_channel_alloc_ap(), __ast_dummy_channel_alloc(), and channel_do_masquerade().

ast_channel_internal_fd_set()

void ast_channel_internal_fd_set	(	struct ast_channel *	chan,
		int	which,
		int	value
	)

Definition at line 1162 of file channel_internal_api.c.

{
    int pos;
 
    /* This ensures that if the vector has to grow with unused positions they will be
     * initialized to -1.
     */
    for (pos = AST_VECTOR_SIZE(&chan->fds); pos < which; pos++) {
        AST_VECTOR_REPLACE(&chan->fds, pos, -1);
    }
 
    AST_VECTOR_REPLACE(&chan->fds, which, value);
}

References AST_VECTOR_REPLACE, AST_VECTOR_SIZE, ast_channel::fds, and value.

Referenced by ast_channel_set_fd(), handle_negotiated_sdp(), start_rtp(), swap_subs(), and unistim_new().

ast_channel_internal_oldest_linkedid()

struct ast_channel * ast_channel_internal_oldest_linkedid	(	struct ast_channel *	a,
		struct ast_channel *	b
	)

Determine which channel has an older linkedid.

Parameters

a	First channel
b	Second channel

Returns

Returns an ast_channel structure that has oldest linkedid

Definition at line 1416 of file channel_internal_api.c.

{
    ast_assert(a->linkedid.creation_time != 0);
    ast_assert(b->linkedid.creation_time != 0);
 
    if (a->linkedid.creation_time < b->linkedid.creation_time) {
        return a;
    }
    if (b->linkedid.creation_time < a->linkedid.creation_time) {
        return b;
    }
    if (a->linkedid.creation_unique < b->linkedid.creation_unique) {
        return a;
    }
    return b;
}

References a, ast_assert, and b.

Referenced by ast_bridge_channel_update_linkedids().

ast_channel_internal_set_fake_ids()

void ast_channel_internal_set_fake_ids	(	struct ast_channel *	chan,
		const char *	uniqueid,
		const char *	linkedid
	)

Set uniqueid and linkedid string value only (not time)

Parameters

chan	The channel to set the uniqueid to
uniqueid	The uniqueid to set
linkedid	The linkedid to set

Note

This is used only by ast_cel_fabricate_channel_from_event() to create a temporary fake channel - time values are invalid

Definition at line 1494 of file channel_internal_api.c.

{
    ast_copy_string(chan->uniqueid.unique_id, uniqueid, sizeof(chan->uniqueid.unique_id));
    ast_copy_string(chan->linkedid.unique_id, linkedid, sizeof(chan->linkedid.unique_id));
}

References ast_copy_string(), ast_channel::linkedid, ast_channel_id::unique_id, and ast_channel::uniqueid.

Referenced by ast_cel_fabricate_channel_from_event().

ast_channel_internal_swap_endpoint_forward()

void ast_channel_internal_swap_endpoint_forward	(	struct ast_channel *	a,
		struct ast_channel *	b
	)

Swap endpoint_forward between two channels.

Parameters

a	First channel
b	Second channel

Note

This is used in masquerade to exchange endpoint details if one of the two or both the channels were created with endpoint

Definition at line 1476 of file channel_internal_api.c.

{
    struct stasis_forward *temp;
 
    temp = a->endpoint_forward;
    a->endpoint_forward = b->endpoint_forward;
    b->endpoint_forward = temp;
}

References a, and b.

Referenced by channel_do_masquerade().

ast_channel_internal_swap_snapshots()

void ast_channel_internal_swap_snapshots	(	struct ast_channel *	a,
		struct ast_channel *	b
	)

Swap snapshots beteween two channels.

Parameters

a	First channel
b	Second channel

Note

This is used in masquerade to exchange snapshots

Definition at line 1485 of file channel_internal_api.c.

{
    struct ast_channel_snapshot *snapshot;
 
    snapshot = a->snapshot;
    a->snapshot = b->snapshot;
    b->snapshot = snapshot;
}

References a, and b.

Referenced by channel_do_masquerade().

ast_channel_internal_swap_topics()

void ast_channel_internal_swap_topics	(	struct ast_channel *	a,
		struct ast_channel *	b
	)

Swap topics beteween two channels.

Parameters

a	First channel
b	Second channel

Note

This is used in masquerade to exchange topics for message routing

Definition at line 1462 of file channel_internal_api.c.

{
    struct stasis_topic *topic;
    struct stasis_forward *forward;
 
    topic = a->topic;
    a->topic = b->topic;
    b->topic = topic;
 
    forward = a->channel_forward;
    a->channel_forward = b->channel_forward;
    b->channel_forward = forward;
}

References a, and b.

Referenced by channel_do_masquerade().

ast_channel_internal_swap_uniqueid_and_linkedid()

void ast_channel_internal_swap_uniqueid_and_linkedid	(	struct ast_channel *	a,
		struct ast_channel *	b
	)

Swap uniqueid and linkedid beteween two channels.

Parameters

a	First channel
b	Second channel

Note

This is used in masquerade to exchange identities

Definition at line 1445 of file channel_internal_api.c.

{
    struct ast_channel_id temp;
 
    /* This operation is used as part of masquerading and so does not invalidate the peer
     * segment. This is due to the masquerade process invalidating all segments.
     */
 
    temp = a->uniqueid;
    a->uniqueid = b->uniqueid;
    b->uniqueid = temp;
 
    temp = a->linkedid;
    a->linkedid = b->linkedid;
    b->linkedid = temp;
}

References a, and b.

Referenced by channel_do_masquerade().

ast_channel_is_bridged()

int ast_channel_is_bridged

(

const struct ast_channel *

chan

)

Determine if a channel is in a bridge.

Since

12.0.0

Parameters

chan	The channel to test

Note

This function expects the channel to be locked prior to being called and will not grab the channel lock.

Return values

0	The channel is not bridged
non-zero	The channel is bridged

Definition at line 10567 of file channel.c.

{
    return ast_channel_internal_bridge(chan) != NULL;
}

References ast_channel_internal_bridge(), and NULL.

Referenced by __ast_read(), action_redirect(), app_control_dial(), ast_async_goto(), ast_audiohook_attach(), ast_audiohook_remove(), ast_framehook_attach(), ast_framehook_detach(), ast_framehook_list_fixup(), ast_var_channel_bridge(), attach_barge(), audio_audiohook_write_list(), chan_pjsip_read_stream(), chan_pjsip_set_rtp_peer(), common_exec(), dtmf_audiohook_write_list(), mixmonitor_autochan_is_bridged(), set_caps(), set_timeout(), wait_for_bridged(), and wait_for_unbridged().

ast_channel_is_leaving_bridge()

int ast_channel_is_leaving_bridge

(

struct ast_channel *

chan

)

Determine if a channel is leaving a bridge, but not hung up.

Since

12.4.0

Parameters

chan	The channel to test

Note

If a channel is hung up, it is implicitly leaving any bridge it may be in. This function is used to test if a channel is leaving a bridge but may survive the experience, if it has a place to go to (dialplan or otherwise)

Return values

0	The channel is not leaving the bridge or is hung up
non-zero	The channel is leaving the bridge

Definition at line 10572 of file channel.c.

{
    int hangup_flags = ast_channel_softhangup_internal_flag(chan);
    int hangup_test = hangup_flags & AST_SOFTHANGUP_ASYNCGOTO;
    int unbridge = ast_channel_unbridged(chan);
 
    /* This function should only return true if either the unbridged flag or
     * the ASYNCGOTO soft hangup flag is set and when no other soft hangup
     * flags are set. Any other soft hangup flags being set should make it
     * return false.
     */
    return ((hangup_test || unbridge) && (hangup_test == hangup_flags));
}

References ast_channel_softhangup_internal_flag(), ast_channel_unbridged(), and AST_SOFTHANGUP_ASYNCGOTO.

Referenced by ast_indicate_data(), and bridge_channel_internal_pull().

ast_channel_is_multistream()

int ast_channel_is_multistream

(

struct ast_channel *

chan

)

Determine if a channel is multi-stream capable.

Parameters

chan	The channel to test

Precondition

chan is locked

Return values

true	if the channel is multi-stream capable.

Definition at line 1672 of file channel_internal_api.c.

{
    return (chan && chan->tech && chan->tech->read_stream && chan->tech->write_stream);
}

References ast_channel_tech::read_stream, ast_channel::tech, and ast_channel_tech::write_stream.

Referenced by ast_channel_nativeformats_set(), ast_channel_request_stream_topology_change(), ast_channel_set_stream_topology(), ast_channel_stream_topology_changed(), ast_channel_stream_topology_changed_externally(), ast_unreal_indicate(), ast_unreal_new_channels(), bridge_channel_write_frame(), bridge_handle_trip(), and stream_echo_write().

ast_channel_is_t38_active()

int ast_channel_is_t38_active

(

struct ast_channel *

chan

)

This function will check if T.38 is active on the channel.

Parameters

chan	Channel on which to check the unbridge_eval flag

Returns

Returns 0 if the flag is down or 1 if the flag is up.

Definition at line 1047 of file channel_internal_api.c.

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

References ast_channel_is_t38_active_nolock(), ast_channel_lock, and ast_channel_unlock.

Referenced by bridge_channel_internal_join().

ast_channel_is_t38_active_nolock()

int ast_channel_is_t38_active_nolock

(

struct ast_channel *

chan

)

ast_channel_is_t38_active variant. Use this if the channel is already locked prior to calling.

Parameters

chan	Channel on which to check the is_t38_active flag

Returns

Returns 0 if the flag is down or 1 if the flag is up.

Definition at line 1042 of file channel_internal_api.c.

{
    return chan->is_t38_active;
}

References ast_channel::is_t38_active.

Referenced by ast_channel_is_t38_active().

ast_channel_iterator_all_new()

struct ast_channel_iterator * ast_channel_iterator_all_new

(

void

)

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.

Note

You must call ast_channel_iterator_destroy() when done.

Return values

NULL	on failure
a	new channel iterator

Since

1.8

Definition at line 1427 of file channel.c.

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

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

Referenced by action_status(), ast_manager_hangup_helper(), ast_var_channel_bridge(), ast_var_channel_types_table(), ast_var_channels_table(), common_exec(), func_channels_read(), handle_show_hangup_all(), and handle_softhangup().

ast_channel_iterator_by_exten_new()

struct ast_channel_iterator * ast_channel_iterator_by_exten_new	(	const char *	exten,
		const char *	context
	)

Create a new channel iterator based on extension.

Parameters

exten	The extension that channels must be in
context	The context that channels must be in

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.

Note

You must call ast_channel_iterator_destroy() when done.

Return values

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

Since

1.8

Definition at line 1387 of file channel.c.

{
    struct ast_channel_iterator *i;
    char *l_exten = (char *) exten;
    char *l_context = (char *) context;
 
    if (!(i = ast_calloc(1, sizeof(*i)))) {
        return NULL;
    }
 
    i->active_iterator = (void *) ast_channel_callback(ast_channel_by_exten_cb,
        l_context, l_exten, OBJ_MULTIPLE);
    if (!i->active_iterator) {
        ast_free(i);
        return NULL;
    }
 
    return i;
}

References ast_channel_iterator::active_iterator, ast_calloc, ast_channel_by_exten_cb(), ast_channel_callback(), ast_free, voicemailpwcheck::context, NULL, and OBJ_MULTIPLE.

Referenced by common_exec(), and pickup_by_exten().

ast_channel_iterator_by_name_new()

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.

Parameters

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.

Note

You must call ast_channel_iterator_destroy() when done.

Return values

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

Since

1.8

Definition at line 1407 of file channel.c.

{
    struct ast_channel_iterator *i;
    char *l_name = (char *) name;
 
    if (!(i = ast_calloc(1, sizeof(*i)))) {
        return NULL;
    }
 
    i->active_iterator = (void *) ast_channel_callback(ast_channel_by_name_cb,
        l_name, &name_len,
        OBJ_MULTIPLE | (name_len == 0 /* match the whole word, so optimize */ ? OBJ_KEY : 0));
    if (!i->active_iterator) {
        ast_free(i);
        return NULL;
    }
 
    return i;
}

References ast_channel_iterator::active_iterator, ast_calloc, ast_channel_by_name_cb(), ast_channel_callback(), ast_free, name, NULL, OBJ_KEY, and OBJ_MULTIPLE.

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

ast_channel_iterator_destroy()

struct ast_channel_iterator * ast_channel_iterator_destroy

(

struct ast_channel_iterator *

i

)

Destroy a channel iterator.

Parameters

i	the itereator to destroy

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

Return values

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

Since

1.8

Definition at line 1379 of file channel.c.

{
    ao2_iterator_destroy(i->active_iterator);
    ast_free(i);
 
    return NULL;
}

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

Referenced by action_status(), ast_manager_hangup_helper(), ast_var_channel_bridge(), ast_var_channel_types_table(), ast_var_channels_table(), common_exec(), func_channels_read(), get_device_state_causing_channels(), handle_show_hangup_all(), handle_softhangup(), pickup_by_exten(), and softhangup_exec().

ast_channel_iterator_next()

struct ast_channel * ast_channel_iterator_next

(

struct ast_channel_iterator *

i

)

Get the next channel for a channel iterator.

Parameters

i	the channel iterator that was created using one of the channel_iterator_xxx_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.8

Definition at line 1441 of file channel.c.

{
    return ao2_iterator_next(i->active_iterator);
}

References ast_channel_iterator::active_iterator, and ao2_iterator_next.

Referenced by action_status(), ast_manager_hangup_helper(), ast_var_channel_bridge(), ast_var_channel_types_table(), ast_var_channels_table(), func_channels_read(), get_device_state_causing_channels(), handle_show_hangup_all(), handle_softhangup(), next_channel(), pickup_by_exten(), and softhangup_exec().

ast_channel_jb()

struct ast_jb * ast_channel_jb

(

struct ast_channel *

chan

)

Definition at line 885 of file channel_internal_api.c.

{
    return &chan->jb;
}

References ast_channel::jb.

Referenced by ast_jb_configure(), ast_jb_destroy(), ast_jb_do_usecheck(), ast_jb_empty_and_reset(), ast_jb_enable_for_channel(), ast_jb_get_and_deliver(), ast_jb_get_config(), ast_jb_get_when_to_wakeup(), ast_jb_put(), create_jb(), jb_choose_impl(), and jb_get_and_deliver().

ast_channel_jb_set()

void ast_channel_jb_set	(	struct ast_channel *	chan,
		struct ast_jb *	value
	)

Definition at line 941 of file channel_internal_api.c.

{
    chan->jb = *value;
}

References ast_channel::jb, and value.

ast_channel_language()

const char * ast_channel_language

(

const struct ast_channel *

chan

)

Examples

app_skel.c.

Referenced by __analog_ss_thread(), acf_vm_info(), action_playback_and_continue(), action_toggle_mute_participants(), analog_ss_thread(), announce_to_dial(), announce_user_count(), app_exec(), ast_app_getdata_full(), ast_app_getdata_terminator(), ast_ari_channels_dial(), ast_moh_files_next(), ast_play_and_wait(), ast_say_counted_adjective(), ast_say_counted_noun(), ast_say_date_with_format_gr(), ast_say_number_full_gr(), ast_send_image(), ast_stream_and_wait(), ast_unreal_call_setup(), ast_var_channels_table(), auth_exec(), background_detect_exec(), begin_dial_prerun(), channel_do_masquerade(), channel_snapshot_base_create(), common_exec(), conf_exec(), conf_get_pin(), conf_run(), confbridge_exec(), control_streamfile(), copy_message(), count_exec(), dial_exec_full(), dictate_exec(), do_directory(), eivr_comm(), find_conf_realtime(), findmeexec(), forward_message(), func_channel_read(), gen_nextfile(), get_folder(), get_folder2(), get_folder_ja(), handle_getoption(), handle_recordfile(), handle_sayalpha(), handle_saydate(), handle_saydatetime(), handle_saydigits(), handle_saynumber(), handle_sayphonetic(), handle_saytime(), handle_showchan(), handle_speechrecognize(), handle_streamfile(), iax2_call(), invent_message(), isAnsweringMachine(), leave_voicemail(), limits_interval_playback(), meetme_menu_admin(), meetme_menu_admin_extended(), meetme_menu_normal(), minivm_greet_exec(), page_exec(), pbx_builtin_background(), pbx_builtin_saycharacters(), pbx_builtin_saycharacters_case(), pbx_builtin_saydigits(), pbx_builtin_saymoney(), pbx_builtin_saynumber(), pbx_builtin_sayordinal(), pbx_builtin_sayphonetic(), play_and_wait(), play_file(), play_mailbox_owner(), play_message(), play_message_callerid(), play_message_datetime(), play_message_duration(), play_record_review(), playback_common(), playback_exec(), privacy_exec(), readexten_exec(), record_exec(), retrydial_exec(), say_parking_space(), say_position(), sayfile_exec(), sayunixtime_exec(), select_item_menu(), serialize_showchan(), setup_env(), setup_privacy_args(), speech_background(), try_calling(), vm_authenticate(), vm_browse_messages(), vm_execmain(), vm_instructions(), vm_intro(), vm_intro_cs(), vm_intro_da(), vm_intro_de(), vm_intro_en(), vm_intro_es(), vm_intro_fr(), vm_intro_gr(), vm_intro_he(), vm_intro_is(), vm_intro_it(), vm_intro_ja(), vm_intro_multilang(), vm_intro_nl(), vm_intro_no(), vm_intro_pl(), vm_intro_pt(), vm_intro_pt_BR(), vm_intro_se(), vm_intro_vi(), vm_intro_zh(), vm_play_folder_name(), vmsayname_exec(), and wait_for_winner().

ast_channel_lastcontext()

const char * ast_channel_lastcontext

(

const struct ast_channel *

chan

)

Definition at line 362 of file channel_internal_api.c.

{
    return chan->lastcontext;
}

References ast_channel::lastcontext.

Referenced by func_channel_read().

ast_channel_lastexten()

const char * ast_channel_lastexten

(

const struct ast_channel *

chan

)

Definition at line 379 of file channel_internal_api.c.

{
    return chan->lastexten;
}

References ast_channel::lastexten.

Referenced by func_channel_read().

ast_channel_latest_musicclass()

const char * ast_channel_latest_musicclass

(

const struct ast_channel *

chan

)

Referenced by ast_bridge_channel_playfile(), channel_do_masquerade(), and limits_interval_playback().

ast_channel_linkedid()

const char * ast_channel_linkedid

(

const struct ast_channel *

chan

)

Definition at line 310 of file channel_internal_api.c.

{
    ast_assert(chan->linkedid.unique_id[0] != '\0');
    return chan->linkedid.unique_id;
}

References ast_assert, ast_channel::linkedid, and ast_channel_id::unique_id.

Referenced by ast_channel_log(), AST_TEST_DEFINE(), channel_snapshot_peer_create(), func_channel_read(), func_mchan_read(), func_mchan_write(), handle_showchan(), and serialize_showchan().

ast_channel_make_compatible()

int ast_channel_make_compatible	(	struct ast_channel *	chan,
		struct ast_channel *	peer
	)

Make the frame formats of two channels compatible.

Parameters

chan	First channel to make compatible. Should be the calling party.
peer	Other channel to make compatible. Should be the called party.

Note

Absolutely NO channel locks should be held before calling this function.

Set two channels to compatible frame formats in both directions. The path from peer to chan is made compatible first to allow for in-band audio in case the other direction cannot be made compatible.

Return values

0	on success.
-1	on error.

Definition at line 6739 of file channel.c.

{
    /*
     * Set up translation from the peer to the chan first in case we
     * need to hear any in-band tones and the other direction fails.
     */
    if (ast_channel_make_compatible_helper(peer, chan)) {
        return -1;
    }
 
    /* Set up translation from the chan to the peer */
    if (ast_channel_make_compatible_helper(chan, peer)) {
        return -1;
    }
 
    return 0;
}

References ast_channel_make_compatible_helper().

Referenced by app_exec(), dial_exec_full(), do_forward(), fax_detect_framehook(), fax_gateway_framehook(), native_bridge_join(), simple_bridge_join(), try_calling(), and wait_for_answer().

ast_channel_masq()

struct ast_channel * ast_channel_masq

(

const struct ast_channel *

chan

)

Definition at line 606 of file channel_internal_api.c.

{
    return chan->masq;
}

References ast_channel::masq.

Referenced by ast_can_pickup(), ast_channel_log(), ast_hangup(), and ast_var_channels_table().

ast_channel_masq_set()

void ast_channel_masq_set	(	struct ast_channel *	chan,
		struct ast_channel *	value
	)

Definition at line 610 of file channel_internal_api.c.

{
    chan->masq = value;
}

References ast_channel::masq, and value.

Referenced by ast_channel_move(), and channel_do_masquerade().

ast_channel_masqr()

struct ast_channel * ast_channel_masqr

(

const struct ast_channel *

chan

)

Definition at line 614 of file channel_internal_api.c.

{
    return chan->masqr;
}

References ast_channel::masqr.

Referenced by ast_channel_log(), ast_hangup(), and ast_var_channels_table().

ast_channel_masqr_set()

void ast_channel_masqr_set	(	struct ast_channel *	chan,
		struct ast_channel *	value
	)

Definition at line 618 of file channel_internal_api.c.

{
    chan->masqr = value;
}

References ast_channel::masqr, and value.

Referenced by ast_channel_move(), and channel_do_masquerade().

ast_channel_move()

int ast_channel_move	(	struct ast_channel *	dest,
		struct ast_channel *	source
	)

Move a channel from its current location to a new location.

Since

12

The intention of this function is to have the destination channel take on the identity of the source channel.

Note

This function is NOT intended to be used on bridged channels. If you wish to move an unbridged channel into the place of a bridged channel, then use ast_bridge_join() or ast_bridge_impart(). If you wish to move a bridged channel into the place of another bridged channel, then use ast_bridge_move().

When this function returns succesfully, the source channel is in a state where its continued use is unreliable.

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

Parameters

dest	The place to move the source channel
source	The channel to move

Return values

0	Success
non-zero	Failure

Definition at line 10688 of file channel.c.

{
    RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
    SCOPED_MUTEX(lock, &channel_move_lock);
 
    if (dest == source) {
        ast_log(LOG_WARNING, "Can't move channel '%s' into itself!\n",
            ast_channel_name(dest));
        return -1;
    }
 
    ast_channel_lock_both(dest, source);
 
    if (ast_test_flag(ast_channel_flags(dest), AST_FLAG_ZOMBIE)
        || ast_test_flag(ast_channel_flags(source), AST_FLAG_ZOMBIE)) {
        /* Zombies! Run! */
        ast_log(LOG_WARNING,
            "Can't move channel. One or both is dead (%s <-- %s)\n",
            ast_channel_name(dest), ast_channel_name(source));
        ast_channel_unlock(source);
        ast_channel_unlock(dest);
        return -1;
    }
 
    ast_channel_masq_set(dest, source);
    ast_channel_masqr_set(source, dest);
 
    blob = ast_json_pack("{s: s}",
            "newchanneluniqueid", ast_channel_uniqueid(dest));
    ast_channel_publish_blob(source, ast_channel_masquerade_type(), blob);
 
    ast_channel_unlock(dest);
    ast_channel_unlock(source);
 
    channel_do_masquerade(dest, source);
    return 0;
}

References ast_channel_flags(), ast_channel_lock_both, ast_channel_masq_set(), ast_channel_masqr_set(), ast_channel_masquerade_type(), ast_channel_name(), ast_channel_publish_blob(), ast_channel_uniqueid(), ast_channel_unlock, AST_FLAG_ZOMBIE, ast_json_pack(), ast_json_unref(), ast_log, ast_test_flag, channel_do_masquerade(), channel_move_lock, lock, LOG_WARNING, NULL, RAII_VAR, and SCOPED_MUTEX.

Referenced by after_bridge_move_channel(), ast_channel_yank(), ast_do_pickup(), local_call(), and refer_incoming_invite_request().

ast_channel_music_state()

void * ast_channel_music_state

(

const struct ast_channel *

chan

)

Definition at line 563 of file channel_internal_api.c.

{
    return chan->music_state;
}

References ast_channel::music_state.

Referenced by __ast_read(), ast_channel_destructor(), ast_moh_files_next(), local_ast_moh_cleanup(), local_ast_moh_start(), local_ast_moh_stop(), moh_alloc(), moh_files_alloc(), moh_files_generator(), moh_files_release(), moh_files_write_format_change(), and moh_release().

ast_channel_music_state_set()

void ast_channel_music_state_set	(	struct ast_channel *	chan,
		void *	value
	)

Definition at line 567 of file channel_internal_api.c.

{
    chan->music_state = value;
}

References ast_channel::music_state, and value.

Referenced by local_ast_moh_cleanup(), moh_alloc(), and moh_files_alloc().

ast_channel_musicclass()

const char * ast_channel_musicclass

(

const struct ast_channel *

chan

)

Referenced by ast_ari_channels_dial(), ast_unreal_call_setup(), ast_var_channels_table(), begin_dial_prerun(), channel_do_masquerade(), conf_start_moh(), dial_exec_full(), findmeexec(), func_channel_read(), local_ast_moh_start(), and monitor_dial().

ast_channel_name()

const char * ast_channel_name

(

const struct ast_channel *

chan

)

Referenced by __adsi_transmit_messages(), __analog_handle_event(), __analog_ss_thread(), __ast_answer(), __ast_change_name_nolink(), __ast_channel_alloc_ap(), __ast_pbx_run(), __ast_play_and_record(), __ast_queue_frame(), __ast_read(), __attempt_transmit(), __dahdi_exception(), __get_from_jb(), __print_debug_details(), _analog_get_index(), _dahdi_get_index(), acf_curl_helper(), acf_faxopt_read(), acf_faxopt_write(), acf_jabberreceive_read(), action_add_agi_cmd(), action_bridge(), action_confbridgesetsinglevideosrc(), action_dahdishowchannels(), action_kick_last(), action_meetmelist(), add_agi_cmd(), adsi_prog(), adsi_search_input(), agent_after_bridge_cb(), agent_after_bridge_cb_failed(), agent_function_read(), agent_handle_show_specific(), agent_request_exec(), agent_run(), agent_show_requested(), agents_sweep(), alarmreceiver_exec(), alloc_playback_chan(), analog_answer(), analog_attempt_transfer(), analog_call(), analog_exception(), analog_fixup(), analog_handle_dtmf(), analog_hangup(), analog_ss_thread(), announce_to_dial(), answer(), aoc_attach_framehook(), aoc_display_decoded_debug(), aoc_framehook(), app_control_redirect(), app_exec(), app_notify(), append_channel_vars(), aqm_exec(), ari_bridges_play_new(), ari_originate_dial(), assign_uuid(), ast_agi_send(), ast_answer(), ast_async_goto(), ast_audiohook_set_mute_all(), ast_audiosocket_connect(), ast_autochan_new_channel(), ast_autochan_setup(), ast_autoservice_start(), ast_autoservice_stop(), ast_bridge_add_channel(), ast_bridge_call_with_flags(), ast_bridge_channel_feature_digit(), ast_bridge_channel_kick(), ast_bridge_channel_leave_bridge_nolock(), ast_bridge_channel_queue_frame(), ast_bridge_channel_restore_formats(), ast_bridge_depart(), ast_bridge_features_ds_set_string(), ast_bridge_impart(), ast_bridge_join(), ast_bridge_remove(), ast_bridge_set_single_src_video_mode(), ast_bridge_transfer_attended(), ast_bridge_transfer_blind(), ast_bridge_update_talker_src_video_mode(), ast_call_forward(), ast_cc_call_init(), ast_cc_offer(), ast_channel_add_bridge_role(), ast_channel_by_name_cb(), ast_channel_callid_set(), ast_channel_clear_bridge_roles(), ast_channel_destructor(), ast_channel_end_dtmf(), ast_channel_get_cc_agent_type(), ast_channel_get_device_name(), ast_channel_hangupcause_hash_set(), ast_channel_hash_cb(), ast_channel_inherit_variables(), ast_channel_log(), ast_channel_make_compatible_helper(), ast_channel_move(), ast_channel_nativeformats_set(), ast_channel_publish_final_snapshot(), ast_channel_publish_snapshot(), ast_channel_publish_varset(), ast_channel_remove_bridge_role(), ast_channel_request_stream_topology_change(), ast_channel_set_stream_topology(), ast_channel_softhangup_withcause_locked(), ast_channel_start_silence_generator(), ast_channel_stop_silence_generator(), ast_channel_yank(), ast_check_hangup(), ast_cli_netstats(), ast_dial_append_channel(), ast_do_pickup(), ast_dsp_process(), ast_get_chan_applicationmap(), ast_hangup(), ast_iax2_new(), ast_jb_destroy(), ast_jb_put(), ast_manager_hangup_helper(), ast_moh_files_next(), ast_pbx_h_exten_run(), ast_pbx_hangup_handler_show(), ast_pbx_outgoing_exten_predial(), ast_pickup_call(), ast_prod(), ast_raw_answer_with_stream_topology(), ast_readaudio_callback(), ast_rtp_instance_early_bridge(), ast_rtp_instance_early_bridge_make_compatible(), ast_senddigit_begin(), ast_senddigit_mf_begin(), ast_sendtext_data(), ast_set_read_format_path(), ast_set_write_format_path(), ast_setstate(), ast_sip_session_get_name(), ast_sip_session_is_pending_stream_default(), ast_sip_session_regenerate_answer(), ast_softhangup_nolock(), ast_stir_shaken_add_result_to_channel(), ast_stir_shaken_as_ctx_create(), ast_stir_shaken_vs_ctx_create(), ast_str_retrieve_variable(), ast_streamfile(), AST_TEST_DEFINE(), ast_unreal_answer(), ast_unreal_fixup(), ast_unreal_hangup(), ast_var_channels_table(), ast_waitfor_nandfds(), ast_write_stream(), async_agi_read_frame(), attach_barge(), attach_framehook(), attempt_transfer(), attended_transfer_bridge(), attended_transfer_properties_alloc(), audiosocket_exec(), audiosocket_run(), background_detect_exec(), begin_dial_channel(), begin_dial_prerun(), blind_transfer_bridge(), bridge_channel_complete_join(), bridge_channel_dtmf_stream(), bridge_channel_feature_digit_add(), bridge_channel_handle_interval(), bridge_channel_handle_write(), bridge_channel_internal_join(), bridge_channel_internal_pull(), bridge_channel_internal_push_full(), bridge_channel_internal_queue_attended_transfer(), bridge_channel_moving(), bridge_channel_park(), bridge_channel_settle_owed_events(), bridge_channel_talking(), bridge_channel_wait(), bridge_do_move(), bridge_exec(), bridge_features_duration_callback(), bridge_impart_internal(), bridge_move_locked(), bridge_parking_push(), bridge_stasis_push(), bridge_stasis_push_peek(), bridge_stasis_run_cb(), bridgeadd_exec(), bridgewait_exec(), bridgewait_timeout_callback(), broadcast_exec(), builtin_features_helper(), calendar_event_read(), calendar_query_result_exec(), call(), cdr_prop_write(), cdr_prop_write_callback(), cdr_read(), cdr_read_callback(), cdr_retrieve_time(), cdr_write(), cdr_write_callback(), chan_pjsip_answer(), chan_pjsip_cng_tone_detected(), chan_pjsip_digit_end(), chan_pjsip_get_codec(), chan_pjsip_hangup(), chan_pjsip_incoming_response_update_cause(), chan_pjsip_indicate(), chan_pjsip_read_stream(), chan_pjsip_request_with_stream_topology(), chan_pjsip_sendtext_data(), chan_pjsip_session_end(), chan_pjsip_set_rtp_peer(), chan_pjsip_write_stream(), chan_rtp_get_codec(), chanavail_exec(), change_priority_caller_on_queue(), channel_cmp(), channel_do_masquerade(), channel_fill_empty_accountcode(), channel_fill_empty_peeraccount(), channel_hash(), channel_read_pjsip(), channel_read_rtcp(), channel_read_rtp(), channel_set_debug(), channel_snapshot_base_create(), channel_spy(), channel_update_peeraccount(), comeback_goto(), common_exec(), complete_bridge_participant(), complete_confbridge_participant(), conf_exec(), conf_play(), conf_queue_dtmf(), conf_run(), conf_send_event_to_participants(), conf_update_user_mute(), confbridge_exec(), confbridge_handle_atxfer(), console_indicate(), control_streamfile(), cpeid_exec(), create_channel_name(), create_jb(), dahdi_call(), dahdi_digit_begin(), dahdi_digit_end(), dahdi_fake_event(), dahdi_fixup(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_hangup(), dahdi_indicate(), dahdi_new(), dahdi_queryoption(), dahdi_read(), dahdi_setoption(), dahdi_show_channel(), dahdi_softhangup_all(), dahdi_write(), deactivate_silence_generator(), defer_action(), defer_incoming_sdp_stream(), detect_callback(), dial_bridge_after_cb(), dial_bridge_after_cb_failed(), dial_exec_full(), dial_masquerade_breakdown(), dial_masquerade_fixup(), dial_transfer(), dial_trunk(), directory_exec(), disa_exec(), disable_t38(), display_parked_call(), do_broadcast(), do_forward(), do_monitor(), do_waiting(), does_id_conflict(), dtmf_mode_refresh_cb(), dtmfstore_exec(), dumpchan_exec(), dundi_lookup_internal(), dynamic_dtmf_hook_trip(), eagi_exec(), enable_jack_hook(), execute_menu_entry(), fast_originate(), fax_detect_framehook(), fax_gateway_detect_t38(), fax_gateway_detect_v21(), fax_gateway_framehook(), fax_gateway_new(), fax_gateway_request_t38(), fax_session_new(), feature_attended_transfer(), feature_automixmonitor(), feature_blind_transfer(), find_by_name(), find_details(), find_or_create_details(), flash_exec(), forkcdr_exec(), forward_message(), func_channel_read(), func_channels_read(), func_confbridge_channels(), func_get_parkingslot_channel(), func_read_header(), func_read_headers(), func_read_param(), func_response_read_header(), func_response_read_headers(), func_write_header(), func_write_param(), fxo_pvt(), generic_fax_exec(), generic_mute_unmute_helper(), generic_mute_unmute_user(), geoloc_profile_read(), geoloc_profile_write(), get_agi_cmd(), gosub_exec(), gosub_run(), grab_transfer(), group_count_function_read(), group_show_channels(), handle_bridge_kick_channel(), handle_call_outgoing(), handle_cli_agi_add_cmd(), handle_cli_confbridge_list_item(), handle_cli_iax2_show_channels(), handle_cli_locks_show(), handle_dump_frames(), handle_frame(), handle_gosub(), handle_incoming_request(), handle_participant_join(), handle_recordfile(), handle_showchan(), handle_softhangup(), handle_streamfile(), hangup(), holding_bridge_join(), hook_callback(), hook_event_cb(), hook_off(), hook_on(), hook_re_enable(), hook_thread_arg_alloc(), iax2_call(), iax2_hangup(), iax2_request(), iax2_transfer(), incoming_in_dialog_request(), increase_call_count(), indicate_connected_line(), indicate_data_internal(), inherit_channel_vars_from_id(), init_jack_data(), is_our_turn(), isAnsweringMachine(), jack_hook_callback(), jingle_action_session_terminate(), jingle_queue_hangup_with_cause(), jingle_read(), join_queue(), kick_conference_participant(), launch_asyncagi(), launch_monitor_thread(), leave_queue(), leave_voicemail(), linear_alloc(), linear_release(), local_ast_moh_start(), locals_show(), log_caps(), log_group_write(), log_jitterstats(), lua_get_state(), lua_pbx_exec(), manager_park(), manager_queues_status(), map_source_to_destinations(), mbl_call(), meetme_menu_admin(), meetme_show_cmd(), meetmemute(), milliwatt_generate(), moh_alloc(), moh_files_generator(), moh_files_release(), moh_generate(), moh_post_start(), moh_post_stop(), moh_release(), my_handle_dtmf(), my_set_cadence(), native_bridge_changed(), native_bridge_compatible(), native_bridge_is_capable(), native_rtp_bridge_compatible_check(), native_rtp_bridge_framehook_attach(), native_rtp_bridge_framehook_detach(), native_rtp_bridge_join(), native_rtp_bridge_leave(), native_rtp_bridge_start(), native_rtp_bridge_stop(), native_rtp_bridge_suspend(), native_rtp_bridge_unsuspend(), native_start(), native_stop(), next_channel(), notify_channel(), old_milliwatt_exec(), on_personality_change_normal(), onModeChanged(), ooh323_answer(), ooh323_call(), ooh323_destroy(), ooh323_get_codec(), ooh323_get_rtp_peer(), ooh323_new(), ooh323_queryoption(), ooh323_rtp_read(), ooh323_set_rtp_peer(), ooh323_write(), page_exec(), park_local_transfer(), parking_park_bridge_channel(), parking_park_call(), participant_idle_mode_setup(), participant_reaction_announcer_join(), pbx_builtin_background(), pbx_builtin_waitexten(), pbx_extension_helper(), pbx_outgoing_exec(), pbx_outgoing_state_callback(), pbx_start_incoming_request(), pickup_by_exten(), pickup_by_group(), pjsip_acf_channel_read(), pjsip_acf_dtmf_mode_read(), pjsip_acf_dtmf_mode_write(), pjsip_acf_session_refresh_write(), pjsip_app_hangup(), pjsip_app_hangup_handler(), play_message(), play_moh_exec(), play_on_channel(), play_record_review(), playback_exec(), playtones_alloc(), pre_bridge_setup(), print_escaped_uri(), print_queue(), prnt_channel_key(), publish_app_cdr_message(), publish_transfer_fail(), publish_transfer_success(), publish_transfer_threeway(), queue_exec(), queue_function_queuegetchannel(), read_mf_digits(), read_pjsip(), read_sf_digits(), readexten_exec(), realtime_exec(), receive_dtmf_digits(), receivefax_exec(), receivefax_t38_init(), record_exec(), refer_attended_task(), refer_blind_callback(), refer_incoming_attended_request(), refer_incoming_blind_request(), refer_incoming_invite_request(), refer_incoming_refer_request(), refer_progress_alloc(), refer_progress_bridge(), refer_progress_framehook(), remove_detect(), remove_dtmf_store(), remove_framehook(), remove_hold_intercept(), remove_scrambler(), remove_talk_detect(), request_withdraw_caller_from_queue(), resetcdr_exec(), revert_fax_buffers(), ring_entry(), rqm_exec(), rtp_check_timeout(), run_agi(), say_number_full(), say_position(), scan_exec(), send_direct_media_request(), send_message(), send_start_msg_snapshots(), sendfax_exec(), sendfax_t38_init(), serialize_showchan(), session_inv_on_media_update(), session_inv_on_tsx_state_changed(), set_bridge_peer_vars_multiparty(), set_fax_t38_caps(), set_format(), set_hangup_source_and_cause(), set_hold_intercept(), set_transfer_variables_all(), setup_env(), setup_privacy_args(), setup_udptl_connection(), sfu_topologies_on_join(), sfu_topologies_on_leave(), sfu_topologies_on_source_change(), simple_bridge_join(), smart_bridge_operation(), sms_generate(), socket_process_helper(), softhangup_exec(), softmix_bridge_join(), softmix_bridge_stream_sources_update(), softmix_bridge_stream_topology_changed(), softmix_bridge_write_text(), softmix_bridge_write_voice(), softmix_mixing_loop(), start_automixmonitor(), start_moh_exec(), start_spying(), start_whispering(), stasis_app_exec(), stop_automixmonitor(), stream_echo_perform(), stream_echo_write_error(), t38_attach_framehook(), t38_automatic_reject(), t38_change_state(), t38_framehook(), t38_initialize_session(), t38_interpret_parameters(), t38_reinvite_response_cb(), talk_detect_audiohook_cb(), testclient_exec(), testserver_exec(), tonepair_alloc(), transfer_exec(), transfer_redirect(), try_calling(), try_merge_optimize_out(), try_swap_optimize_out(), unistim_answer(), unistim_call(), unistim_fixup(), unistim_hangup(), unistim_indicate(), unistim_new(), update_qe_rule(), user_chan_cb(), vm_exec(), vm_execmain(), vm_options(), wait_exec(), wait_for_answer(), wait_for_signal_or_hangup(), wait_for_winner(), waitsignal_exec(), waitstream_control(), waitstream_core(), and xfer_client_on_evsub_state().

ast_channel_name_to_dial_string()

void ast_channel_name_to_dial_string

(

char *

channel_name

)

Removes the trailing identifiers from a channel name string.

Since

12.0.0

Parameters

channel_name

string that you wish to turn into a dial string. This string will be edited in place.

Definition at line 6858 of file channel.c.

{
    char *dash;
 
    /* Truncate after the dash */
    dash = strrchr(channel_name, '-');
    if (dash) {
        *dash = '\0';
    }
}

Referenced by parked_user_set_parker_dial_string(), and setup_park_common_datastore().

ast_channel_named_callgroups()

struct ast_namedgroups * ast_channel_named_callgroups

(

const struct ast_channel *

chan

)

Definition at line 1091 of file channel_internal_api.c.

{
    return chan->named_callgroups;
}

References ast_channel::named_callgroups.

Referenced by find_channel_by_group(), and func_channel_read().

ast_channel_named_callgroups_set()

void ast_channel_named_callgroups_set	(	struct ast_channel *	chan,
		struct ast_namedgroups *	value
	)

Definition at line 1095 of file channel_internal_api.c.

{
    ast_unref_namedgroups(chan->named_callgroups);
    chan->named_callgroups = ast_ref_namedgroups(value);
}

References ast_ref_namedgroups(), ast_unref_namedgroups(), ast_channel::named_callgroups, and value.

Referenced by ast_channel_destructor(), chan_pjsip_new(), dahdi_new(), and func_channel_write_real().

ast_channel_named_pickupgroups()

struct ast_namedgroups * ast_channel_named_pickupgroups

(

const struct ast_channel *

chan

)

Definition at line 1100 of file channel_internal_api.c.

{
    return chan->named_pickupgroups;
}

References ast_channel::named_pickupgroups.

Referenced by find_channel_by_group(), and func_channel_read().

ast_channel_named_pickupgroups_set()

void ast_channel_named_pickupgroups_set	(	struct ast_channel *	chan,
		struct ast_namedgroups *	value
	)

Definition at line 1104 of file channel_internal_api.c.

{
    ast_unref_namedgroups(chan->named_pickupgroups);
    chan->named_pickupgroups = ast_ref_namedgroups(value);
}

References ast_ref_namedgroups(), ast_unref_namedgroups(), ast_channel::named_pickupgroups, and value.

Referenced by ast_channel_destructor(), chan_pjsip_new(), dahdi_new(), and func_channel_write_real().

ast_channel_nativeformats()

struct ast_format_cap * ast_channel_nativeformats

(

const struct ast_channel *

chan

)

Definition at line 638 of file channel_internal_api.c.

{
    return chan->nativeformats;
}

References ast_channel::nativeformats.

Referenced by ast_ari_channels_create(), ast_bridge_update_talker_src_video_mode(), ast_channel_make_compatible_helper(), ast_openvstream(), ast_sendtext_data(), ast_streamfile(), ast_write_stream(), attended_transfer_bridge(), begin_dial_prerun(), blind_transfer_bridge(), chan_pjsip_get_codec(), chan_pjsip_indicate(), chan_pjsip_read_stream(), chan_pjsip_write_stream(), chan_rtp_get_codec(), chanavail_exec(), channel_do_masquerade(), create_addr(), dial_transfer(), findmeexec(), func_channel_read(), generate_status(), handle_showchan(), iax2_call(), iax2_request(), jingle_read(), jingle_write(), mp3_exec(), ooh323_get_codec(), ooh323_rtp_read(), ooh323_set_write_format(), ooh323_write(), park_local_transfer(), ring_entry(), serialize_showchan(), set_caps(), set_format(), sip_session_response_cb(), socket_process_helper(), speech_create(), start_rtp(), test_vm_api_create_mock_channel(), unistim_new(), unistim_rtp_read(), unistim_write(), and wait_for_answer().

ast_channel_nativeformats_set()

void ast_channel_nativeformats_set	(	struct ast_channel *	chan,
		struct ast_format_cap *	value
	)

Definition at line 678 of file channel_internal_api.c.

{
    SCOPE_ENTER(2, "%s: %sFormats: %s\n", S_OR(ast_channel_name(chan), "<initializing>"),
        S_COR(ast_channel_is_multistream(chan), "Multistream", ""),
        ast_str_tmp(128, ast_format_cap_get_names(value, &STR_TMP)));
 
    ast_assert(chan != NULL);
 
    ao2_replace(chan->nativeformats, value);
 
    /* If chan->stream_topology is NULL, the channel is being destroyed
     * and topology is destroyed.
     */
    if (!chan->stream_topology) {
        SCOPE_EXIT_RTN("Channel is being initialized or destroyed\n");
    }
 
    if (!ast_channel_is_multistream(chan) || !value) {
        struct ast_stream_topology *new_topology;
 
        new_topology = ast_stream_topology_create_from_format_cap(value);
        ast_channel_internal_set_stream_topology(chan, new_topology);
        SCOPE_EXIT_RTN("New %stopology set\n", value ? "" : "empty ");
    }
    SCOPE_EXIT_RTN("Set native formats but not topology\n");
}

References ao2_replace, ast_assert, ast_channel_internal_set_stream_topology(), ast_channel_is_multistream(), ast_channel_name(), ast_format_cap_get_names(), ast_str_tmp, ast_stream_topology_create_from_format_cap(), ast_channel::nativeformats, NULL, S_COR, S_OR, SCOPE_ENTER, SCOPE_EXIT_RTN, ast_channel::stream_topology, and value.

Referenced by __ast_channel_alloc_ap(), ast_channel_destructor(), ast_iax2_new(), AST_TEST_DEFINE(), ast_unreal_new_channels(), audiosocket_request(), chan_pjsip_new(), chan_pjsip_read_stream(), channel_do_masquerade(), console_new(), dahdi_new(), do_notify(), handle_exec(), iax2_request(), jingle_interpret_content(), jingle_new(), jingle_read(), make_channel(), mbl_new(), multicast_rtp_request(), ooh323_new(), ooh323_rtp_read(), ooh323_set_read_format(), ooh323_set_write_format(), rec_request(), set_caps(), set_format(), socket_process_helper(), stasis_app_control_snoop(), unicast_rtp_request(), unistim_new(), and unistim_rtp_read().

ast_channel_oldest_linkedid()

const char * ast_channel_oldest_linkedid	(	const char *	a,
		const char *	b
	)

Return the oldest linkedid between two channels.

A channel linkedid is derived from the channel uniqueid which is formed like this: [systemname-]ctime.seq

The systemname, and the dash are optional, followed by the epoch time followed by an integer sequence. Note that this is not a decimal number, since 1.2 is less than 1.11 in uniqueid land.

To compare two uniqueids, we parse out the integer values of the time and the sequence numbers and compare them, with time trumping sequence.

Parameters

a	The linkedid value of the first channel to compare
b	The linkedid value of the second channel to compare

Return values

NULL	on failure
The	oldest linkedid value

Since

12.0.0

ast_channel_oldwriteformat()

struct ast_format * ast_channel_oldwriteformat

(

struct ast_channel *

chan

)

Definition at line 845 of file channel_internal_api.c.

{
    return chan->oldwriteformat;
}

References ast_channel::oldwriteformat.

Referenced by ast_stopstream().

ast_channel_outsmpl()

unsigned long ast_channel_outsmpl

(

const struct ast_channel *

chan

)

Definition at line 547 of file channel_internal_api.c.

{
    return chan->outsmpl;
}

References ast_channel::outsmpl.

ast_channel_outsmpl_set()

void ast_channel_outsmpl_set	(	struct ast_channel *	chan,
		unsigned long	value
	)

Definition at line 551 of file channel_internal_api.c.

{
    chan->outsmpl = value;
}

References ast_channel::outsmpl, and value.

ast_channel_parkinglot()

const char * ast_channel_parkinglot

(

const struct ast_channel *

chan

)

Referenced by ast_unreal_call_setup(), channel_do_masquerade(), find_channel_parking_lot_name(), func_channel_read(), park_local_transfer(), and serialize_showchan().

ast_channel_pbx()

struct ast_pbx * ast_channel_pbx

(

const struct ast_channel *

chan

)

Definition at line 722 of file channel_internal_api.c.

{
    return chan->pbx;
}

References ast_channel::pbx.

Referenced by __analog_handle_event(), __ast_pbx_run(), action_dialplan_exec(), ast_app_dtget(), ast_app_getdata_terminator(), ast_async_goto(), ast_bridge_add_channel(), ast_can_pickup(), ast_channel_destructor(), bridge_impart_internal(), collect_digits(), control_swap_channel_in_bridge(), dahdi_handle_event(), depart_channel(), disa_exec(), handle_getoption(), handle_gosub(), ivr_dispatch(), pbx_builtin_waitexten(), read_exec(), read_newoption(), readexten_exec(), speech_background(), stasis_app_exec(), timeout_read(), and timeout_write().

ast_channel_pbx_set()

void ast_channel_pbx_set	(	struct ast_channel *	chan,
		struct ast_pbx *	value
	)

Definition at line 726 of file channel_internal_api.c.

{
    chan->pbx = value;
}

References ast_channel::pbx, and value.

Referenced by __ast_pbx_run(), action_dialplan_exec(), control_swap_channel_in_bridge(), handle_gosub(), and internal_bridge_after_cb().

ast_channel_peeraccount()

const char * ast_channel_peeraccount

(

const struct ast_channel *

chan

)

Referenced by ast_unreal_call_setup(), channel_fill_empty_accountcode(), channel_fill_empty_peeraccount(), channel_req_accountcodes(), channel_snapshot_peer_create(), channel_update_peeraccount(), and func_channel_read().

ast_channel_pickupgroup()

ast_group_t ast_channel_pickupgroup

(

const struct ast_channel *

chan

)

Definition at line 1083 of file channel_internal_api.c.

{
    return chan->pickupgroup;
}

References ast_channel::pickupgroup.

Referenced by ast_var_channels_table(), find_channel_by_group(), func_channel_read(), generate_status(), handle_showchan(), and serialize_showchan().

ast_channel_pickupgroup_set()

void ast_channel_pickupgroup_set	(	struct ast_channel *	chan,
		ast_group_t	value
	)

Precondition

chan is locked

Definition at line 1087 of file channel_internal_api.c.

{
    chan->pickupgroup = value;
}

References ast_channel::pickupgroup, and value.

Referenced by chan_pjsip_new(), dahdi_new(), func_channel_write_real(), jingle_new(), and unistim_new().

ast_channel_priority()

int ast_channel_priority

(

const struct ast_channel *

chan

)

Definition at line 450 of file channel_internal_api.c.

{
    return chan->priority;
}

References ast_channel::priority.

Referenced by __ast_pbx_run(), _while_exec(), action_bridge(), action_dialplan_exec(), ast_bridge_setup_after_goto(), ast_channel_log(), ast_channel_yank(), ast_pbx_h_exten_run(), ast_str_retrieve_variable(), ast_var_channels_table(), bridge_exec(), channel_snapshot_dialplan_create(), dial_exec_full(), feature_blind_transfer(), find_matching_endif(), find_matching_endwhile(), forward_message(), func_channel_write_real(), gosub_exec(), gosub_run(), handle_gosub(), handle_showchan(), if_helper(), launch_monitor_thread(), leave_voicemail(), log_exec(), lua_pbx_exec(), make_email_file(), pbx_builtin_goto(), pbx_builtin_setvar_multiple(), pbx_builtin_waitexten(), pbx_parseable_goto(), raise_exception(), realtime_exec(), serialize_showchan(), setup_env(), and setup_peer_after_bridge_goto().

ast_channel_priority_set()

void ast_channel_priority_set	(	struct ast_channel *	chan,
		int	value
	)

Definition at line 454 of file channel_internal_api.c.

{
    chan->priority = value;
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN);
}

References AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN, ast_channel_snapshot_invalidate_segment(), ast_channel::priority, and value.

Referenced by __ast_channel_alloc_ap(), __ast_pbx_run(), __ast_request_and_dial(), _while_exec(), action_dialplan_exec(), ari_originate_dial(), ast_bridge_setup_after_goto(), ast_channel_yank(), ast_explicit_goto(), ast_pbx_h_exten_run(), AST_TEST_DEFINE(), chan_pjsip_new(), dial_exec_full(), dialout(), do_notify(), forward_message(), generic_recall(), gosub_exec(), gosub_run(), handle_gosub(), if_helper(), jingle_new(), leave_voicemail(), minivm_greet_exec(), ooh323_new(), pbx_builtin_background(), pbx_extension_helper(), pbx_outgoing_exec(), return_exec(), set_ext_pri(), and unistim_new().

ast_channel_queryoption()

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

{
    int res;
 
    ast_channel_lock(chan);
    if (!ast_channel_tech(chan)->queryoption) {
        errno = ENOSYS;
        ast_channel_unlock(chan);
        return -1;
    }
 
    if (block)
        ast_log(LOG_ERROR, "XXX Blocking not implemented yet XXX\n");
 
    res = ast_channel_tech(chan)->queryoption(chan, option, data, datalen);
    ast_channel_unlock(chan);
 
    return res;
}

References ast_channel_lock, ast_channel_tech(), ast_channel_unlock, ast_log, ast_datastore::data, errno, LOG_ERROR, and ast_channel_tech::queryoption.

Referenced by ast_channel_get_cc_agent_type(), ast_channel_get_device_name(), ast_channel_get_t38_state(), ast_unreal_queryoption(), and func_channel_read().

ast_channel_queue_connected_line_update()

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

Queue a connected line update frame on a channel.

Since

1.8

Parameters

chan	Asterisk channel to indicate connected line information
connected	Connected line information
update	What connected line information to update. NULL if all.

Definition at line 9128 of file channel.c.

{
    unsigned char data[1024];   /* This should be large enough */
    size_t datalen;
 
    datalen = ast_connected_line_build_data(data, sizeof(data), connected, update);
    if (datalen == (size_t) -1) {
        return;
    }
 
    ast_queue_control_data(chan, AST_CONTROL_CONNECTED_LINE, data, datalen);
}

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

Referenced by after_bridge_move_channel(), ast_do_pickup(), onAlerting(), onCallEstablished(), onProgress(), queue_connected_line_update(), and update_initial_connected_line().

ast_channel_queue_redirecting_update()

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

Queue a redirecting update frame on a channel.

Since

1.8

Parameters

chan	Asterisk channel to indicate redirecting id information
redirecting	Redirecting id information
update	What redirecting information to update. NULL if all.

Definition at line 10319 of file channel.c.

{
    unsigned char data[1024];   /* This should be large enough */
    size_t datalen;
 
    datalen = ast_redirecting_build_data(data, sizeof(data), redirecting, update);
    if (datalen == (size_t) -1) {
        return;
    }
 
    ast_queue_control_data(chan, AST_CONTROL_REDIRECTING, data, datalen);
}

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

Referenced by set_redirecting().

ast_channel_rawreadformat()

struct ast_format * ast_channel_rawreadformat

(

struct ast_channel *

chan

)

Definition at line 849 of file channel_internal_api.c.

{
    return chan->rawreadformat;
}

References ast_channel::rawreadformat.

Referenced by __ast_read(), ast_set_read_format_path(), chan_pjsip_write_stream(), channel_do_masquerade(), cli_channelstats_print_body(), dahdi_read(), gather_softmix_stats(), native_rtp_bridge_compatible_check(), serialize_showchan(), set_softmix_bridge_data(), set_talk_detect(), and snoop_determine_format().

ast_channel_rawwriteformat()

struct ast_format * ast_channel_rawwriteformat

(

struct ast_channel *

chan

)

Definition at line 853 of file channel_internal_api.c.

{
    return chan->rawwriteformat;
}

References ast_channel::rawwriteformat.

Referenced by ast_prod(), ast_set_write_format_path(), ast_write_stream(), chan_pjsip_read_stream(), chan_pjsip_write_stream(), channel_do_masquerade(), conf_run(), native_rtp_bridge_compatible_check(), serialize_showchan(), snoop_determine_format(), and softmix_mixing_loop().

ast_channel_readformat()

struct ast_format * ast_channel_readformat

(

struct ast_channel *

chan

)

Definition at line 857 of file channel_internal_api.c.

{
    return chan->readformat;
}

References ast_channel::readformat.

Referenced by __ast_read(), adsi_transmit_message_full(), agent_login_exec(), alarmreceiver_exec(), ast_bridge_channel_restore_formats(), ast_channel_yank(), ast_set_read_format_path(), audiosocket_exec(), background_detect_exec(), bridge_channel_internal_join(), chan_pjsip_read_stream(), chan_pjsip_write_stream(), channel_do_masquerade(), dictate_exec(), do_waiting(), eagi_exec(), fax_detect_framehook(), fax_gateway_framehook(), func_channel_read(), generate_status(), generic_fax_exec(), handle_recordfile(), handle_showchan(), init_jack_data(), isAnsweringMachine(), jingle_read(), jingle_write(), measurenoise(), ooh323_rtp_read(), ooh323_set_read_format(), ooh323_set_write_format(), ooh323_write(), record_exec(), send_start_rtp(), serialize_showchan(), set_caps(), set_read_to_slin(), socket_process_helper(), speech_background(), start_rtp(), unistim_rtp_read(), and unistim_write().

ast_channel_readq()

struct ast_readq_list * ast_channel_readq

(

struct ast_channel *

chan

)

Definition at line 877 of file channel_internal_api.c.

{
    return &chan->readq;
}

References ast_channel::readq.

Referenced by __ast_queue_frame(), __ast_read(), ast_channel_clear_softhangup(), ast_channel_destructor(), chan_cleanup(), channel_do_masquerade(), handle_dump_frames(), load_stream_readqueue(), optimize_lock_chan_stack(), optimize_lock_peer_stack(), and wait_for_empty_queue().

ast_channel_readtrans()

struct ast_trans_pvt * ast_channel_readtrans

(

const struct ast_channel *

chan

)

Definition at line 754 of file channel_internal_api.c.

{
    return chan->readtrans;
}

References ast_channel::readtrans.

Referenced by __ast_read(), ast_channel_destructor(), ast_set_read_format_path(), chan_pjsip_write_stream(), fax_gateway_framehook(), free_translation(), generate_status(), handle_showchan(), and serialize_showchan().

ast_channel_readtrans_set()

void ast_channel_readtrans_set	(	struct ast_channel *	chan,
		struct ast_trans_pvt *	value
	)

Definition at line 758 of file channel_internal_api.c.

{
    chan->readtrans = value;
}

References ast_channel::readtrans, and value.

Referenced by ast_set_read_format_path(), and free_translation().

ast_channel_reason2str()

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

{
    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!!";
    }
}

References AST_CONTROL_ANSWER, AST_CONTROL_BUSY, AST_CONTROL_CONGESTION, AST_CONTROL_HANGUP, AST_CONTROL_RING, and AST_CONTROL_RINGING.

Referenced by attempt_thread().

ast_channel_redirecting()

struct ast_party_redirecting * ast_channel_redirecting

(

struct ast_channel *

chan

)

Definition at line 909 of file channel_internal_api.c.

{
    return &chan->redirecting;
}

References ast_channel::redirecting.

Referenced by __ast_channel_alloc_ap(), analog_call(), ast_ari_channels_dial(), ast_call_forward(), ast_cel_fabricate_channel_from_event(), ast_channel_destructor(), ast_channel_redirecting_sub(), ast_channel_set_redirecting(), ast_dummy_channel_destructor(), ast_iax2_new(), ast_unreal_call_setup(), ast_var_channels_table(), begin_dial_prerun(), call_forward_inherit(), callerid_read(), callerid_write(), channel_do_masquerade(), channel_snapshot_caller_create(), dahdi_new(), dial_exec_full(), do_forward(), get_redirecting_add_diversion(), iax2_call(), indicate_redirecting(), isAnsweringMachine(), leave_voicemail(), my_get_callerid(), redirecting_read(), redirecting_write(), ring_entry(), serialize_showchan(), setup_env(), unreal_colp_redirect_indicate(), and wait_for_answer().

ast_channel_redirecting_effective_from()

struct ast_party_id ast_channel_redirecting_effective_from

(

struct ast_channel *

chan

)

Definition at line 917 of file channel_internal_api.c.

{
    return ast_party_id_merge(&chan->redirecting.from, &chan->redirecting.priv_from);
}

References ast_party_id_merge().

ast_channel_redirecting_effective_orig()

struct ast_party_id ast_channel_redirecting_effective_orig

(

struct ast_channel *

chan

)

Definition at line 913 of file channel_internal_api.c.

{
    return ast_party_id_merge(&chan->redirecting.orig, &chan->redirecting.priv_orig);
}

References ast_party_id_merge().

ast_channel_redirecting_effective_to()

struct ast_party_id ast_channel_redirecting_effective_to

(

struct ast_channel *

chan

)

Definition at line 921 of file channel_internal_api.c.

{
    return ast_party_id_merge(&chan->redirecting.to, &chan->redirecting.priv_to);
}

References ast_party_id_merge().

ast_channel_redirecting_set()

void ast_channel_redirecting_set	(	struct ast_channel *	chan,
		struct ast_party_redirecting *	value
	)

Definition at line 960 of file channel_internal_api.c.

{
    chan->redirecting = *value;
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER);
}

References AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER, ast_channel_snapshot_invalidate_segment(), ast_channel::redirecting, and value.

Referenced by channel_do_masquerade().

ast_channel_redirecting_sub()

int ast_channel_redirecting_sub	(	struct ast_channel *	autoservice_chan,
		struct ast_channel *	sub_chan,
		const void *	redirecting_info,
		int	is_frame
	)

Run a redirecting interception subroutine and update a channel's redirecting information.

Since

11

Whenever we want to update a channel's redirecting information, we may need to run a subroutine so that an administrator can manipulate the information before sending it out. This function both runs the subroutine specified by REDIRECTING_SEND_SUB and sends the update to the channel.

Parameters

autoservice_chan	Channel to place into autoservice while the subroutine is running. It is perfectly safe for this to be NULL
sub_chan	The channel to run the subroutine on. Also the channel from which we determine which subroutine we need to run.
redirecting_info	Either an ast_party_redirecting or ast_frame pointer of type AST_CONTROL_REDIRECTING
is_frame	If true, then redirecting_info is an ast_frame pointer, otherwise it is an ast_party_redirecting pointer.

Return values

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

Definition at line 10405 of file channel.c.

{
    const char *sub;
    const char *sub_args;
    int retval;
 
    ast_channel_lock(sub_chan);
    sub = pbx_builtin_getvar_helper(sub_chan, "REDIRECTING_SEND_SUB");
    sub = ast_strdupa(S_OR(sub, ""));
    sub_args = pbx_builtin_getvar_helper(sub_chan, "REDIRECTING_SEND_SUB_ARGS");
    sub_args = ast_strdupa(S_OR(sub_args, ""));
 
    if (ast_strlen_zero(sub)) {
        ast_channel_unlock(sub_chan);
        return -1;
    }
 
    if (is_frame) {
        const struct ast_frame *frame = redirecting_info;
 
        ast_redirecting_parse_data(frame->data.ptr, frame->datalen, ast_channel_redirecting(sub_chan));
    } else {
        const struct ast_party_redirecting *redirecting = redirecting_info;
 
        ast_party_redirecting_copy(ast_channel_redirecting(sub_chan), redirecting);
    }
    ast_channel_unlock(sub_chan);
 
    channel_set_intercept_mode(1);
    retval = ast_app_run_sub(autoservice_chan, sub_chan, sub, sub_args, 0);
    channel_set_intercept_mode(0);
    if (!retval) {
        struct ast_party_redirecting saved_redirecting;
 
        ast_party_redirecting_init(&saved_redirecting);
        ast_channel_lock(sub_chan);
        ast_party_redirecting_copy(&saved_redirecting, ast_channel_redirecting(sub_chan));
        ast_channel_unlock(sub_chan);
        ast_channel_update_redirecting(sub_chan, &saved_redirecting, NULL);
        ast_party_redirecting_free(&saved_redirecting);
    }
 
    return retval;
}

References ast_app_run_sub(), ast_channel_lock, ast_channel_redirecting(), ast_channel_unlock, ast_channel_update_redirecting(), ast_party_redirecting_copy(), ast_party_redirecting_free(), ast_party_redirecting_init(), ast_redirecting_parse_data(), ast_strdupa, ast_strlen_zero(), channel_set_intercept_mode(), ast_frame::data, ast_frame::datalen, NULL, pbx_builtin_getvar_helper(), ast_frame::ptr, retval, S_OR, and sub.

Referenced by bridge_channel_handle_control(), call_forward_inherit(), do_forward(), handle_frame(), and wait_for_answer().

ast_channel_register()

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.

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

Definition at line 539 of file channel.c.

{
    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(5, "Registered handler for '%s' (%s)\n", chan->tech->type, chan->tech->description);
 
    ast_verb(5, "Registered channel type '%s' (%s)\n", chan->tech->type, chan->tech->description);
 
    AST_RWLIST_UNLOCK(&backends);
 
    return 0;
}

References ast_calloc, ast_debug, ast_log, AST_RWLIST_INSERT_HEAD, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, ast_verb, chanlist::chan, ast_channel_tech::description, chanlist::list, LOG_WARNING, chanlist::tech, ast_channel::tech, and ast_channel_tech::type.

Referenced by ast_channels_init(), ast_local_init(), load_module(), and register_channel_tech().

ast_channel_release()

struct ast_channel * ast_channel_release

(

struct ast_channel *

chan

)

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.

Return values

NULL	convenient for clearing invalid pointers

Note

Absolutely NO channel locks should be held before calling this function.

Since

1.8

Definition at line 1603 of file channel.c.

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

References ao2_unlink, ast_channel_unref, and channels.

Referenced by ast_iax2_new(), ast_unreal_new_channels(), destroy_msg_q_chan(), do_notify(), rec_request(), and safe_channel_release().

ast_channel_req_accountcodes()

void ast_channel_req_accountcodes	(	struct ast_channel *	chan,
		const struct ast_channel *	requestor,
		enum ast_channel_requestor_relationship	relationship
	)

Setup new channel accountcodes from the requestor channel after ast_request().

Since

13.0.0

Parameters

chan	New channel to get accountcodes setup.
requestor	Requesting channel to get accountcodes from.
relationship	What the new channel was created for.

Precondition

The chan and requestor channels are already locked.

Note

Pre-existing accountcodes on chan will be overwritten.

Definition at line 6453 of file channel.c.

{
    channel_req_accountcodes(chan, requestor, relationship, 0);
}

References channel_req_accountcodes().

Referenced by __ast_request_and_dial(), ast_ari_channels_dial(), ast_call_forward(), attended_transfer_bridge(), begin_dial_prerun(), blind_transfer_bridge(), common_recall_channel_setup(), dial_exec_full(), dial_transfer(), do_forward(), findmeexec(), park_local_transfer(), and wait_for_answer().

ast_channel_req_accountcodes_precious()

void ast_channel_req_accountcodes_precious	(	struct ast_channel *	chan,
		const struct ast_channel *	requestor,
		enum ast_channel_requestor_relationship	relationship
	)

Setup new channel accountcodes from the requestor channel after ast_request().

Since

13.0.0

Parameters

chan	New channel to get accountcodes setup.
requestor	Requesting channel to get accountcodes from.
relationship	What the new channel was created for.

Precondition

The chan and requestor channels are already locked.

Note

Pre-existing accountcodes on chan will not be overwritten.

Definition at line 6458 of file channel.c.

{
    channel_req_accountcodes(chan, requestor, relationship, 1);
}

References channel_req_accountcodes().

Referenced by ring_entry().

ast_channel_request_stream_topology_change()

int ast_channel_request_stream_topology_change	(	struct ast_channel *	chan,
		struct ast_stream_topology *	topology,
		void *	change_source
	)

Request that the stream topology of a channel change.

Parameters

chan	The channel to change
topology	The new stream topology
change_source	The source that initiated the change

Note

Absolutely NO channel locks should be held before calling this function.

Return values

0	request has been accepted to be attempted
-1	request could not be attempted

Note

This function initiates an asynchronous request to change the stream topology. It is not guaranteed that the topology will change and until an AST_CONTROL_STREAM_TOPOLOGY_CHANGED frame is received from the channel the current handler of the channel must tolerate the stream topology as it currently exists.

This interface is provided for applications and resources to request that the topology change. It is not for use by the channel driver itself.

Definition at line 10988 of file channel.c.

{
    int res;
 
    ast_assert(chan != NULL);
    ast_assert(topology != NULL);
 
    ast_channel_lock(chan);
    if (!ast_channel_is_multistream(chan) || !ast_channel_tech(chan)->indicate) {
        ast_channel_unlock(chan);
        return -1;
    }
 
    if (ast_stream_topology_equal(ast_channel_get_stream_topology(chan), topology)) {
        ast_debug(2, "%s: Topologies already match. Current: %s  Requested: %s\n",
                ast_channel_name(chan),
                ast_str_tmp(256, ast_stream_topology_to_str(ast_channel_get_stream_topology(chan), &STR_TMP)),
                ast_str_tmp(256, ast_stream_topology_to_str(topology, &STR_TMP)));
        ast_channel_unlock(chan);
        return 0;
    }
 
    ast_channel_internal_set_stream_topology_change_source(chan, change_source);
 
    res = ast_channel_tech(chan)->indicate(chan, AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE, topology, sizeof(topology));
    ast_channel_unlock(chan);
    return res;
}

References ast_assert, ast_channel_get_stream_topology(), ast_channel_internal_set_stream_topology_change_source(), ast_channel_is_multistream(), ast_channel_lock, ast_channel_name(), ast_channel_tech(), ast_channel_unlock, AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE, ast_debug, ast_str_tmp, ast_stream_topology_equal(), ast_stream_topology_to_str(), indicate(), ast_channel_tech::indicate, and NULL.

Referenced by AST_TEST_DEFINE(), native_rtp_bridge_join(), native_rtp_stream_topology_changed(), sfu_topologies_on_join(), sfu_topologies_on_leave(), sfu_topologies_on_source_change(), simple_bridge_join(), simple_bridge_stream_topology_changed(), softmix_bridge_stream_sources_update(), and stream_echo_perform().

ast_channel_rings()

int ast_channel_rings

(

const struct ast_channel *

chan

)

Definition at line 459 of file channel_internal_api.c.

{
    return chan->rings;
}

References ast_channel::rings.

Referenced by __analog_handle_event(), ast_var_channels_table(), and serialize_showchan().

ast_channel_rings_set()

void ast_channel_rings_set	(	struct ast_channel *	chan,
		int	value
	)

Definition at line 463 of file channel_internal_api.c.

{
    chan->rings = value;
}

References ast_channel::rings, and value.

Referenced by __analog_handle_event(), __analog_ss_thread(), analog_ss_thread(), chan_pjsip_new(), dahdi_handle_event(), dahdi_new(), jingle_new(), mbl_new(), ooh323_new(), and unistim_new().

ast_channel_sched()

struct ast_sched_context * ast_channel_sched

(

const struct ast_channel *

chan

)

Definition at line 730 of file channel_internal_api.c.

{
    return chan->sched;
}

References ast_channel::sched.

Referenced by ast_channel_destructor(), ast_hangup(), ast_readaudio_callback(), ast_readvideo_callback(), background_detect_exec(), dial_exec_full(), filestream_close(), handle_speechrecognize(), speech_background(), wait_for_winner(), and waitstream_core().

ast_channel_sched_set()

void ast_channel_sched_set	(	struct ast_channel *	chan,
		struct ast_sched_context *	value
	)

Definition at line 734 of file channel_internal_api.c.

{
    chan->sched = value;
}

References ast_channel::sched, and value.

Referenced by __ast_channel_alloc_ap(), and ast_hangup().

ast_channel_sendhtml()

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

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

References ast_channel_tech(), and ast_channel_tech::send_html.

Referenced by ast_channel_sendurl(), and wait_for_answer().

ast_channel_sending_dtmf_digit()

char ast_channel_sending_dtmf_digit

(

const struct ast_channel *

chan

)

Definition at line 402 of file channel_internal_api.c.

{
    return chan->sending_dtmf_digit;
}

References ast_channel::sending_dtmf_digit.

Referenced by ast_senddigit_end(), bridge_channel_internal_join(), and channel_do_masquerade().

ast_channel_sending_dtmf_digit_set()

void ast_channel_sending_dtmf_digit_set	(	struct ast_channel *	chan,
		char	value
	)

Definition at line 406 of file channel_internal_api.c.

{
    chan->sending_dtmf_digit = value;
}

References ast_channel::sending_dtmf_digit, and value.

Referenced by ast_senddigit_begin(), and ast_senddigit_end().

ast_channel_sending_dtmf_tv()

struct timeval ast_channel_sending_dtmf_tv

(

const struct ast_channel *

chan

)

Definition at line 411 of file channel_internal_api.c.

{
    return chan->sending_dtmf_tv;
}

Referenced by bridge_channel_internal_join(), and channel_do_masquerade().

ast_channel_sending_dtmf_tv_set()

void ast_channel_sending_dtmf_tv_set	(	struct ast_channel *	chan,
		struct timeval	value
	)

Definition at line 415 of file channel_internal_api.c.

{
    chan->sending_dtmf_tv = value;
}

References ast_channel::sending_dtmf_tv, and value.

Referenced by ast_senddigit_begin().

ast_channel_sendurl()

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

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

References ast_channel_sendhtml(), AST_HTML_URL, and url.

Referenced by dial_exec_full(), and try_calling().

ast_channel_set_ari_vars()

void ast_channel_set_ari_vars	(	size_t	varc,
		char **	vars
	)

Sets the variables to be stored in the ari_vars field of all snapshots.

Since

14.2.0

Parameters

varc	Number of variable names.
vars	Array of variable names.

Definition at line 7914 of file channel.c.

{
    channel_set_external_vars(&ari_vars, varc, vars);
}

References ari_vars, and channel_set_external_vars().

Referenced by channelvars_handler().

ast_channel_set_caller()

void ast_channel_set_caller	(	struct ast_channel *	chan,
		const struct ast_party_caller *	caller,
		const struct ast_set_party_caller *	update
	)

Set the caller id information in the Asterisk channel.

Since

1.8

Parameters

chan	Asterisk channel to set caller id information
caller	Caller id information
update	What caller information to update. NULL if all.

Note

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

Definition at line 7381 of file channel.c.

{
    if (ast_channel_caller(chan) == caller) {
        /* Don't set to self */
        return;
    }
 
    ast_channel_lock(chan);
    ast_party_caller_set(ast_channel_caller(chan), caller, update);
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER);
    ast_channel_unlock(chan);
}

References ast_channel_caller(), ast_channel_lock, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER, ast_channel_snapshot_invalidate_segment(), ast_channel_unlock, ast_party_caller_set(), and update().

ast_channel_set_caller_event()

void ast_channel_set_caller_event	(	struct ast_channel *	chan,
		const struct ast_party_caller *	caller,
		const struct ast_set_party_caller *	update
	)

Set the caller id information in the Asterisk channel and generate an AMI event if the caller id name or number changed.

Since

1.8

Parameters

chan	Asterisk channel to set caller id information
caller	Caller id information
update	What caller information to update. NULL if all.

Note

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

Definition at line 7394 of file channel.c.

{
    if (ast_channel_caller(chan) == caller) {
        /* Don't set to self */
        return;
    }
 
    ast_channel_lock(chan);
    ast_party_caller_set(ast_channel_caller(chan), caller, update);
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER);
    ast_channel_publish_snapshot(chan);
    ast_channel_unlock(chan);
}

References ast_channel_caller(), ast_channel_lock, ast_channel_publish_snapshot(), AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER, ast_channel_snapshot_invalidate_segment(), ast_channel_unlock, ast_party_caller_set(), and update().

Referenced by callerid_write(), dial_exec_full(), do_forward(), queue_connected_line_update(), and ring_entry().

ast_channel_set_connected_line()

void ast_channel_set_connected_line	(	struct ast_channel *	chan,
		const struct ast_party_connected_line *	connected,
		const struct ast_set_party_connected_line *	update
	)

Set the connected line information in the Asterisk channel.

Since

1.8

Parameters

chan	Asterisk channel to set connected line information
connected	Connected line information
update	What connected line information to update. NULL if all.

Note

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

Definition at line 8330 of file channel.c.

{
    if (ast_channel_connected(chan) == connected) {
        /* Don't set to self */
        return;
    }
 
    ast_channel_lock(chan);
    ast_party_connected_line_set(ast_channel_connected(chan), connected, update);
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CONNECTED);
    ast_channel_publish_snapshot(chan);
    ast_channel_unlock(chan);
}

References ast_channel_connected(), ast_channel_lock, ast_channel_publish_snapshot(), AST_CHANNEL_SNAPSHOT_INVALIDATE_CONNECTED, ast_channel_snapshot_invalidate_segment(), ast_channel_unlock, ast_party_connected_line_set(), connected, and update().

Referenced by __ast_request_and_dial(), ari_channels_handle_originate_with_id(), connectedline_write(), dial_exec_full(), indicate_connected_line(), and pbx_outgoing_attempt().

ast_channel_set_fd()

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

Set the file descriptor on the channel

Definition at line 2445 of file channel.c.

{
    ast_channel_internal_fd_set(chan, which, fd);
    return;
}

References ast_channel_internal_fd_set().

Referenced by __ast_channel_alloc_ap(), ast_jb_create_framehook(), AST_TEST_DEFINE(), audiosocket_request(), channel_do_masquerade(), check_for_rtp_changes(), configure_local_rtp(), dahdi_new(), deactivate_generator_nolock(), do_monitor_headset(), jingle_enable_video(), jingle_new(), mbl_hangup(), mbl_new(), mbl_read(), my_swap_subchannels(), sco_accept(), stasis_app_control_snoop(), swap_subs(), and unicast_rtp_request().

ast_channel_set_flag()

void ast_channel_set_flag	(	struct ast_channel *	chan,
		unsigned int	flag
	)

Set a flag on a channel.

Since

13.17.0

Parameters

chan	The channel to set the flag on
flag	The flag to set

Note

This will lock the channel internally. If the channel is already locked it is still safe to call.

Definition at line 11049 of file channel.c.

{
    ast_channel_lock(chan);
    ast_set_flag(ast_channel_flags(chan), flag);
    ast_channel_unlock(chan);
}

References ast_channel_flags(), ast_channel_lock, ast_channel_unlock, and ast_set_flag.

Referenced by ast_call_forward(), ast_waitfordigit_full(), channel_spy(), common_exec(), dial_exec_full(), disa_exec(), do_broadcast(), and waitstream_core().

ast_channel_set_is_t38_active()

void ast_channel_set_is_t38_active	(	struct ast_channel *	chan,
		int	is_t38_active
	)

Sets the is_t38_active flag.

Parameters

chan	Which channel is having its is_t38_active value set
is_t38_active	Non-zero if T.38 is active

Definition at line 1062 of file channel_internal_api.c.

{
    ast_channel_lock(chan);
    ast_channel_set_is_t38_active_nolock(chan, is_t38_active);
    ast_channel_unlock(chan);
}

References ast_channel_lock, ast_channel_set_is_t38_active_nolock(), and ast_channel_unlock.

ast_channel_set_is_t38_active_nolock()

void ast_channel_set_is_t38_active_nolock	(	struct ast_channel *	chan,
		int	is_t38_active
	)

Variant of ast_channel_set_is_t38_active. Use this if the channel is already locked prior to calling.

Parameters

chan	Which channel is having its is_t38_active value set
is_t38_active	Non-zero if T.38 is active

Definition at line 1057 of file channel_internal_api.c.

{
    chan->is_t38_active = !!is_t38_active;
}

References ast_channel::is_t38_active.

Referenced by ast_channel_set_is_t38_active(), and indicate_data_internal().

ast_channel_set_manager_vars()

void ast_channel_set_manager_vars	(	size_t	varc,
		char **	vars
	)

Sets the variables to be stored in the manager_vars field of all snapshots.

Since

12

Parameters

varc	Number of variable names.
vars	Array of variable names.

Definition at line 7909 of file channel.c.

{
    channel_set_external_vars(&ami_vars, varc, vars);
}

References ami_vars, and channel_set_external_vars().

Referenced by load_channelvars().

ast_channel_set_oldwriteformat()

void ast_channel_set_oldwriteformat	(	struct ast_channel *	chan,
		struct ast_format *	format
	)

Definition at line 825 of file channel_internal_api.c.

{
    ao2_replace(chan->oldwriteformat, format);
}

References ao2_replace, and ast_channel::oldwriteformat.

Referenced by ast_channel_destructor(), and ast_openstream_full().

ast_channel_set_rawreadformat()

void ast_channel_set_rawreadformat	(	struct ast_channel *	chan,
		struct ast_format *	format
	)

Definition at line 829 of file channel_internal_api.c.

{
    ao2_replace(chan->rawreadformat, format);
}

References ao2_replace, and ast_channel::rawreadformat.

Referenced by __ast_channel_alloc_ap(), ast_channel_destructor(), ast_iax2_new(), ast_set_read_format_path(), ast_unreal_new_channels(), audiosocket_request(), chan_pjsip_new(), channel_do_masquerade(), dahdi_new(), do_notify(), handle_exec(), jingle_new(), mbl_new(), multicast_rtp_request(), ooh323_new(), rec_request(), sip_session_response_cb(), stasis_app_control_snoop(), test_vm_api_create_mock_channel(), unicast_rtp_request(), and unistim_new().

ast_channel_set_rawwriteformat()

void ast_channel_set_rawwriteformat	(	struct ast_channel *	chan,
		struct ast_format *	format
	)

Definition at line 833 of file channel_internal_api.c.

{
    ao2_replace(chan->rawwriteformat, format);
}

References ao2_replace, and ast_channel::rawwriteformat.

Referenced by __ast_channel_alloc_ap(), ast_channel_destructor(), ast_iax2_new(), ast_set_write_format_path(), ast_unreal_new_channels(), audiosocket_request(), chan_pjsip_new(), channel_do_masquerade(), dahdi_new(), do_notify(), handle_exec(), jingle_new(), mbl_new(), multicast_rtp_request(), ooh323_new(), rec_request(), sip_session_response_cb(), stasis_app_control_snoop(), test_vm_api_create_mock_channel(), unicast_rtp_request(), and unistim_new().

ast_channel_set_readformat()

void ast_channel_set_readformat	(	struct ast_channel *	chan,
		struct ast_format *	format
	)

Definition at line 837 of file channel_internal_api.c.

{
    ao2_replace(chan->readformat, format);
}

References ao2_replace, and ast_channel::readformat.

Referenced by __ast_channel_alloc_ap(), ast_channel_destructor(), ast_channel_yank(), ast_iax2_new(), ast_set_read_format_path(), ast_unreal_new_channels(), audiosocket_request(), chan_pjsip_new(), console_new(), dahdi_new(), do_notify(), handle_exec(), iax2_request(), jingle_new(), mbl_new(), multicast_rtp_request(), rec_request(), sip_session_response_cb(), start_rtp(), stasis_app_control_snoop(), test_vm_api_create_mock_channel(), unicast_rtp_request(), and unistim_new().

ast_channel_set_redirecting()

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

Set the redirecting id information in the Asterisk channel.

Since

1.8

Parameters

chan	Asterisk channel to set redirecting id information
redirecting	Redirecting id information
update	What redirecting information to update. NULL if all.

Note

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

Definition at line 9141 of file channel.c.

{
    if (ast_channel_redirecting(chan) == redirecting) {
        /* Don't set to self */
        return;
    }
 
    ast_channel_lock(chan);
    ast_party_redirecting_set(ast_channel_redirecting(chan), redirecting, update);
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER);
    ast_channel_publish_snapshot(chan);
    ast_channel_unlock(chan);
}

References ast_channel_lock, ast_channel_publish_snapshot(), ast_channel_redirecting(), AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER, ast_channel_snapshot_invalidate_segment(), ast_channel_unlock, ast_party_redirecting_set(), and update().

Referenced by AST_TEST_DEFINE(), indicate_redirecting(), redirecting_write(), and set_redirecting().

ast_channel_set_stream_topology()

struct ast_stream_topology * ast_channel_set_stream_topology	(	struct ast_channel *	chan,
		struct ast_stream_topology *	topology
	)

Set the topology of streams on a channel.

Parameters

chan	The channel to set the stream topology on
topology	The stream topology to set

Precondition

chan is locked

Note

If topology is NULL a new empty topology will be created and returned.

Return values

non-NULL	Success
NULL	failure

Definition at line 1620 of file channel_internal_api.c.

{
    struct ast_stream_topology *new_topology;
    SCOPE_ENTER(1, "%s: %s\n", ast_channel_name(chan),
        ast_str_tmp(256, ast_stream_topology_to_str(topology, &STR_TMP)));
 
    ast_assert(chan != NULL);
 
    /* A non-MULTISTREAM channel can't manipulate topology directly */
    ast_assert(ast_channel_is_multistream(chan));
 
    /* Unless the channel is being destroyed, we always want a topology on
     * it even if its empty.
     */
    if (!topology) {
        new_topology = ast_stream_topology_alloc();
    } else {
        new_topology = topology;
    }
 
    if (new_topology) {
        ast_channel_internal_set_stream_topology(chan, new_topology);
    }
 
    SCOPE_EXIT_RTN_VALUE(new_topology, "Used %s topology\n", topology ? "provided" : "empty");
}

References ast_assert, ast_channel_internal_set_stream_topology(), ast_channel_is_multistream(), ast_channel_name(), ast_str_tmp, ast_stream_topology_alloc(), ast_stream_topology_to_str(), NULL, SCOPE_ENTER, and SCOPE_EXIT_RTN_VALUE.

Referenced by AST_TEST_DEFINE(), ast_unreal_indicate(), ast_unreal_new_channels(), chan_pjsip_new(), handle_negotiated_sdp(), make_channel(), and unreal_colp_stream_topology_request_change().

ast_channel_set_unbridged()

void ast_channel_set_unbridged	(	struct ast_channel *	chan,
		int	value
	)

Sets the unbridged flag and queues a NULL frame on the channel to trigger a check by bridge_channel_wait.

Parameters

chan	Which channel is having its unbridged value set
value	What the unbridge value is being set to

Definition at line 1035 of file channel_internal_api.c.

{
    ast_channel_lock(chan);
    ast_channel_set_unbridged_nolock(chan, value);
    ast_channel_unlock(chan);
}

References ast_channel_lock, ast_channel_set_unbridged_nolock(), ast_channel_unlock, and value.

Referenced by ast_bridge_setup_after_goto(), bridge_channel_wait(), and t38_change_state().

ast_channel_set_unbridged_nolock()

void ast_channel_set_unbridged_nolock	(	struct ast_channel *	chan,
		int	value
	)

Variant of ast_channel_set_unbridged. Use this if the channel is already locked prior to calling.

Parameters

chan	Which channel is having its unbridged value set
value	What the unbridge value is being set to

Definition at line 1029 of file channel_internal_api.c.

{
    chan->unbridged = !!value;
    ast_queue_frame(chan, &ast_null_frame);
}

References ast_null_frame, ast_queue_frame(), ast_channel::unbridged, and value.

Referenced by ast_audiohook_attach(), ast_audiohook_remove(), ast_channel_set_unbridged(), ast_framehook_attach(), ast_framehook_detach(), ast_framehook_list_fixup(), audio_audiohook_write_list(), chan_pjsip_read_stream(), dtmf_audiohook_write_list(), and set_caps().

ast_channel_set_writeformat()

void ast_channel_set_writeformat	(	struct ast_channel *	chan,
		struct ast_format *	format
	)

Definition at line 841 of file channel_internal_api.c.

{
    ao2_replace(chan->writeformat, format);
}

References ao2_replace, and ast_channel::writeformat.

Referenced by __ast_channel_alloc_ap(), ast_channel_destructor(), ast_channel_yank(), ast_iax2_new(), ast_set_write_format_path(), ast_unreal_new_channels(), audiosocket_request(), chan_pjsip_new(), console_new(), dahdi_new(), do_notify(), handle_exec(), iax2_request(), jingle_new(), mbl_new(), multicast_rtp_request(), rec_request(), sip_session_response_cb(), start_rtp(), stasis_app_control_snoop(), test_vm_api_create_mock_channel(), unicast_rtp_request(), and unistim_new().

ast_channel_setoption()

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

{
    int res;
 
    ast_channel_lock(chan);
    if (!ast_channel_tech(chan)->setoption) {
        errno = ENOSYS;
        ast_channel_unlock(chan);
        return -1;
    }
 
    if (block)
        ast_log(LOG_ERROR, "XXX Blocking not implemented yet XXX\n");
 
    res = ast_channel_tech(chan)->setoption(chan, option, data, datalen);
    ast_channel_unlock(chan);
 
    return res;
}

References ast_channel_lock, ast_channel_tech(), ast_channel_unlock, ast_log, ast_datastore::data, errno, LOG_ERROR, and ast_channel_tech::setoption.

Referenced by analog_hangup(), bridge_channel_handle_control(), common_exec(), conf_run(), dahdi_hangup(), dial_exec_full(), func_channel_write(), func_channel_write_real(), handle_tddmode(), play_record_review(), reset_volumes(), set_format(), set_listen_volume(), set_security_requirements(), set_talk_volume(), try_calling(), and vm_forwardoptions().

ast_channel_setwhentohangup_tv()

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

Precondition

chan is locked

Since

1.6.1

Set when to hang a channel up.

Definition at line 510 of file channel.c.

{
    if (ast_tvzero(offset)) {
        ast_channel_whentohangup_set(chan, &offset);
    } else {
        struct timeval tv = ast_tvadd(offset, ast_tvnow());
        ast_channel_whentohangup_set(chan, &tv);
    }
    ast_queue_frame(chan, &ast_null_frame);
    return;
}

References ast_channel_whentohangup_set(), ast_null_frame, ast_queue_frame(), ast_tvadd(), ast_tvnow(), and ast_tvzero().

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

ast_channel_snapshot()

struct ast_channel_snapshot * ast_channel_snapshot

(

const struct ast_channel *

chan

)

Definition at line 1677 of file channel_internal_api.c.

{
    return chan->snapshot;
}

References ast_channel::snapshot.

Referenced by aoc_publish_blob(), ast_channel_blob_create(), ast_channel_snapshot_create(), and channel_snapshot_update_create().

ast_channel_snapshot_segment_flags()

struct ast_flags * ast_channel_snapshot_segment_flags

(

struct ast_channel *

chan

)

Definition at line 1688 of file channel_internal_api.c.

{
    return &chan->snapshot_segment_flags;
}

References ast_channel::snapshot_segment_flags.

Referenced by ast_channel_publish_snapshot(), ast_channel_snapshot_create(), ast_channel_snapshot_invalidate_segment(), and channel_do_masquerade().

ast_channel_snapshot_set()

void ast_channel_snapshot_set	(	struct ast_channel *	chan,
		struct ast_channel_snapshot *	snapshot
	)

Definition at line 1682 of file channel_internal_api.c.

{
    ao2_cleanup(chan->snapshot);
    chan->snapshot = ao2_bump(snapshot);
}

References ao2_bump, ao2_cleanup, and ast_channel::snapshot.

Referenced by ast_channel_publish_final_snapshot(), and ast_channel_publish_snapshot().

ast_channel_softhangup_internal_flag()

int ast_channel_softhangup_internal_flag

(

struct ast_channel *

chan

)

Definition at line 998 of file channel_internal_api.c.

{
    return chan->softhangup;
}

References ast_channel::softhangup.

Referenced by __ast_pbx_run(), __ast_read(), agent_request_exec(), ast_autoservice_stop(), ast_bridge_call_with_flags(), ast_bridge_join(), ast_bridge_setup_after_goto(), ast_channel_clear_softhangup(), ast_channel_end_dtmf(), ast_channel_is_leaving_bridge(), ast_channel_snapshot_create(), ast_check_hangup(), collect_digits(), gosub_run(), park_and_announce_app_exec(), park_app_exec(), and waitstream_core().

ast_channel_softhangup_internal_flag_add()

void ast_channel_softhangup_internal_flag_add	(	struct ast_channel *	chan,
		int	value
	)

Definition at line 1006 of file channel_internal_api.c.

{
    chan->softhangup |= value;
}

References ast_channel::softhangup, and value.

Referenced by __ast_read(), ast_check_hangup(), ast_dsp_process(), ast_queue_hangup(), ast_queue_hangup_with_cause(), ast_softhangup_nolock(), ast_waitfor_nandfds(), ast_write_stream(), dahdi_handle_event(), and onCallCleared().

ast_channel_softhangup_internal_flag_clear()

void ast_channel_softhangup_internal_flag_clear	(	struct ast_channel *	chan,
		int	value
	)

Definition at line 1010 of file channel_internal_api.c.

{
    chan ->softhangup &= ~value;
}

References ast_channel::softhangup.

Referenced by ast_channel_clear_softhangup().

ast_channel_softhangup_internal_flag_set()

void ast_channel_softhangup_internal_flag_set	(	struct ast_channel *	chan,
		int	value
	)

Definition at line 1002 of file channel_internal_api.c.

{
    chan->softhangup = value;
}

References ast_channel::softhangup, and value.

Referenced by channel_do_masquerade().

ast_channel_softhangup_withcause_locked()

void ast_channel_softhangup_withcause_locked	(	struct ast_channel *	chan,
		int	causecode
	)

Lock the given channel, then request softhangup on the channel with the given causecode.

Parameters

chan	channel on which to hang up
causecode	cause code to use (Zero if don't use cause code)

Definition at line 468 of file channel.c.

{
    ast_channel_lock(chan);
 
    if (causecode > 0) {
        ast_debug(1, "Setting hangupcause of channel %s to %d (is %d now)\n",
            ast_channel_name(chan), causecode, ast_channel_hangupcause(chan));
 
        ast_channel_hangupcause_set(chan, causecode);
    }
 
    ast_softhangup_nolock(chan, AST_SOFTHANGUP_EXPLICIT);
 
    ast_channel_unlock(chan);
}

References ast_channel_hangupcause(), ast_channel_hangupcause_set(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_debug, AST_SOFTHANGUP_EXPLICIT, and ast_softhangup_nolock().

Referenced by action_hangup().

ast_channel_start_silence_generator()

struct ast_silence_generator * ast_channel_start_silence_generator

(

struct ast_channel *

chan

)

Starts a silence generator on the given channel.

Parameters

chan	The channel to generate silence on

Returns

An ast_silence_generator pointer, or NULL if an error occurs

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

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

{
    struct ast_silence_generator *state;
 
    if (!(state = ast_calloc(1, sizeof(*state)))) {
        return NULL;
    }
 
    state->old_write_format = ao2_bump(ast_channel_writeformat(chan));
 
    if (ast_set_write_format(chan, ast_format_slin) < 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", ast_channel_name(chan));
 
    return state;
}

References ao2_bump, ast_activate_generator(), ast_calloc, ast_channel_name(), ast_channel_writeformat(), ast_debug, ast_format_slin, ast_free, ast_log, ast_set_write_format(), LOG_ERROR, NULL, silence_generator, and state.

Referenced by __ast_play_and_record(), app_control_silence_start(), ast_readstring_full(), channel_spy(), control_streamfile(), do_broadcast(), dtmf_stream(), handle_recordfile(), mf_stream(), participant_entertainment_start(), record_exec(), safe_sleep_conditional(), sf_stream(), sub_start_silence(), waitfor_exec(), and waitforring_exec().

ast_channel_state()

enum ast_channel_state ast_channel_state

(

const struct ast_channel *

chan

)

Definition at line 790 of file channel_internal_api.c.

{
    return chan->state;
}

References ast_channel::state.

ast_channel_state_set()

void ast_channel_state_set	(	struct ast_channel *	chan,
		enum	ast_channel_state
	)

Definition at line 821 of file channel_internal_api.c.

{
    chan->state = value;
}

References ast_channel::state, and value.

Referenced by __ast_channel_alloc_ap(), ast_setstate(), AST_TEST_DEFINE(), and channel_do_masquerade().

ast_channel_stop_silence_generator()

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.

This function will stop the operating silence generator and return the channel to its previous write format.

Definition at line 8232 of file channel.c.

{
    if (!state) {
        return;
    }
 
    if (deactivate_silence_generator(chan)) {
        ast_debug(1, "Stopped silence generator on '%s'\n", ast_channel_name(chan));
        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");
        }
    }
    ao2_cleanup(state->old_write_format);
    ast_free(state);
}

References ao2_cleanup, ast_channel_name(), ast_debug, ast_free, ast_log, ast_set_write_format(), deactivate_silence_generator(), and LOG_ERROR.

Referenced by __ast_play_and_record(), app_control_silence_start(), ast_readstring_full(), channel_spy(), control_silence_stop_now(), control_streamfile(), do_broadcast(), dtmf_stream(), handle_recordfile(), mf_stream(), participant_entertainment_stop(), record_exec(), safe_sleep_conditional(), sf_stream(), sub_stop_silence(), waitfor_exec(), and waitforring_exec().

ast_channel_stream()

struct ast_filestream * ast_channel_stream

(

const struct ast_channel *

chan

)

Definition at line 622 of file channel_internal_api.c.

{
    return chan->stream;
}

References ast_channel::stream.

Referenced by ast_hangup(), ast_moh_files_next(), ast_openstream_full(), ast_readstring_full(), ast_stopstream(), background_detect_exec(), control_streamfile(), dial_exec_full(), filehelper(), handle_getoption(), handle_speechrecognize(), handle_streamfile(), local_ast_moh_stop(), moh_files_readframe(), moh_files_release(), speech_background(), wait_for_winner(), waitstream_control(), and waitstream_core().

ast_channel_stream_set()

void ast_channel_stream_set	(	struct ast_channel *	chan,
		struct ast_filestream *	value
	)

Definition at line 626 of file channel_internal_api.c.

{
    chan->stream = value;
}

References ast_channel::stream, and value.

Referenced by ast_hangup(), ast_moh_files_next(), ast_stopstream(), dictate_exec(), filehelper(), filestream_close(), gen_closestream(), handle_recordfile(), local_ast_moh_stop(), and moh_files_release().

ast_channel_stream_topology_changed()

int ast_channel_stream_topology_changed	(	struct ast_channel *	chan,
		struct ast_stream_topology *	topology
	)

Provide notice to a channel that the stream topology has changed.

Parameters

chan	The channel to provide notice to
topology	The new stream topology

Precondition

chan is locked Absolutely NO other channels can be locked.

Return values

0	success
-1	failure

Note

This interface is provided for applications and resources to accept a topology change. It is not for use by the channel driver itself.

Definition at line 11018 of file channel.c.

{
    ast_assert(chan != NULL);
    ast_assert(topology != NULL);
 
    if (!ast_channel_is_multistream(chan) || !ast_channel_tech(chan)->indicate) {
        return -1;
    }
 
    return ast_channel_tech(chan)->indicate(chan, AST_CONTROL_STREAM_TOPOLOGY_CHANGED, topology, sizeof(topology));
}

References ast_assert, ast_channel_is_multistream(), ast_channel_tech(), AST_CONTROL_STREAM_TOPOLOGY_CHANGED, indicate(), ast_channel_tech::indicate, and NULL.

Referenced by __ast_read(), and AST_TEST_DEFINE().

ast_channel_stream_topology_changed_externally()

int ast_channel_stream_topology_changed_externally

(

struct ast_channel *

chan

)

Provide notice from a channel that the topology has changed on it as a result of the remote party renegotiating.

Parameters

chan	The channel to provide notice from

Return values

0	success
-1	failure

Note

This interface is provided for channels to provide notice that a topology change has occurred as a result of a remote party renegotiating the stream topology.

Definition at line 11030 of file channel.c.

{
    int res;
    struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_STREAM_TOPOLOGY_CHANGED };
 
    ast_assert(chan != NULL);
 
    if (!ast_channel_is_multistream(chan)) {
        return -1;
    }
 
    ast_channel_lock(chan);
    ast_channel_internal_set_stream_topology_change_source(chan, (void *)&ast_stream_topology_changed_external);
    res = ast_queue_frame(chan, &f);
    ast_channel_unlock(chan);
 
    return res;
}

References ast_assert, ast_channel_internal_set_stream_topology_change_source(), ast_channel_is_multistream(), ast_channel_lock, ast_channel_unlock, AST_CONTROL_STREAM_TOPOLOGY_CHANGED, AST_FRAME_CONTROL, ast_queue_frame(), ast_stream_topology_changed_external, and NULL.

Referenced by handle_negotiated_sdp(), and unreal_colp_stream_topology_request_change().

ast_channel_streamid()

int ast_channel_streamid

(

const struct ast_channel *

chan

)

Definition at line 467 of file channel_internal_api.c.

{
    return chan->streamid;
}

References ast_channel::streamid.

Referenced by filestream_close(), handle_speechrecognize(), and speech_background().

ast_channel_streamid_set()

void ast_channel_streamid_set	(	struct ast_channel *	chan,
		int	value
	)

Definition at line 471 of file channel_internal_api.c.

{
    chan->streamid = value;
}

References ast_channel::streamid, and value.

Referenced by __ast_channel_alloc_ap(), ast_readaudio_callback(), and filestream_close().

ast_channel_string2amaflag()

enum ama_flags ast_channel_string2amaflag

(

const char *

flag

)

Convert a string to a detail record AMA flag.

Since

12

Parameters

flag	string form of flag

Return values

the	enum (integer) form of the flag

Definition at line 4379 of file channel.c.

{
    if (!strcasecmp(flag, "default"))
        return DEFAULT_AMA_FLAGS;
    if (!strcasecmp(flag, "omit"))
        return AST_AMA_OMIT;
    if (!strcasecmp(flag, "billing"))
        return AST_AMA_BILLING;
    if (!strcasecmp(flag, "documentation"))
        return AST_AMA_DOCUMENTATION;
    return AST_AMA_NONE;
}

References AST_AMA_BILLING, AST_AMA_DOCUMENTATION, AST_AMA_NONE, AST_AMA_OMIT, and DEFAULT_AMA_FLAGS.

Referenced by build_device(), build_peer(), build_user(), cdr_write(), func_channel_write_real(), process_dahdi(), reload_config(), and set_config().

ast_channel_supports_html()

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

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

References ast_channel_tech().

Referenced by dial_exec_full(), and try_calling().

ast_channel_suppress()

int ast_channel_suppress	(	struct ast_channel *	chan,
		unsigned int	direction,
		enum ast_frame_type	frametype
	)

Suppress passing of a frame type on a channel.

Note

The channel should be locked before calling this function.

Parameters

chan	The channel to suppress
direction	The direction in which to suppress
frametype	The type of frame (AST_FRAME_VOICE, etc) to suppress

Return values

0	Success
-1	Failure

Definition at line 10799 of file channel.c.

{
    struct suppress_data *suppress;
    const struct ast_datastore_info *datastore_info = NULL;
    struct ast_datastore *datastore = NULL;
    struct ast_framehook_interface interface = {
        .version = AST_FRAMEHOOK_INTERFACE_VERSION,
        .event_cb = suppress_framehook_event_cb,
        .destroy_cb = suppress_framehook_destroy_cb,
        .chan_fixup_cb = suppress_framehook_fixup_cb,
    };
    int framehook_id;
 
    if (!(datastore_info = suppress_get_datastore_information(frametype))) {
        ast_log(LOG_WARNING, "Attempted to suppress an unsupported frame type (%u).\n", frametype);
        return -1;
    }
 
    if ((datastore = ast_channel_datastore_find(chan, datastore_info, NULL))) {
        suppress = datastore->data;
        suppress->direction |= direction;
        return 0;
    }
 
    if (!(suppress = ao2_alloc(sizeof(*suppress), NULL))) {
        ast_log(LOG_WARNING, "Failed to allocate data while attempting to suppress a stream.\n");
        return -1;
    }
 
    suppress->frametype = frametype;
    suppress->direction |= direction;
 
    interface.data = suppress;
 
    framehook_id = ast_framehook_attach(chan, &interface);
    if (framehook_id < 0) {
        /* Hook attach failed.  Get rid of the evidence. */
        ast_log(LOG_WARNING, "Failed to attach framehook while attempting to suppress a stream.\n");
        ao2_ref(suppress, -1);
        return -1;
    }
 
    /* One ref for the framehook */
    ao2_ref(suppress, +1);
 
    suppress->framehook_id = framehook_id;
 
    if (!(datastore = ast_datastore_alloc(datastore_info, NULL))) {
        ast_log(LOG_WARNING, "Failed to allocate datastore while attempting to suppress a stream.\n");
        ast_framehook_detach(chan, framehook_id);
        ao2_ref(suppress, -1);
        return -1;
    }
 
    /* the ref provided by the allocation is taken by the datastore */
    datastore->data = suppress;
 
    ast_channel_datastore_add(chan, datastore);
 
    return 0;
}

References ao2_alloc, ao2_ref, ast_channel_datastore_add(), ast_channel_datastore_find(), ast_datastore_alloc, ast_framehook_attach(), ast_framehook_detach(), AST_FRAMEHOOK_INTERFACE_VERSION, ast_log, ast_datastore::data, ast_framehook_interface::data, suppress_data::direction, suppress_data::framehook_id, suppress_data::frametype, LOG_WARNING, NULL, suppress_framehook_destroy_cb(), suppress_framehook_event_cb(), suppress_framehook_fixup_cb(), suppress_get_datastore_information(), and ast_framehook_interface::version.

Referenced by app_control_mute(), and mute_channel().

ast_channel_tech()

const struct ast_channel_tech * ast_channel_tech

(

const struct ast_channel *

chan

)

Definition at line 770 of file channel_internal_api.c.

{
    return chan->tech;
}

References ast_channel::tech.

Referenced by __ast_read(), acf_channel_read(), analog_ss_thread(), ast_ari_channels_rtpstatistics(), ast_call(), ast_channel_early_bridge(), ast_channel_queryoption(), ast_channel_request_stream_topology_change(), ast_channel_sendhtml(), ast_channel_setoption(), ast_channel_snapshot_create(), ast_channel_stream_topology_changed(), ast_channel_supports_html(), ast_hangup(), ast_jb_do_usecheck(), ast_pre_call(), ast_raw_answer_with_stream_topology(), ast_rtp_dtmf_compatible(), ast_rtp_instance_early_bridge(), ast_rtp_instance_early_bridge_make_compatible(), ast_rtp_instance_make_compatible(), ast_send_image(), ast_senddigit(), ast_senddigit_begin(), ast_senddigit_end(), ast_senddigit_external(), ast_senddigit_mf(), ast_sendtext_data(), ast_supports_images(), ast_transfer_protocol(), ast_var_channel_types_table(), ast_var_channels_table(), ast_write_stream(), ast_write_video(), channel_do_masquerade(), channel_sanitizer(), channel_snapshot_base_create(), conf_run(), dahdi_setoption(), flash_exec(), func_channel_read(), func_channel_write_real(), function_iaxpeer(), function_ooh323_read(), function_ooh323_write(), fxo_pvt(), generate_status(), handle_showchan(), iax2_prov_app(), indicate_data_internal(), my_get_sigpvt_bridged_channel(), native_bridge_is_capable(), pjsip_acf_channel_read(), pjsip_acf_dtmf_mode_read(), pjsip_acf_dtmf_mode_write(), pjsip_acf_media_offer_read(), pjsip_acf_media_offer_write(), pjsip_acf_moh_passthrough_read(), pjsip_acf_moh_passthrough_write(), pjsip_acf_session_refresh_write(), pjsip_app_hangup_handler(), push_notify_channel(), rtp_glue_data_get(), sendtext_exec(), serialize_showchan(), setup_env(), softhangup_exec(), t38_masq(), tech_write(), transfer_exec(), and try_calling().

ast_channel_tech_pvt()

void * ast_channel_tech_pvt

(

const struct ast_channel *

chan

)

Definition at line 571 of file channel_internal_api.c.

{
    return chan->tech_pvt;
}

References ast_channel::tech_pvt.

Referenced by __analog_ss_thread(), __dahdi_exception(), acf_channel_read(), analog_hangup(), analog_ss_thread(), announce_hangup(), aoc_framehook(), ast_channel_destructor(), ast_local_get_peer(), ast_local_lock_all(), ast_local_setup_bridge(), ast_local_setup_masquerade(), AST_TEST_DEFINE(), ast_unreal_answer(), ast_unreal_channel_push_to_bridge(), ast_unreal_digit_begin(), ast_unreal_digit_end(), ast_unreal_fixup(), ast_unreal_indicate(), ast_unreal_queryoption(), ast_unreal_sendhtml(), ast_unreal_sendtext(), ast_unreal_setoption(), ast_unreal_write_stream(), audiosocket_call(), audiosocket_hangup(), audiosocket_read(), audiosocket_write(), chan_pjsip_answer(), chan_pjsip_call(), chan_pjsip_digit_begin(), chan_pjsip_digit_end(), chan_pjsip_fixup(), chan_pjsip_get_rtp_peer(), chan_pjsip_get_uniqueid(), chan_pjsip_get_vrtp_peer(), chan_pjsip_hangup(), chan_pjsip_indicate(), chan_pjsip_queryoption(), chan_pjsip_read_stream(), chan_pjsip_sendtext_data(), chan_pjsip_set_rtp_peer(), chan_pjsip_transfer(), chan_pjsip_write_stream(), chan_rtp_get_rtp_peer(), channel_do_masquerade(), channel_read_pjsip(), channel_read_rtcp(), channel_read_rtp(), channel_to_session(), cli_channelstats_print_body(), conf_announce_channel_push(), console_answer(), console_call(), console_fixup(), console_hangup(), console_indicate(), console_write(), dahdi_answer(), dahdi_call(), dahdi_callwait(), dahdi_digit_begin(), dahdi_digit_end(), dahdi_exception(), dahdi_fixup(), dahdi_func_read(), dahdi_func_write(), dahdi_handle_dtmf(), dahdi_handle_event(), dahdi_hangup(), dahdi_indicate(), dahdi_queryoption(), dahdi_read(), dahdi_sendtext(), dahdi_setoption(), dahdi_write(), func_read_header(), func_read_headers(), func_read_param(), func_response_read_header(), func_response_read_headers(), func_write_header(), func_write_param(), function_iaxpeer(), function_ooh323_read(), function_ooh323_write(), fxo_pvt(), hangup(), iax2_answer(), iax2_call(), iax2_digit_begin(), iax2_digit_end(), iax2_fixup(), iax2_hangup(), iax2_indicate(), iax2_prov_app(), iax2_queryoption(), iax2_sendhtml(), iax2_sendimage(), iax2_sendtext(), iax2_setoption(), iax2_transfer(), iax2_write(), jingle_answer(), jingle_call(), jingle_digit_begin(), jingle_digit_end(), jingle_fixup(), jingle_get_rtp_peer(), jingle_hangup(), jingle_indicate(), jingle_read(), jingle_sendtext(), jingle_write(), load_stream_readqueue(), local_call(), local_hangup(), manager_optimize_away(), mbl_answer(), mbl_call(), mbl_digit_end(), mbl_fixup(), mbl_hangup(), mbl_read(), mbl_write(), media_hangup(), mock_channel_hangup(), mock_channel_indicate(), mock_channel_read(), mock_channel_write(), mock_channel_write_stream(), my_get_sigpvt_bridged_channel(), native_bridge_is_capable(), native_chan_changed(), native_start(), native_stop(), ooh323_answer(), ooh323_call(), ooh323_digit_begin(), ooh323_digit_end(), ooh323_fixup(), ooh323_get_codec(), ooh323_get_rtp_peer(), ooh323_get_vrtp_peer(), ooh323_hangup(), ooh323_indicate(), ooh323_queryoption(), ooh323_read(), ooh323_set_rtp_peer(), ooh323_write(), pjsip_acf_channel_read(), pjsip_acf_dtmf_mode_read(), pjsip_acf_dtmf_mode_write(), pjsip_acf_media_offer_read(), pjsip_acf_media_offer_write(), pjsip_acf_moh_passthrough_read(), pjsip_acf_moh_passthrough_write(), pjsip_acf_session_refresh_write(), pjsip_app_hangup_handler(), push_notify_channel(), read_test(), rtp_call(), rtp_hangup(), rtp_read(), rtp_write(), send_direct_media_request(), sendtext_data_create(), snoop_fixup(), snoop_hangup(), snoop_read(), snoop_write(), stasis_app_channel_unreal_set_internal(), t38_framehook(), test_bridging_chan_hangup(), test_bridging_chan_indicate(), unistim_answer(), unistim_call(), unistim_fixup(), unistim_get_rtp_peer(), unistim_hangup(), unistim_indicate(), unistim_read(), unistim_set_rtp_peer(), unistim_ss(), and unistim_write().

ast_channel_tech_pvt_set()

void ast_channel_tech_pvt_set	(	struct ast_channel *	chan,
		void *	value
	)

Definition at line 575 of file channel_internal_api.c.

{
    chan->tech_pvt = value;
    if (value != NULL) {
        ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_BASE);
    }
}

References AST_CHANNEL_SNAPSHOT_INVALIDATE_BASE, ast_channel_snapshot_invalidate_segment(), NULL, ast_channel::tech_pvt, and value.

Referenced by ast_iax2_new(), AST_TEST_DEFINE(), ast_unreal_hangup(), ast_unreal_new_channels(), audiosocket_hangup(), audiosocket_request(), chan_pjsip_new(), channel_do_masquerade(), clear_session_and_channel(), console_hangup(), console_new(), dahdi_hangup(), dahdi_new(), destroy_dahdi_pvt(), iax2_hangup(), iax2_predestroy(), jingle_hangup(), jingle_new(), kill_hangup(), make_channel(), mbl_hangup(), mbl_new(), mock_channel_hangup(), multicast_rtp_request(), onCallCleared(), ooh323_destroy(), ooh323_hangup(), ooh323_new(), rtp_hangup(), snoop_hangup(), stasis_app_control_snoop(), test_bridging_chan_hangup(), unicast_rtp_request(), unistim_hangup_clean(), and unistim_new().

ast_channel_tech_set()

void ast_channel_tech_set	(	struct ast_channel *	chan,
		const struct ast_channel_tech *	value
	)

Definition at line 774 of file channel_internal_api.c.

{
    if (value->read_stream || value->write_stream) {
        ast_assert(value->read_stream && value->write_stream);
    }
 
    chan->tech = value;
}

References ast_assert, ast_channel::tech, and value.

Referenced by __ast_channel_alloc_ap(), ast_iax2_new(), AST_TEST_DEFINE(), ast_unreal_new_channels(), audiosocket_request(), chan_pjsip_new(), channel_do_masquerade(), console_new(), create_msg_q_chan(), dahdi_new(), do_notify(), handle_exec(), jingle_new(), make_channel(), mbl_new(), multicast_rtp_request(), ooh323_new(), rec_request(), stasis_app_control_snoop(), test_vm_api_create_mock_channel(), unicast_rtp_request(), and unistim_new().

ast_channel_tenantid()

const char * ast_channel_tenantid

(

const struct ast_channel *

chan

)

Definition at line 316 of file channel_internal_api.c.

{
    /* It's ok for tenantid to be empty, so no need to assert */
    return chan->linkedid.tenant_id;
}

References ast_channel::linkedid, and ast_channel_id::tenant_id.

Referenced by channel_snapshot_base_create(), func_channel_read(), and handle_showchan().

ast_channel_tenantid_set()

void ast_channel_tenantid_set	(	struct ast_channel *	chan,
		const char *	value
	)

Definition at line 322 of file channel_internal_api.c.

{
    if (ast_strlen_zero(value)) {
        return;
    }
    ast_copy_string(chan->linkedid.tenant_id, value, sizeof(chan->linkedid.tenant_id));
    ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_BASE);
}

References AST_CHANNEL_SNAPSHOT_INVALIDATE_BASE, ast_channel_snapshot_invalidate_segment(), ast_copy_string(), ast_strlen_zero(), ast_channel::linkedid, ast_channel_id::tenant_id, and value.

Referenced by func_channel_write_real().

ast_channel_timer()

struct ast_timer * ast_channel_timer

(

const struct ast_channel *

chan

)

Definition at line 738 of file channel_internal_api.c.

{
    return chan->timer;
}

References ast_channel::timer.

Referenced by __ast_channel_alloc_ap(), __ast_queue_frame(), __ast_read(), ast_channel_destructor(), ast_deactivate_generator(), and ast_settimeout_full().

ast_channel_timer_set()

void ast_channel_timer_set	(	struct ast_channel *	chan,
		struct ast_timer *	value
	)

Definition at line 742 of file channel_internal_api.c.

{
    chan->timer = value;
}

References ast_channel::timer, and value.

Referenced by __ast_channel_alloc_ap(), and ast_channel_destructor().

ast_channel_timingdata()

void * ast_channel_timingdata

(

const struct ast_channel *

chan

)

Definition at line 582 of file channel_internal_api.c.

{
    return chan->timingdata;
}

References ast_channel::timingdata.

Referenced by __ast_read(), and ast_settimeout_full().

ast_channel_timingdata_set()

void ast_channel_timingdata_set	(	struct ast_channel *	chan,
		void *	value
	)

Definition at line 586 of file channel_internal_api.c.

{
    chan->timingdata = value;
}

References ast_channel::timingdata, and value.

Referenced by ast_settimeout_full().

ast_channel_timingfd()

int ast_channel_timingfd

(

const struct ast_channel *

chan

)

Definition at line 475 of file channel_internal_api.c.

{
    return chan->timingfd;
}

References ast_channel::timingfd.

Referenced by __ast_channel_alloc_ap(), __ast_queue_frame(), __ast_read(), ast_readaudio_callback(), ast_settimeout_full(), and channel_do_masquerade().

ast_channel_timingfd_set()

void ast_channel_timingfd_set	(	struct ast_channel *	chan,
		int	value
	)

Definition at line 479 of file channel_internal_api.c.

{
    chan->timingfd = value;
}

References ast_channel::timingfd, and value.

Referenced by __ast_channel_alloc_ap(), and __ast_dummy_channel_alloc().

ast_channel_timingfunc()

ast_timing_func_t ast_channel_timingfunc

(

const struct ast_channel *

chan

)

Definition at line 1232 of file channel_internal_api.c.

{
    return chan->timingfunc;
}

References ast_channel::timingfunc.

Referenced by __ast_read(), ast_read_generator_actions(), background_detect_exec(), dial_exec_full(), handle_speechrecognize(), speech_background(), wait_for_winner(), and waitstream_core().

ast_channel_timingfunc_set()

void ast_channel_timingfunc_set	(	struct ast_channel *	chan,
		ast_timing_func_t	value
	)

Definition at line 1236 of file channel_internal_api.c.

{
    chan->timingfunc = value;
}

References ast_channel::timingfunc, and value.

Referenced by ast_settimeout_full().

ast_channel_topic()

struct stasis_topic * ast_channel_topic

(

struct ast_channel *

chan

)

A topic which publishes the events for a particular channel.

Since

12

If the given chan is NULL, ast_channel_topic_all() is returned.

Parameters

chan	Channel, or NULL.

Return values

Topic	for channel's events.
ast_channel_topic_all()	if chan is NULL.

Definition at line 1531 of file channel_internal_api.c.

{
    if (!chan) {
        return ast_channel_topic_all();
    }
 
    return chan->topic;
}

References ast_channel_topic_all(), and ast_channel::topic.

Referenced by ari_bridges_play_new(), ast_ari_bridges_record(), ast_channel_forward_endpoint(), ast_channel_internal_setup_topics(), ast_channel_publish_blob(), ast_channel_publish_cached_blob(), ast_channel_publish_final_snapshot(), ast_channel_publish_snapshot(), ast_multi_object_blob_single_channel_publish(), AST_TEST_DEFINE(), detect_callback(), forwards_create_channel(), local_optimization_finished_cb(), local_optimization_started_cb(), manager_mute_mixmonitor(), meetme_stasis_generate_msg(), mixmonitor_exec(), moh_post_start(), moh_post_stop(), publish_chanspy_message(), publish_local_bridge_message(), publish_message_for_channel_topics(), queue_publish_multi_channel_blob(), report_fax_status(), report_receive_fax_status(), report_send_fax_status(), send_call_pickup_stasis_message(), send_conf_stasis(), stasis_app_control_publish(), stop_mixmonitor_full(), and talk_detect_audiohook_cb().

ast_channel_transfercapability()

unsigned short ast_channel_transfercapability

(

const struct ast_channel *

chan

)

Definition at line 507 of file channel_internal_api.c.

{
    return chan->transfercapability;
}

References ast_channel::transfercapability.

Referenced by ast_ari_channels_dial(), ast_var_channels_table(), begin_dial_prerun(), dahdi_call(), dial_exec_full(), func_channel_read(), and ooh323_call().

ast_channel_transfercapability_set()

void ast_channel_transfercapability_set	(	struct ast_channel *	chan,
		unsigned short	value
	)

Definition at line 511 of file channel_internal_api.c.

{
    chan->transfercapability = value;
}

References ast_channel::transfercapability, and value.

Referenced by ast_ari_channels_dial(), begin_dial_prerun(), dial_exec_full(), and func_channel_write_real().

ast_channel_unbridged()

int ast_channel_unbridged

(

struct ast_channel *

chan

)

This function will check if the bridge needs to be re-evaluated due to external changes.

Parameters

chan	Channel on which to check the unbridge_eval flag

Returns

Returns 0 if the flag is down or 1 if the flag is up.

Definition at line 1020 of file channel_internal_api.c.

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

References ast_channel_lock, ast_channel_unbridged_nolock(), and ast_channel_unlock.

Referenced by ast_channel_is_leaving_bridge(), and bridge_channel_wait().

ast_channel_unbridged_nolock()

int ast_channel_unbridged_nolock

(

struct ast_channel *

chan

)

ast_channel_unbridged variant. Use this if the channel is already locked prior to calling.

Parameters

chan	Channel on which to check the unbridge flag

Returns

Returns 0 if the flag is down or 1 if the flag is up.

Definition at line 1015 of file channel_internal_api.c.

{
    return chan->unbridged;
}

References ast_channel::unbridged.

Referenced by ast_channel_unbridged().

ast_channel_undefer_dtmf()

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

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

References ast_channel_clear_flag(), and AST_FLAG_DEFER_DTMF.

Referenced by __adsi_transmit_messages().

ast_channel_uniqueid()

const char * ast_channel_uniqueid

(

const struct ast_channel *

chan

)

Definition at line 304 of file channel_internal_api.c.

{
    ast_assert(chan->uniqueid.unique_id[0] != '\0');
    return chan->uniqueid.unique_id;
}

References ast_assert, ast_channel_id::unique_id, and ast_channel::uniqueid.

Referenced by __ast_change_name_nolink(), action_confbridgelist_item(), action_dahdishowchannels(), app_exec(), app_subscribe_channel(), app_unsubscribe_channel(), apply_negotiated_sdp_stream(), aqm_exec(), ari_channels_handle_originate_with_id(), ari_channels_handle_snoop_channel(), ast_ari_channels_create(), ast_attended_transfer_message_add_app(), ast_attended_transfer_message_add_link(), ast_attended_transfer_message_add_threeway(), ast_attended_transfer_message_create(), ast_blind_transfer_message_create(), ast_bridge_blob_create(), ast_bridge_publish_enter(), ast_bridge_set_single_src_video_mode(), ast_bridge_snapshot_create(), ast_bridge_transfer_blind(), ast_bridge_update_talker_src_video_mode(), ast_cel_publish_event(), ast_channel_by_uniqueid_cb(), ast_channel_log(), ast_channel_move(), ast_channel_publish_cached_blob(), ast_channel_publish_dial_internal(), ast_channel_publish_final_snapshot(), ast_channel_publish_snapshot(), ast_do_pickup(), ast_endpoint_add_channel(), ast_str_retrieve_variable(), AST_TEST_DEFINE(), ast_var_channels_table(), blind_transfer_bridge(), bridge_channel_depart(), bridge_channel_snapshot_pair_init(), bridge_moh_create(), bridge_stasis_push_peek(), build_conf(), call(), chan_pjsip_fixup(), chan_pjsip_indicate(), chan_pjsip_new(), chan_pjsip_session_end(), channel_replaced_cb(), channel_snapshot_base_create(), conf_rec_name(), conf_run(), conf_send_event_to_participants(), create_parked_subscription_full(), detect_callback(), fast_originate(), fax_session_new(), find_by_uniqueid(), find_conf_realtime(), forwards_create_channel(), func_channel_read(), generate_status(), handle_showchan(), internal_bridge_after_cb(), jingle_enable_video(), jingle_set_owner(), local_channel_optimization_blob(), local_optimization_started_cb(), manager_mute_mixmonitor(), manager_park(), manager_park_bridged(), manager_queues_status(), masq_match_cb(), meetme_menu_admin_extended(), meetmemute(), minivm_mwi_exec(), mixmonitor_exec(), moh_post_start(), moh_post_stop(), multicast_rtp_request(), notify_new_message(), pack_channel_into_message(), park_and_announce_app_exec(), park_common_setup2(), park_local_transfer(), parking_blind_transfer_park(), parking_park_bridge_channel(), play_on_channel(), publish_chanspy_message(), publish_local_bridge_message(), queue_exec(), queue_stasis_data_alloc(), record_file(), refer_blind_callback(), report_fax_status(), report_receive_fax_status(), report_send_fax_status(), rna(), rqm_exec(), serialize_showchan(), setup_env(), setup_mixmonitor(), sfu_topologies_on_join(), sfu_topologies_on_source_change(), softmix_bridge_stream_sources_update(), start_rtp(), stasis_app_bridge_playback_channel_add(), stasis_app_control_find_by_channel(), stasis_app_control_get_channel_id(), stasis_app_control_snoop(), stasis_app_exec(), stasis_app_subscribe_channel(), stop_mixmonitor_full(), talk_detect_audiohook_cb(), test_cel_generate_peer_str(), try_calling(), unicast_rtp_request(), unistim_set_owner(), vm_execmain(), wait_for_answer(), and wait_our_turn().

ast_channel_unlink()

void ast_channel_unlink

(

struct ast_channel *

chan

)

Remove a channel from the global channels container.

Parameters

chan	channel to remove

In a case where it is desired that a channel not be available in any lookups in the global channels conatiner, use this function.

Definition at line 10551 of file channel.c.

{
    ao2_unlink(channels, chan);
}

References ao2_unlink, and channels.

Referenced by create_msg_q_chan().

ast_channel_unregister()

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

Unregister a channel technology.

Definition at line 570 of file channel.c.

{
    struct chanlist *chan;
 
    ast_debug(5, "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(5, "Unregistered channel type '%s'\n", tech->type);
            break;
        }
    }
    AST_LIST_TRAVERSE_SAFE_END;
 
    AST_RWLIST_UNLOCK(&backends);
}

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::chan, chanlist::list, chanlist::tech, and ast_channel::tech.

Referenced by __unload_module(), channels_shutdown(), load_module(), local_shutdown(), unload_module(), and unregister_channel_tech().

ast_channel_unsuppress()

int ast_channel_unsuppress	(	struct ast_channel *	chan,
		unsigned int	direction,
		enum ast_frame_type	frametype
	)

Stop suppressing of a frame type on a channel.

Note

The channel should be locked before calling this function.

Parameters

chan	The channel to stop suppressing
direction	The direction in which to stop suppressing
frametype	The type of frame (AST_FRAME_VOICE, etc) to stop suppressing

Return values

0	Success
-1	Failure

Definition at line 10861 of file channel.c.

{
    const struct ast_datastore_info *datastore_info = NULL;
    struct ast_datastore *datastore = NULL;
    struct suppress_data *suppress;
 
    if (!(datastore_info = suppress_get_datastore_information(frametype))) {
        ast_log(LOG_WARNING, "Attempted to unsuppress an unsupported frame type (%u).\n", frametype);
        return -1;
    }
 
    if (!(datastore = ast_channel_datastore_find(chan, datastore_info, NULL))) {
        /* Nothing to do! */
        return 0;
    }
 
    suppress = datastore->data;
 
    suppress->direction &= ~(direction);
 
    if (suppress->direction == 0) {
        /* Nothing left to suppress.  Bye! */
        ast_framehook_detach(chan, suppress->framehook_id);
        ast_channel_datastore_remove(chan, datastore);
        ast_datastore_free(datastore);
    }
 
    return 0;
}

References ast_channel_datastore_find(), ast_channel_datastore_remove(), ast_datastore_free(), ast_framehook_detach(), ast_log, ast_datastore::data, suppress_data::direction, suppress_data::framehook_id, suppress_data::frametype, LOG_WARNING, NULL, and suppress_get_datastore_information().

Referenced by app_control_unmute(), and mute_channel().

ast_channel_update_connected_line()

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

Indicate that the connected line information has changed.

Since

1.8

Parameters

chan	Asterisk channel to indicate connected line information
connected	Connected line information
update	What connected line information to update. NULL if all.

Definition at line 9115 of file channel.c.

{
    unsigned char data[1024];   /* This should be large enough */
    size_t datalen;
 
    datalen = ast_connected_line_build_data(data, sizeof(data), connected, update);
    if (datalen == (size_t) -1) {
        return;
    }
 
    ast_indicate_data(chan, AST_CONTROL_CONNECTED_LINE, data, datalen);
}

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

Referenced by agent_run(), app_exec(), ast_channel_connected_line_sub(), ast_do_pickup(), connectedline_write(), update_connected_line_from_peer(), and wait_for_answer().

ast_channel_update_redirecting()

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

Indicate that the redirecting id has changed.

Since

1.8

Parameters

chan	Asterisk channel to indicate redirecting id information
redirecting	Redirecting id information
update	What redirecting information to update. NULL if all.

Definition at line 10306 of file channel.c.

{
    unsigned char data[1024];   /* This should be large enough */
    size_t datalen;
 
    datalen = ast_redirecting_build_data(data, sizeof(data), redirecting, update);
    if (datalen == (size_t) -1) {
        return;
    }
 
    ast_indicate_data(chan, AST_CONTROL_REDIRECTING, data, datalen);
}

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

Referenced by ast_channel_redirecting_sub(), call_forward_inherit(), do_forward(), redirecting_write(), and wait_for_answer().

ast_channel_userfield()

const char * ast_channel_userfield

(

const struct ast_channel *

chan

)

Referenced by channel_do_masquerade(), channel_snapshot_base_create(), and func_channel_read().

ast_channel_varshead()

struct varshead * ast_channel_varshead

(

struct ast_channel *

chan

)

Definition at line 933 of file channel_internal_api.c.

{
    return &chan->varshead;
}

References ast_channel::varshead.

Referenced by __ast_channel_alloc_ap(), __ast_dummy_channel_alloc(), ast_cel_fabricate_channel_from_event(), ast_channel_destructor(), ast_channel_get_vars(), ast_channel_inherit_variables(), ast_dummy_channel_destructor(), ast_str_retrieve_variable(), ast_str_substitute_variables_full2(), ast_unreal_call_setup(), chan_cleanup(), clearvar_prefix(), clone_variables(), eval_exten_read(), external_media_audiosocket_tcp(), external_media_rtp_udp(), generate_status(), handle_show_chanvar(), handle_showchan(), hashkeys_read(), hashkeys_read2(), inherit_channel_vars_from_id(), lua_get_variable(), lua_get_variable_value(), pbx_builtin_getvar_helper(), pbx_builtin_pushvar_helper(), pbx_builtin_serialize_variables(), pbx_builtin_setvar_helper(), pbx_substitute_variables_helper(), pbx_substitute_variables_helper_full_location(), and peek_read().

ast_channel_varshead_set()

void ast_channel_varshead_set	(	struct ast_channel *	chan,
		struct varshead *	value
	)

Definition at line 973 of file channel_internal_api.c.

{
    chan->varshead = *value;
}

References value, and ast_channel::varshead.

ast_channel_visible_indication()

int ast_channel_visible_indication

(

const struct ast_channel *

chan

)

Definition at line 483 of file channel_internal_api.c.

{
    return chan->visible_indication;
}

References ast_channel::visible_indication.

Referenced by channel_do_masquerade(), and pre_bridge_setup().

ast_channel_visible_indication_set()

void ast_channel_visible_indication_set	(	struct ast_channel *	chan,
		int	value
	)

Definition at line 487 of file channel_internal_api.c.

{
    chan->visible_indication = value;
}

References value, and ast_channel::visible_indication.

Referenced by dial_exec_full(), and indicate_data_internal().

ast_channel_vstream()

struct ast_filestream * ast_channel_vstream

(

const struct ast_channel *

chan

)

Definition at line 630 of file channel_internal_api.c.

{
    return chan->vstream;
}

References ast_channel::vstream.

Referenced by ast_hangup(), ast_openvstream(), ast_stopstream(), and filehelper().

ast_channel_vstream_set()

void ast_channel_vstream_set	(	struct ast_channel *	chan,
		struct ast_filestream *	value
	)

Definition at line 634 of file channel_internal_api.c.

{
    chan->vstream = value;
}

References value, and ast_channel::vstream.

Referenced by ast_hangup(), ast_stopstream(), filehelper(), and filestream_close().

ast_channel_vstreamid()

int ast_channel_vstreamid

(

const struct ast_channel *

chan

)

Definition at line 499 of file channel_internal_api.c.

{
    return chan->vstreamid;
}

References ast_channel::vstreamid.

Referenced by filestream_close().

ast_channel_vstreamid_set()

void ast_channel_vstreamid_set	(	struct ast_channel *	chan,
		int	value
	)

Definition at line 503 of file channel_internal_api.c.

{
    chan->vstreamid = value;
}

References value, and ast_channel::vstreamid.

Referenced by __ast_channel_alloc_ap(), ast_readvideo_callback(), and filestream_close().

ast_channel_whentohangup()

struct timeval * ast_channel_whentohangup

(

struct ast_channel *

chan

)

Definition at line 929 of file channel_internal_api.c.

{
    return &chan->whentohangup;
}

References ast_channel::whentohangup.

Referenced by __ast_pbx_run(), ast_channel_cmpwhentohangup_tv(), ast_check_hangup(), ast_var_channels_table(), ast_waitfor_nandfds(), begin_dial_prerun(), dial_exec_full(), generate_status(), handle_showchan(), ring_entry(), serialize_showchan(), timeout_read(), and timeout_write().

ast_channel_whentohangup_set()

void ast_channel_whentohangup_set	(	struct ast_channel *	chan,
		struct timeval *	value
	)

Precondition

chan is locked

Definition at line 969 of file channel_internal_api.c.

{
    chan->whentohangup = *value;
}

References value, and ast_channel::whentohangup.

Referenced by ast_channel_setwhentohangup_tv(), and dial_exec_full().

ast_channel_writeformat()

struct ast_format * ast_channel_writeformat

(

struct ast_channel *

chan

)

Definition at line 861 of file channel_internal_api.c.

{
    return chan->writeformat;
}

References ast_channel::writeformat.

Referenced by adsi_transmit_message_full(), agent_login_exec(), alarmreceiver_exec(), ast_bridge_channel_restore_formats(), ast_channel_start_silence_generator(), ast_channel_yank(), ast_openstream_full(), ast_read_generator_actions(), ast_set_write_format_path(), ast_streamfile(), ast_write_stream(), audiosocket_exec(), bridge_channel_internal_join(), broadcast_exec(), chan_pjsip_read_stream(), chan_pjsip_write_stream(), channel_do_masquerade(), chanspy_exec(), dahdiscan_exec(), extenspy_exec(), fax_gateway_framehook(), filehelper(), func_channel_read(), generate_status(), generator_force(), generic_fax_exec(), handle_showchan(), handle_streamfile(), jingle_read(), jingle_write(), linear_alloc(), moh_alloc(), moh_files_alloc(), moh_files_write_format_change(), mp3_exec(), ooh323_rtp_read(), ooh323_set_rtp_peer(), ooh323_set_write_format(), ooh323_write(), playtones_alloc(), send_waveform_to_channel(), serialize_showchan(), set_caps(), socket_process_helper(), test_vm_api_create_mock_channel(), tonepair_alloc(), unistim_rtp_read(), and unistim_write().

ast_channel_writetrans()

struct ast_trans_pvt * ast_channel_writetrans

(

const struct ast_channel *

chan

)

Definition at line 762 of file channel_internal_api.c.

{
    return chan->writetrans;
}

References ast_channel::writetrans.

Referenced by __ast_read(), ast_channel_destructor(), ast_set_write_format_path(), ast_write_stream(), chan_pjsip_write_stream(), free_translation(), generate_status(), handle_showchan(), and serialize_showchan().

ast_channel_writetrans_set()

void ast_channel_writetrans_set	(	struct ast_channel *	chan,
		struct ast_trans_pvt *	value
	)

Definition at line 766 of file channel_internal_api.c.

{
    chan->writetrans = value;
}

References value, and ast_channel::writetrans.

Referenced by ast_set_write_format_path(), and free_translation().

ast_channel_yank()

struct ast_channel * ast_channel_yank

(

struct ast_channel *

yankee

)

Gain control of a channel in the system.

Since

12

The intention of this function is to take a channel that currently is running in one thread and gain control of it in the current thread. This can be used to redirect a channel to a different place in the dialplan, for instance.

Note

This function is NOT intended to be used on bridged channels. If you need to control a bridged channel, you can set a callback to be called once the channel exits the bridge, and run your controlling logic in that callback

XXX Put name of callback-setting function in above paragraph once it is written

Note

When this function returns successfully, the yankee channel is in a state where it cannot be used any further. Always use the returned channel instead.

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

The dialplan location on the returned channel is where the channel should be started in the dialplan if it is returned to it.

Parameters

yankee

The channel to gain control of

Return values

NULL	Could not gain control of the channel
non-NULL	The channel

Definition at line 10615 of file channel.c.

{
    struct ast_channel *yanked_chan;
    struct {
        char *accountcode;
        char *exten;
        char *context;
        char *name;
        int amaflags;
        int priority;
        struct ast_format *readformat;
        struct ast_format *writeformat;
    } my_vars = { 0, };
 
    ast_channel_lock(yankee);
    my_vars.accountcode = ast_strdupa(ast_channel_accountcode(yankee));
    my_vars.exten = ast_strdupa(ast_channel_exten(yankee));
    my_vars.context = ast_strdupa(ast_channel_context(yankee));
    my_vars.name = ast_strdupa(ast_channel_name(yankee));
    my_vars.amaflags = ast_channel_amaflags(yankee);
    my_vars.priority = ast_channel_priority(yankee);
    /* The priority as returned by ast_channel_yank is where the channel
     * should go if the dialplan is executed on it. If the channel is
     * already executing dialplan then the priority currently set is
     * where it is currently. We increment it so it becomes where it should
     * execute.
     */
    if (ast_test_flag(ast_channel_flags(yankee), AST_FLAG_IN_AUTOLOOP)) {
        my_vars.priority++;
    }
    my_vars.writeformat = ao2_bump(ast_channel_writeformat(yankee));
    my_vars.readformat = ao2_bump(ast_channel_readformat(yankee));
    ast_channel_unlock(yankee);
 
    /* Do not hold any channel locks while calling channel_alloc() since the function
     * locks the channel container when linking the new channel in. */
    if (!(yanked_chan = ast_channel_alloc(0, AST_STATE_DOWN, 0, 0, my_vars.accountcode,
                    my_vars.exten, my_vars.context, NULL, yankee, my_vars.amaflags,
                    "Surrogate/%s", my_vars.name))) {
        ao2_cleanup(my_vars.writeformat);
        ao2_cleanup(my_vars.readformat);
        return NULL;
    }
 
    /* Make formats okay */
    ast_channel_set_readformat(yanked_chan, my_vars.readformat);
    ast_channel_set_writeformat(yanked_chan, my_vars.writeformat);
    ao2_cleanup(my_vars.readformat);
    ao2_cleanup(my_vars.writeformat);
    ast_channel_priority_set(yanked_chan, my_vars.priority);
 
    ast_channel_unlock(yanked_chan);
 
    if (ast_channel_move(yanked_chan, yankee)) {
        ast_hangup(yanked_chan);
        return NULL;
    }
 
    return yanked_chan;
}

References ast_channel::accountcode, ast_channel::amaflags, ao2_bump, ao2_cleanup, ast_channel_accountcode(), ast_channel_alloc, ast_channel_amaflags(), ast_channel_context(), ast_channel_exten(), ast_channel_flags(), ast_channel_lock, ast_channel_move(), ast_channel_name(), ast_channel_priority(), ast_channel_priority_set(), ast_channel_readformat(), ast_channel_set_readformat(), ast_channel_set_writeformat(), ast_channel_unlock, ast_channel_writeformat(), AST_FLAG_IN_AUTOLOOP, ast_hangup(), AST_STATE_DOWN, ast_strdupa, ast_test_flag, ast_channel::context, ast_channel::exten, ast_channel::name, NULL, ast_channel::priority, ast_channel::readformat, and ast_channel::writeformat.

Referenced by ast_async_goto(), and ast_bridge_add_channel().

ast_channel_zone()

struct ast_tone_zone * ast_channel_zone

(

const struct ast_channel *

chan

)

Definition at line 746 of file channel_internal_api.c.

{
    return chan->zone;
}

References ast_channel::zone.

Referenced by ast_app_dtget(), ast_channel_destructor(), ast_control_tone(), ast_var_channels_table(), dial_handle_playtones(), func_channel_read(), func_channel_write_real(), handle_playtones(), indicate_data_internal(), pbx_builtin_waitexten(), play_dialtone(), read_exec(), and readexten_exec().

ast_channel_zone_set()

void ast_channel_zone_set	(	struct ast_channel *	chan,
		struct ast_tone_zone *	value
	)

Definition at line 750 of file channel_internal_api.c.

{
    chan->zone = value;
}

References value, and ast_channel::zone.

Referenced by ast_channel_destructor(), chan_pjsip_new(), and func_channel_write_real().

ast_channeltype_list()

struct ast_variable * ast_channeltype_list

(

void

)

return an ast_variable list of channeltypes

Definition at line 188 of file channel.c.

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

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, ast_variable_new, NULL, chanlist::tech, and var.

Referenced by ast_var_channel_types(), and ast_var_channel_types_table().

ast_check_hangup()

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

Check to see if a channel is needing hang up.

Definition at line 445 of file channel.c.

{
    if (ast_channel_softhangup_internal_flag(chan))     /* yes if soft hangup flag set */
        return 1;
    if (ast_tvzero(*ast_channel_whentohangup(chan)))    /* no if no hangup scheduled */
        return 0;
    if (ast_tvdiff_ms(*ast_channel_whentohangup(chan), ast_tvnow()) > 0)        /* no if hangup time has not come yet. */
        return 0;
    ast_debug(4, "Hangup time has come: %" PRIi64 "\n", ast_tvdiff_ms(*ast_channel_whentohangup(chan), ast_tvnow()));
    ast_test_suite_event_notify("HANGUP_TIME", "Channel: %s", ast_channel_name(chan));
    ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_TIMEOUT); /* record event */
    return 1;
}

References ast_channel_name(), ast_channel_softhangup_internal_flag(), ast_channel_softhangup_internal_flag_add(), ast_channel_whentohangup(), ast_debug, AST_SOFTHANGUP_TIMEOUT, ast_test_suite_event_notify, ast_tvdiff_ms(), ast_tvnow(), and ast_tvzero().

Referenced by __ast_pbx_run(), __ast_read(), agent_request_exec(), agi_exec(), announce_thread(), app_exec(), ast_bridge_setup_after_goto(), ast_call(), ast_check_hangup_locked(), ast_indicate_data(), ast_raw_answer_with_stream_topology(), ast_readstring_full(), ast_recvtext(), ast_sendtext_data(), ast_transfer_protocol(), ast_unreal_fixup(), ast_waitfordigit_full(), ast_write_stream(), autoservice_run(), call_forward_inherit(), channel_spy(), common_exec(), conf_play(), conf_run(), confbridge_exec(), dahdi_sendtext(), dahdi_setoption(), depart_channel(), dial_exec_full(), directory_exec(), dundi_lookup_internal(), eagi_exec(), eivr_comm(), fax_gateway_framehook(), find_cache(), findmeexec(), func_channel_read(), gosub_run(), handle_sendimage(), join_conference_bridge(), launch_asyncagi(), lua_check_hangup(), pbx_builtin_incomplete(), pbx_builtin_waitexten(), play_on_channel(), playback_exec(), read_exec(), readexten_exec(), run_agi(), stasis_app_exec(), transfer_target_framehook_cb(), try_calling(), vm_authenticate(), and wait_for_answer().

ast_check_hangup_locked()

int ast_check_hangup_locked

(

struct ast_channel *

chan

)

Definition at line 459 of file channel.c.

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

References ast_channel_lock, ast_channel_unlock, and ast_check_hangup().

Referenced by action_redirect(), agent_run(), ast_app_exec_sub(), ast_bridge_channel_feature_digit(), bridge_channel_handle_action(), bridge_reconfigured_connected_line_update(), bridge_stasis_run_cb(), bridgewait_exec(), dial_exec_full(), launch_asyncagi(), pbx_builtin_saynumber(), pbx_builtin_sayordinal(), and stasis_app_exec().

ast_connected_line_build_data()

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

Build the connected line information data frame.

Since

1.8

Parameters

data	Buffer to fill with the frame data
datalen	Size of the buffer to fill
connected	Connected line information
update	What connected line information to build. NULL if all.

Return values

-1	if error
Amount	of data buffer used

Definition at line 8719 of file channel.c.

{
    int32_t value;
    size_t pos = 0;
    int res;
 
    static const struct ast_party_id_ies ies = {
        .name.str = AST_CONNECTED_LINE_NAME,
        .name.char_set = AST_CONNECTED_LINE_NAME_CHAR_SET,
        .name.presentation = AST_CONNECTED_LINE_NAME_PRESENTATION,
        .name.valid = AST_CONNECTED_LINE_NAME_VALID,
 
        .number.str = AST_CONNECTED_LINE_NUMBER,
        .number.plan = AST_CONNECTED_LINE_NUMBER_PLAN,
        .number.presentation = AST_CONNECTED_LINE_NUMBER_PRESENTATION,
        .number.valid = AST_CONNECTED_LINE_NUMBER_VALID,
 
        .subaddress.str = AST_CONNECTED_LINE_SUBADDRESS,
        .subaddress.type = AST_CONNECTED_LINE_SUBADDRESS_TYPE,
        .subaddress.odd_even_indicator = AST_CONNECTED_LINE_SUBADDRESS_ODD_EVEN,
        .subaddress.valid = AST_CONNECTED_LINE_SUBADDRESS_VALID,
 
        .tag = AST_CONNECTED_LINE_TAG,
        .combined_presentation = AST_CONNECTED_LINE_ID_PRESENTATION,
    };
 
    static const struct ast_party_id_ies priv_ies = {
        .name.str = AST_CONNECTED_LINE_PRIV_NAME,
        .name.char_set = AST_CONNECTED_LINE_PRIV_NAME_CHAR_SET,
        .name.presentation = AST_CONNECTED_LINE_PRIV_NAME_PRESENTATION,
        .name.valid = AST_CONNECTED_LINE_PRIV_NAME_VALID,
 
        .number.str = AST_CONNECTED_LINE_PRIV_NUMBER,
        .number.plan = AST_CONNECTED_LINE_PRIV_NUMBER_PLAN,
        .number.presentation = AST_CONNECTED_LINE_PRIV_NUMBER_PRESENTATION,
        .number.valid = AST_CONNECTED_LINE_PRIV_NUMBER_VALID,
 
        .subaddress.str = AST_CONNECTED_LINE_PRIV_SUBADDRESS,
        .subaddress.type = AST_CONNECTED_LINE_PRIV_SUBADDRESS_TYPE,
        .subaddress.odd_even_indicator = AST_CONNECTED_LINE_PRIV_SUBADDRESS_ODD_EVEN,
        .subaddress.valid = AST_CONNECTED_LINE_PRIV_SUBADDRESS_VALID,
 
        .tag = AST_CONNECTED_LINE_PRIV_TAG,
        .combined_presentation = 0,/* Not sent. */
    };
 
    /*
     * The size of integer values must be fixed in case the frame is
     * shipped to another machine.
     */
 
    /* Connected line frame version */
    if (datalen < pos + (sizeof(data[0]) * 2) + 1) {
        ast_log(LOG_WARNING, "No space left for connected line frame version\n");
        return -1;
    }
    data[pos++] = AST_CONNECTED_LINE_VERSION;
    data[pos++] = 1;
    data[pos++] = 2;/* Version 1 did not have a version ie */
 
    res = party_id_build_data(data + pos, datalen - pos, &connected->id,
        "connected line", &ies, update ? &update->id : NULL);
    if (res < 0) {
        return -1;
    }
    pos += res;
 
    res = party_id_build_data(data + pos, datalen - pos, &connected->priv,
        "connected line priv", &priv_ies, update ? &update->priv : NULL);
    if (res < 0) {
        return -1;
    }
    pos += res;
 
    /* 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);
 
    return pos;
}

References AST_CONNECTED_LINE_ID_PRESENTATION, AST_CONNECTED_LINE_NAME, AST_CONNECTED_LINE_NAME_CHAR_SET, AST_CONNECTED_LINE_NAME_PRESENTATION, AST_CONNECTED_LINE_NAME_VALID, AST_CONNECTED_LINE_NUMBER, AST_CONNECTED_LINE_NUMBER_PLAN, AST_CONNECTED_LINE_NUMBER_PRESENTATION, AST_CONNECTED_LINE_NUMBER_VALID, AST_CONNECTED_LINE_PRIV_NAME, AST_CONNECTED_LINE_PRIV_NAME_CHAR_SET, AST_CONNECTED_LINE_PRIV_NAME_PRESENTATION, AST_CONNECTED_LINE_PRIV_NAME_VALID, AST_CONNECTED_LINE_PRIV_NUMBER, AST_CONNECTED_LINE_PRIV_NUMBER_PLAN, AST_CONNECTED_LINE_PRIV_NUMBER_PRESENTATION, AST_CONNECTED_LINE_PRIV_NUMBER_VALID, AST_CONNECTED_LINE_PRIV_SUBADDRESS, AST_CONNECTED_LINE_PRIV_SUBADDRESS_ODD_EVEN, AST_CONNECTED_LINE_PRIV_SUBADDRESS_TYPE, AST_CONNECTED_LINE_PRIV_SUBADDRESS_VALID, AST_CONNECTED_LINE_PRIV_TAG, 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_CONNECTED_LINE_TAG, AST_CONNECTED_LINE_VERSION, ast_log, connected, LOG_WARNING, ast_party_id_ies::name, NULL, party_id_build_data(), ast_party_name_ies::str, update(), and value.

Referenced by after_bridge_move_channel(), ast_channel_queue_connected_line_update(), ast_channel_update_connected_line(), bridge_reconfigured_connected_line_update(), indicate_connected_line(), send_colp_to_agent(), and unreal_colp_redirect_indicate().

ast_connected_line_copy_from_caller()

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

Copy the caller information to the connected line information.

Since

1.8

Parameters

dest	Destination connected line information
src	Source caller information

Note

Assumes locks are already acquired

Definition at line 8315 of file channel.c.

{
    ast_party_id_copy(&dest->id, &src->id);
    ast_party_id_copy(&dest->ani, &src->ani);
    dest->ani2 = src->ani2;
}

References ast_party_caller::ani, ast_party_connected_line::ani, ast_party_caller::ani2, ast_party_connected_line::ani2, ast_party_id_copy(), ast_party_caller::id, and ast_party_connected_line::id.

Referenced by after_bridge_move_channel(), agent_request_exec(), app_exec(), ast_ari_channels_dial(), ast_do_pickup(), ast_unreal_call_setup(), begin_dial_prerun(), bridge_reconfigured_connected_line_update(), copy_caller_data(), dial_exec_full(), do_forward(), findmeexec(), park_local_transfer(), ring_entry(), update_connected_line_from_peer(), and wait_for_answer().

ast_connected_line_copy_to_caller()

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

Copy the connected line information to the caller information.

Since

1.8

Parameters

dest	Destination caller information
src	Source connected line information

Note

Assumes locks are already acquired

Definition at line 8322 of file channel.c.

{
    ast_party_id_copy(&dest->id, &src->id);
    ast_party_id_copy(&dest->ani, &src->ani);
 
    dest->ani2 = src->ani2;
}

References ast_party_caller::ani, ast_party_connected_line::ani, ast_party_caller::ani2, ast_party_connected_line::ani2, ast_party_id_copy(), ast_party_caller::id, and ast_party_connected_line::id.

Referenced by ast_unreal_call_setup(), and unreal_colp_redirect_indicate().

ast_connected_line_parse_data()

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

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

{
    size_t pos;
    unsigned char ie_len;
    unsigned char ie_id;
    int32_t value;
    int frame_version = 1;
    int combined_presentation = 0;
    int got_combined_presentation = 0;/* TRUE if got a combined name and number presentation 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) {
/* Connected line party frame version */
        case AST_CONNECTED_LINE_VERSION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line frame version (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            frame_version = data[pos];
            break;
/* Connected line party id name */
        case AST_CONNECTED_LINE_NAME:
            ast_free(connected->id.name.str);
            connected->id.name.str = ast_malloc(ie_len + 1);
            if (connected->id.name.str) {
                memcpy(connected->id.name.str, data + pos, ie_len);
                connected->id.name.str[ie_len] = 0;
            }
            break;
        case AST_CONNECTED_LINE_NAME_CHAR_SET:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line name char set (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->id.name.char_set = data[pos];
            break;
        case AST_CONNECTED_LINE_NAME_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line name presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->id.name.presentation = data[pos];
            break;
        case AST_CONNECTED_LINE_NAME_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line name valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->id.name.valid = data[pos];
            break;
/* Connected line party id number */
        case AST_CONNECTED_LINE_NUMBER:
            ast_free(connected->id.number.str);
            connected->id.number.str = ast_malloc(ie_len + 1);
            if (connected->id.number.str) {
                memcpy(connected->id.number.str, data + pos, ie_len);
                connected->id.number.str[ie_len] = 0;
            }
            break;
        case AST_CONNECTED_LINE_NUMBER_PLAN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line numbering plan (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->id.number.plan = data[pos];
            break;
        case AST_CONNECTED_LINE_NUMBER_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line number presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->id.number.presentation = data[pos];
            break;
        case AST_CONNECTED_LINE_NUMBER_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line number valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->id.number.valid = data[pos];
            break;
/* Connected line party id subaddress */
        case AST_CONNECTED_LINE_SUBADDRESS:
            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;
/* Connected line party tag */
        case AST_CONNECTED_LINE_TAG:
            ast_free(connected->id.tag);
            connected->id.tag = ast_malloc(ie_len + 1);
            if (connected->id.tag) {
                memcpy(connected->id.tag, data + pos, ie_len);
                connected->id.tag[ie_len] = 0;
            }
            break;
/* Connected line party id combined presentation */
        case AST_CONNECTED_LINE_ID_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line combined presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            combined_presentation = data[pos];
            got_combined_presentation = 1;
            break;
/* Private connected line party id name */
        case AST_CONNECTED_LINE_PRIV_NAME:
            ast_free(connected->priv.name.str);
            connected->priv.name.str = ast_malloc(ie_len + 1);
            if (connected->priv.name.str) {
                memcpy(connected->priv.name.str, data + pos, ie_len);
                connected->priv.name.str[ie_len] = 0;
            }
            break;
        case AST_CONNECTED_LINE_PRIV_NAME_CHAR_SET:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line private name char set (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->priv.name.char_set = data[pos];
            break;
        case AST_CONNECTED_LINE_PRIV_NAME_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line private name presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->priv.name.presentation = data[pos];
            break;
        case AST_CONNECTED_LINE_PRIV_NAME_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line private name valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->priv.name.valid = data[pos];
            break;
/* Private connected line party id number */
        case AST_CONNECTED_LINE_PRIV_NUMBER:
            ast_free(connected->priv.number.str);
            connected->priv.number.str = ast_malloc(ie_len + 1);
            if (connected->priv.number.str) {
                memcpy(connected->priv.number.str, data + pos, ie_len);
                connected->priv.number.str[ie_len] = 0;
            }
            break;
        case AST_CONNECTED_LINE_PRIV_NUMBER_PLAN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line private numbering plan (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->priv.number.plan = data[pos];
            break;
        case AST_CONNECTED_LINE_PRIV_NUMBER_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line private number presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->priv.number.presentation = data[pos];
            break;
        case AST_CONNECTED_LINE_PRIV_NUMBER_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line private number valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->priv.number.valid = data[pos];
            break;
/* Private connected line party id subaddress */
        case AST_CONNECTED_LINE_PRIV_SUBADDRESS:
            ast_free(connected->priv.subaddress.str);
            connected->priv.subaddress.str = ast_malloc(ie_len + 1);
            if (connected->priv.subaddress.str) {
                memcpy(connected->priv.subaddress.str, data + pos, ie_len);
                connected->priv.subaddress.str[ie_len] = 0;
            }
            break;
        case AST_CONNECTED_LINE_PRIV_SUBADDRESS_TYPE:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line private type of subaddress (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->priv.subaddress.type = data[pos];
            break;
        case AST_CONNECTED_LINE_PRIV_SUBADDRESS_ODD_EVEN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING,
                    "Invalid connected line private subaddress odd-even indicator (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->priv.subaddress.odd_even_indicator = data[pos];
            break;
        case AST_CONNECTED_LINE_PRIV_SUBADDRESS_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid connected line private subaddress valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            connected->priv.subaddress.valid = data[pos];
            break;
/* Private connected line party tag */
        case AST_CONNECTED_LINE_PRIV_TAG:
            ast_free(connected->priv.tag);
            connected->priv.tag = ast_malloc(ie_len + 1);
            if (connected->priv.tag) {
                memcpy(connected->priv.tag, data + pos, ie_len);
                connected->priv.tag[ie_len] = 0;
            }
            break;
/* Connected line party source */
        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;
/* Connected line party unknown element */
        default:
            ast_debug(1, "Unknown connected line element: %u (%u)\n",
                (unsigned) ie_id, (unsigned) ie_len);
            break;
        }
    }
 
    switch (frame_version) {
    case 1:
        /*
         * The other end is an earlier version that we need to adjust
         * for compatibility.
         */
        connected->id.name.valid = 1;
        connected->id.name.char_set = AST_PARTY_CHAR_SET_ISO8859_1;
        connected->id.number.valid = 1;
        if (got_combined_presentation) {
            connected->id.name.presentation = combined_presentation;
            connected->id.number.presentation = combined_presentation;
        }
        break;
    case 2:
        /* The other end is at the same level as we are. */
        break;
    default:
        /*
         * The other end is newer than we are.
         * We need to assume that they are compatible with us.
         */
        ast_debug(1, "Connected line frame has newer version: %u\n",
            (unsigned) frame_version);
        break;
    }
 
    return 0;
}

References AST_CONNECTED_LINE_ID_PRESENTATION, AST_CONNECTED_LINE_NAME, AST_CONNECTED_LINE_NAME_CHAR_SET, AST_CONNECTED_LINE_NAME_PRESENTATION, AST_CONNECTED_LINE_NAME_VALID, AST_CONNECTED_LINE_NUMBER, AST_CONNECTED_LINE_NUMBER_PLAN, AST_CONNECTED_LINE_NUMBER_PRESENTATION, AST_CONNECTED_LINE_NUMBER_VALID, AST_CONNECTED_LINE_PRIV_NAME, AST_CONNECTED_LINE_PRIV_NAME_CHAR_SET, AST_CONNECTED_LINE_PRIV_NAME_PRESENTATION, AST_CONNECTED_LINE_PRIV_NAME_VALID, AST_CONNECTED_LINE_PRIV_NUMBER, AST_CONNECTED_LINE_PRIV_NUMBER_PLAN, AST_CONNECTED_LINE_PRIV_NUMBER_PRESENTATION, AST_CONNECTED_LINE_PRIV_NUMBER_VALID, AST_CONNECTED_LINE_PRIV_SUBADDRESS, AST_CONNECTED_LINE_PRIV_SUBADDRESS_ODD_EVEN, AST_CONNECTED_LINE_PRIV_SUBADDRESS_TYPE, AST_CONNECTED_LINE_PRIV_SUBADDRESS_VALID, AST_CONNECTED_LINE_PRIV_TAG, 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_CONNECTED_LINE_TAG, AST_CONNECTED_LINE_VERSION, ast_debug, ast_free, ast_log, ast_malloc, AST_PARTY_CHAR_SET_ISO8859_1, ast_party_id_ies::combined_presentation, connected, LOG_WARNING, and value.

Referenced by __ast_read(), ast_channel_connected_line_sub(), indicate_connected_line(), socket_process_helper(), wait_for_answer(), and wait_for_winner().

ast_deactivate_generator()

void ast_deactivate_generator

(

struct ast_channel *

chan

)

Deactivate an active generator

Definition at line 2912 of file channel.c.

{
    ast_channel_lock(chan);
    deactivate_generator_nolock(chan);
    if (should_trigger_dtmf_emulating(chan)) {
        /* if in the middle of dtmf emulation keep 50 tick per sec timer on rolling */
        ast_timer_set_rate(ast_channel_timer(chan), 50);
    }
    ast_channel_unlock(chan);
}

References ast_channel_lock, ast_channel_timer(), ast_channel_unlock, ast_timer_set_rate(), deactivate_generator_nolock(), and should_trigger_dtmf_emulating().

Referenced by __ast_read(), app_exec(), ast_openstream_full(), ast_playtones_stop(), ast_read_generator_actions(), ast_tonepair_stop(), ast_write_stream(), channel_spy(), dial_exec_full(), do_broadcast(), generator_force(), local_ast_moh_stop(), old_milliwatt_exec(), and wait_for_answer().

ast_fdisset()

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

inlinestatic

Helper function for migrating select to poll.

Definition at line 2873 of file channel.h.

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

References dummy(), and ast_channel::x.

Referenced by do_monitor().

ast_get_channel_tech()

const struct ast_channel_tech * ast_get_channel_tech

(

const char *

name

)

Get a channel technology structure by name.

Parameters

name	name of technology to find

Returns

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

Get a channel technology structure by name.

Definition at line 592 of file channel.c.

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

References AST_RWLIST_RDLOCK, AST_RWLIST_TRAVERSE, AST_RWLIST_UNLOCK, name, NULL, and chanlist::tech.

Referenced by __ast_channel_alloc_ap(), _ast_device_state(), ast_cc_callback(), ast_presence_state_helper(), and ast_var_channel_types_table().

ast_get_group()

ast_group_t ast_get_group

(

const char *

s

)

Definition at line 7640 of file channel.c.

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

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

Referenced by build_device(), custom_group_handler(), func_channel_write_real(), group_handler(), and process_dahdi().

ast_get_namedgroups()

struct ast_namedgroups * ast_get_namedgroups

(

const char *

s

)

Create an ast_namedgroups set with group names from comma separated string.

Remove leading and trailing whitespace

Definition at line 7697 of file channel.c.

{
    struct ao2_container *namedgroups;
    char *piece;
    char *c;
 
    if (!s) {
        return NULL;
    }
 
    /*! \brief Remove leading and trailing whitespace */
    c = ast_trim_blanks(ast_strdupa(ast_skip_blanks(s)));
    if (ast_strlen_zero(c)) {
        return NULL;
    }
 
    namedgroups = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, 19,
        namedgroup_hash_cb, NULL, namedgroup_cmp_cb);
    if (!namedgroups) {
        return NULL;
    }
 
    while ((piece = strsep(&c, ","))) {
        struct namedgroup_member *member;
        size_t len;
 
        /* remove leading/trailing whitespace */
        piece = ast_strip(piece);
 
        len = strlen(piece);
        if (!len) {
            continue;
        }
 
        member = ao2_alloc_options(sizeof(*member) + len, NULL, AO2_ALLOC_OPT_LOCK_NOLOCK);
        if (!member) {
            ao2_ref(namedgroups, -1);
            return NULL;
        }
        strcpy(member->name, piece);/* Safe */
        member->hash = ast_str_hash(member->name);
 
        /* every group name may exist only once, delete duplicates */
        ao2_find(namedgroups, member, OBJ_POINTER | OBJ_UNLINK | OBJ_NODATA);
        ao2_link(namedgroups, member);
        ao2_ref(member, -1);
    }
 
    if (!ao2_container_count(namedgroups)) {
        /* There were no group names specified. */
        ao2_ref(namedgroups, -1);
        namedgroups = NULL;
    }
 
    return (struct ast_namedgroups *) namedgroups;
}

References AO2_ALLOC_OPT_LOCK_NOLOCK, ao2_alloc_options, ao2_container_alloc_hash, ao2_container_count(), ao2_find, ao2_link, ao2_ref, ast_skip_blanks(), ast_str_hash(), ast_strdupa, ast_strip(), ast_strlen_zero(), ast_trim_blanks(), c, len(), namedgroup_cmp_cb(), namedgroup_hash_cb(), NULL, OBJ_NODATA, OBJ_POINTER, OBJ_UNLINK, and strsep().

Referenced by func_channel_write_real(), named_groups_handler(), and process_dahdi().

ast_hangup()

void ast_hangup

(

struct ast_channel *

chan

)

Hang up a channel.

Note

Absolutely NO channel locks should be held before calling this function.

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 (NULL tolerant)

Hang up a channel.

Definition at line 2560 of file channel.c.

{
    /* Be NULL safe for RAII_VAR() usage. */
    if (!chan) {
        return;
    }
 
    ast_debug(1, "Channel %p '%s' hanging up.  Refs: %d\n", chan, ast_channel_name(chan),
        ao2_ref(chan, 0));
 
    ast_autoservice_stop(chan);
 
    ast_channel_lock(chan);
 
    while (ast_channel_masq(chan) || ast_channel_masqr(chan))  {
        CHANNEL_DEADLOCK_AVOIDANCE(chan);
    }
 
    /* Mark as a zombie so a masquerade cannot be setup on this channel. */
    ast_set_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE);
 
    ast_channel_unlock(chan);
 
    /*
     * XXX if running the hangup handlers here causes problems
     * because the handlers take too long to execute, we could move
     * the meat of this function into another thread.  A thread
     * where channels go to die.
     *
     * If this is done, ast_autoservice_chan_hangup_peer() will no
     * longer be needed.
     */
    ast_pbx_hangup_handler_run(chan);
    ao2_unlink(channels, chan);
    ast_channel_lock(chan);
 
    destroy_hooks(chan);
 
    free_translation(chan);
    /* Close audio stream */
    if (ast_channel_stream(chan)) {
        ast_closestream(ast_channel_stream(chan));
        ast_channel_stream_set(chan, NULL);
    }
    /* Close video stream */
    if (ast_channel_vstream(chan)) {
        ast_closestream(ast_channel_vstream(chan));
        ast_channel_vstream_set(chan, NULL);
    }
    if (ast_channel_sched(chan)) {
        ast_sched_context_destroy(ast_channel_sched(chan));
        ast_channel_sched_set(chan, NULL);
    }
 
    if (ast_channel_generatordata(chan)) {  /* Clear any tone stuff remaining */
        if (ast_channel_generator(chan) && ast_channel_generator(chan)->release) {
            ast_channel_generator(chan)->release(chan, ast_channel_generatordata(chan));
        }
    }
    ast_channel_generatordata_set(chan, NULL);
    ast_channel_generator_set(chan, NULL);
 
    if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING)) {
        ast_log(LOG_WARNING, "Hard hangup called by thread LWP %d on %s, while blocked by thread LWP %d in procedure %s!  Expect a failure\n",
            ast_get_tid(), ast_channel_name(chan), ast_channel_blocker_tid(chan),
            ast_channel_blockproc(chan));
        ast_assert(0);
    }
 
    if (ast_channel_tech(chan)->hangup) {
        ast_channel_tech(chan)->hangup(chan);
    }
 
    ast_channel_unlock(chan);
 
    ast_cc_offer(chan);
 
    ast_channel_unref(chan);
}

References ao2_ref, ao2_unlink, ast_assert, ast_autoservice_stop(), ast_cc_offer(), ast_channel_blocker_tid(), ast_channel_blockproc(), ast_channel_flags(), ast_channel_generator(), ast_channel_generator_set(), ast_channel_generatordata(), ast_channel_generatordata_set(), ast_channel_lock, ast_channel_masq(), ast_channel_masqr(), ast_channel_name(), ast_channel_sched(), ast_channel_sched_set(), ast_channel_stream(), ast_channel_stream_set(), ast_channel_tech(), ast_channel_unlock, ast_channel_unref, ast_channel_vstream(), ast_channel_vstream_set(), ast_closestream(), ast_debug, AST_FLAG_BLOCKING, AST_FLAG_ZOMBIE, ast_get_tid(), ast_log, ast_pbx_hangup_handler_run(), ast_sched_context_destroy(), ast_set_flag, ast_test_flag, CHANNEL_DEADLOCK_AVOIDANCE, channels, destroy_hooks(), free_translation(), hangup(), ast_channel_tech::hangup, LOG_WARNING, NULL, and ast_generator::release.

Referenced by __analog_handle_event(), __analog_ss_thread(), __ast_pbx_run(), __ast_request_and_dial(), alloc_playback_chan(), analog_handle_init_event(), analog_ss_thread(), announce_request(), announce_to_dial(), answer_exec_run(), ari_bridges_play_new(), ast_ari_bridges_record(), ast_async_goto(), ast_autoservice_chan_hangup_peer(), ast_bridge_add_channel(), ast_bridge_run_after_goto(), ast_call_forward(), ast_channel_yank(), ast_dial_destroy(), ast_dial_hangup(), ast_iax2_new(), ast_pbx_outgoing_exten_predial(), AST_TEST_DEFINE(), ast_unreal_hangup(), attended_transfer_bridge(), begin_dial_channel(), blind_transfer_bridge(), bridge_channel_control_thread(), bridge_moh_create(), build_conf(), call_pickup_incoming_request(), chan_data_destroy(), chan_pjsip_new(), chanavail_exec(), clear_caller(), conf_free(), conf_run(), conf_start_record(), console_new(), create_msg_q_chan(), dahdi_handle_event(), dahdi_new(), destroy_conference_bridge(), dial_exec_full(), do_forward(), do_hang(), do_monitor(), do_monitor_headset(), feature_attended_transfer(), generic_recall(), handle_call_forward(), handle_call_outgoing(), handle_exec(), handle_frame(), handle_init_event(), handle_timeout_trip(), hangup_playback(), hangupcalls(), hanguptree(), iax2_request(), jingle_action_session_initiate(), local_call(), make_channel(), mbl_ast_hangup(), media_request_helper(), meetme_menu_admin_extended(), moh_channel_thread(), monitor_dial(), mwi_thread(), my_distinctive_ring(), my_handle_notify_message(), ooh323_new(), park_local_transfer(), parking_blind_transfer_park(), pbx_outgoing_exec(), pbx_start_incoming_request(), push_announcer(), read_test(), recalling_exit(), refer_incoming_invite_request(), reject_incoming_call(), request_channel(), retransfer_enter(), safe_hangup(), snoop_stasis_thread(), stasis_app_control_snoop(), unistim_new(), and wait_for_answer().

ast_indicate()

int ast_indicate	(	struct ast_channel *	chan,
		int	condition
	)

Indicates condition of channel.

Note

Absolutely NO channel locks should be held before calling this function.

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

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

References ast_indicate_data(), and NULL.

Referenced by __ast_play_and_record(), answer_trunk_chan(), app_control_dtmf(), app_control_hold(), app_control_moh_start(), app_control_ring(), app_control_ring_stop(), app_control_silence_start(), app_control_unhold(), app_exec(), ast_bridge_channel_feature_digit(), ast_bridge_set_single_src_video_mode(), ast_bridge_update_talker_src_video_mode(), ast_raw_answer_with_stream_topology(), bridge_channel_do_callback(), bridge_channel_event_join_leave(), bridge_channel_handle_action(), bridge_channel_handle_control(), bridge_channel_handle_interval(), bridge_channel_internal_join(), caller_joined_bridge(), channel_do_masquerade(), cli_console_answer(), conf_run(), console_call(), dial_exec_full(), dial_trunk(), disa_exec(), do_forward(), dtmf_stream(), handle_frame(), handle_recordfile(), indicate_busy(), indicate_congestion(), mf_stream(), monitor_dial(), participant_entertainment_start(), participant_entertainment_stop(), pbx_builtin_incomplete(), pbx_builtin_proceeding(), pbx_builtin_progress(), pbx_builtin_ringing(), pbx_builtin_waitexten(), play_on_channel(), pre_bridge_setup(), queue_exec(), record_exec(), rna(), say_periodic_announcement(), say_position(), send_waveform_to_channel(), sf_stream(), simple_bridge_join(), sla_handle_hold_event(), sla_station_exec(), sla_trunk_exec(), softmix_bridge_join(), try_calling(), vm_exec(), and wait_for_answer().

ast_indicate_data()

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

Indicates condition of channel, with payload.

Note

Absolutely NO channel locks should be held before calling this function.

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

Definition at line 4672 of file channel.c.

{
    int res;
    /* this frame is used by framehooks. if it is set, we must free it at the end of this function */
    struct ast_frame *awesome_frame = NULL;
 
    ast_channel_lock(chan);
 
    /* Don't bother if the channel is about to go away, anyway. */
    if ((ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE)
            || (ast_check_hangup(chan) && !ast_channel_is_leaving_bridge(chan)))
        && _condition != AST_CONTROL_MASQUERADE_NOTIFY) {
        res = -1;
        goto indicate_cleanup;
    }
 
    if (!ast_framehook_list_is_empty(ast_channel_framehooks(chan))) {
        /* Do framehooks now, do it, go, go now */
        struct ast_frame frame = {
            .frametype = AST_FRAME_CONTROL,
            .subclass.integer = _condition,
            .data.ptr = (void *) data, /* this cast from const is only okay because we do the ast_frdup below */
            .datalen = datalen
        };
 
        /* we have now committed to freeing this frame */
        awesome_frame = ast_frdup(&frame);
 
        /* who knows what we will get back! the anticipation is killing me. */
        awesome_frame = ast_framehook_list_write_event(ast_channel_framehooks(chan),
            awesome_frame);
        if (!awesome_frame
            || awesome_frame->frametype != AST_FRAME_CONTROL) {
            res = 0;
            goto indicate_cleanup;
        }
 
        _condition = awesome_frame->subclass.integer;
        data = awesome_frame->data.ptr;
        datalen = awesome_frame->datalen;
    }
 
    res = indicate_data_internal(chan, _condition, data, datalen);
 
indicate_cleanup:
    ast_channel_unlock(chan);
    if (awesome_frame) {
        ast_frfree(awesome_frame);
    }
 
    return res;
}

References ast_channel_flags(), ast_channel_framehooks(), ast_channel_is_leaving_bridge(), ast_channel_lock, ast_channel_unlock, ast_check_hangup(), AST_CONTROL_MASQUERADE_NOTIFY, AST_FLAG_ZOMBIE, AST_FRAME_CONTROL, ast_framehook_list_is_empty(), ast_framehook_list_write_event(), ast_frdup, ast_frfree, ast_test_flag, ast_frame::data, ast_frame::datalen, ast_frame::frametype, indicate_data_internal(), ast_frame_subclass::integer, NULL, ast_frame::ptr, and ast_frame::subclass.

Referenced by __ast_read(), action_aocmessage(), app_exec(), ast_channel_update_connected_line(), ast_channel_update_redirecting(), ast_handle_cc_control_frame(), ast_indicate(), bridge_channel_handle_control(), bridge_channel_internal_join(), channel_do_masquerade(), dial_exec_full(), disable_t38(), fax_gateway_indicate_t38(), generic_fax_exec(), handle_frame(), participant_entertainment_start(), pbx_builtin_waitexten(), receivefax_t38_init(), sendfax_t38_init(), set_fax_t38_caps(), wait_for_answer(), and wait_for_winner().

ast_is_deferrable_frame()

int ast_is_deferrable_frame

(

const struct ast_frame *

frame

)

Should we keep this frame for later?

There are functions such as ast_safe_sleep which will service a channel to ensure that it does not have a large backlog of queued frames. When this happens, we want to hold on to specific frame types and just drop others. This function will tell if the frame we just read should be held onto.

Parameters

frame

The frame we just read

Return values

1	frame should be kept
0	frame should be dropped

Definition at line 1486 of file channel.c.

{
    /* Do not add a default entry in this switch statement.  Each new
     * frame type should be addressed directly as to whether it should
     * be queued up or not.
     */
    switch (frame->frametype) {
    case AST_FRAME_BRIDGE_ACTION:
    case AST_FRAME_BRIDGE_ACTION_SYNC:
    case AST_FRAME_CONTROL:
    case AST_FRAME_TEXT:
    case AST_FRAME_TEXT_DATA:
    case AST_FRAME_IMAGE:
    case AST_FRAME_HTML:
        return 1;
 
    case AST_FRAME_DTMF_END:
    case AST_FRAME_DTMF_BEGIN:
    case AST_FRAME_VOICE:
    case AST_FRAME_VIDEO:
    case AST_FRAME_NULL:
    case AST_FRAME_IAX:
    case AST_FRAME_CNG:
    case AST_FRAME_MODEM:
    case AST_FRAME_RTCP:
        return 0;
    }
    return 0;
}

References AST_FRAME_BRIDGE_ACTION, AST_FRAME_BRIDGE_ACTION_SYNC, 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_RTCP, AST_FRAME_TEXT, AST_FRAME_TEXT_DATA, AST_FRAME_VIDEO, AST_FRAME_VOICE, and ast_frame::frametype.

Referenced by ast_bridge_channel_queue_frame(), autoservice_run(), and safe_sleep_conditional().

ast_namedgroups_intersect()

int ast_namedgroups_intersect	(	struct ast_namedgroups *	a,
		struct ast_namedgroups *	b
	)

Return TRUE if group a and b contain at least one common groupname.

Definition at line 8112 of file channel.c.

{
    void *match;
    struct ao2_container *group_a = (struct ao2_container *) a;
    struct ao2_container *group_b = (struct ao2_container *) b;
 
    if (!a || !b) {
        return 0;
    }
 
    /*
     * Do groups a and b intersect?  Since a and b are hash tables,
     * the average time complexity is:
     * O(a.count <= b.count ? a.count : b.count)
     */
    if (ao2_container_count(group_b) < ao2_container_count(group_a)) {
        /* Traverse over the smaller group. */
        SWAP(group_a, group_b);
    }
    match = ao2_callback(group_a, 0, namedgroup_match, group_b);
    ao2_cleanup(match);
 
    return match != NULL;
}

References a, ao2_callback, ao2_cleanup, ao2_container_count(), b, match(), namedgroup_match(), NULL, and SWAP.

Referenced by find_channel_by_group().

ast_party_caller_copy()

void ast_party_caller_copy	(	struct ast_party_caller *	dest,
		const struct ast_party_caller *	src
	)

Copy the source caller information to the destination caller.

Since

1.8

Parameters

dest	Destination caller
src	Source caller

Definition at line 2005 of file channel.c.

{
    if (dest == src) {
        /* Don't copy to self */
        return;
    }
 
    ast_party_id_copy(&dest->id, &src->id);
    ast_party_id_copy(&dest->ani, &src->ani);
    ast_party_id_copy(&dest->priv, &src->priv);
    dest->ani2 = src->ani2;
}

References ast_party_caller::ani, ast_party_caller::ani2, ast_party_id_copy(), ast_party_caller::id, and ast_party_caller::priv.

Referenced by recalling_enter().

ast_party_caller_free()

void ast_party_caller_free

(

struct ast_party_caller *

doomed

)

Destroy the caller party contents.

Since

1.8

Parameters

doomed

The caller party to destroy.

Definition at line 2034 of file channel.c.

{
    ast_party_id_free(&doomed->id);
    ast_party_id_free(&doomed->ani);
    ast_party_id_free(&doomed->priv);
}

References ast_party_caller::ani, ast_party_id_free(), ast_party_caller::id, and ast_party_caller::priv.

Referenced by ast_channel_destructor(), ast_dummy_channel_destructor(), callerid_write(), dial_trunk(), my_get_callerid(), and sla_ring_station().

ast_party_caller_init()

void ast_party_caller_init

(

struct ast_party_caller *

init

)

Initialize the given caller structure.

Since

1.8

Parameters

init	Caller structure to initialize.

Definition at line 1997 of file channel.c.

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

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

Referenced by __ast_channel_alloc_ap(), dial_trunk(), queue_connected_line_update(), and sla_ring_station().

ast_party_caller_set()

void ast_party_caller_set	(	struct ast_party_caller *	dest,
		const struct ast_party_caller *	src,
		const struct ast_set_party_caller *	update
	)

Set the caller information based on another caller source.

Since

1.8

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

Parameters

dest	The caller one wishes to update
src	The new caller values to update the dest
update	What caller information to update. NULL if all.

Definition at line 2026 of file channel.c.

{
    ast_party_id_set(&dest->id, &src->id, update ? &update->id : NULL);
    ast_party_id_set(&dest->ani, &src->ani, update ? &update->ani : NULL);
    ast_party_id_set(&dest->priv, &src->priv, update ? &update->priv : NULL);
    dest->ani2 = src->ani2;
}

References ast_party_caller::ani, ast_party_caller::ani2, ast_party_id_set(), ast_party_caller::id, NULL, ast_party_caller::priv, and update().

Referenced by ast_channel_set_caller(), ast_channel_set_caller_event(), callerid_write(), and my_get_callerid().

ast_party_caller_set_init()

void ast_party_caller_set_init	(	struct ast_party_caller *	init,
		const struct ast_party_caller *	guide
	)

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

Since

1.8

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	Caller structure to initialize.
guide	Source caller to use as a guide in initializing.

Definition at line 2018 of file channel.c.

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

References ast_party_caller::ani, ast_party_caller::ani2, ast_party_id_set_init(), ast_party_caller::id, and ast_party_caller::priv.

Referenced by callerid_write(), dial_exec_full(), do_forward(), my_get_callerid(), and ring_entry().

ast_party_connected_line_collect_caller()

void ast_party_connected_line_collect_caller	(	struct ast_party_connected_line *	connected,
		struct ast_party_caller *	caller
	)

Collect the caller party information into a connected line structure.

Since

1.8

Parameters

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

Warning

This is a shallow copy.

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

Definition at line 2082 of file channel.c.

{
    connected->id = caller->id;
    connected->ani = caller->ani;
    connected->priv = caller->priv;
    connected->ani2 = caller->ani2;
    connected->source = AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN;
}

References ast_party_caller::ani, ast_party_caller::ani2, AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN, connected, ast_party_caller::id, and ast_party_caller::priv.

ast_party_connected_line_copy()

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

Parameters

dest	Destination connected line
src	Source connected line

Definition at line 2050 of file channel.c.

{
    if (dest == src) {
        /* Don't copy to self */
        return;
    }
 
    ast_party_id_copy(&dest->id, &src->id);
    ast_party_id_copy(&dest->ani, &src->ani);
    ast_party_id_copy(&dest->priv, &src->priv);
    dest->ani2 = src->ani2;
    dest->source = src->source;
}

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

Referenced by __ast_read(), after_bridge_move_channel(), agent_login_channel_config(), ast_call_forward(), ast_channel_connected_line_sub(), ast_do_pickup(), attended_transfer_properties_alloc(), dial_exec_full(), do_forward(), indicate_connected_line(), recalling_enter(), retransfer_enter(), try_calling(), and wait_for_answer().

ast_party_connected_line_free()

void ast_party_connected_line_free

(

struct ast_party_connected_line *

doomed

)

Destroy the connected line information contents.

Since

1.8

Parameters

doomed

The connected line information to destroy.

Definition at line 2091 of file channel.c.

{
    ast_party_id_free(&doomed->id);
    ast_party_id_free(&doomed->ani);
    ast_party_id_free(&doomed->priv);
}

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

Referenced by __ast_read(), after_bridge_move_channel(), agent_login_channel_config(), agent_pvt_destructor(), agent_request_exec(), app_exec(), ast_channel_connected_line_sub(), ast_channel_destructor(), ast_do_pickup(), ast_dummy_channel_destructor(), attended_transfer_properties_destructor(), bridge_reconfigured_connected_line_update(), callattempt_free(), chanlist_free(), connectedline_write(), destroy_calling_node(), indicate_connected_line(), socket_process_helper(), update_connected_line_from_peer(), wait_for_answer(), and wait_for_winner().

ast_party_connected_line_init()

void ast_party_connected_line_init

(

struct ast_party_connected_line *

init

)

Initialize the given connected line structure.

Since

1.8

Parameters

init	Connected line structure to initialize.

Definition at line 2041 of file channel.c.

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

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, ast_party_connected_line::priv, and ast_party_connected_line::source.

Referenced by __ast_channel_alloc_ap(), __ast_read(), after_bridge_move_channel(), agent_login_channel_config(), agent_pvt_new(), agent_request_exec(), ast_channel_connected_line_sub(), ast_do_pickup(), bridge_reconfigured_connected_line_update(), do_forward(), onAlerting(), onCallEstablished(), onProgress(), queue_connected_line_update(), socket_process_helper(), update_connected_line_from_peer(), and update_initial_connected_line().

ast_party_connected_line_set()

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

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

Since

1.8

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

dest	The connected line one wishes to update
src	The new connected line values to update the dest
update	What connected line information to update. NULL if all.

Definition at line 2073 of file channel.c.

{
    ast_party_id_set(&dest->id, &src->id, update ? &update->id : NULL);
    ast_party_id_set(&dest->ani, &src->ani, update ? &update->ani : NULL);
    ast_party_id_set(&dest->priv, &src->priv, update ? &update->priv : NULL);
    dest->ani2 = src->ani2;
    dest->source = src->source;
}

References ast_party_connected_line::ani, ast_party_connected_line::ani2, ast_party_id_set(), ast_party_connected_line::id, NULL, ast_party_connected_line::priv, ast_party_connected_line::source, and update().

Referenced by ast_channel_set_connected_line(), wait_for_answer(), and wait_for_winner().

ast_party_connected_line_set_init()

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

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.

Definition at line 2064 of file channel.c.

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

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

Referenced by __ast_request_and_dial(), ari_channels_handle_originate_with_id(), connectedline_write(), dial_exec_full(), indicate_connected_line(), pbx_outgoing_attempt(), wait_for_answer(), and wait_for_winner().

ast_party_dialed_copy()

void ast_party_dialed_copy	(	struct ast_party_dialed *	dest,
		const struct ast_party_dialed *	src
	)

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

Since

1.8

Parameters

dest	Destination dialed party
src	Source dialed party

Definition at line 1955 of file channel.c.

{
    if (dest == src) {
        /* Don't copy to self */
        return;
    }
 
    ast_free(dest->number.str);
    dest->number.str = ast_strdup(src->number.str);
    dest->number.plan = src->number.plan;
    ast_party_subaddress_copy(&dest->subaddress, &src->subaddress);
    dest->transit_network_select = src->transit_network_select;
}

References ast_free, ast_party_subaddress_copy(), ast_strdup, ast_party_dialed::number, ast_party_dialed::plan, ast_party_dialed::str, ast_party_dialed::subaddress, and ast_party_dialed::transit_network_select.

Referenced by ast_unreal_call_setup().

ast_party_dialed_free()

void ast_party_dialed_free

(

struct ast_party_dialed *

doomed

)

Destroy the dialed party contents.

Since

1.8

Parameters

doomed

The dialed party to destroy.

Definition at line 1990 of file channel.c.

{
    ast_free(doomed->number.str);
    doomed->number.str = NULL;
    ast_party_subaddress_free(&doomed->subaddress);
}

References ast_free, ast_party_subaddress_free(), NULL, ast_party_dialed::number, ast_party_dialed::str, and ast_party_dialed::subaddress.

Referenced by ast_channel_destructor(), ast_dummy_channel_destructor(), and callerid_write().

ast_party_dialed_init()

void ast_party_dialed_init

(

struct ast_party_dialed *

init

)

Initialize the given dialed structure.

Since

1.8

Parameters

init	Dialed structure to initialize.

Definition at line 1947 of file channel.c.

{
    init->number.str = NULL;
    init->number.plan = 0;/* Unknown */
    ast_party_subaddress_init(&init->subaddress);
    init->transit_network_select = 0;
}

References ast_party_subaddress_init(), NULL, ast_party_dialed::number, ast_party_dialed::plan, ast_party_dialed::str, ast_party_dialed::subaddress, and ast_party_dialed::transit_network_select.

Referenced by __ast_channel_alloc_ap().

ast_party_dialed_set()

void ast_party_dialed_set	(	struct ast_party_dialed *	dest,
		const struct ast_party_dialed *	src
	)

Set the dialed information based on another dialed source.

Since

1.8

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

Parameters

dest	The dialed one wishes to update
src	The new dialed values to update the dest

Definition at line 1977 of file channel.c.

{
    if (src->number.str && src->number.str != dest->number.str) {
        ast_free(dest->number.str);
        dest->number.str = ast_strdup(src->number.str);
    }
    dest->number.plan = src->number.plan;
 
    ast_party_subaddress_set(&dest->subaddress, &src->subaddress);
 
    dest->transit_network_select = src->transit_network_select;
}

References ast_free, ast_party_subaddress_set(), ast_strdup, ast_party_dialed::number, ast_party_dialed::plan, ast_party_dialed::str, ast_party_dialed::subaddress, and ast_party_dialed::transit_network_select.

Referenced by callerid_write().

ast_party_dialed_set_init()

void ast_party_dialed_set_init	(	struct ast_party_dialed *	init,
		const struct ast_party_dialed *	guide
	)

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

Since

1.8

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	Caller structure to initialize.
guide	Source dialed to use as a guide in initializing.

Definition at line 1969 of file channel.c.

{
    init->number.str = NULL;
    init->number.plan = guide->number.plan;
    ast_party_subaddress_set_init(&init->subaddress, &guide->subaddress);
    init->transit_network_select = guide->transit_network_select;
}

References ast_party_subaddress_set_init(), NULL, ast_party_dialed::number, ast_party_dialed::plan, ast_party_dialed::str, ast_party_dialed::subaddress, and ast_party_dialed::transit_network_select.

Referenced by callerid_write().

ast_party_id_copy()

void ast_party_id_copy	(	struct ast_party_id *	dest,
		const struct ast_party_id *	src
	)

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

Since

1.8

Parameters

dest	Destination party id
src	Source party id

Definition at line 1784 of file channel.c.

{
    if (dest == src) {
        /* Don't copy to self */
        return;
    }
 
    ast_party_name_copy(&dest->name, &src->name);
    ast_party_number_copy(&dest->number, &src->number);
    ast_party_subaddress_copy(&dest->subaddress, &src->subaddress);
 
    ast_free(dest->tag);
    dest->tag = ast_strdup(src->tag);
}

References ast_free, ast_party_name_copy(), ast_party_number_copy(), ast_party_subaddress_copy(), ast_strdup, ast_party_id::name, ast_party_id::number, ast_party_id::subaddress, and ast_party_id::tag.

Referenced by ast_connected_line_copy_from_caller(), ast_connected_line_copy_to_caller(), ast_party_caller_copy(), ast_party_connected_line_copy(), ast_party_id_merge_copy(), ast_party_redirecting_copy(), ast_sip_session_create_outgoing(), ast_sip_set_id_from_invite(), caller_id_outgoing_request(), caller_id_outgoing_response(), chan_pjsip_new(), copy_redirecting_id(), queue_connected_line_update(), set_from_header(), stir_shaken_outgoing_request(), and update_initial_connected_line().

ast_party_id_free()

void ast_party_id_free

(

struct ast_party_id *

doomed

)

Destroy the party id contents.

Since

1.8

Parameters

doomed

The party id to destroy.

Definition at line 1830 of file channel.c.

{
    ast_party_name_free(&doomed->name);
    ast_party_number_free(&doomed->number);
    ast_party_subaddress_free(&doomed->subaddress);
 
    ast_free(doomed->tag);
    doomed->tag = NULL;
}

References ast_free, ast_party_name_free(), ast_party_number_free(), ast_party_subaddress_free(), ast_party_id::name, NULL, ast_party_id::number, ast_party_id::subaddress, and ast_party_id::tag.

Referenced by ast_party_caller_free(), ast_party_connected_line_free(), ast_party_id_reset(), ast_party_redirecting_free(), caller_id_outgoing_request(), caller_id_outgoing_response(), endpoint_destructor(), fetch_callerid_num(), session_destructor(), set_from_header(), stir_shaken_outgoing_request(), and update_incoming_connected_line().

ast_party_id_init()

void ast_party_id_init

(

struct ast_party_id *

init

)

Initialize the given party id structure.

Since

1.8

Parameters

init	Party id structure to initialize.

Definition at line 1776 of file channel.c.

{
    ast_party_name_init(&init->name);
    ast_party_number_init(&init->number);
    ast_party_subaddress_init(&init->subaddress);
    init->tag = NULL;
}

References ast_party_name_init(), ast_party_number_init(), ast_party_subaddress_init(), ast_party_id::name, NULL, ast_party_id::number, ast_party_id::subaddress, and ast_party_id::tag.

Referenced by ast_party_caller_init(), ast_party_connected_line_init(), ast_party_id_reset(), ast_party_redirecting_init(), ast_sip_endpoint_alloc(), ast_sip_session_alloc(), caller_id_outgoing_request(), caller_id_outgoing_response(), dial_exec_full(), fetch_callerid_num(), set_from_header(), stir_shaken_outgoing_request(), and update_incoming_connected_line().

ast_party_id_invalidate()

void ast_party_id_invalidate

(

struct ast_party_id *

id

)

Invalidate all components of the given party id.

Since

11.0

Parameters

id	The party id to invalidate.

Definition at line 1908 of file channel.c.

{
    id->name.valid = 0;
    id->number.valid = 0;
    id->subaddress.valid = 0;
}

ast_party_id_merge()

struct ast_party_id ast_party_id_merge	(	struct ast_party_id *	base,
		struct ast_party_id *	overlay
	)

Merge a given party id into another given party id.

Since

11.0

This function will generate an effective party id.

Each party id component of the party id 'base' is overwritten by components of the party id 'overlay' if the overlay component is marked as valid. However the component 'tag' of the base party id remains untouched.

Parameters

base	The party id which is merged.
overlay	The party id which is used to merge into.

Returns

The merged party id as a struct, not as a pointer.

Note

The merged party id returned is a shallow copy and must not be freed.

Definition at line 1921 of file channel.c.

{
    struct ast_party_id merged;
 
    merged = *base;
    if (overlay->name.valid) {
        merged.name = overlay->name;
    }
    if (overlay->number.valid) {
        merged.number = overlay->number;
    }
    if (overlay->subaddress.valid) {
        merged.subaddress = overlay->subaddress;
    }
    /* Note the actual structure is returned and not a pointer to it! */
    return merged;
}

References ast_party_id::name, ast_party_id::number, and ast_party_id::subaddress.

Referenced by ast_channel_connected_effective_id(), ast_channel_redirecting_effective_from(), ast_channel_redirecting_effective_orig(), ast_channel_redirecting_effective_to(), and ast_party_id_merge_copy().

ast_party_id_merge_copy()

void ast_party_id_merge_copy	(	struct ast_party_id *	dest,
		struct ast_party_id *	base,
		struct ast_party_id *	overlay
	)

Copy a merge of a given party id into another given party id to a given destination party id.

Since

11.0

Each party id component of the party id 'base' is overwritten by components of the party id 'overlay' if the 'overlay' component is marked as valid. However the component 'tag' of the 'base' party id remains untouched. The result is copied into the given party id 'dest'.

Note

The resulting merged party id is a real copy and has to be freed.

Parameters

dest	The resulting merged party id.
base	The party id which is merged.
overlay	The party id which is used to merge into.

Definition at line 1939 of file channel.c.

{
    struct ast_party_id merged;
 
    merged = ast_party_id_merge(base, overlay);
    ast_party_id_copy(dest, &merged);
}

References ast_party_id_copy(), and ast_party_id_merge().

ast_party_id_presentation()

int ast_party_id_presentation

(

const struct ast_party_id *

id

)

Determine the overall presentation value for the given party.

Since

1.8

Parameters

id	Party to determine the overall presentation value.

Returns

Overall presentation value for the given party.

Definition at line 1840 of file channel.c.

{
    int number_priority;
    int number_value;
    int number_screening;
    int name_priority;
    int name_value;
 
    /* Determine name presentation priority. */
    if (!id->name.valid) {
        name_value = AST_PRES_UNAVAILABLE;
        name_priority = 3;
    } else {
        name_value = id->name.presentation & AST_PRES_RESTRICTION;
        switch (name_value) {
        case AST_PRES_RESTRICTED:
            name_priority = 0;
            break;
        case AST_PRES_ALLOWED:
            name_priority = 1;
            break;
        case AST_PRES_UNAVAILABLE:
            name_priority = 2;
            break;
        default:
            name_value = AST_PRES_UNAVAILABLE;
            name_priority = 3;
            break;
        }
    }
 
    /* Determine number presentation priority. */
    if (!id->number.valid) {
        number_screening = AST_PRES_USER_NUMBER_UNSCREENED;
        number_value = AST_PRES_UNAVAILABLE;
        number_priority = 3;
    } else {
        number_screening = id->number.presentation & AST_PRES_NUMBER_TYPE;
        number_value = id->number.presentation & AST_PRES_RESTRICTION;
        switch (number_value) {
        case AST_PRES_RESTRICTED:
            number_priority = 0;
            break;
        case AST_PRES_ALLOWED:
            number_priority = 1;
            break;
        case AST_PRES_UNAVAILABLE:
            number_priority = 2;
            break;
        default:
            number_screening = AST_PRES_USER_NUMBER_UNSCREENED;
            number_value = AST_PRES_UNAVAILABLE;
            number_priority = 3;
            break;
        }
    }
 
    /* Select the wining presentation value. */
    if (name_priority < number_priority) {
        number_value = name_value;
    }
    if (number_value == AST_PRES_UNAVAILABLE) {
        return AST_PRES_NUMBER_NOT_AVAILABLE;
    }
 
    return number_value | number_screening;
}

References AST_PRES_ALLOWED, AST_PRES_NUMBER_NOT_AVAILABLE, AST_PRES_NUMBER_TYPE, AST_PRES_RESTRICTED, AST_PRES_RESTRICTION, AST_PRES_UNAVAILABLE, AST_PRES_USER_NUMBER_UNSCREENED, and id.

Referenced by add_privacy_header(), add_privacy_params(), ast_json_party_id(), ast_sip_can_present_connected_id(), ast_str_retrieve_variable(), ast_var_channels_table(), channel_snapshot_caller_create(), iax2_call(), is_colp_update_allowed(), my_send_callerid(), party_id_build_data(), party_id_read(), queue_exec(), redirecting_read(), set_from_header(), setup_env(), and socket_process_helper().

ast_party_id_reset()

void ast_party_id_reset

(

struct ast_party_id *

id

)

Destroy and initialize the given party id structure.

Since

11.0

Parameters

id	The party id to reset.

Definition at line 1915 of file channel.c.

{
    ast_party_id_free(id);
    ast_party_id_init(id);
}

References ast_party_id_free(), and ast_party_id_init().

Referenced by after_bridge_move_channel(), ast_do_pickup(), channel_do_masquerade(), and retransfer_enter().

ast_party_id_set()

void ast_party_id_set	(	struct ast_party_id *	dest,
		const struct ast_party_id *	src,
		const struct ast_set_party_id *	update
	)

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

Since

1.8

Parameters

dest	The id one wishes to update
src	The new id values to update the dest
update	What id information to update. NULL if all.

Definition at line 1807 of file channel.c.

{
    if (dest == src) {
        /* Don't set to self */
        return;
    }
 
    if (!update || update->name) {
        ast_party_name_set(&dest->name, &src->name);
    }
    if (!update || update->number) {
        ast_party_number_set(&dest->number, &src->number);
    }
    if (!update || update->subaddress) {
        ast_party_subaddress_set(&dest->subaddress, &src->subaddress);
    }
 
    if (src->tag && src->tag != dest->tag) {
        ast_free(dest->tag);
        dest->tag = ast_strdup(src->tag);
    }
}

References ast_free, ast_party_name_set(), ast_party_number_set(), ast_party_subaddress_set(), ast_strdup, ast_party_id::name, ast_party_id::number, ast_party_id::subaddress, ast_party_id::tag, and update().

Referenced by ast_party_caller_set(), ast_party_connected_line_set(), and ast_party_redirecting_set().

ast_party_id_set_init()

void ast_party_id_set_init	(	struct ast_party_id *	init,
		const struct ast_party_id *	guide
	)

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

Since

1.8

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 id structure to initialize.
guide	Source party id to use as a guide in initializing.

Definition at line 1799 of file channel.c.

{
    ast_party_name_set_init(&init->name, &guide->name);
    ast_party_number_set_init(&init->number, &guide->number);
    ast_party_subaddress_set_init(&init->subaddress, &guide->subaddress);
    init->tag = NULL;
}

References ast_party_name_set_init(), ast_party_number_set_init(), ast_party_subaddress_set_init(), ast_party_id::name, NULL, ast_party_id::number, ast_party_id::subaddress, and ast_party_id::tag.

Referenced by ast_party_caller_set_init(), ast_party_connected_line_set_init(), ast_party_redirecting_set_init(), and dial_exec_full().

ast_party_name_copy()

void ast_party_name_copy	(	struct ast_party_name *	dest,
		const struct ast_party_name *	src
	)

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

Since

1.8

Parameters

dest	Destination party name
src	Source party name

Definition at line 1618 of file channel.c.

{
    if (dest == src) {
        /* Don't copy to self */
        return;
    }
 
    ast_free(dest->str);
    dest->str = ast_strdup(src->str);
    dest->char_set = src->char_set;
    dest->presentation = src->presentation;
    dest->valid = src->valid;
}

References ast_free, ast_strdup, ast_party_name::char_set, ast_party_name::presentation, ast_party_name::str, and ast_party_name::valid.

Referenced by ast_party_id_copy().

ast_party_name_free()

void ast_party_name_free

(

struct ast_party_name *

doomed

)

Destroy the party name contents.

Since

1.8

Parameters

doomed

The party name to destroy.

Definition at line 1657 of file channel.c.

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

References ast_free, NULL, and ast_party_name::str.

Referenced by analog_ss_thread(), and ast_party_id_free().

ast_party_name_init()

void ast_party_name_init

(

struct ast_party_name *

init

)

Initialize the given name structure.

Since

1.8

Parameters

init	Name structure to initialize.

Definition at line 1610 of file channel.c.

{
    init->str = NULL;
    init->char_set = AST_PARTY_CHAR_SET_ISO8859_1;
    init->presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
    init->valid = 0;
}

References AST_PARTY_CHAR_SET_ISO8859_1, AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED, ast_party_name::char_set, NULL, ast_party_name::presentation, ast_party_name::str, and ast_party_name::valid.

Referenced by analog_ss_thread(), and ast_party_id_init().

ast_party_name_set()

void ast_party_name_set	(	struct ast_party_name *	dest,
		const struct ast_party_name *	src
	)

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

Since

1.8

Parameters

dest	The name one wishes to update
src	The new name values to update the dest

Definition at line 1640 of file channel.c.

{
    if (dest == src) {
        /* Don't set to self */
        return;
    }
 
    if (src->str && src->str != dest->str) {
        ast_free(dest->str);
        dest->str = ast_strdup(src->str);
    }
 
    dest->char_set = src->char_set;
    dest->presentation = src->presentation;
    dest->valid = src->valid;
}

References ast_free, ast_strdup, ast_party_name::char_set, ast_party_name::presentation, ast_party_name::str, and ast_party_name::valid.

Referenced by ast_party_id_set().

ast_party_name_set_init()

void ast_party_name_set_init	(	struct ast_party_name *	init,
		const struct ast_party_name *	guide
	)

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

Since

1.8

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 name structure to initialize.
guide	Source party name to use as a guide in initializing.

Definition at line 1632 of file channel.c.

{
    init->str = NULL;
    init->char_set = guide->char_set;
    init->presentation = guide->presentation;
    init->valid = guide->valid;
}

References ast_party_name::char_set, NULL, ast_party_name::presentation, ast_party_name::str, and ast_party_name::valid.

Referenced by ast_party_id_set_init().

ast_party_number_copy()

void ast_party_number_copy	(	struct ast_party_number *	dest,
		const struct ast_party_number *	src
	)

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

Since

1.8

Parameters

dest	Destination party number
src	Source party number

Definition at line 1671 of file channel.c.

{
    if (dest == src) {
        /* Don't copy to self */
        return;
    }
 
    ast_free(dest->str);
    dest->str = ast_strdup(src->str);
    dest->plan = src->plan;
    dest->presentation = src->presentation;
    dest->valid = src->valid;
}

References ast_free, ast_strdup, ast_party_number::plan, ast_party_number::presentation, ast_party_number::str, and ast_party_number::valid.

Referenced by ast_party_id_copy().

ast_party_number_free()

void ast_party_number_free

(

struct ast_party_number *

doomed

)

Destroy the party number contents.

Since

1.8

Parameters

doomed

The party number to destroy.

Definition at line 1710 of file channel.c.

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

References ast_free, NULL, and ast_party_number::str.

Referenced by analog_ss_thread(), ast_party_id_free(), do_forward(), and wait_for_answer().

ast_party_number_init()

void ast_party_number_init

(

struct ast_party_number *

init

)

Initialize the given number structure.

Since

1.8

Parameters

init	Number structure to initialize.

Definition at line 1663 of file channel.c.

{
    init->str = NULL;
    init->plan = 0;/* Unknown */
    init->presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
    init->valid = 0;
}

References AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED, NULL, ast_party_number::plan, ast_party_number::presentation, ast_party_number::str, and ast_party_number::valid.

Referenced by analog_ss_thread(), ast_party_id_init(), do_forward(), and wait_for_answer().

ast_party_number_set()

void ast_party_number_set	(	struct ast_party_number *	dest,
		const struct ast_party_number *	src
	)

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

Since

1.8

Parameters

dest	The number one wishes to update
src	The new number values to update the dest

Definition at line 1693 of file channel.c.

{
    if (dest == src) {
        /* Don't set to self */
        return;
    }
 
    if (src->str && src->str != dest->str) {
        ast_free(dest->str);
        dest->str = ast_strdup(src->str);
    }
 
    dest->plan = src->plan;
    dest->presentation = src->presentation;
    dest->valid = src->valid;
}

References ast_free, ast_strdup, ast_party_number::plan, ast_party_number::presentation, ast_party_number::str, and ast_party_number::valid.

Referenced by ast_party_id_set().

ast_party_number_set_init()

void ast_party_number_set_init	(	struct ast_party_number *	init,
		const struct ast_party_number *	guide
	)

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

Since

1.8

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 number structure to initialize.
guide	Source party number to use as a guide in initializing.

Definition at line 1685 of file channel.c.

{
    init->str = NULL;
    init->plan = guide->plan;
    init->presentation = guide->presentation;
    init->valid = guide->valid;
}

References NULL, ast_party_number::plan, ast_party_number::presentation, ast_party_number::str, and ast_party_number::valid.

Referenced by ast_party_id_set_init().

ast_party_redirecting_copy()

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

Parameters

dest	Destination redirecting
src	Source redirecting

Definition at line 2154 of file channel.c.

{
    if (dest == src) {
        /* Don't copy to self */
        return;
    }
 
    ast_party_id_copy(&dest->orig, &src->orig);
    ast_party_id_copy(&dest->from, &src->from);
    ast_party_id_copy(&dest->to, &src->to);
    ast_party_id_copy(&dest->priv_orig, &src->priv_orig);
    ast_party_id_copy(&dest->priv_from, &src->priv_from);
    ast_party_id_copy(&dest->priv_to, &src->priv_to);
    ast_party_redirecting_reason_copy(&dest->reason, &src->reason);
    ast_party_redirecting_reason_copy(&dest->orig_reason, &src->orig_reason);
    dest->count = src->count;
}

References ast_party_id_copy(), ast_party_redirecting_reason_copy(), ast_party_redirecting::count, ast_party_redirecting::from, ast_party_redirecting::orig, ast_party_redirecting::orig_reason, ast_party_redirecting::priv_from, ast_party_redirecting::priv_orig, ast_party_redirecting::priv_to, ast_party_redirecting::reason, and ast_party_redirecting::to.

Referenced by ast_ari_channels_dial(), ast_call_forward(), ast_channel_redirecting_sub(), ast_unreal_call_setup(), begin_dial_prerun(), call_forward_inherit(), dial_exec_full(), do_forward(), ring_entry(), and wait_for_answer().

ast_party_redirecting_free()

void ast_party_redirecting_free

(

struct ast_party_redirecting *

doomed

)

Destroy the redirecting information contents.

Since

1.8

Parameters

doomed

The redirecting information to destroy.

Definition at line 2198 of file channel.c.

{
    ast_party_id_free(&doomed->orig);
    ast_party_id_free(&doomed->from);
    ast_party_id_free(&doomed->to);
    ast_party_id_free(&doomed->priv_orig);
    ast_party_id_free(&doomed->priv_from);
    ast_party_id_free(&doomed->priv_to);
    ast_party_redirecting_reason_free(&doomed->reason);
    ast_party_redirecting_reason_free(&doomed->orig_reason);
}

References ast_party_id_free(), ast_party_redirecting_reason_free(), ast_party_redirecting::from, ast_party_redirecting::orig, ast_party_redirecting::orig_reason, ast_party_redirecting::priv_from, ast_party_redirecting::priv_orig, ast_party_redirecting::priv_to, ast_party_redirecting::reason, and ast_party_redirecting::to.

Referenced by ast_channel_destructor(), ast_channel_redirecting_sub(), ast_dummy_channel_destructor(), AST_TEST_DEFINE(), call_forward_inherit(), do_forward(), indicate_redirecting(), redirecting_write(), set_redirecting(), and wait_for_answer().

ast_party_redirecting_init()

void ast_party_redirecting_init

(

struct ast_party_redirecting *

init

)

Initialize the given redirecting structure.

Since

1.8

Parameters

init	Redirecting structure to initialize.

Definition at line 2141 of file channel.c.

{
    ast_party_id_init(&init->orig);
    ast_party_id_init(&init->from);
    ast_party_id_init(&init->to);
    ast_party_id_init(&init->priv_orig);
    ast_party_id_init(&init->priv_from);
    ast_party_id_init(&init->priv_to);
    ast_party_redirecting_reason_init(&init->reason);
    ast_party_redirecting_reason_init(&init->orig_reason);
    init->count = 0;
}

References ast_party_id_init(), ast_party_redirecting_reason_init(), ast_party_redirecting::count, ast_party_redirecting::from, ast_party_redirecting::orig, ast_party_redirecting::orig_reason, ast_party_redirecting::priv_from, ast_party_redirecting::priv_orig, ast_party_redirecting::priv_to, ast_party_redirecting::reason, and ast_party_redirecting::to.

Referenced by __ast_channel_alloc_ap(), ast_channel_redirecting_sub(), AST_TEST_DEFINE(), call_forward_inherit(), do_forward(), set_redirecting(), and wait_for_answer().

ast_party_redirecting_reason_copy()

void ast_party_redirecting_reason_copy	(	struct ast_party_redirecting_reason *	dest,
		const struct ast_party_redirecting_reason *	src
	)

Copy the source redirecting reason information to the destination redirecting reason.

Parameters

dest	Destination redirecting reason
src	Source redirecting reason

Definition at line 2104 of file channel.c.

{
    if (dest == src) {
        return;
    }
 
    ast_free(dest->str);
    dest->str = ast_strdup(src->str);
    dest->code = src->code;
}

References ast_free, ast_strdup, ast_party_redirecting_reason::code, and ast_party_redirecting_reason::str.

Referenced by ast_party_redirecting_copy().

ast_party_redirecting_reason_free()

void ast_party_redirecting_reason_free

(

struct ast_party_redirecting_reason *

doomed

)

Destroy the redirecting reason contents.

Parameters

doomed

The redirecting reason to destroy.

Definition at line 2135 of file channel.c.

{
    ast_free(doomed->str);
}

References ast_free, and ast_party_redirecting_reason::str.

Referenced by ast_party_redirecting_free().

ast_party_redirecting_reason_init()

void ast_party_redirecting_reason_init

(

struct ast_party_redirecting_reason *

init

)

Initialize the given redirecting reason structure.

Parameters

init	Redirecting reason structure to initialize

Definition at line 2098 of file channel.c.

{
    init->str = NULL;
    init->code = AST_REDIRECTING_REASON_UNKNOWN;
}

References AST_REDIRECTING_REASON_UNKNOWN, ast_party_redirecting_reason::code, NULL, and ast_party_redirecting_reason::str.

Referenced by ast_party_redirecting_init().

ast_party_redirecting_reason_set()

void ast_party_redirecting_reason_set	(	struct ast_party_redirecting_reason *	dest,
		const struct ast_party_redirecting_reason *	src
	)

Set the redirecting reason information based on another redirecting reason source.

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

Parameters

dest	The redirecting reason one wishes to update
src	The new redirecting reason values to update the dest

Definition at line 2121 of file channel.c.

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

References ast_free, ast_strdup, ast_party_redirecting_reason::code, and ast_party_redirecting_reason::str.

Referenced by ast_party_redirecting_set().

ast_party_redirecting_reason_set_init()

void ast_party_redirecting_reason_set_init	(	struct ast_party_redirecting_reason *	init,
		const struct ast_party_redirecting_reason *	guide
	)

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

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 reason structure to initialize.
guide	Source redirecting reason to use as a guide in initializing.

Definition at line 2115 of file channel.c.

{
    init->str = NULL;
    init->code = guide->code;
}

References ast_party_redirecting_reason::code, NULL, and ast_party_redirecting_reason::str.

Referenced by ast_party_redirecting_set_init().

ast_party_redirecting_set()

void ast_party_redirecting_set	(	struct ast_party_redirecting *	dest,
		const struct ast_party_redirecting *	src,
		const struct ast_set_party_redirecting *	update
	)

Set the redirecting information based on another redirecting source.

Since

1.8

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

Parameters

dest	The redirecting one wishes to update
src	The new redirecting values to update the dest
update	What redirecting information to update. NULL if all.

Definition at line 2185 of file channel.c.

{
    ast_party_id_set(&dest->orig, &src->orig, update ? &update->orig : NULL);
    ast_party_id_set(&dest->from, &src->from, update ? &update->from : NULL);
    ast_party_id_set(&dest->to, &src->to, update ? &update->to : NULL);
    ast_party_id_set(&dest->priv_orig, &src->priv_orig, update ? &update->priv_orig : NULL);
    ast_party_id_set(&dest->priv_from, &src->priv_from, update ? &update->priv_from : NULL);
    ast_party_id_set(&dest->priv_to, &src->priv_to, update ? &update->priv_to : NULL);
    ast_party_redirecting_reason_set(&dest->reason, &src->reason);
    ast_party_redirecting_reason_set(&dest->orig_reason, &src->orig_reason);
    dest->count = src->count;
}

References ast_party_id_set(), ast_party_redirecting_reason_set(), ast_party_redirecting::count, ast_party_redirecting::from, NULL, ast_party_redirecting::orig, ast_party_redirecting::orig_reason, ast_party_redirecting::priv_from, ast_party_redirecting::priv_orig, ast_party_redirecting::priv_to, ast_party_redirecting::reason, ast_party_redirecting::to, and update().

Referenced by ast_channel_set_redirecting().

ast_party_redirecting_set_init()

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

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.

Definition at line 2172 of file channel.c.

{
    ast_party_id_set_init(&init->orig, &guide->orig);
    ast_party_id_set_init(&init->from, &guide->from);
    ast_party_id_set_init(&init->to, &guide->to);
    ast_party_id_set_init(&init->priv_orig, &guide->priv_orig);
    ast_party_id_set_init(&init->priv_from, &guide->priv_from);
    ast_party_id_set_init(&init->priv_to, &guide->priv_to);
    ast_party_redirecting_reason_set_init(&init->reason, &guide->reason);
    ast_party_redirecting_reason_set_init(&init->orig_reason, &guide->orig_reason);
    init->count = guide->count;
}

References ast_party_id_set_init(), ast_party_redirecting_reason_set_init(), ast_party_redirecting::count, ast_party_redirecting::from, ast_party_redirecting::orig, ast_party_redirecting::orig_reason, ast_party_redirecting::priv_from, ast_party_redirecting::priv_orig, ast_party_redirecting::priv_to, ast_party_redirecting::reason, and ast_party_redirecting::to.

Referenced by indicate_redirecting(), and redirecting_write().

ast_party_subaddress_copy()

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

Parameters

dest	Destination party subaddress
src	Source party subaddress

Definition at line 1724 of file channel.c.

{
    if (dest == src) {
        /* Don't copy to self */
        return;
    }
 
    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;
}

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_dialed_copy(), and ast_party_id_copy().

ast_party_subaddress_free()

void ast_party_subaddress_free

(

struct ast_party_subaddress *

doomed

)

Destroy the party subaddress contents.

Since

1.8

Parameters

doomed

The party subaddress to destroy.

Definition at line 1763 of file channel.c.

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

References ast_free, NULL, and ast_party_subaddress::str.

Referenced by ast_party_dialed_free(), and ast_party_id_free().

ast_party_subaddress_init()

void ast_party_subaddress_init

(

struct ast_party_subaddress *

init

)

Initialize the given subaddress structure.

Since

1.8

Parameters

init	Subaddress structure to initialize.

Definition at line 1716 of file channel.c.

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

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

Referenced by ast_party_dialed_init(), and ast_party_id_init().

ast_party_subaddress_set()

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

Parameters

dest	The subaddress one wishes to update
src	The new subaddress values to update the dest

Definition at line 1746 of file channel.c.

{
    if (dest == src) {
        /* Don't set to self */
        return;
    }
 
    if (src->str && src->str != 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;
}

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_dialed_set(), and ast_party_id_set().

ast_party_subaddress_set_init()

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

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

Since

1.8

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.

Definition at line 1738 of file channel.c.

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

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

Referenced by ast_party_dialed_set_init(), and ast_party_id_set_init().

ast_pre_call()

int ast_pre_call	(	struct ast_channel *	chan,
		const char *	sub_args
	)

Execute a Gosub call on the channel before a call is placed.

Since

11.0

This is called between ast_request() and ast_call() to execute a predial routine on the newly created channel.

Parameters

chan	Channel to execute Gosub.
sub_args	Gosub application parameter string.

Note

Absolutely NO channel locks should be held before calling this function.

Return values

0	on success.
-1	on error.

Definition at line 6463 of file channel.c.

{
    int (*pre_call)(struct ast_channel *chan, const char *sub_args);
 
    ast_channel_lock(chan);
    pre_call = ast_channel_tech(chan)->pre_call;
    if (pre_call) {
        int res;
 
        res = pre_call(chan, sub_args);
        ast_channel_unlock(chan);
        return res;
    }
    ast_channel_unlock(chan);
    return ast_app_exec_sub(NULL, chan, sub_args, 0);
}

References ast_app_exec_sub(), ast_channel_lock, ast_channel_tech(), ast_channel_unlock, NULL, and ast_channel_tech::pre_call.

Referenced by begin_dial_prerun(), dial_exec_full(), findmeexec(), and ring_entry().

ast_print_group()

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

Print call and pickup groups into buffer.

Print call and pickup groups into buffer.

Definition at line 8053 of file channel.c.

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

References buf, and first.

Referenced by callgroup_to_str(), func_channel_read(), pickupgroup_to_str(), and serialize_showchan().

ast_print_namedgroups()

char * ast_print_namedgroups	(	struct ast_str **	buf,
		struct ast_namedgroups *	groups
	)

Print named call groups and named pickup groups.

Definition at line 8078 of file channel.c.

{
    struct ao2_container *grp = (struct ao2_container *) group;
    struct namedgroup_member *ng;
    int first = 1;
    struct ao2_iterator it;
 
    if (!grp) {
        return ast_str_buffer(*buf);
    }
 
    for (it = ao2_iterator_init(grp, 0); (ng = ao2_iterator_next(&it)); ao2_ref(ng, -1)) {
        if (!first) {
            ast_str_append(buf, 0, ", ");
        } else {
            first = 0;
        }
        ast_str_append(buf, 0, "%s", ng->name);
    }
    ao2_iterator_destroy(&it);
 
    return ast_str_buffer(*buf);
}

References ao2_iterator_destroy(), ao2_iterator_init(), ao2_iterator_next, ao2_ref, ast_str_append(), ast_str_buffer(), buf, first, and namedgroup_member::name.

Referenced by func_channel_read(), named_callgroups_to_str(), and named_pickupgroups_to_str().

ast_prod()

int ast_prod

(

struct ast_channel *

chan

)

Send empty audio to prime a channel driver.

Definition at line 5019 of file channel.c.

{
    struct ast_frame a = { AST_FRAME_VOICE };
    char nothing[128];
 
    /* Send an empty audio frame to get things moving */
    if (ast_channel_state(chan) != AST_STATE_UP) {
        ast_debug(3, "Prodding channel '%s'\n", ast_channel_name(chan));
        a.subclass.format = ast_channel_rawwriteformat(chan);
        a.data.ptr = nothing + AST_FRIENDLY_OFFSET;
        a.src = "ast_prod"; /* this better match check in ast_write */
        if (ast_write(chan, &a))
            ast_log(LOG_WARNING, "Prodding channel '%s' failed\n", ast_channel_name(chan));
    }
    return 0;
}

References a, ast_channel_name(), ast_channel_rawwriteformat(), ast_debug, AST_FRAME_VOICE, AST_FRIENDLY_OFFSET, ast_log, AST_STATE_UP, ast_write(), and LOG_WARNING.

Referenced by ast_activate_generator().

ast_queue_answer()

int ast_queue_answer	(	struct ast_channel *	chan,
		const struct ast_stream_topology *	topology
	)

Queue an ANSWER control frame with topology.

Parameters

chan	channel to queue frame onto
topology	topology to be passed through the core to the peer channel

Return values

0	success
non-zero	failure

Definition at line 1265 of file channel.c.

{
    struct ast_frame f = {
        AST_FRAME_CONTROL,
        .subclass.integer = AST_CONTROL_ANSWER,
        .subclass.topology = (struct ast_stream_topology *)topology,
    };
    return ast_queue_frame(chan, &f);
}

References AST_CONTROL_ANSWER, AST_FRAME_CONTROL, and ast_queue_frame().

ast_queue_control()

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

Queue a control frame without 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

Queue a control frame without payload.

Definition at line 1250 of file channel.c.

{
    struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = control };
    return ast_queue_frame(chan, &f);
}

References AST_FRAME_CONTROL, and ast_queue_frame().

Referenced by __analog_handle_event(), __ast_read(), analog_call(), analog_exception(), analog_hangup(), apply_negotiated_sdp_stream(), ast_do_pickup(), audiosocket_call(), chan_pjsip_incoming_ack(), chan_pjsip_incoming_response(), cli_console_answer(), cli_console_flash(), console_call(), controlplayback_manager(), handle_call_incoming(), jingle_action_session_accept(), jingle_action_session_info(), jingle_outgoing_hook(), mbl_queue_control(), on_topology_change_response(), onAlerting(), onCallEstablished(), onProgress(), pbx_outgoing_state_callback(), rtp_call(), stasis_app_control_queue_control(), unistim_call(), unreal_colp_stream_topology_request_change(), and video_info_incoming_request().

ast_queue_control_data()

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

{
    struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = control, .data.ptr = (void *) data, .datalen = datalen };
    return ast_queue_frame(chan, &f);
}

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

Referenced by __analog_handle_event(), after_bridge_move_channel(), ast_channel_queue_connected_line_update(), ast_channel_queue_redirecting_update(), chan_pjsip_incoming_response_update_cause(), close_udptl_connection(), fax_gateway_indicate_t38(), iax2_transfer(), jingle_action_session_terminate(), onModeChanged(), ooh323_indicate(), queue_read_action_payload(), setup_udptl_connection(), socket_process_helper(), t38_change_state(), t38_framehook(), t38_interpret_parameters(), transfer_redirect(), transfer_refer(), and xfer_client_on_evsub_state().

ast_queue_frame()

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

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

References __ast_queue_frame(), and NULL.

Referenced by __ast_read(), action_atxfer(), action_cancel_atxfer(), apply_negotiated_sdp_stream(), ast_channel_set_unbridged_nolock(), ast_channel_setwhentohangup_tv(), ast_channel_stream_topology_changed_externally(), ast_dsp_process(), ast_msg_data_queue_frame(), ast_queue_answer(), ast_queue_cc_frame(), ast_queue_control(), ast_queue_control_data(), ast_queue_hangup(), ast_queue_hangup_with_cause(), ast_queue_hold(), ast_queue_unhold(), ast_softhangup_nolock(), AST_TEST_DEFINE(), attended_transfer_exec(), bridge_channel_internal_push_full(), bridge_channel_poke(), channel_do_masquerade(), cli_console_dial(), cli_console_sendtext(), conf_stop_record(), dahdi_queue_frame(), dahdi_read(), dictate_exec(), dtmf_info_incoming_request(), exec_command_on_condition(), handle_incoming_request(), handle_negotiated_sdp(), iax2_queue_frame(), load_stream_readqueue(), manager_play_dtmf(), manager_send_flash(), ooh323_onReceivedDigit(), queue_dtmf_readq(), refer_incoming_invite_request(), set_interval_hook(), stream_monitor(), stream_periodic_frames(), t38_tx_packet_handler(), unistim_do_senddigit(), unreal_queue_frame(), and wakeup_sub().

ast_queue_frame_head()

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

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

References __ast_queue_frame(), and NULL.

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

ast_queue_hangup()

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.

Queue a hangup frame.

Definition at line 1169 of file channel.c.

{
    struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_HANGUP };
    int res;
 
    /* Yeah, let's not change a lock-critical value without locking */
    ast_channel_lock(chan);
    ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_DEV);
    ast_channel_publish_blob(chan, ast_channel_hangup_request_type(), NULL);
 
    res = ast_queue_frame(chan, &f);
    ast_channel_unlock(chan);
    return res;
}

References ast_channel_hangup_request_type(), ast_channel_lock, ast_channel_publish_blob(), ast_channel_softhangup_internal_flag_add(), ast_channel_unlock, AST_CONTROL_HANGUP, AST_FRAME_CONTROL, ast_queue_frame(), AST_SOFTHANGUP_DEV, and NULL.

Referenced by ast_app_exec_sub(), ast_unreal_fixup(), call(), chan_pjsip_session_end(), cli_console_hangup(), close_call(), iax2_destroy(), iax2_queue_hangup(), mbl_queue_hangup(), refer_incoming_invite_request(), and session_inv_on_media_update().

ast_queue_hangup_with_cause()

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

Return values

0	on success
-1	on error

Since

1.6.1

Queue a hangup frame with hangupcause set.

Definition at line 1185 of file channel.c.

{
    RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
    struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_HANGUP };
    int res;
 
    if (cause >= 0) {
        f.data.uint32 = cause;
    }
 
    /* Yeah, let's not change a lock-critical value without locking */
    ast_channel_lock(chan);
    ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_DEV);
    if (cause < 0) {
        f.data.uint32 = ast_channel_hangupcause(chan);
    }
    blob = ast_json_pack("{s: i}",
                 "cause", cause);
    ast_channel_publish_blob(chan, ast_channel_hangup_request_type(), blob);
 
    res = ast_queue_frame(chan, &f);
    ast_channel_unlock(chan);
    return res;
}

References ast_channel_hangup_request_type(), ast_channel_hangupcause(), ast_channel_lock, ast_channel_publish_blob(), ast_channel_softhangup_internal_flag_add(), ast_channel_unlock, AST_CONTROL_HANGUP, AST_FRAME_CONTROL, ast_json_pack(), ast_json_unref(), ast_queue_frame(), AST_SOFTHANGUP_DEV, ast_frame::data, NULL, RAII_VAR, and ast_frame::uint32.

Referenced by __analog_handle_event(), ast_unreal_hangup(), chan_pjsip_session_end(), close_call(), close_client(), dahdi_handle_event(), discard_call(), handle_call_outgoing(), jingle_action_session_terminate(), jingle_queue_hangup_with_cause(), onCallCleared(), and transfer_cancel_step2().

ast_queue_hold()

int ast_queue_hold	(	struct ast_channel *	chan,
		const char *	musicclass
	)

Queue a hold frame.

Parameters

chan	channel to queue frame onto
musicclass	The suggested musicclass for the other end to use

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

{
    struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_HOLD };
    struct ast_json *blob = NULL;
    int res;
 
    if (!ast_strlen_zero(musicclass)) {
        f.data.ptr = (void *) musicclass;
        f.datalen = strlen(musicclass) + 1;
 
        blob = ast_json_pack("{s: s}",
                     "musicclass", musicclass);
    }
 
    ast_channel_lock(chan);
    ast_channel_publish_blob(chan, ast_channel_hold_type(), blob);
    ast_channel_unlock(chan);
 
    res = ast_queue_frame(chan, &f);
 
    ast_json_unref(blob);
 
    return res;
}

References ast_channel_hold_type(), ast_channel_lock, ast_channel_publish_blob(), ast_channel_unlock, AST_CONTROL_HOLD, AST_FRAME_CONTROL, ast_json_pack(), ast_json_unref(), ast_queue_frame(), ast_strlen_zero(), ast_frame::data, ast_frame::datalen, NULL, and ast_frame::ptr.

Referenced by __analog_handle_event(), analog_hangup(), apply_negotiated_sdp_stream(), dahdi_handle_event(), dahdi_hangup(), iax2_queue_hold(), jingle_action_session_info(), sub_hold(), and transfer_call_step1().

ast_queue_unhold()

int ast_queue_unhold

(

struct ast_channel *

chan

)

Queue an unhold frame.

Parameters

chan	channel to queue frame onto

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

{
    struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_UNHOLD };
    int res;
 
    ast_channel_lock(chan);
    ast_channel_publish_blob(chan, ast_channel_unhold_type(), NULL);
    ast_channel_unlock(chan);
 
    res = ast_queue_frame(chan, &f);
 
    return res;
}

References ast_channel_lock, ast_channel_publish_blob(), ast_channel_unhold_type(), ast_channel_unlock, AST_CONTROL_UNHOLD, AST_FRAME_CONTROL, ast_queue_frame(), and NULL.

Referenced by __analog_handle_event(), __analog_ss_thread(), __dahdi_exception(), analog_exception(), analog_hangup(), analog_ss_thread(), apply_negotiated_sdp_stream(), dahdi_handle_event(), dahdi_hangup(), iax2_queue_unhold(), jingle_action_session_info(), key_dial_page(), refer_incoming_invite_request(), session_inv_on_create_offer(), sub_unhold(), transfer_cancel_step2(), and unistim_hangup().

ast_raw_answer()

int ast_raw_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.

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

{
    return ast_raw_answer_with_stream_topology(chan, NULL);
}

References ast_raw_answer_with_stream_topology(), and NULL.

Referenced by __ast_answer(), answer_trunk_chan(), app_control_answer(), pbx_builtin_answer(), and refer_incoming_invite_request().

ast_raw_answer_with_stream_topology()

int ast_raw_answer_with_stream_topology	(	struct ast_channel *	chan,
		struct ast_stream_topology *	topology
	)

Answer a channel passing in a stream topology.

Since

18.0.0

Parameters

chan	channel to answer
topology	the peer's stream topology

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.

The topology is usually that of the peer channel and may be NULL.

Return values

0	on success
non-zero	on failure

Definition at line 2658 of file channel.c.

{
    int res = 0;
    SCOPE_TRACE(1, "%s\n", ast_channel_name(chan));
 
    ast_channel_lock(chan);
 
    /* You can't answer an outbound call */
    if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_OUTGOING)) {
        ast_channel_unlock(chan);
        return 0;
    }
 
    /* Stop if we're a zombie or need a soft hangup */
    if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
        ast_channel_unlock(chan);
        return -1;
    }
 
    /*
     * Mark when incoming channel answered so we can know how
     * long the channel has been up.
     */
    set_channel_answer_time(chan);
 
    ast_channel_unlock(chan);
 
    switch (ast_channel_state(chan)) {
    case AST_STATE_RINGING:
    case AST_STATE_RING:
        ast_channel_lock(chan);
        if (ast_channel_tech(chan)->answer_with_stream_topology) {
            res = ast_channel_tech(chan)->answer_with_stream_topology(chan, topology);
 
        } else if (ast_channel_tech(chan)->answer) {
            res = ast_channel_tech(chan)->answer(chan);
        }
        ast_setstate(chan, AST_STATE_UP);
        ast_channel_unlock(chan);
        break;
    case AST_STATE_UP:
        break;
    default:
        break;
    }
 
    ast_indicate(chan, -1);
 
    return res;
}

References answer(), ast_channel_tech::answer, ast_channel_tech::answer_with_stream_topology, ast_channel_flags(), ast_channel_lock, ast_channel_name(), ast_channel_tech(), ast_channel_unlock, ast_check_hangup(), AST_FLAG_OUTGOING, AST_FLAG_ZOMBIE, ast_indicate(), ast_setstate(), AST_STATE_RING, AST_STATE_RINGING, AST_STATE_UP, ast_test_flag, SCOPE_TRACE, and set_channel_answer_time().

Referenced by ast_raw_answer(), and pre_bridge_setup().

ast_read()

struct ast_frame * ast_read

(

struct ast_channel *

chan

)

Reads a frame.

Parameters

chan	channel to read a frame from

Returns

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

Note

This function will filter frames received from the channel so that only frames from the default stream for each media type are returned. All other media frames from other streams will be absorbed internally and a NULL frame returned instead.

Definition at line 4276 of file channel.c.

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

References __ast_read().

Referenced by __adsi_transmit_messages(), __analog_ss_thread(), __ast_answer(), __ast_play_and_record(), __ast_request_and_dial(), adsi_careful_send(), analog_ss_thread(), ast_recvtext(), AST_TEST_DEFINE(), ast_tonepair(), ast_transfer_protocol(), ast_waitfordigit_full(), async_agi_read_frame(), audiosocket_run(), autoservice_run(), background_detect_exec(), channel_spy(), conf_flush(), conf_run(), dial_exec_full(), dial_trunk(), dictate_exec(), disa_exec(), disable_t38(), do_broadcast(), do_waiting(), echo_exec(), eivr_comm(), generic_fax_exec(), handle_recordfile(), handle_speechrecognize(), isAnsweringMachine(), jack_exec(), measurenoise(), moh_channel_thread(), monitor_dial(), mp3_exec(), read_from_chan(), read_mf_digits(), read_sf_digits(), receive_dtmf_digits(), receivefax_t38_init(), record_exec(), recordthread(), run_agi(), safe_sleep_conditional(), scan_exec(), send_waveform_to_channel(), sendfax_t38_init(), speech_background(), stasis_app_exec(), wait_exec(), wait_for_answer(), wait_for_hangup(), wait_for_signal_or_hangup(), wait_for_winner(), waitforring_exec(), and waitstream_core().

ast_read_noaudio()

struct ast_frame * ast_read_noaudio

(

struct ast_channel *

chan

)

Reads a frame, returning AST_FRAME_NULL frame if audio.

Parameters

chan	channel to read a frame from

Returns

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

Note

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

Definition at line 4286 of file channel.c.

{
    return __ast_read(chan, 1, 1);
}

References __ast_read().

Referenced by ast_control_tone(), and conf_run().

ast_read_stream()

struct ast_frame * ast_read_stream

(

struct ast_channel *

chan

)

Reads a frame, but does not filter to just the default streams.

Parameters

chan	channel to read a frame from

Returns

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

Note

This function will not perform any filtering and will return media frames from all streams on the channel. To determine which stream a frame originated from the stream_num on it can be examined.

Definition at line 4281 of file channel.c.

{
    return __ast_read(chan, 0, 0);
}

References __ast_read().

Referenced by AST_TEST_DEFINE(), bridge_handle_trip(), read_from_chan(), and stream_echo_perform().

ast_read_stream_noaudio()

struct ast_frame * ast_read_stream_noaudio

(

struct ast_channel *

chan

)

Reads a frame, but does not filter to just the default streams, returning AST_FRAME_NULL frame if audio.

Parameters

chan	channel to read a frame from

Returns

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

Note

This function will not perform any filtering and will return media frames from all streams on the channel. To determine which stream a frame originated from the stream_num on it can be examined.

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

Definition at line 4291 of file channel.c.

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

References __ast_read().

Referenced by bridge_handle_trip().

ast_readstring()

int ast_readstring	(	struct ast_channel *	c,
		char *	s,
		int	len,
		int	timeout,
		int	rtimeout,
		char *	enders
	)

Reads multiple digits.

Parameters

c	channel to read from
s	string to read in to. Must be at least the size of your length
len	how many digits to read (maximum)
timeout	how long to timeout between digits
rtimeout	timeout to wait on the first digit
enders	digits to end the string

Read in a digit string "s", max length "len", maximum timeout between digits "timeout" (-1 for none), terminated by anything in "enders". Give them rtimeout for the first digit.

Returns

Returns 0 on normal return, or 1 on a timeout. In the case of a timeout, any digits that were read before the timeout will still be available in s. RETURNS 2 in full version when ctrlfd is available, NOT 1

Examples

app_skel.c.

Definition at line 6577 of file channel.c.

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

References ast_readstring_full(), c, and len().

Referenced by __adsi_transmit_messages(), adsi_begin_download(), adsi_get_cpeinfo(), adsi_load_session(), app_exec(), ast_app_getdata_terminator(), dialout(), do_directory(), forward_message(), privacy_exec(), vm_authenticate(), vm_newuser_setup(), and vm_options().

ast_readstring_full()

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

Definition at line 6582 of file channel.c.

{
    int pos = 0;    /* index in the buffer where we accumulate digits */
    int to = ftimeout;
 
    struct ast_silence_generator *silgen = NULL;
 
    /* Stop if we're a zombie or need a soft hangup */
    if (ast_test_flag(ast_channel_flags(c), AST_FLAG_ZOMBIE) || ast_check_hangup(c))
        return -1;
    if (!len)
        return -1;
    for (;;) {
        int d;
        if (ast_channel_stream(c)) {
            d = ast_waitstream_full(c, AST_DIGIT_ANY, audiofd, ctrlfd);
            ast_stopstream(c);
            if (!silgen && ast_opt_transmit_silence)
                silgen = ast_channel_start_silence_generator(c);
            usleep(1000);
            if (!d)
                d = ast_waitfordigit_full(c, to, NULL, audiofd, ctrlfd);
        } else {
            if (!silgen && ast_opt_transmit_silence)
                silgen = ast_channel_start_silence_generator(c);
            d = ast_waitfordigit_full(c, to, NULL, audiofd, ctrlfd);
        }
        if (d < 0) {
            ast_channel_stop_silence_generator(c, silgen);
            return AST_GETDATA_FAILED;
        }
        if (d == 0) {
            s[pos] = '\0';
            ast_channel_stop_silence_generator(c, silgen);
            return AST_GETDATA_TIMEOUT;
        }
        if (d == 1) {
            s[pos] = '\0';
            ast_channel_stop_silence_generator(c, silgen);
            return AST_GETDATA_INTERRUPTED;
        }
        if (strchr(enders, d) && (pos == 0)) {
            s[pos] = '\0';
            ast_channel_stop_silence_generator(c, silgen);
            return AST_GETDATA_EMPTY_END_TERMINATED;
        }
        if (!strchr(enders, d)) {
            s[pos++] = d;
        }
        if (strchr(enders, d) || (pos >= len)) {
            s[pos] = '\0';
            ast_channel_stop_silence_generator(c, silgen);
            return AST_GETDATA_COMPLETE;
        }
        to = timeout;
    }
    /* Never reached */
    return 0;
}

References ast_channel_flags(), ast_channel_start_silence_generator(), ast_channel_stop_silence_generator(), ast_channel_stream(), ast_check_hangup(), AST_DIGIT_ANY, AST_FLAG_ZOMBIE, AST_GETDATA_COMPLETE, AST_GETDATA_EMPTY_END_TERMINATED, AST_GETDATA_FAILED, AST_GETDATA_INTERRUPTED, AST_GETDATA_TIMEOUT, ast_opt_transmit_silence, ast_stopstream(), ast_test_flag, ast_waitfordigit_full(), ast_waitstream_full(), c, d, len(), and NULL.

Referenced by ast_app_getdata_full(), and ast_readstring().

ast_recvchar()

int ast_recvchar	(	struct ast_channel *	chan,
		int	timeout
	)

Receives a text character from a channel.

Parameters

chan	channel to act upon
timeout	timeout in milliseconds (0 for infinite wait)

Read a char of text from a channel

Returns

0 on success, -1 on failure

Definition at line 4725 of file channel.c.

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

References ast_free, ast_recvtext(), buf, c, and NULL.

Referenced by handle_recvchar().

ast_recvtext()

char * ast_recvtext	(	struct ast_channel *	chan,
		int	timeout
	)

Receives a text string from a channel Read a string of text from a channel.

Parameters

chan	channel to act upon
timeout	timeout in milliseconds (0 for infinite wait)

Returns

the received text, or NULL to signify failure.

Definition at line 4736 of file channel.c.

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

References ast_check_hangup(), AST_CONTROL_HANGUP, AST_FRAME_CONTROL, AST_FRAME_TEXT, ast_frfree, ast_read(), ast_remaining_ms(), ast_strndup, ast_tvnow(), ast_waitfor(), buf, ast_frame::data, ast_frame::datalen, ast_frame::frametype, ast_frame_subclass::integer, NULL, ast_frame::ptr, and ast_frame::subclass.

Referenced by ast_recvchar(), handle_recvtext(), and recvtext_exec().

ast_redirecting_build_data()

int ast_redirecting_build_data	(	unsigned char *	data,
		size_t	datalen,
		const struct ast_party_redirecting *	redirecting,
		const struct ast_set_party_redirecting *	update
	)

Build the redirecting id data frame.

Since

1.8

Parameters

data	Buffer to fill with the frame data
datalen	Size of the buffer to fill
redirecting	Redirecting id information
update	What redirecting information to build. NULL if all.

Return values

-1	if error
Amount	of data buffer used

Definition at line 9290 of file channel.c.

{
    int32_t value;
    size_t pos = 0;
    int res;
 
    static const struct ast_party_id_ies orig_ies = {
        .name.str = AST_REDIRECTING_ORIG_NAME,
        .name.char_set = AST_REDIRECTING_ORIG_NAME_CHAR_SET,
        .name.presentation = AST_REDIRECTING_ORIG_NAME_PRESENTATION,
        .name.valid = AST_REDIRECTING_ORIG_NAME_VALID,
 
        .number.str = AST_REDIRECTING_ORIG_NUMBER,
        .number.plan = AST_REDIRECTING_ORIG_NUMBER_PLAN,
        .number.presentation = AST_REDIRECTING_ORIG_NUMBER_PRESENTATION,
        .number.valid = AST_REDIRECTING_ORIG_NUMBER_VALID,
 
        .subaddress.str = AST_REDIRECTING_ORIG_SUBADDRESS,
        .subaddress.type = AST_REDIRECTING_ORIG_SUBADDRESS_TYPE,
        .subaddress.odd_even_indicator = AST_REDIRECTING_ORIG_SUBADDRESS_ODD_EVEN,
        .subaddress.valid = AST_REDIRECTING_ORIG_SUBADDRESS_VALID,
 
        .tag = AST_REDIRECTING_ORIG_TAG,
        .combined_presentation = 0,/* Not sent. */
    };
    static const struct ast_party_id_ies from_ies = {
        .name.str = AST_REDIRECTING_FROM_NAME,
        .name.char_set = AST_REDIRECTING_FROM_NAME_CHAR_SET,
        .name.presentation = AST_REDIRECTING_FROM_NAME_PRESENTATION,
        .name.valid = AST_REDIRECTING_FROM_NAME_VALID,
 
        .number.str = AST_REDIRECTING_FROM_NUMBER,
        .number.plan = AST_REDIRECTING_FROM_NUMBER_PLAN,
        .number.presentation = AST_REDIRECTING_FROM_NUMBER_PRESENTATION,
        .number.valid = AST_REDIRECTING_FROM_NUMBER_VALID,
 
        .subaddress.str = AST_REDIRECTING_FROM_SUBADDRESS,
        .subaddress.type = AST_REDIRECTING_FROM_SUBADDRESS_TYPE,
        .subaddress.odd_even_indicator = AST_REDIRECTING_FROM_SUBADDRESS_ODD_EVEN,
        .subaddress.valid = AST_REDIRECTING_FROM_SUBADDRESS_VALID,
 
        .tag = AST_REDIRECTING_FROM_TAG,
        .combined_presentation = AST_REDIRECTING_FROM_ID_PRESENTATION,
    };
    static const struct ast_party_id_ies to_ies = {
        .name.str = AST_REDIRECTING_TO_NAME,
        .name.char_set = AST_REDIRECTING_TO_NAME_CHAR_SET,
        .name.presentation = AST_REDIRECTING_TO_NAME_PRESENTATION,
        .name.valid = AST_REDIRECTING_TO_NAME_VALID,
 
        .number.str = AST_REDIRECTING_TO_NUMBER,
        .number.plan = AST_REDIRECTING_TO_NUMBER_PLAN,
        .number.presentation = AST_REDIRECTING_TO_NUMBER_PRESENTATION,
        .number.valid = AST_REDIRECTING_TO_NUMBER_VALID,
 
        .subaddress.str = AST_REDIRECTING_TO_SUBADDRESS,
        .subaddress.type = AST_REDIRECTING_TO_SUBADDRESS_TYPE,
        .subaddress.odd_even_indicator = AST_REDIRECTING_TO_SUBADDRESS_ODD_EVEN,
        .subaddress.valid = AST_REDIRECTING_TO_SUBADDRESS_VALID,
 
        .tag = AST_REDIRECTING_TO_TAG,
        .combined_presentation = AST_REDIRECTING_TO_ID_PRESENTATION,
    };
    static const struct ast_party_id_ies priv_orig_ies = {
        .name.str = AST_REDIRECTING_PRIV_ORIG_NAME,
        .name.char_set = AST_REDIRECTING_PRIV_ORIG_NAME_CHAR_SET,
        .name.presentation = AST_REDIRECTING_PRIV_ORIG_NAME_PRESENTATION,
        .name.valid = AST_REDIRECTING_PRIV_ORIG_NAME_VALID,
 
        .number.str = AST_REDIRECTING_PRIV_ORIG_NUMBER,
        .number.plan = AST_REDIRECTING_PRIV_ORIG_NUMBER_PLAN,
        .number.presentation = AST_REDIRECTING_PRIV_ORIG_NUMBER_PRESENTATION,
        .number.valid = AST_REDIRECTING_PRIV_ORIG_NUMBER_VALID,
 
        .subaddress.str = AST_REDIRECTING_PRIV_ORIG_SUBADDRESS,
        .subaddress.type = AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_TYPE,
        .subaddress.odd_even_indicator = AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_ODD_EVEN,
        .subaddress.valid = AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_VALID,
 
        .tag = AST_REDIRECTING_PRIV_ORIG_TAG,
        .combined_presentation = 0,/* Not sent. */
    };
    static const struct ast_party_id_ies priv_from_ies = {
        .name.str = AST_REDIRECTING_PRIV_FROM_NAME,
        .name.char_set = AST_REDIRECTING_PRIV_FROM_NAME_CHAR_SET,
        .name.presentation = AST_REDIRECTING_PRIV_FROM_NAME_PRESENTATION,
        .name.valid = AST_REDIRECTING_PRIV_FROM_NAME_VALID,
 
        .number.str = AST_REDIRECTING_PRIV_FROM_NUMBER,
        .number.plan = AST_REDIRECTING_PRIV_FROM_NUMBER_PLAN,
        .number.presentation = AST_REDIRECTING_PRIV_FROM_NUMBER_PRESENTATION,
        .number.valid = AST_REDIRECTING_PRIV_FROM_NUMBER_VALID,
 
        .subaddress.str = AST_REDIRECTING_PRIV_FROM_SUBADDRESS,
        .subaddress.type = AST_REDIRECTING_PRIV_FROM_SUBADDRESS_TYPE,
        .subaddress.odd_even_indicator = AST_REDIRECTING_PRIV_FROM_SUBADDRESS_ODD_EVEN,
        .subaddress.valid = AST_REDIRECTING_PRIV_FROM_SUBADDRESS_VALID,
 
        .tag = AST_REDIRECTING_PRIV_FROM_TAG,
        .combined_presentation = 0,/* Not sent. */
    };
    static const struct ast_party_id_ies priv_to_ies = {
        .name.str = AST_REDIRECTING_PRIV_TO_NAME,
        .name.char_set = AST_REDIRECTING_PRIV_TO_NAME_CHAR_SET,
        .name.presentation = AST_REDIRECTING_PRIV_TO_NAME_PRESENTATION,
        .name.valid = AST_REDIRECTING_PRIV_TO_NAME_VALID,
 
        .number.str = AST_REDIRECTING_PRIV_TO_NUMBER,
        .number.plan = AST_REDIRECTING_PRIV_TO_NUMBER_PLAN,
        .number.presentation = AST_REDIRECTING_PRIV_TO_NUMBER_PRESENTATION,
        .number.valid = AST_REDIRECTING_PRIV_TO_NUMBER_VALID,
 
        .subaddress.str = AST_REDIRECTING_PRIV_TO_SUBADDRESS,
        .subaddress.type = AST_REDIRECTING_PRIV_TO_SUBADDRESS_TYPE,
        .subaddress.odd_even_indicator = AST_REDIRECTING_PRIV_TO_SUBADDRESS_ODD_EVEN,
        .subaddress.valid = AST_REDIRECTING_PRIV_TO_SUBADDRESS_VALID,
 
        .tag = AST_REDIRECTING_PRIV_TO_TAG,
        .combined_presentation = 0,/* Not sent. */
    };
    static const struct ast_party_redirecting_reason_ies reason_ies = {
        .code = AST_REDIRECTING_REASON_CODE,
        .str = AST_REDIRECTING_REASON_STR,
    };
 
    static const struct ast_party_redirecting_reason_ies orig_reason_ies = {
        .code = AST_REDIRECTING_ORIG_REASON_CODE,
        .str = AST_REDIRECTING_ORIG_REASON_STR,
    };
 
    /* Redirecting frame version */
    if (datalen < pos + (sizeof(data[0]) * 2) + 1) {
        ast_log(LOG_WARNING, "No space left for redirecting frame version\n");
        return -1;
    }
    data[pos++] = AST_REDIRECTING_VERSION;
    data[pos++] = 1;
    data[pos++] = 2;/* Version 1 did not have a version ie */
 
    res = party_id_build_data(data + pos, datalen - pos, &redirecting->orig,
        "redirecting-orig", &orig_ies, update ? &update->orig : NULL);
    if (res < 0) {
        return -1;
    }
    pos += res;
 
    res = party_id_build_data(data + pos, datalen - pos, &redirecting->from,
        "redirecting-from", &from_ies, update ? &update->from : NULL);
    if (res < 0) {
        return -1;
    }
    pos += res;
 
    res = party_id_build_data(data + pos, datalen - pos, &redirecting->to,
        "redirecting-to", &to_ies, update ? &update->to : NULL);
    if (res < 0) {
        return -1;
    }
    pos += res;
 
    res = party_id_build_data(data + pos, datalen - pos, &redirecting->priv_orig,
        "redirecting-priv-orig", &priv_orig_ies, update ? &update->priv_orig : NULL);
    if (res < 0) {
        return -1;
    }
    pos += res;
 
    res = party_id_build_data(data + pos, datalen - pos, &redirecting->priv_from,
        "redirecting-priv-from", &priv_from_ies, update ? &update->priv_from : NULL);
    if (res < 0) {
        return -1;
    }
    pos += res;
 
    res = party_id_build_data(data + pos, datalen - pos, &redirecting->priv_to,
        "redirecting-priv-to", &priv_to_ies, update ? &update->priv_to : NULL);
    if (res < 0) {
        return -1;
    }
    pos += res;
 
    /* Redirecting reason */
    res = redirecting_reason_build_data(data + pos, datalen - pos, &redirecting->reason,
            "redirecting-reason", &reason_ies);
    if (res < 0) {
        return -1;
    }
    pos += res;
 
    /* Redirecting original reason */
    res = redirecting_reason_build_data(data + pos, datalen - pos, &redirecting->orig_reason,
            "redirecting-orig-reason", &orig_reason_ies);
    if (res < 0) {
        return -1;
    }
    pos += res;
 
    /* Redirecting count */
    if (datalen < pos + (sizeof(data[0]) * 2) + sizeof(value)) {
        ast_log(LOG_WARNING, "No space left for redirecting count\n");
        return -1;
    }
    data[pos++] = AST_REDIRECTING_COUNT;
    data[pos++] = sizeof(value);
    value = htonl(redirecting->count);
    memcpy(data + pos, &value, sizeof(value));
    pos += sizeof(value);
 
    return pos;
}

References ast_log, AST_REDIRECTING_COUNT, AST_REDIRECTING_FROM_ID_PRESENTATION, AST_REDIRECTING_FROM_NAME, AST_REDIRECTING_FROM_NAME_CHAR_SET, AST_REDIRECTING_FROM_NAME_PRESENTATION, AST_REDIRECTING_FROM_NAME_VALID, AST_REDIRECTING_FROM_NUMBER, AST_REDIRECTING_FROM_NUMBER_PLAN, AST_REDIRECTING_FROM_NUMBER_PRESENTATION, AST_REDIRECTING_FROM_NUMBER_VALID, AST_REDIRECTING_FROM_SUBADDRESS, AST_REDIRECTING_FROM_SUBADDRESS_ODD_EVEN, AST_REDIRECTING_FROM_SUBADDRESS_TYPE, AST_REDIRECTING_FROM_SUBADDRESS_VALID, AST_REDIRECTING_FROM_TAG, AST_REDIRECTING_ORIG_NAME, AST_REDIRECTING_ORIG_NAME_CHAR_SET, AST_REDIRECTING_ORIG_NAME_PRESENTATION, AST_REDIRECTING_ORIG_NAME_VALID, AST_REDIRECTING_ORIG_NUMBER, AST_REDIRECTING_ORIG_NUMBER_PLAN, AST_REDIRECTING_ORIG_NUMBER_PRESENTATION, AST_REDIRECTING_ORIG_NUMBER_VALID, AST_REDIRECTING_ORIG_REASON_CODE, AST_REDIRECTING_ORIG_REASON_STR, AST_REDIRECTING_ORIG_SUBADDRESS, AST_REDIRECTING_ORIG_SUBADDRESS_ODD_EVEN, AST_REDIRECTING_ORIG_SUBADDRESS_TYPE, AST_REDIRECTING_ORIG_SUBADDRESS_VALID, AST_REDIRECTING_ORIG_TAG, AST_REDIRECTING_PRIV_FROM_NAME, AST_REDIRECTING_PRIV_FROM_NAME_CHAR_SET, AST_REDIRECTING_PRIV_FROM_NAME_PRESENTATION, AST_REDIRECTING_PRIV_FROM_NAME_VALID, AST_REDIRECTING_PRIV_FROM_NUMBER, AST_REDIRECTING_PRIV_FROM_NUMBER_PLAN, AST_REDIRECTING_PRIV_FROM_NUMBER_PRESENTATION, AST_REDIRECTING_PRIV_FROM_NUMBER_VALID, AST_REDIRECTING_PRIV_FROM_SUBADDRESS, AST_REDIRECTING_PRIV_FROM_SUBADDRESS_ODD_EVEN, AST_REDIRECTING_PRIV_FROM_SUBADDRESS_TYPE, AST_REDIRECTING_PRIV_FROM_SUBADDRESS_VALID, AST_REDIRECTING_PRIV_FROM_TAG, AST_REDIRECTING_PRIV_ORIG_NAME, AST_REDIRECTING_PRIV_ORIG_NAME_CHAR_SET, AST_REDIRECTING_PRIV_ORIG_NAME_PRESENTATION, AST_REDIRECTING_PRIV_ORIG_NAME_VALID, AST_REDIRECTING_PRIV_ORIG_NUMBER, AST_REDIRECTING_PRIV_ORIG_NUMBER_PLAN, AST_REDIRECTING_PRIV_ORIG_NUMBER_PRESENTATION, AST_REDIRECTING_PRIV_ORIG_NUMBER_VALID, AST_REDIRECTING_PRIV_ORIG_SUBADDRESS, AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_ODD_EVEN, AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_TYPE, AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_VALID, AST_REDIRECTING_PRIV_ORIG_TAG, AST_REDIRECTING_PRIV_TO_NAME, AST_REDIRECTING_PRIV_TO_NAME_CHAR_SET, AST_REDIRECTING_PRIV_TO_NAME_PRESENTATION, AST_REDIRECTING_PRIV_TO_NAME_VALID, AST_REDIRECTING_PRIV_TO_NUMBER, AST_REDIRECTING_PRIV_TO_NUMBER_PLAN, AST_REDIRECTING_PRIV_TO_NUMBER_PRESENTATION, AST_REDIRECTING_PRIV_TO_NUMBER_VALID, AST_REDIRECTING_PRIV_TO_SUBADDRESS, AST_REDIRECTING_PRIV_TO_SUBADDRESS_ODD_EVEN, AST_REDIRECTING_PRIV_TO_SUBADDRESS_TYPE, AST_REDIRECTING_PRIV_TO_SUBADDRESS_VALID, AST_REDIRECTING_PRIV_TO_TAG, AST_REDIRECTING_REASON_CODE, AST_REDIRECTING_REASON_STR, AST_REDIRECTING_TO_ID_PRESENTATION, AST_REDIRECTING_TO_NAME, AST_REDIRECTING_TO_NAME_CHAR_SET, AST_REDIRECTING_TO_NAME_PRESENTATION, AST_REDIRECTING_TO_NAME_VALID, AST_REDIRECTING_TO_NUMBER, AST_REDIRECTING_TO_NUMBER_PLAN, AST_REDIRECTING_TO_NUMBER_PRESENTATION, AST_REDIRECTING_TO_NUMBER_VALID, AST_REDIRECTING_TO_SUBADDRESS, AST_REDIRECTING_TO_SUBADDRESS_ODD_EVEN, AST_REDIRECTING_TO_SUBADDRESS_TYPE, AST_REDIRECTING_TO_SUBADDRESS_VALID, AST_REDIRECTING_TO_TAG, AST_REDIRECTING_VERSION, ast_party_redirecting_reason_ies::code, ast_party_redirecting::count, ast_party_redirecting::from, LOG_WARNING, ast_party_id_ies::name, NULL, ast_party_redirecting::orig, ast_party_redirecting::orig_reason, party_id_build_data(), ast_party_redirecting::priv_from, ast_party_redirecting::priv_orig, ast_party_redirecting::priv_to, ast_party_redirecting::reason, redirecting_reason_build_data(), ast_party_name_ies::str, ast_party_redirecting::to, update(), and value.

Referenced by ast_channel_queue_redirecting_update(), ast_channel_update_redirecting(), and unreal_colp_redirect_indicate().

ast_redirecting_parse_data()

int ast_redirecting_parse_data	(	const unsigned char *	data,
		size_t	datalen,
		struct ast_party_redirecting *	redirecting
	)

Parse redirecting indication frame data.

Since

1.8

Parameters

data	Buffer with the frame data to parse
datalen	Size of the buffer
redirecting	Extracted redirecting id information

Return values

0	on success.
-1	on error.

Note

The filled in id structure needs to be initialized by ast_party_redirecting_set_init() before calling.

The filled in id structure needs to be destroyed by ast_party_redirecting_free() when it is no longer needed.

Definition at line 9501 of file channel.c.

{
    size_t pos;
    unsigned char ie_len;
    unsigned char ie_id;
    int32_t value;
    int frame_version = 1;
    int from_combined_presentation = 0;
    int got_from_combined_presentation = 0;/* TRUE if got a combined name and number presentation value. */
    int to_combined_presentation = 0;
    int got_to_combined_presentation = 0;/* TRUE if got a combined name and number presentation value. */
 
    for (pos = 0; pos < datalen; pos += ie_len) {
        if (datalen < pos + sizeof(ie_id) + sizeof(ie_len)) {
            ast_log(LOG_WARNING, "Invalid redirecting update\n");
            return -1;
        }
        ie_id = data[pos++];
        ie_len = data[pos++];
        if (datalen < pos + ie_len) {
            ast_log(LOG_WARNING, "Invalid redirecting update\n");
            return -1;
        }
 
        switch (ie_id) {
/* Redirecting frame version */
        case AST_REDIRECTING_VERSION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting frame version (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            frame_version = data[pos];
            break;
/* Redirecting-orig party id name */
        case AST_REDIRECTING_ORIG_NAME:
            ast_free(redirecting->orig.name.str);
            redirecting->orig.name.str = ast_malloc(ie_len + 1);
            if (redirecting->orig.name.str) {
                memcpy(redirecting->orig.name.str, data + pos, ie_len);
                redirecting->orig.name.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_ORIG_NAME_CHAR_SET:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-orig name char set (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->orig.name.char_set = data[pos];
            break;
        case AST_REDIRECTING_ORIG_NAME_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-orig name presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->orig.name.presentation = data[pos];
            break;
        case AST_REDIRECTING_ORIG_NAME_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-orig name valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->orig.name.valid = data[pos];
            break;
/* Redirecting-orig party id number */
        case AST_REDIRECTING_ORIG_NUMBER:
            ast_free(redirecting->orig.number.str);
            redirecting->orig.number.str = ast_malloc(ie_len + 1);
            if (redirecting->orig.number.str) {
                memcpy(redirecting->orig.number.str, data + pos, ie_len);
                redirecting->orig.number.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_ORIG_NUMBER_PLAN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-orig numbering plan (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->orig.number.plan = data[pos];
            break;
        case AST_REDIRECTING_ORIG_NUMBER_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-orig number presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->orig.number.presentation = data[pos];
            break;
        case AST_REDIRECTING_ORIG_NUMBER_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-orig number valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->orig.number.valid = data[pos];
            break;
/* Redirecting-orig party id subaddress */
        case AST_REDIRECTING_ORIG_SUBADDRESS:
            ast_free(redirecting->orig.subaddress.str);
            redirecting->orig.subaddress.str = ast_malloc(ie_len + 1);
            if (redirecting->orig.subaddress.str) {
                memcpy(redirecting->orig.subaddress.str, data + pos, ie_len);
                redirecting->orig.subaddress.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_ORIG_SUBADDRESS_TYPE:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-orig type of subaddress (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->orig.subaddress.type = data[pos];
            break;
        case AST_REDIRECTING_ORIG_SUBADDRESS_ODD_EVEN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING,
                    "Invalid redirecting-orig subaddress odd-even indicator (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->orig.subaddress.odd_even_indicator = data[pos];
            break;
        case AST_REDIRECTING_ORIG_SUBADDRESS_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-orig subaddress valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->orig.subaddress.valid = data[pos];
            break;
/* Redirecting-orig party id tag */
        case AST_REDIRECTING_ORIG_TAG:
            ast_free(redirecting->orig.tag);
            redirecting->orig.tag = ast_malloc(ie_len + 1);
            if (redirecting->orig.tag) {
                memcpy(redirecting->orig.tag, data + pos, ie_len);
                redirecting->orig.tag[ie_len] = 0;
            }
            break;
/* Redirecting-from party id name */
        case AST_REDIRECTING_FROM_NAME:
            ast_free(redirecting->from.name.str);
            redirecting->from.name.str = ast_malloc(ie_len + 1);
            if (redirecting->from.name.str) {
                memcpy(redirecting->from.name.str, data + pos, ie_len);
                redirecting->from.name.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_FROM_NAME_CHAR_SET:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-from name char set (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->from.name.char_set = data[pos];
            break;
        case AST_REDIRECTING_FROM_NAME_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-from name presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->from.name.presentation = data[pos];
            break;
        case AST_REDIRECTING_FROM_NAME_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-from name valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->from.name.valid = data[pos];
            break;
/* Redirecting-from party id number */
        case AST_REDIRECTING_FROM_NUMBER:
            ast_free(redirecting->from.number.str);
            redirecting->from.number.str = ast_malloc(ie_len + 1);
            if (redirecting->from.number.str) {
                memcpy(redirecting->from.number.str, data + pos, ie_len);
                redirecting->from.number.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_FROM_NUMBER_PLAN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-from numbering plan (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->from.number.plan = data[pos];
            break;
        case AST_REDIRECTING_FROM_NUMBER_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-from number presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->from.number.presentation = data[pos];
            break;
        case AST_REDIRECTING_FROM_NUMBER_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-from number valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->from.number.valid = data[pos];
            break;
/* Redirecting-from party id combined presentation */
        case AST_REDIRECTING_FROM_ID_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-from combined presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            from_combined_presentation = data[pos];
            got_from_combined_presentation = 1;
            break;
/* Redirecting-from party id subaddress */
        case AST_REDIRECTING_FROM_SUBADDRESS:
            ast_free(redirecting->from.subaddress.str);
            redirecting->from.subaddress.str = ast_malloc(ie_len + 1);
            if (redirecting->from.subaddress.str) {
                memcpy(redirecting->from.subaddress.str, data + pos, ie_len);
                redirecting->from.subaddress.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_FROM_SUBADDRESS_TYPE:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-from type of subaddress (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->from.subaddress.type = data[pos];
            break;
        case AST_REDIRECTING_FROM_SUBADDRESS_ODD_EVEN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING,
                    "Invalid redirecting-from subaddress odd-even indicator (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->from.subaddress.odd_even_indicator = data[pos];
            break;
        case AST_REDIRECTING_FROM_SUBADDRESS_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-from subaddress valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->from.subaddress.valid = data[pos];
            break;
/* Redirecting-from party id tag */
        case AST_REDIRECTING_FROM_TAG:
            ast_free(redirecting->from.tag);
            redirecting->from.tag = ast_malloc(ie_len + 1);
            if (redirecting->from.tag) {
                memcpy(redirecting->from.tag, data + pos, ie_len);
                redirecting->from.tag[ie_len] = 0;
            }
            break;
/* Redirecting-to party id name */
        case AST_REDIRECTING_TO_NAME:
            ast_free(redirecting->to.name.str);
            redirecting->to.name.str = ast_malloc(ie_len + 1);
            if (redirecting->to.name.str) {
                memcpy(redirecting->to.name.str, data + pos, ie_len);
                redirecting->to.name.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_TO_NAME_CHAR_SET:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-to name char set (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->to.name.char_set = data[pos];
            break;
        case AST_REDIRECTING_TO_NAME_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-to name presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->to.name.presentation = data[pos];
            break;
        case AST_REDIRECTING_TO_NAME_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-to name valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->to.name.valid = data[pos];
            break;
/* Redirecting-to party id number */
        case AST_REDIRECTING_TO_NUMBER:
            ast_free(redirecting->to.number.str);
            redirecting->to.number.str = ast_malloc(ie_len + 1);
            if (redirecting->to.number.str) {
                memcpy(redirecting->to.number.str, data + pos, ie_len);
                redirecting->to.number.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_TO_NUMBER_PLAN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-to numbering plan (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->to.number.plan = data[pos];
            break;
        case AST_REDIRECTING_TO_NUMBER_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-to number presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->to.number.presentation = data[pos];
            break;
        case AST_REDIRECTING_TO_NUMBER_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-to number valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->to.number.valid = data[pos];
            break;
/* Redirecting-to party id combined presentation */
        case AST_REDIRECTING_TO_ID_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-to combined presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            to_combined_presentation = data[pos];
            got_to_combined_presentation = 1;
            break;
/* Redirecting-to party id subaddress */
        case AST_REDIRECTING_TO_SUBADDRESS:
            ast_free(redirecting->to.subaddress.str);
            redirecting->to.subaddress.str = ast_malloc(ie_len + 1);
            if (redirecting->to.subaddress.str) {
                memcpy(redirecting->to.subaddress.str, data + pos, ie_len);
                redirecting->to.subaddress.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_TO_SUBADDRESS_TYPE:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-to type of subaddress (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->to.subaddress.type = data[pos];
            break;
        case AST_REDIRECTING_TO_SUBADDRESS_ODD_EVEN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING,
                    "Invalid redirecting-to subaddress odd-even indicator (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->to.subaddress.odd_even_indicator = data[pos];
            break;
        case AST_REDIRECTING_TO_SUBADDRESS_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid redirecting-to subaddress valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->to.subaddress.valid = data[pos];
            break;
/* Redirecting-to party id tag */
        case AST_REDIRECTING_TO_TAG:
            ast_free(redirecting->to.tag);
            redirecting->to.tag = ast_malloc(ie_len + 1);
            if (redirecting->to.tag) {
                memcpy(redirecting->to.tag, data + pos, ie_len);
                redirecting->to.tag[ie_len] = 0;
            }
            break;
/* Private redirecting-orig party id name */
        case AST_REDIRECTING_PRIV_ORIG_NAME:
            ast_free(redirecting->priv_orig.name.str);
            redirecting->priv_orig.name.str = ast_malloc(ie_len + 1);
            if (redirecting->priv_orig.name.str) {
                memcpy(redirecting->priv_orig.name.str, data + pos, ie_len);
                redirecting->priv_orig.name.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_PRIV_ORIG_NAME_CHAR_SET:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-orig name char set (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_orig.name.char_set = data[pos];
            break;
        case AST_REDIRECTING_PRIV_ORIG_NAME_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-orig name presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_orig.name.presentation = data[pos];
            break;
        case AST_REDIRECTING_PRIV_ORIG_NAME_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-orig name valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_orig.name.valid = data[pos];
            break;
/* Private redirecting-orig party id number */
        case AST_REDIRECTING_PRIV_ORIG_NUMBER:
            ast_free(redirecting->priv_orig.number.str);
            redirecting->priv_orig.number.str = ast_malloc(ie_len + 1);
            if (redirecting->priv_orig.number.str) {
                memcpy(redirecting->priv_orig.number.str, data + pos, ie_len);
                redirecting->priv_orig.number.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_PRIV_ORIG_NUMBER_PLAN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-orig numbering plan (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_orig.number.plan = data[pos];
            break;
        case AST_REDIRECTING_PRIV_ORIG_NUMBER_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-orig number presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_orig.number.presentation = data[pos];
            break;
        case AST_REDIRECTING_PRIV_ORIG_NUMBER_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-orig number valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_orig.number.valid = data[pos];
            break;
/* Private redirecting-orig party id subaddress */
        case AST_REDIRECTING_PRIV_ORIG_SUBADDRESS:
            ast_free(redirecting->priv_orig.subaddress.str);
            redirecting->priv_orig.subaddress.str = ast_malloc(ie_len + 1);
            if (redirecting->priv_orig.subaddress.str) {
                memcpy(redirecting->priv_orig.subaddress.str, data + pos, ie_len);
                redirecting->priv_orig.subaddress.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_TYPE:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-orig type of subaddress (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_orig.subaddress.type = data[pos];
            break;
        case AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_ODD_EVEN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING,
                    "Invalid private redirecting-orig subaddress odd-even indicator (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_orig.subaddress.odd_even_indicator = data[pos];
            break;
        case AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-orig subaddress valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_orig.subaddress.valid = data[pos];
            break;
/* Private redirecting-orig party id tag */
        case AST_REDIRECTING_PRIV_ORIG_TAG:
            ast_free(redirecting->priv_orig.tag);
            redirecting->priv_orig.tag = ast_malloc(ie_len + 1);
            if (redirecting->priv_orig.tag) {
                memcpy(redirecting->priv_orig.tag, data + pos, ie_len);
                redirecting->priv_orig.tag[ie_len] = 0;
            }
            break;
/* Private redirecting-from party id name */
        case AST_REDIRECTING_PRIV_FROM_NAME:
            ast_free(redirecting->priv_from.name.str);
            redirecting->priv_from.name.str = ast_malloc(ie_len + 1);
            if (redirecting->priv_from.name.str) {
                memcpy(redirecting->priv_from.name.str, data + pos, ie_len);
                redirecting->priv_from.name.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_PRIV_FROM_NAME_CHAR_SET:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-from name char set (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_from.name.char_set = data[pos];
            break;
        case AST_REDIRECTING_PRIV_FROM_NAME_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-from name presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_from.name.presentation = data[pos];
            break;
        case AST_REDIRECTING_PRIV_FROM_NAME_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-from name valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_from.name.valid = data[pos];
            break;
/* Private redirecting-from party id number */
        case AST_REDIRECTING_PRIV_FROM_NUMBER:
            ast_free(redirecting->priv_from.number.str);
            redirecting->priv_from.number.str = ast_malloc(ie_len + 1);
            if (redirecting->priv_from.number.str) {
                memcpy(redirecting->priv_from.number.str, data + pos, ie_len);
                redirecting->priv_from.number.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_PRIV_FROM_NUMBER_PLAN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-from numbering plan (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_from.number.plan = data[pos];
            break;
        case AST_REDIRECTING_PRIV_FROM_NUMBER_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-from number presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_from.number.presentation = data[pos];
            break;
        case AST_REDIRECTING_PRIV_FROM_NUMBER_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-from number valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_from.number.valid = data[pos];
            break;
/* Private redirecting-from party id subaddress */
        case AST_REDIRECTING_PRIV_FROM_SUBADDRESS:
            ast_free(redirecting->priv_from.subaddress.str);
            redirecting->priv_from.subaddress.str = ast_malloc(ie_len + 1);
            if (redirecting->priv_from.subaddress.str) {
                memcpy(redirecting->priv_from.subaddress.str, data + pos, ie_len);
                redirecting->priv_from.subaddress.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_PRIV_FROM_SUBADDRESS_TYPE:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-from type of subaddress (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_from.subaddress.type = data[pos];
            break;
        case AST_REDIRECTING_PRIV_FROM_SUBADDRESS_ODD_EVEN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING,
                    "Invalid private redirecting-from subaddress odd-even indicator (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_from.subaddress.odd_even_indicator = data[pos];
            break;
        case AST_REDIRECTING_PRIV_FROM_SUBADDRESS_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-from subaddress valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_from.subaddress.valid = data[pos];
            break;
/* Private redirecting-from party id tag */
        case AST_REDIRECTING_PRIV_FROM_TAG:
            ast_free(redirecting->priv_from.tag);
            redirecting->priv_from.tag = ast_malloc(ie_len + 1);
            if (redirecting->priv_from.tag) {
                memcpy(redirecting->priv_from.tag, data + pos, ie_len);
                redirecting->priv_from.tag[ie_len] = 0;
            }
            break;
/* Private redirecting-to party id name */
        case AST_REDIRECTING_PRIV_TO_NAME:
            ast_free(redirecting->priv_to.name.str);
            redirecting->priv_to.name.str = ast_malloc(ie_len + 1);
            if (redirecting->priv_to.name.str) {
                memcpy(redirecting->priv_to.name.str, data + pos, ie_len);
                redirecting->priv_to.name.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_PRIV_TO_NAME_CHAR_SET:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-to name char set (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_to.name.char_set = data[pos];
            break;
        case AST_REDIRECTING_PRIV_TO_NAME_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-to name presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_to.name.presentation = data[pos];
            break;
        case AST_REDIRECTING_PRIV_TO_NAME_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-to name valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_to.name.valid = data[pos];
            break;
/* Private redirecting-to party id number */
        case AST_REDIRECTING_PRIV_TO_NUMBER:
            ast_free(redirecting->priv_to.number.str);
            redirecting->priv_to.number.str = ast_malloc(ie_len + 1);
            if (redirecting->priv_to.number.str) {
                memcpy(redirecting->priv_to.number.str, data + pos, ie_len);
                redirecting->priv_to.number.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_PRIV_TO_NUMBER_PLAN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-to numbering plan (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_to.number.plan = data[pos];
            break;
        case AST_REDIRECTING_PRIV_TO_NUMBER_PRESENTATION:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-to number presentation (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_to.number.presentation = data[pos];
            break;
        case AST_REDIRECTING_PRIV_TO_NUMBER_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-to number valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_to.number.valid = data[pos];
            break;
/* Private redirecting-to party id subaddress */
        case AST_REDIRECTING_PRIV_TO_SUBADDRESS:
            ast_free(redirecting->priv_to.subaddress.str);
            redirecting->priv_to.subaddress.str = ast_malloc(ie_len + 1);
            if (redirecting->priv_to.subaddress.str) {
                memcpy(redirecting->priv_to.subaddress.str, data + pos, ie_len);
                redirecting->priv_to.subaddress.str[ie_len] = 0;
            }
            break;
        case AST_REDIRECTING_PRIV_TO_SUBADDRESS_TYPE:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-to type of subaddress (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_to.subaddress.type = data[pos];
            break;
        case AST_REDIRECTING_PRIV_TO_SUBADDRESS_ODD_EVEN:
            if (ie_len != 1) {
                ast_log(LOG_WARNING,
                    "Invalid private redirecting-to subaddress odd-even indicator (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_to.subaddress.odd_even_indicator = data[pos];
            break;
        case AST_REDIRECTING_PRIV_TO_SUBADDRESS_VALID:
            if (ie_len != 1) {
                ast_log(LOG_WARNING, "Invalid private redirecting-to subaddress valid (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            redirecting->priv_to.subaddress.valid = data[pos];
            break;
/* Private redirecting-to party id tag */
        case AST_REDIRECTING_PRIV_TO_TAG:
            ast_free(redirecting->priv_to.tag);
            redirecting->priv_to.tag = ast_malloc(ie_len + 1);
            if (redirecting->priv_to.tag) {
                memcpy(redirecting->priv_to.tag, data + pos, ie_len);
                redirecting->priv_to.tag[ie_len] = 0;
            }
            break;
/* Redirecting reason code */
        case AST_REDIRECTING_REASON_CODE:
            if (ie_len != sizeof(value)) {
                ast_log(LOG_WARNING, "Invalid redirecting reason (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            memcpy(&value, data + pos, sizeof(value));
            redirecting->reason.code = ntohl(value);
            break;
/* Redirecting reason string */
        case AST_REDIRECTING_REASON_STR:
            ast_free(redirecting->reason.str);
            redirecting->reason.str = ast_malloc(ie_len + 1);
            if (redirecting->reason.str) {
                memcpy(redirecting->reason.str, data + pos, ie_len);
                redirecting->reason.str[ie_len] = 0;
            }
            break;
/* Redirecting orig-reason code */
        case AST_REDIRECTING_ORIG_REASON_CODE:
            if (ie_len != sizeof(value)) {
                ast_log(LOG_WARNING, "Invalid redirecting original reason (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            memcpy(&value, data + pos, sizeof(value));
            redirecting->orig_reason.code = ntohl(value);
            break;
/* Redirecting orig-reason string */
        case AST_REDIRECTING_ORIG_REASON_STR:
            ast_free(redirecting->orig_reason.str);
            redirecting->orig_reason.str = ast_malloc(ie_len + 1);
            if (redirecting->orig_reason.str) {
                memcpy(redirecting->orig_reason.str, data + pos, ie_len);
                redirecting->orig_reason.str[ie_len] = 0;
            }
            break;
/* Redirecting count */
        case AST_REDIRECTING_COUNT:
            if (ie_len != sizeof(value)) {
                ast_log(LOG_WARNING, "Invalid redirecting count (%u)\n",
                    (unsigned) ie_len);
                break;
            }
            memcpy(&value, data + pos, sizeof(value));
            redirecting->count = ntohl(value);
            break;
/* Redirecting unknown element */
        default:
            ast_debug(1, "Unknown redirecting element: %u (%u)\n",
                (unsigned) ie_id, (unsigned) ie_len);
            break;
        }
    }
 
    switch (frame_version) {
    case 1:
        /*
         * The other end is an earlier version that we need to adjust
         * for compatibility.
         *
         * The earlier version did not have the orig party id or
         * orig_reason value.
         */
        redirecting->from.name.valid = 1;
        redirecting->from.name.char_set = AST_PARTY_CHAR_SET_ISO8859_1;
        redirecting->from.number.valid = 1;
        if (got_from_combined_presentation) {
            redirecting->from.name.presentation = from_combined_presentation;
            redirecting->from.number.presentation = from_combined_presentation;
        }
 
        redirecting->to.name.valid = 1;
        redirecting->to.name.char_set = AST_PARTY_CHAR_SET_ISO8859_1;
        redirecting->to.number.valid = 1;
        if (got_to_combined_presentation) {
            redirecting->to.name.presentation = to_combined_presentation;
            redirecting->to.number.presentation = to_combined_presentation;
        }
        break;
    case 2:
        /* The other end is at the same level as we are. */
        break;
    default:
        /*
         * The other end is newer than we are.
         * We need to assume that they are compatible with us.
         */
        ast_debug(1, "Redirecting frame has newer version: %u\n",
            (unsigned) frame_version);
        break;
    }
 
    return 0;
}

References ast_debug, ast_free, ast_log, ast_malloc, AST_PARTY_CHAR_SET_ISO8859_1, AST_REDIRECTING_COUNT, AST_REDIRECTING_FROM_ID_PRESENTATION, AST_REDIRECTING_FROM_NAME, AST_REDIRECTING_FROM_NAME_CHAR_SET, AST_REDIRECTING_FROM_NAME_PRESENTATION, AST_REDIRECTING_FROM_NAME_VALID, AST_REDIRECTING_FROM_NUMBER, AST_REDIRECTING_FROM_NUMBER_PLAN, AST_REDIRECTING_FROM_NUMBER_PRESENTATION, AST_REDIRECTING_FROM_NUMBER_VALID, AST_REDIRECTING_FROM_SUBADDRESS, AST_REDIRECTING_FROM_SUBADDRESS_ODD_EVEN, AST_REDIRECTING_FROM_SUBADDRESS_TYPE, AST_REDIRECTING_FROM_SUBADDRESS_VALID, AST_REDIRECTING_FROM_TAG, AST_REDIRECTING_ORIG_NAME, AST_REDIRECTING_ORIG_NAME_CHAR_SET, AST_REDIRECTING_ORIG_NAME_PRESENTATION, AST_REDIRECTING_ORIG_NAME_VALID, AST_REDIRECTING_ORIG_NUMBER, AST_REDIRECTING_ORIG_NUMBER_PLAN, AST_REDIRECTING_ORIG_NUMBER_PRESENTATION, AST_REDIRECTING_ORIG_NUMBER_VALID, AST_REDIRECTING_ORIG_REASON_CODE, AST_REDIRECTING_ORIG_REASON_STR, AST_REDIRECTING_ORIG_SUBADDRESS, AST_REDIRECTING_ORIG_SUBADDRESS_ODD_EVEN, AST_REDIRECTING_ORIG_SUBADDRESS_TYPE, AST_REDIRECTING_ORIG_SUBADDRESS_VALID, AST_REDIRECTING_ORIG_TAG, AST_REDIRECTING_PRIV_FROM_NAME, AST_REDIRECTING_PRIV_FROM_NAME_CHAR_SET, AST_REDIRECTING_PRIV_FROM_NAME_PRESENTATION, AST_REDIRECTING_PRIV_FROM_NAME_VALID, AST_REDIRECTING_PRIV_FROM_NUMBER, AST_REDIRECTING_PRIV_FROM_NUMBER_PLAN, AST_REDIRECTING_PRIV_FROM_NUMBER_PRESENTATION, AST_REDIRECTING_PRIV_FROM_NUMBER_VALID, AST_REDIRECTING_PRIV_FROM_SUBADDRESS, AST_REDIRECTING_PRIV_FROM_SUBADDRESS_ODD_EVEN, AST_REDIRECTING_PRIV_FROM_SUBADDRESS_TYPE, AST_REDIRECTING_PRIV_FROM_SUBADDRESS_VALID, AST_REDIRECTING_PRIV_FROM_TAG, AST_REDIRECTING_PRIV_ORIG_NAME, AST_REDIRECTING_PRIV_ORIG_NAME_CHAR_SET, AST_REDIRECTING_PRIV_ORIG_NAME_PRESENTATION, AST_REDIRECTING_PRIV_ORIG_NAME_VALID, AST_REDIRECTING_PRIV_ORIG_NUMBER, AST_REDIRECTING_PRIV_ORIG_NUMBER_PLAN, AST_REDIRECTING_PRIV_ORIG_NUMBER_PRESENTATION, AST_REDIRECTING_PRIV_ORIG_NUMBER_VALID, AST_REDIRECTING_PRIV_ORIG_SUBADDRESS, AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_ODD_EVEN, AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_TYPE, AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_VALID, AST_REDIRECTING_PRIV_ORIG_TAG, AST_REDIRECTING_PRIV_TO_NAME, AST_REDIRECTING_PRIV_TO_NAME_CHAR_SET, AST_REDIRECTING_PRIV_TO_NAME_PRESENTATION, AST_REDIRECTING_PRIV_TO_NAME_VALID, AST_REDIRECTING_PRIV_TO_NUMBER, AST_REDIRECTING_PRIV_TO_NUMBER_PLAN, AST_REDIRECTING_PRIV_TO_NUMBER_PRESENTATION, AST_REDIRECTING_PRIV_TO_NUMBER_VALID, AST_REDIRECTING_PRIV_TO_SUBADDRESS, AST_REDIRECTING_PRIV_TO_SUBADDRESS_ODD_EVEN, AST_REDIRECTING_PRIV_TO_SUBADDRESS_TYPE, AST_REDIRECTING_PRIV_TO_SUBADDRESS_VALID, AST_REDIRECTING_PRIV_TO_TAG, AST_REDIRECTING_REASON_CODE, AST_REDIRECTING_REASON_STR, AST_REDIRECTING_TO_ID_PRESENTATION, AST_REDIRECTING_TO_NAME, AST_REDIRECTING_TO_NAME_CHAR_SET, AST_REDIRECTING_TO_NAME_PRESENTATION, AST_REDIRECTING_TO_NAME_VALID, AST_REDIRECTING_TO_NUMBER, AST_REDIRECTING_TO_NUMBER_PLAN, AST_REDIRECTING_TO_NUMBER_PRESENTATION, AST_REDIRECTING_TO_NUMBER_VALID, AST_REDIRECTING_TO_SUBADDRESS, AST_REDIRECTING_TO_SUBADDRESS_ODD_EVEN, AST_REDIRECTING_TO_SUBADDRESS_TYPE, AST_REDIRECTING_TO_SUBADDRESS_VALID, AST_REDIRECTING_TO_TAG, AST_REDIRECTING_VERSION, ast_party_name::char_set, ast_party_redirecting_reason::code, ast_party_redirecting::count, ast_party_redirecting::from, LOG_WARNING, ast_party_id::name, ast_party_id::number, ast_party_subaddress::odd_even_indicator, ast_party_redirecting::orig, ast_party_redirecting::orig_reason, ast_party_number::plan, ast_party_name::presentation, ast_party_number::presentation, ast_party_redirecting::priv_from, ast_party_redirecting::priv_orig, ast_party_redirecting::priv_to, ast_party_redirecting::reason, ast_party_name::str, ast_party_number::str, ast_party_subaddress::str, ast_party_redirecting_reason::str, ast_party_id::subaddress, ast_party_id::tag, ast_party_redirecting::to, ast_party_subaddress::type, ast_party_name::valid, ast_party_number::valid, ast_party_subaddress::valid, and value.

Referenced by ast_channel_redirecting_sub(), and indicate_redirecting().

ast_ref_namedgroups()

struct ast_namedgroups * ast_ref_namedgroups

(

struct ast_namedgroups *

groups

)

Definition at line 7760 of file channel.c.

{
    if (groups) {
        ao2_ref(groups, 1);
    }
    return groups;
}

References ao2_ref, and groups.

Referenced by ast_channel_named_callgroups_set(), ast_channel_named_pickupgroups_set(), and mkintf().

ast_request()

struct ast_channel * ast_request	(	const char *	type,
		struct ast_format_cap *	request_cap,
		const struct ast_assigned_ids *	assignedids,
		const struct ast_channel *	requestor,
		const char *	addr,
		int *	cause
	)

Requests a channel.

Parameters

type	type of channel to request
request_cap	Format capabilities for requested channel
assignedids	Unique ID to create channel with
requestor	channel asking for data
addr	destination of the call
cause	Cause of failure

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

Return values

NULL	failure
non-NULL	channel on success

Definition at line 6373 of file channel.c.

{
    return request_channel(type, request_cap, NULL, assignedids, requestor, addr, cause);
}

References NULL, request_channel(), and type.

Referenced by __ast_request_and_dial(), alloc_playback_chan(), ast_ari_channels_create(), ast_call_forward(), attended_transfer_bridge(), begin_dial_prerun(), blind_transfer_bridge(), build_conf(), chanavail_exec(), conf_run(), conf_start_record(), dial_transfer(), findmeexec(), meetme_menu_admin_extended(), park_local_transfer(), prepare_bridge_media_channel(), prepare_bridge_moh_channel(), retransfer_enter(), ring_entry(), and wait_for_answer().

ast_request_and_dial()

struct ast_channel * ast_request_and_dial	(	const char *	type,
		struct ast_format_cap *	cap,
		const struct ast_assigned_ids *	assignedids,
		const struct ast_channel *	requestor,
		const char *	addr,
		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.

Parameters

type	type of channel to request
cap	format capabilities for requested channel
assignedids	Unique Id to assign to channel
requestor	channel asking for data
addr	destination of the call
timeout	maximum amount of time to wait for an answer
reason	why unsuccessful (if unsuccessful)
cid_num	Caller-ID Number
cid_name	Caller-ID Name (ascii)

Returns

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

Definition at line 6193 of file channel.c.

{
    return __ast_request_and_dial(type, cap, assignedids, requestor, addr, timeout, outstate, cidnum, cidname, NULL);
}

References __ast_request_and_dial(), NULL, and type.

Referenced by generic_recall().

ast_request_with_stream_topology()

struct ast_channel * ast_request_with_stream_topology	(	const char *	type,
		struct ast_stream_topology *	topology,
		const struct ast_assigned_ids *	assignedids,
		const struct ast_channel *	requestor,
		const char *	addr,
		int *	cause
	)

Requests a channel (specifying stream topology)

Parameters

type	type of channel to request
topology	Stream topology for requested channel
assignedids	Unique ID to create channel with
requestor	channel asking for data
addr	destination of the call
cause	Cause of failure

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

Return values

NULL	failure
non-NULL	channel on success

Definition at line 6378 of file channel.c.

{
    return request_channel(type, NULL, topology, assignedids, requestor, addr, cause);
}

References NULL, request_channel(), and type.

Referenced by dial_exec_full(), and do_forward().

ast_safe_sleep()

int ast_safe_sleep	(	struct ast_channel *	chan,
		int	ms
	)

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

Parameters

chan	channel to wait for
ms	length of time in milliseconds to sleep. This should never be less than zero.

Waits for a specified amount of time, servicing the channel as required.

Returns

returns -1 on hangup, otherwise 0.

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

Definition at line 1593 of file channel.c.

{
    return safe_sleep_conditional(chan, ms, NULL, NULL, 1);
}

References NULL, and safe_sleep_conditional().

Referenced by __analog_ss_thread(), adsi_transmit_message_full(), alarmreceiver_exec(), analog_ss_thread(), ast_senddigit(), ast_senddigit_mf(), conf_run(), dictate_exec(), disa_exec(), dtmf_no_bridge(), dtmf_stream(), flash_exec(), mf_stream(), milliwatt_exec(), old_milliwatt_exec(), pbx_builtin_wait(), play_moh_exec(), playtone(), privacy_exec(), send_tone_burst(), sf_stream(), testclient_exec(), testserver_exec(), try_calling(), waitforcond_exec(), waituntil_exec(), and zapateller_exec().

ast_safe_sleep_conditional()

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

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

Parameters

chan	channel to wait for
ms	length of time in milliseconds to sleep.
cond	a function pointer for testing continue condition
data	argument to be passed to the condition test function

Returns

returns -1 on hangup, otherwise 0.

Waits for a specified amount of time, servicing the channel as required. If cond returns 0, this function returns.

Definition at line 1587 of file channel.c.

{
    return safe_sleep_conditional(chan, timeout_ms, cond, data, 1);
}

References cond, ast_frame::data, and safe_sleep_conditional().

ast_safe_sleep_without_silence()

int ast_safe_sleep_without_silence	(	struct ast_channel *	chan,
		int	ms
	)

Wait for a specified amount of time, looking for hangups, and do not generate silence.

Parameters

chan	channel to wait for
ms	length of time in milliseconds to sleep. This should never be less than zero.

Waits for a specified amount of time, servicing the channel as required.

Returns

returns -1 on hangup, otherwise 0.

Note

Unlike ast_safe_sleep this will not generate silence if Asterisk is configured to do so.

Definition at line 1598 of file channel.c.

{
    return safe_sleep_conditional(chan, ms, NULL, NULL, 0);
}

References NULL, and safe_sleep_conditional().

Referenced by wait_for_hangup().

ast_senddigit()

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

Send a DTMF digit to a channel.

Parameters

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

Precondition

This must only be called by the channel's media handler thread.

Returns

0 on success, -1 on failure

Definition at line 4993 of file channel.c.

{
    if (duration < AST_DEFAULT_EMULATE_DTMF_DURATION) {
        duration = AST_DEFAULT_EMULATE_DTMF_DURATION;
    }
    if (ast_channel_tech(chan)->send_digit_begin) {
        ast_senddigit_begin(chan, digit);
        ast_safe_sleep(chan, duration);
    }
 
    return ast_senddigit_end(chan, digit, duration);
}

References ast_channel_tech(), AST_DEFAULT_EMULATE_DTMF_DURATION, ast_safe_sleep(), ast_senddigit_begin(), ast_senddigit_end(), and digit.

Referenced by dial_exec_full(), and dtmf_stream().

ast_senddigit_begin()

int ast_senddigit_begin	(	struct ast_channel *	chan,
		char	digit
	)

Send a DTMF digit to a channel.

Parameters

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

Returns

0 on success, -1 on failure

Definition at line 4893 of file channel.c.

{
    /* Device does not support DTMF tones, lets fake
     * it by doing our own generation. */
    static const char * const dtmf_tones[] = {
        "941+1336", /* 0 */
        "697+1209", /* 1 */
        "697+1336", /* 2 */
        "697+1477", /* 3 */
        "770+1209", /* 4 */
        "770+1336", /* 5 */
        "770+1477", /* 6 */
        "852+1209", /* 7 */
        "852+1336", /* 8 */
        "852+1477", /* 9 */
        "697+1633", /* A */
        "770+1633", /* B */
        "852+1633", /* C */
        "941+1633", /* D */
        "941+1209", /* * */
        "941+1477"  /* # */
    };
 
    if (!ast_channel_tech(chan)->send_digit_begin)
        return 0;
 
    ast_channel_lock(chan);
    ast_channel_sending_dtmf_digit_set(chan, digit);
    ast_channel_sending_dtmf_tv_set(chan, ast_tvnow());
    ast_channel_unlock(chan);
 
    if (!ast_channel_tech(chan)->send_digit_begin(chan, digit))
        return 0;
 
    if (digit >= '0' && digit <='9')
        ast_playtones_start(chan, 0, dtmf_tones[digit-'0'], 0);
    else if (digit >= 'A' && digit <= 'D')
        ast_playtones_start(chan, 0, dtmf_tones[digit-'A'+10], 0);
    else if (digit == '*')
        ast_playtones_start(chan, 0, dtmf_tones[14], 0);
    else if (digit == '#')
        ast_playtones_start(chan, 0, dtmf_tones[15], 0);
    else {
        /* not handled */
        ast_debug(1, "Unable to generate DTMF tone '%c' for '%s'\n", digit, ast_channel_name(chan));
    }
 
    return 0;
}

References ast_channel_lock, ast_channel_name(), ast_channel_sending_dtmf_digit_set(), ast_channel_sending_dtmf_tv_set(), ast_channel_tech(), ast_channel_unlock, ast_debug, ast_playtones_start(), ast_tvnow(), and digit.

Referenced by ast_senddigit(), ast_senddigit_external(), and ast_write_stream().

ast_senddigit_end()

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

Send a DTMF digit to a channel.

Parameters

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

Returns

Returns 0 on success, -1 on failure

Definition at line 4943 of file channel.c.

{
    int res = -1;
 
    if (ast_channel_tech(chan)->send_digit_end)
        res = ast_channel_tech(chan)->send_digit_end(chan, digit, duration);
 
    ast_channel_lock(chan);
    if (ast_channel_sending_dtmf_digit(chan) == digit) {
        ast_channel_sending_dtmf_digit_set(chan, 0);
    }
    ast_channel_unlock(chan);
 
    if (res && ast_channel_generator(chan))
        ast_playtones_stop(chan);
 
    return 0;
}

References ast_channel_generator(), ast_channel_lock, ast_channel_sending_dtmf_digit(), ast_channel_sending_dtmf_digit_set(), ast_channel_tech(), ast_channel_unlock, ast_playtones_stop(), digit, and ast_channel_tech::send_digit_end.

Referenced by ast_channel_end_dtmf(), ast_senddigit(), ast_senddigit_external(), and ast_write_stream().

ast_senddigit_external()

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

Send a DTMF digit to a channel from an external thread.

Parameters

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

Precondition

This must only be called by threads that are not the channel's media handler thread.

Returns

0 on success, -1 on failure

Definition at line 5006 of file channel.c.

{
    if (duration < AST_DEFAULT_EMULATE_DTMF_DURATION) {
        duration = AST_DEFAULT_EMULATE_DTMF_DURATION;
    }
    if (ast_channel_tech(chan)->send_digit_begin) {
        ast_senddigit_begin(chan, digit);
        usleep(duration * 1000);
    }
 
    return ast_senddigit_end(chan, digit, duration);
}

References ast_channel_tech(), AST_DEFAULT_EMULATE_DTMF_DURATION, ast_senddigit_begin(), ast_senddigit_end(), and digit.

Referenced by dtmf_stream(), and manager_play_dtmf().

ast_senddigit_mf()

int ast_senddigit_mf	(	struct ast_channel *	chan,
		char	digit,
		unsigned int	duration,
		unsigned int	durationkp,
		unsigned int	durationst,
		int	is_external
	)

Send an MF digit to a channel.

Parameters

chan	channel to act upon
digit	the MF digit to send, encoded in ASCII
duration	the duration of a numeric digit ending in ms
durationkp	the duration of a KP digit ending in ms
durationst	the duration of a ST, STP, ST2P, or ST3P digit ending in ms
is_external	1 if called by a thread that is not the channel's media handler thread, 0 if called by the channel's media handler thread.

Returns

0 on success, -1 on failure

Definition at line 4971 of file channel.c.

{
    if (duration < DEFAULT_EMULATE_MF_DURATION) {
        duration = DEFAULT_EMULATE_MF_DURATION;
    }
    if (ast_channel_tech(chan)->send_digit_begin) {
        if (digit == '*') {
            duration = durationkp;
        } else if (digit == '#' || digit == 'A' || digit == 'B' || digit == 'C') {
            duration = durationst;
        }
        ast_senddigit_mf_begin(chan, digit);
        if (is_external) {
            usleep(duration * 1000);
        } else {
            ast_safe_sleep(chan, duration);
        }
    }
    return ast_senddigit_mf_end(chan);
}

References ast_channel_tech(), ast_safe_sleep(), ast_senddigit_mf_begin(), ast_senddigit_mf_end(), DEFAULT_EMULATE_MF_DURATION, and digit.

Referenced by mf_stream().

ast_senddigit_mf_begin()

int ast_senddigit_mf_begin	(	struct ast_channel *	chan,
		char	digit
	)

Send an MF digit to a channel.

Parameters

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

Returns

0 on success, -1 on failure

Definition at line 4854 of file channel.c.

{
    static const char * const mf_tones[] = {
        "1300+1500", /* 0 */
        "700+900",   /* 1 */
        "700+1100",  /* 2 */
        "900+1100",  /* 3 */
        "700+1300",  /* 4 */
        "900+1300",  /* 5 */
        "1100+1300", /* 6 */
        "700+1500",  /* 7 */
        "900+1500",  /* 8 */
        "1100+1500", /* 9 */
        "1100+1700", /* * (KP) */
        "1500+1700", /* # (ST) */
        "900+1700",  /* A (STP) */
        "1300+1700", /* B (ST2P) */
        "700+1700"   /* C (ST3P) */
    };
 
    if (digit >= '0' && digit <='9') {
        ast_playtones_start(chan, 0, mf_tones[digit-'0'], 0);
    } else if (digit == '*') {
        ast_playtones_start(chan, 0, mf_tones[10], 0);
    } else if (digit == '#') {
        ast_playtones_start(chan, 0, mf_tones[11], 0);
    } else if (digit == 'A') {
        ast_playtones_start(chan, 0, mf_tones[12], 0);
    } else if (digit == 'B') {
        ast_playtones_start(chan, 0, mf_tones[13], 0);
    } else if (digit == 'C') {
        ast_playtones_start(chan, 0, mf_tones[14], 0);
    } else {
        /* not handled */
        ast_log(LOG_WARNING, "Unable to generate MF tone '%c' for '%s'\n", digit, ast_channel_name(chan));
    }
    return 0;
}

References ast_channel_name(), ast_log, ast_playtones_start(), digit, LOG_WARNING, and mf_tones.

Referenced by ast_senddigit_mf().

ast_senddigit_mf_end()

int ast_senddigit_mf_end

(

struct ast_channel *

chan

)

End sending an MF digit to a channel.

Parameters

chan	channel to act upon

Returns

Returns 0 on success, -1 on failure

Definition at line 4962 of file channel.c.

{
    if (ast_channel_generator(chan)) {
        ast_playtones_stop(chan);
        return 0;
    }
    return -1;
}

References ast_channel_generator(), and ast_playtones_stop().

Referenced by ast_senddigit_mf(), mf_stream(), and sf_stream().

ast_sendtext()

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

Sends text to a channel.

Parameters

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

Write text to a display on a channel

Note

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

Return values

0	on success
-1	on failure

Definition at line 4828 of file channel.c.

{
    struct ast_msg_data *msg;
    int rc;
    struct ast_msg_data_attribute attrs[] =
    {
        {
            .type = AST_MSG_DATA_ATTR_BODY,
            .value = (char *)text,
        }
    };
 
    if (ast_strlen_zero(text)) {
        return 0;
    }
 
    msg = ast_msg_data_alloc(AST_MSG_DATA_SOURCE_TYPE_UNKNOWN, attrs, ARRAY_LEN(attrs));
    if (!msg) {
        return -1;
    }
    rc = ast_sendtext_data(chan, msg);
    ast_free(msg);
 
    return rc;
}

References ARRAY_LEN, ast_free, ast_msg_data_alloc(), AST_MSG_DATA_ATTR_BODY, AST_MSG_DATA_SOURCE_TYPE_UNKNOWN, ast_sendtext_data(), ast_strlen_zero(), text, and ast_msg_data_attribute::type.

Referenced by __ast_read(), handle_sendtext(), sendtext_exec(), and sendtext_safe().

ast_sendtext_data()

int ast_sendtext_data	(	struct ast_channel *	chan,
		struct ast_msg_data *	msg
	)

Sends text to a channel in an ast_msg_data structure wrapper with ast_sendtext as fallback.

Since

13.22.0

15.5.0

Parameters

chan	channel to act upon
msg	ast_msg_data structure

Write text to a display on a channel. If the channel driver doesn't support the send_text_data callback. then the original send_text callback will be used if available.

Note

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

Return values

0	on success
-1	on failure

Definition at line 4770 of file channel.c.

{
    int res = 0;
    const char *body = ast_msg_data_get_attribute(msg, AST_MSG_DATA_ATTR_BODY);
    const char *content_type = ast_msg_data_get_attribute(msg, AST_MSG_DATA_ATTR_CONTENT_TYPE);
 
    ast_channel_lock(chan);
    /* Stop if we're a zombie or need a soft hangup */
    if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
        ast_channel_unlock(chan);
        return -1;
    }
 
    CHECK_BLOCKING(chan);
    if (ast_channel_tech(chan)->write_text
        && (ast_strlen_zero(content_type) || ast_begins_with(content_type, "text/"))
        && (ast_format_cap_has_type(ast_channel_nativeformats(chan), AST_MEDIA_TYPE_TEXT))) {
        struct ast_frame f;
        /* T.140 payload does not include the null byte terminator */
        size_t body_len = strlen(body);
 
        /* Process as T.140 text (moved here from ast_sendtext() */
        memset(&f, 0, sizeof(f));
        f.src = "DIALPLAN";
        f.subclass.format = ast_format_t140;
        f.frametype = AST_FRAME_TEXT;
        f.datalen = body_len;
        f.mallocd = AST_MALLOCD_DATA;
        f.data.ptr = ast_strdup(body);
        if (f.data.ptr) {
            res = ast_channel_tech(chan)->write_text(chan, &f);
        } else {
            res = -1;
        }
        ast_frfree(&f);
    } else if ((ast_channel_tech(chan)->properties & AST_CHAN_TP_SEND_TEXT_DATA)
        && ast_channel_tech(chan)->send_text_data) {
        /* Send enhanced message to a channel driver that supports it */
        ast_debug(1, "Sending TEXT_DATA from '%s' to %s:%s %s\n",
            ast_msg_data_get_attribute(msg, AST_MSG_DATA_ATTR_FROM),
            ast_msg_data_get_attribute(msg, AST_MSG_DATA_ATTR_TO),
            ast_channel_name(chan), body);
        res = ast_channel_tech(chan)->send_text_data(chan, msg);
    } else if (ast_channel_tech(chan)->send_text
        && (ast_strlen_zero(content_type) || ast_begins_with(content_type, "text/"))) {
        /* Send the body of an enhanced message to a channel driver that supports only a char str */
        ast_debug(1, "Sending TEXT to %s: %s\n", ast_channel_name(chan), body);
        res = ast_channel_tech(chan)->send_text(chan, body);
    } else {
        ast_debug(1, "Channel technology does not support sending content type '%s' on channel '%s'\n",
            S_OR(content_type, "text/plain"), ast_channel_name(chan));
        res = -1;
    }
    ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
    ast_channel_unlock(chan);
    return res;
}

References ast_begins_with(), AST_CHAN_TP_SEND_TEXT_DATA, ast_channel_flags(), ast_channel_lock, ast_channel_name(), ast_channel_nativeformats(), ast_channel_tech(), ast_channel_unlock, ast_check_hangup(), ast_clear_flag, ast_debug, AST_FLAG_BLOCKING, AST_FLAG_ZOMBIE, ast_format_cap_has_type(), ast_format_t140, AST_FRAME_TEXT, ast_frfree, AST_MALLOCD_DATA, AST_MEDIA_TYPE_TEXT, AST_MSG_DATA_ATTR_BODY, AST_MSG_DATA_ATTR_CONTENT_TYPE, AST_MSG_DATA_ATTR_FROM, AST_MSG_DATA_ATTR_TO, ast_msg_data_get_attribute(), ast_strdup, ast_strlen_zero(), ast_test_flag, CHECK_BLOCKING, ast_frame::data, ast_frame::datalen, ast_frame_subclass::format, ast_frame::frametype, ast_frame::mallocd, ast_frame::ptr, S_OR, send_text(), ast_channel_tech::send_text, ast_channel_tech::send_text_data, ast_frame::src, ast_frame::subclass, and ast_channel_tech::write_text.

Referenced by __ast_read(), ast_sendtext(), bridge_channel_handle_write(), and sendtext_exec().

ast_set_callerid()

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 and generate AMI event.

Note

Use ast_channel_set_caller() and ast_channel_set_caller_event() instead.

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

Definition at line 7356 of file channel.c.

{
    ast_channel_lock(chan);
 
    if (cid_num) {
        ast_channel_caller(chan)->id.number.valid = 1;
        ast_free(ast_channel_caller(chan)->id.number.str);
        ast_channel_caller(chan)->id.number.str = ast_strdup(cid_num);
    }
    if (cid_name) {
        ast_channel_caller(chan)->id.name.valid = 1;
        ast_free(ast_channel_caller(chan)->id.name.str);
        ast_channel_caller(chan)->id.name.str = ast_strdup(cid_name);
    }
    if (cid_ani) {
        ast_channel_caller(chan)->ani.number.valid = 1;
        ast_free(ast_channel_caller(chan)->ani.number.str);
        ast_channel_caller(chan)->ani.number.str = ast_strdup(cid_ani);
    }
 
    ast_channel_publish_snapshot(chan);
 
    ast_channel_unlock(chan);
}

References ast_party_caller::ani, ast_channel_caller(), ast_channel_lock, ast_channel_publish_snapshot(), ast_channel_unlock, ast_free, ast_strdup, ast_party_caller::id, name, ast_party_id::name, ast_party_id::number, ast_party_name::str, ast_party_number::str, ast_party_name::valid, and ast_party_number::valid.

Referenced by __analog_ss_thread(), __ast_request_and_dial(), analog_ss_thread(), ari_channels_handle_originate_with_id(), disa_exec(), handle_setcallerid(), pbx_outgoing_attempt(), privacy_exec(), ring_entry(), and socket_process_helper().

ast_set_hangupsource()

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.

Parameters

chan	channel to set the field on
source	a string describing the source of the hangup for this channel
force

Note

Absolutely NO channel locks should be held before calling this function.

Since

1.8

Hangupsource is generally the channel name that caused the bridge to be hung up, but it can also be other things such as "dialplan/agi" This can then be logged in the CDR or CEL

Definition at line 2518 of file channel.c.

{
    RAII_VAR(struct ast_channel *, bridge, ast_channel_bridge_peer(chan), ast_channel_cleanup);
 
    ast_channel_lock(chan);
    if (force || ast_strlen_zero(ast_channel_hangupsource(chan))) {
        ast_channel_hangupsource_set(chan, source);
    }
    ast_channel_unlock(chan);
 
    if (bridge) {
        ast_channel_lock(bridge);
        if (force || ast_strlen_zero(ast_channel_hangupsource(bridge))) {
            ast_channel_hangupsource_set(bridge, source);
        }
        ast_channel_unlock(bridge);
    }
}

References ast_channel_bridge_peer(), ast_channel_cleanup, ast_channel_hangupsource(), ast_channel_lock, ast_channel_unlock, ast_strlen_zero(), and RAII_VAR.

Referenced by __dahdi_exception(), analog_exception(), call(), chan_pjsip_session_end(), func_channel_write_real(), handle_hangup(), pbx_builtin_hangup(), session_inv_on_media_update(), and set_hangup_source_and_cause().

ast_set_party_id_all()

void ast_set_party_id_all

(

struct ast_set_party_id *

update_id

)

Set the update marker to update all information of a corresponding party id.

Since

11.0

Parameters

update_id

The update marker for a corresponding party id.

Definition at line 1769 of file channel.c.

{
    update_id->name = 1;
    update_id->number = 1;
    update_id->subaddress = 1;
}

References ast_set_party_id::name, ast_set_party_id::number, and ast_set_party_id::subaddress.

Referenced by set_redirecting().

ast_set_read_format()

int ast_set_read_format	(	struct ast_channel *	chan,
		struct ast_format *	format
	)

Sets read format on channel chan.

Parameters

chan	channel to change
format	format to set for reading

Returns

Returns 0 on success, -1 on failure

Definition at line 5781 of file channel.c.

{
    struct ast_format_cap *cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
    int res;
 
    ast_assert(format != NULL);
 
    if (!cap) {
        return -1;
    }
    ast_format_cap_append(cap, format, 0);
 
    res = set_format(chan, cap, 0, 0);
 
    ao2_cleanup(cap);
    return res;
}

References ao2_cleanup, ast_assert, ast_format_cap_alloc, ast_format_cap_append, AST_FORMAT_CAP_FLAG_DEFAULT, NULL, and set_format().

Referenced by __ast_play_and_record(), adsi_transmit_message_full(), alarmreceiver_exec(), ast_bridge_channel_restore_formats(), ast_channel_make_compatible_helper(), audiosocket_exec(), background_detect_exec(), build_conf(), channel_do_masquerade(), conf_run(), dictate_exec(), do_waiting(), eagi_exec(), fax_detect_framehook(), fax_gateway_framehook(), generic_fax_exec(), handle_recordfile(), handle_speechrecognize(), holding_bridge_join(), isAnsweringMachine(), jack_exec(), jingle_interpret_content(), jingle_read(), measurenoise(), meetme_menu_admin_extended(), old_milliwatt_exec(), ooh323_new(), ooh323_rtp_read(), ooh323_set_read_format(), ooh323_set_write_format(), record_exec(), set_caps(), set_read_to_slin(), socket_process_helper(), speech_background(), and unistim_rtp_read().

ast_set_read_format_from_cap()

int ast_set_read_format_from_cap	(	struct ast_channel *	chan,
		struct ast_format_cap *	formats
	)

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

Parameters

chan	channel to change
formats	new formats to pick from for reading

Returns

Returns 0 on success, -1 on failure

Definition at line 5799 of file channel.c.

{
    return set_format(chan, cap, 0, 0);
}

References set_format().

ast_set_read_format_path()

int ast_set_read_format_path	(	struct ast_channel *	chan,
		struct ast_format *	raw_format,
		struct ast_format *	core_format
	)

Set specific read path on channel.

Since

13.4.0

Parameters

chan	Channel to setup read path.
raw_format	Format to expect from the channel driver.
core_format	What the core wants to read.

Precondition

chan is locked

Return values

0	on success.
-1	on error.

Definition at line 5507 of file channel.c.

{
    struct ast_trans_pvt *trans_old;
    struct ast_trans_pvt *trans_new;
 
    if (ast_format_cmp(ast_channel_rawreadformat(chan), raw_format) == AST_FORMAT_CMP_EQUAL
        && ast_format_cmp(ast_channel_readformat(chan), core_format) == AST_FORMAT_CMP_EQUAL) {
        /* Nothing to setup */
        return 0;
    }
 
    ast_debug(1, "Channel %s setting read format path: %s -> %s\n",
        ast_channel_name(chan),
        ast_format_get_name(raw_format),
        ast_format_get_name(core_format));
 
    /* Setup new translation path. */
    if (ast_format_cmp(raw_format, core_format) != AST_FORMAT_CMP_EQUAL) {
        trans_new = ast_translator_build_path(core_format, raw_format);
        if (!trans_new) {
            return -1;
        }
    } else {
        /* No translation needed. */
        trans_new = NULL;
    }
    trans_old = ast_channel_readtrans(chan);
    if (trans_old) {
        ast_translator_free_path(trans_old);
    }
    ast_channel_readtrans_set(chan, trans_new);
    ast_channel_set_rawreadformat(chan, raw_format);
    ast_channel_set_readformat(chan, core_format);
    return 0;
}

References ast_channel_name(), ast_channel_rawreadformat(), ast_channel_readformat(), ast_channel_readtrans(), ast_channel_readtrans_set(), ast_channel_set_rawreadformat(), ast_channel_set_readformat(), ast_debug, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_format_get_name(), ast_translator_build_path(), ast_translator_free_path(), and NULL.

Referenced by __ast_read(), chan_pjsip_read_stream(), set_softmix_bridge_data(), and softmix_bridge_write_voice().

ast_set_variables()

void ast_set_variables	(	struct ast_channel *	chan,
		struct ast_variable *	vars
	)

adds a list of channel variables to a channel

Parameters

chan	the channel
vars	a linked list of variables

Precondition

chan is locked

Variable names can be for a regular channel variable or a dialplan function that has the ability to be written to.

Definition at line 8137 of file channel.c.

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

References ast_variable::name, ast_variable::next, pbx_builtin_setvar_helper(), and ast_variable::value.

Referenced by __ast_request_and_dial(), ari_channels_handle_originate_with_id(), ast_ari_channels_create(), ast_call_forward(), ast_pbx_outgoing_exten_predial(), and pbx_outgoing_attempt().

ast_set_write_format()

int ast_set_write_format	(	struct ast_channel *	chan,
		struct ast_format *	format
	)

Sets write format on channel chan.

Parameters

chan	channel to change
format	format to set for writing

Returns

Returns 0 on success, -1 on failure

Definition at line 5822 of file channel.c.

{
    struct ast_format_cap *cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
    int res;
 
    ast_assert(format != NULL);
 
    if (!cap) {
        return -1;
    }
    ast_format_cap_append(cap, format, 0);
 
    res = set_format(chan, cap, 1, 0);
 
    ao2_cleanup(cap);
    return res;
}

References ao2_cleanup, ast_assert, ast_format_cap_alloc, ast_format_cap_append, AST_FORMAT_CAP_FLAG_DEFAULT, NULL, and set_format().

Referenced by adsi_transmit_message_full(), alarmreceiver_exec(), ast_bridge_channel_restore_formats(), ast_channel_make_compatible_helper(), ast_channel_start_silence_generator(), ast_channel_stop_silence_generator(), ast_stopstream(), ast_write_stream(), audiosocket_exec(), broadcast_exec(), build_conf(), channel_do_masquerade(), chanspy_exec(), conf_run(), dahdiscan_exec(), extenspy_exec(), fax_gateway_framehook(), generic_fax_exec(), handle_participant_join(), jack_exec(), jingle_interpret_content(), jingle_read(), linear_alloc(), linear_release(), meetme_menu_admin_extended(), moh_alloc(), moh_files_release(), moh_files_write_format_change(), moh_release(), mp3_exec(), old_milliwatt_exec(), ooh323_new(), ooh323_rtp_read(), ooh323_set_write_format(), ooh323_write(), participant_reaction_announcer_join(), playtones_alloc(), playtones_release(), send_waveform_to_channel(), set_caps(), set_softmix_bridge_data(), socket_process_helper(), tonepair_alloc(), tonepair_release(), and unistim_rtp_read().

ast_set_write_format_from_cap()

int ast_set_write_format_from_cap	(	struct ast_channel *	chan,
		struct ast_format_cap *	formats
	)

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

Parameters

chan	channel to change
formats	new formats to pick from for writing

Returns

Returns 0 on success, -1 on failure

Definition at line 5840 of file channel.c.

{
    return set_format(chan, cap, 1, 0);
}

References set_format().

Referenced by ast_openstream_full().

ast_set_write_format_interleaved_stereo()

int ast_set_write_format_interleaved_stereo	(	struct ast_channel *	chan,
		struct ast_format *	format
	)

Sets write format for a channel. All internal data will than be handled in an interleaved format. (needed by binaural opus)

Parameters

chan	channel to change
format	format to set for writing

Returns

Returns 0 on success, -1 on failure

Definition at line 5804 of file channel.c.

{
    struct ast_format_cap *cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
    int res;
 
    ast_assert(format != NULL);
 
    if (!cap) {
        return -1;
    }
    ast_format_cap_append(cap, format, 0);
 
    res = set_format(chan, cap, 1, 1);
 
    ao2_cleanup(cap);
    return res;
}

References ao2_cleanup, ast_assert, ast_format_cap_alloc, ast_format_cap_append, AST_FORMAT_CAP_FLAG_DEFAULT, NULL, and set_format().

Referenced by set_softmix_bridge_data(), and softmix_bridge_unsuspend().

ast_set_write_format_path()

int ast_set_write_format_path	(	struct ast_channel *	chan,
		struct ast_format *	core_format,
		struct ast_format *	raw_format
	)

Set specific write path on channel.

Since

13.13.0

Parameters

chan	Channel to setup write path.
core_format	What the core wants to write.
raw_format	Raw write format.

Precondition

chan is locked

Return values

0	on success.
-1	on error.

Definition at line 5543 of file channel.c.

{
    struct ast_trans_pvt *trans_old;
    struct ast_trans_pvt *trans_new;
 
    if (ast_format_cmp(ast_channel_rawwriteformat(chan), raw_format) == AST_FORMAT_CMP_EQUAL
        && ast_format_cmp(ast_channel_writeformat(chan), core_format) == AST_FORMAT_CMP_EQUAL) {
        /* Nothing to setup */
        return 0;
    }
 
    ast_debug(1, "Channel %s setting write format path: %s -> %s\n",
        ast_channel_name(chan),
        ast_format_get_name(core_format),
        ast_format_get_name(raw_format));
 
    /* Setup new translation path. */
    if (ast_format_cmp(raw_format, core_format) != AST_FORMAT_CMP_EQUAL) {
        trans_new = ast_translator_build_path(raw_format, core_format);
        if (!trans_new) {
            return -1;
        }
    } else {
        /* No translation needed. */
        trans_new = NULL;
    }
    trans_old = ast_channel_writetrans(chan);
    if (trans_old) {
        ast_translator_free_path(trans_old);
    }
    ast_channel_writetrans_set(chan, trans_new);
    ast_channel_set_rawwriteformat(chan, raw_format);
    ast_channel_set_writeformat(chan, core_format);
    return 0;
}

References ast_channel_name(), ast_channel_rawwriteformat(), ast_channel_set_rawwriteformat(), ast_channel_set_writeformat(), ast_channel_writeformat(), ast_channel_writetrans(), ast_channel_writetrans_set(), ast_debug, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_format_get_name(), ast_translator_build_path(), ast_translator_free_path(), and NULL.

Referenced by chan_pjsip_read_stream().

ast_settimeout()

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

Enable or disable timer ticks for a channel.

Parameters

c	channel
rate	number of timer ticks per second
func	callback function
data

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

Note

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

Version

1.6.1 changed samples parameter to rate, accommodates new timing methods

Definition at line 3199 of file channel.c.

{
    return ast_settimeout_full(c, rate, func, data, 0);
}

References ast_settimeout_full(), c, and ast_channel::data.

Referenced by ast_activate_generator(), ast_readaudio_callback(), deactivate_generator_nolock(), and filestream_close().

ast_settimeout_full()

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

Definition at line 3204 of file channel.c.

{
    int res;
    unsigned int real_rate = rate, max_rate;
 
    ast_channel_lock(c);
 
    if (ast_channel_timingfd(c) == -1) {
        ast_channel_unlock(c);
        return -1;
    }
 
    if (!func) {
        rate = 0;
        data = NULL;
    }
 
    if (rate && rate > (max_rate = ast_timer_get_max_rate(ast_channel_timer(c)))) {
        real_rate = max_rate;
    }
 
    ast_debug(3, "Scheduling timer at (%u requested / %u actual) timer ticks per second\n", rate, real_rate);
 
    res = ast_timer_set_rate(ast_channel_timer(c), real_rate);
 
    if (ast_channel_timingdata(c) && ast_test_flag(ast_channel_flags(c), AST_FLAG_TIMINGDATA_IS_AO2_OBJ)) {
        ao2_ref(ast_channel_timingdata(c), -1);
    }
 
    ast_channel_timingfunc_set(c, func);
    ast_channel_timingdata_set(c, data);
 
    if (data && is_ao2_obj) {
        ao2_ref(data, 1);
        ast_set_flag(ast_channel_flags(c), AST_FLAG_TIMINGDATA_IS_AO2_OBJ);
    } else {
        ast_clear_flag(ast_channel_flags(c), AST_FLAG_TIMINGDATA_IS_AO2_OBJ);
    }
 
    if (func == NULL && rate == 0 && ast_channel_fdno(c) == AST_TIMING_FD) {
        /* Clearing the timing func and setting the rate to 0
         * means that we don't want to be reading from the timingfd
         * any more. Setting c->fdno to -1 means we won't have any
         * errant reads from the timingfd, meaning we won't potentially
         * miss any important frames.
         */
        ast_channel_fdno_set(c, -1);
    }
 
    ast_channel_unlock(c);
 
    return res;
}

References ao2_ref, ast_channel_fdno(), ast_channel_fdno_set(), ast_channel_flags(), ast_channel_lock, ast_channel_timer(), ast_channel_timingdata(), ast_channel_timingdata_set(), ast_channel_timingfd(), ast_channel_timingfunc_set(), ast_channel_unlock, ast_clear_flag, ast_debug, AST_FLAG_TIMINGDATA_IS_AO2_OBJ, ast_set_flag, ast_test_flag, ast_timer_get_max_rate(), ast_timer_set_rate(), AST_TIMING_FD, c, ast_channel::data, and NULL.

Referenced by ast_readaudio_callback(), and ast_settimeout().

ast_softhangup()

int ast_softhangup	(	struct ast_channel *	chan,
		int	cause
	)

Softly hangup up a channel.

Parameters

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

Call the protocol layer, but don't destroy the channel structure (use this if you are trying to safely hangup a channel managed by another thread.

Note

The channel passed to this function does not need to be locked.

Returns

Returns 0 regardless

Softly hangup up a channel.

Definition at line 2490 of file channel.c.

{
    RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
    int res;
 
    ast_channel_lock(chan);
    res = ast_softhangup_nolock(chan, cause);
    blob = ast_json_pack("{s: i, s: b}",
                 "cause", cause,
                 "soft", 1);
    ast_channel_publish_blob(chan, ast_channel_hangup_request_type(), blob);
    ast_channel_unlock(chan);
 
    return res;
}

References ast_channel_hangup_request_type(), ast_channel_lock, ast_channel_publish_blob(), ast_channel_unlock, ast_json_pack(), ast_json_unref(), ast_softhangup_nolock(), NULL, and RAII_VAR.

Referenced by __analog_handle_event(), __ast_module_user_hangup_all(), __ast_pbx_run(), __unload_module(), after_bridge_move_channel(), after_bridge_move_channel_fail(), agent_logoff_request(), agents_sweep(), analog_attempt_transfer(), ast_ari_channels_hangup(), ast_bridge_transfer_attended(), ast_channel_softhangup_cb(), ast_dial_join(), attempt_transfer(), blond_nonfinal_exit(), bridge_channel_attended_transfer(), cc_generic_agent_stop_ringing(), conf_free(), dahdi_handle_event(), handle_hangup(), handle_softhangup(), hangup_channel(), retransfer_exit(), rtp_check_timeout(), sla_handle_hold_event(), softhangup_exec(), stasis_app_bridge_moh_stop(), and unload_module().

ast_softhangup_all()

void ast_softhangup_all

(

void

)

Soft hangup all active channels.

Since

13.3.0

Definition at line 493 of file channel.c.

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

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

Referenced by can_safely_quit().

ast_softhangup_nolock()

int ast_softhangup_nolock	(	struct ast_channel *	chan,
		int	cause
	)

Softly hangup up a channel (no channel lock)

Parameters

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

Softly hangup up a channel (no channel lock)

Definition at line 2477 of file channel.c.

{
    ast_debug(1, "Soft-Hanging (%#04x) up channel '%s'\n", (unsigned)cause, ast_channel_name(chan));
    /* Inform channel driver that we need to be hung up, if it cares */
    ast_channel_softhangup_internal_flag_add(chan, cause);
    ast_queue_frame(chan, &ast_null_frame);
    /* Interrupt any poll call or such */
    if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING))
        pthread_kill(ast_channel_blocker(chan), SIGURG);
    return 0;
}

References ast_channel_blocker(), ast_channel_flags(), ast_channel_name(), ast_channel_softhangup_internal_flag_add(), ast_debug, AST_FLAG_BLOCKING, ast_null_frame, ast_queue_frame(), and ast_test_flag.

Referenced by __analog_handle_event(), app_control_dial(), ast_async_goto(), ast_bridge_join(), ast_channel_softhangup_withcause_locked(), ast_pbx_h_exten_run(), ast_pbx_hangup_handler_run(), ast_softhangup(), attempt_transfer(), dahdi_softhangup_all(), do_monitor(), gosub_run(), internal_bridge_after_cb(), jingle_indicate(), and pbx_builtin_hangup().

ast_state2str()

const char * ast_state2str

(

enum ast_channel_state

state

)

Gives the string form of a given channel state.

Parameters

state

state to get the name of

Returns

the text form of the binary state given

Note

This function is not reentrant.

Definition at line 636 of file channel.c.

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

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

Referenced by ast_channel_snapshot_to_json(), ast_manager_build_channel_state_string_prefix(), cli_channel_print_body(), func_channel_read(), handle_chanlist(), handle_showchan(), and serialize_showchan().

ast_str2cause()

int ast_str2cause

(

const char *

name

)

Convert the string form of a cause code to a number.

Parameters

name	string form of the cause

Returns

the cause code

Convert the string form of a cause code to a number.

Definition at line 625 of file channel.c.

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

References ARRAY_LEN, causes, and name.

Referenced by dial_exec_full(), and pbx_builtin_hangup().

ast_tonepair()

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

Play a tone pair for a given amount of time

Definition at line 7622 of file channel.c.

{
    int res;
 
    if ((res = ast_tonepair_start(chan, freq1, freq2, duration, vol)))
        return res;
 
    /* Give us some wiggle room */
    while (ast_channel_generatordata(chan) && ast_waitfor(chan, 100) >= 0) {
        struct ast_frame *f = ast_read(chan);
        if (f)
            ast_frfree(f);
        else
            return -1;
    }
    return 0;
}

References ast_channel_generatordata(), ast_frfree, ast_read(), ast_tonepair_start(), ast_waitfor(), tonepair_def::duration, tonepair_def::freq1, tonepair_def::freq2, and tonepair_def::vol.

Referenced by zapateller_exec().

ast_tonepair_start()

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

Start a tone going

Definition at line 7604 of file channel.c.

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

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

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

ast_tonepair_stop()

void ast_tonepair_stop

(

struct ast_channel *

chan

)

Stop a tone from playing

Definition at line 7617 of file channel.c.

{
    ast_deactivate_generator(chan);
}

References ast_deactivate_generator().

Referenced by sendnoise().

ast_transfer()

int ast_transfer	(	struct ast_channel *	chan,
		char *	dest
	)

Transfer a channel (if supported).

Return values

-1	on error
0	if not supported
1	if supported and requested

Parameters

chan	current channel
dest	destination extension for transfer

Transfer a channel (if supported).

Called by:

• app_transfer
• the manager interface

Definition at line 6504 of file channel.c.

{
    int protocol;
    return ast_transfer_protocol(chan, dest, &protocol);
}

References ast_transfer_protocol().

Referenced by app_control_redirect().

ast_transfer_protocol()

int ast_transfer_protocol	(	struct ast_channel *	chan,
		char *	dest,
		int *	protocol
	)

Transfer a channel (if supported) receieve protocol result.

Return values

-1	on error
0	if not supported
1	if supported and requested

Parameters

chan	channel to transfer
dest	destination extension to transfer to
protocol	protocol is the protocol result SIP example, 0=success, 3xx-6xx is SIP error code

Transfer a channel (if supported) receieve protocol result.

Called by:

• app_transfer
• the manager interface

Definition at line 6517 of file channel.c.

{
    int res = -1;
 
    if (protocol) {
        *protocol = 0;
    }
 
    /* Stop if we're a zombie or need a soft hangup */
    ast_channel_lock(chan);
    if (!ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
        if (ast_channel_tech(chan)->transfer) {
            res = ast_channel_tech(chan)->transfer(chan, dest);
            if (!res)
                res = 1;
        } else
            res = 0;
    }
    ast_channel_unlock(chan);
 
    if (res <= 0) {
        return res;
    }
 
    for (;;) {
        struct ast_frame *fr;
 
        res = ast_waitfor(chan, -1);
 
        if (res < 0 || !(fr = ast_read(chan))) {
            res = -1;
            break;
        }
 
        if (fr->frametype == AST_FRAME_CONTROL && fr->subclass.integer == AST_CONTROL_TRANSFER) {
            enum ast_control_transfer *message = fr->data.ptr;
 
            if (*message == AST_TRANSFER_SUCCESS) {
                res = 1;
            } else {
                res = -1;
                /* Message can contain a protocol specific code
                   AST_TRANSFER_SUCCESS indicates success
                   Else, failure.  Protocol will be set to the failure reason.
                   SIP example, 0 is success, else error code 3xx-6xx */
                if (protocol) {
                    *protocol = *message;
                }
            }
 
            ast_frfree(fr);
            break;
        }
 
        ast_frfree(fr);
    }
 
    return res;
}

References ast_channel_flags(), ast_channel_lock, ast_channel_tech(), ast_channel_unlock, ast_check_hangup(), AST_CONTROL_TRANSFER, AST_FLAG_ZOMBIE, AST_FRAME_CONTROL, ast_frfree, ast_read(), ast_test_flag, AST_TRANSFER_SUCCESS, ast_waitfor(), ast_frame::data, ast_frame::frametype, ast_frame_subclass::integer, ast_frame::ptr, ast_frame::subclass, transfer(), and ast_channel_tech::transfer.

Referenced by ast_transfer(), and transfer_exec().

ast_transfercapability2str()

char * ast_transfercapability2str

(

int

transfercapability

)

const

Gives the string form of a given transfer capability.

Parameters

transfercapability

transfer capability to get the name of

Returns

the text form of the binary transfer capability

Definition at line 672 of file channel.c.

{
    switch (transfercapability) {
    case AST_TRANS_CAP_SPEECH:
        return "SPEECH";
    case AST_TRANS_CAP_DIGITAL:
        return "DIGITAL";
    case AST_TRANS_CAP_RESTRICTED_DIGITAL:
        return "RESTRICTED_DIGITAL";
    case AST_TRANS_CAP_3_1K_AUDIO:
        return "3K1AUDIO";
    case AST_TRANS_CAP_DIGITAL_W_TONES:
        return "DIGITAL_W_TONES";
    case AST_TRANS_CAP_VIDEO:
        return "VIDEO";
    default:
        return "UNKNOWN";
    }
}

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

ast_undestroyed_channels()

int ast_undestroyed_channels

(

void

)

Returns

the number of channels not yet destroyed

Definition at line 504 of file channel.c.

{
    return ast_atomic_fetchadd_int(&chancount, 0);
}

References ast_atomic_fetchadd_int(), and chancount.

Referenced by wait_for_channels_to_die().

ast_unref_namedgroups()

struct ast_namedgroups * ast_unref_namedgroups

(

struct ast_namedgroups *

groups

)

Definition at line 7754 of file channel.c.

{
    ao2_cleanup(groups);
    return NULL;
}

References ao2_cleanup, and NULL.

Referenced by ast_channel_named_callgroups_set(), ast_channel_named_pickupgroups_set(), destroy_dahdi_pvt(), endpoint_destructor(), func_channel_write_real(), mkintf(), named_groups_handler(), and process_dahdi().

ast_waitfor()

int ast_waitfor	(	struct ast_channel *	chan,
		int	ms
	)

Wait for input on a channel.

Parameters

chan	channel to wait on
ms	length of time to wait on the channel

Wait for input on a channel for a given # of milliseconds (<0 for indefinite).

Return values

<	0 on failure
0	if nothing ever arrived
the	# of ms remaining otherwise

Definition at line 3181 of file channel.c.

{
    if (ms < 0) {
        do {
            ms = 100000;
            ast_waitfor_nandfds(&c, 1, NULL, 0, NULL, NULL, &ms);
        } while (!ms);
    } else {
        ast_waitfor_nandfds(&c, 1, NULL, 0, NULL, NULL, &ms);
    }
    return ms;
}

References ast_waitfor_nandfds(), c, and NULL.

Referenced by __adsi_transmit_messages(), __analog_ss_thread(), __ast_answer(), __ast_play_and_record(), __ast_request_and_dial(), adsi_careful_send(), analog_ss_thread(), ast_control_tone(), ast_recvtext(), ast_tonepair(), ast_transfer_protocol(), background_detect_exec(), channel_spy(), conf_flush(), dial_trunk(), dictate_exec(), disa_exec(), disable_t38(), do_broadcast(), do_waiting(), echo_exec(), handle_recordfile(), handle_speechrecognize(), isAnsweringMachine(), jack_exec(), launch_asyncagi(), measurenoise(), moh_channel_thread(), mp3_exec(), read_mf_digits(), read_sf_digits(), receive_dtmf_digits(), receivefax_t38_init(), record_exec(), recordthread(), safe_sleep_conditional(), scan_exec(), send_waveform_to_channel(), sendfax_t38_init(), speech_background(), stasis_app_exec(), stream_echo_perform(), wait_exec(), wait_for_hangup(), waitforring_exec(), and waitstream_core().

ast_waitfor_n()

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

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

Returns

Return channel with activity, or NULL if none has activity.

Parameters

chan	an array of pointers to channels
n	number of channels that are to be waited upon
ms	time "ms" is modified in-place, if applicable

Definition at line 3176 of file channel.c.

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

References ast_waitfor_nandfds(), c, and NULL.

Referenced by autoservice_run(), dial_exec_full(), monitor_dial(), wait_for_answer(), and wait_for_winner().

ast_waitfor_n_fd()

int ast_waitfor_n_fd	(	int *	fds,
		int	n,
		int *	ms,
		int *	exception
	)

Waits for input on an fd.

Note

This version works on fd's only. Be careful with it.

Waits for input on an fd.

Definition at line 2999 of file channel.c.

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

References ast_waitfor_nandfds(), and NULL.

Referenced by dundi_lookup_internal(), dundi_precache_internal(), rfcomm_wait(), and softmix_mixing_loop().

ast_waitfor_nandfds()

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

Waits for activity on a group of channels.

Parameters

c	an array of pointers to channels
n	number of channels that are to be waited upon
fds	an array of fds to wait upon
nfds	the number of fds to wait upon
exception	exception flag
outfd	fd that had activity on it
ms	how long the wait was

Big momma function here. Wait for activity on any of the n channels, or any of the nfds file descriptors.

Returns

Returns the channel with activity, or NULL on error or if an FD came first. If the FD came first, it will be returned in outfd, otherwise, outfd will be -1

Waits for activity on a group of channels.

Definition at line 3007 of file channel.c.

{
    struct timeval start = { 0 , 0 };
    struct pollfd *pfds = NULL;
    int res;
    long rms;
    int x, y, max;
    int sz = nfds;
    struct timeval now = { 0, 0 };
    struct timeval whentohangup = { 0, 0 }, diff;
    struct ast_channel *winner = NULL;
    struct fdmap {
        int chan;
        int fdno;
    } *fdmap = NULL;
 
    if (outfd) {
        *outfd = -99999;
    }
    if (exception) {
        *exception = 0;
    }
 
    for (x = 0; x < n; x++) {
        ast_channel_lock(c[x]);
        if (!ast_tvzero(*ast_channel_whentohangup(c[x]))) {
            if (ast_tvzero(whentohangup))
                now = ast_tvnow();
            diff = ast_tvsub(*ast_channel_whentohangup(c[x]), now);
            if (diff.tv_sec < 0 || ast_tvzero(diff)) {
                ast_test_suite_event_notify("HANGUP_TIME", "Channel: %s", ast_channel_name(c[x]));
                /* Should already be hungup */
                ast_channel_softhangup_internal_flag_add(c[x], AST_SOFTHANGUP_TIMEOUT);
                ast_channel_unlock(c[x]);
                return c[x];
            }
            if (ast_tvzero(whentohangup) || ast_tvcmp(diff, whentohangup) < 0)
                whentohangup = diff;
        }
        sz += ast_channel_fd_count(c[x]);
        ast_channel_unlock(c[x]);
    }
 
    if (!sz) {
        return NULL;
    }
 
    pfds = ast_alloca(sizeof(*pfds) * sz);
    fdmap = ast_alloca(sizeof(*fdmap) * sz);
 
    /* Wait full interval */
    rms = *ms;
    /* INT_MAX, not LONG_MAX, because it matters on 64-bit */
    if (!ast_tvzero(whentohangup) && whentohangup.tv_sec < INT_MAX / 1000) {
        rms = whentohangup.tv_sec * 1000 + whentohangup.tv_usec / 1000;              /* timeout in milliseconds */
        if (*ms >= 0 && *ms < rms) {                                                 /* original *ms still smaller */
            rms =  *ms;
        }
    } else if (!ast_tvzero(whentohangup) && rms < 0) {
        /* Tiny corner case... call would need to last >24 days */
        rms = INT_MAX;
    }
    /*
     * Build the pollfd array, putting the channels' fds first,
     * followed by individual fds. Order is important because
     * individual fd's must have priority over channel fds.
     */
    max = 0;
    for (x = 0; x < n; x++) {
        ast_channel_lock(c[x]);
        for (y = 0; y < ast_channel_fd_count(c[x]); y++) {
            fdmap[max].fdno = y;  /* fd y is linked to this pfds */
            fdmap[max].chan = x;  /* channel x is linked to this pfds */
            max += ast_add_fd(&pfds[max], ast_channel_fd(c[x], y));
        }
        CHECK_BLOCKING(c[x]);
        ast_channel_unlock(c[x]);
    }
    /* Add the individual fds */
    for (x = 0; x < nfds; x++) {
        fdmap[max].chan = -1;
        max += ast_add_fd(&pfds[max], fds[x]);
    }
 
    if (*ms > 0) {
        start = ast_tvnow();
    }
 
    if (sizeof(int) == 4) { /* XXX fix timeout > 600000 on linux x86-32 */
        do {
            int kbrms = rms;
            if (kbrms > 600000) {
                kbrms = 600000;
            }
            res = ast_poll(pfds, max, kbrms);
            if (!res) {
                rms -= kbrms;
            }
        } while (!res && (rms > 0));
    } else {
        res = ast_poll(pfds, max, rms);
    }
    for (x = 0; x < n; x++) {
        ast_channel_lock(c[x]);
        ast_clear_flag(ast_channel_flags(c[x]), AST_FLAG_BLOCKING);
        ast_channel_unlock(c[x]);
    }
    if (res < 0) { /* Simulate a timeout if we were interrupted */
        if (errno != EINTR) {
            *ms = -1;
        }
        return NULL;
    }
    if (!ast_tvzero(whentohangup)) {   /* if we have a timeout, check who expired */
        now = ast_tvnow();
        for (x = 0; x < n; x++) {
            if (!ast_tvzero(*ast_channel_whentohangup(c[x])) && ast_tvcmp(*ast_channel_whentohangup(c[x]), now) <= 0) {
                ast_test_suite_event_notify("HANGUP_TIME", "Channel: %s", ast_channel_name(c[x]));
                ast_channel_softhangup_internal_flag_add(c[x], AST_SOFTHANGUP_TIMEOUT);
                if (winner == NULL) {
                    winner = c[x];
                }
            }
        }
    }
    if (res == 0) { /* no fd ready, reset timeout and done */
        *ms = 0;    /* XXX use 0 since we may not have an exact timeout. */
        return winner;
    }
    /*
     * Then check if any channel or fd has a pending event.
     * Remember to check channels first and fds last, as they
     * must have priority on setting 'winner'
     */
    for (x = 0; x < max; x++) {
        res = pfds[x].revents;
        if (res == 0) {
            continue;
        }
        if (fdmap[x].chan >= 0) {   /* this is a channel */
            winner = c[fdmap[x].chan];  /* override previous winners */
            ast_channel_lock(winner);
            if (res & POLLPRI) {
                ast_set_flag(ast_channel_flags(winner), AST_FLAG_EXCEPTION);
            } else {
                ast_clear_flag(ast_channel_flags(winner), AST_FLAG_EXCEPTION);
            }
            ast_channel_fdno_set(winner, fdmap[x].fdno);
            ast_channel_unlock(winner);
        } else {            /* this is an fd */
            if (outfd) {
                *outfd = pfds[x].fd;
            }
            if (exception) {
                *exception = (res & POLLPRI) ? -1 : 0;
            }
            winner = NULL;
        }
    }
    if (*ms > 0) {
        *ms -= ast_tvdiff_ms(ast_tvnow(), start);
        if (*ms < 0) {
            *ms = 0;
        }
    }
    return winner;
}

References ast_add_fd(), ast_alloca, ast_channel_fd(), ast_channel_fd_count(), ast_channel_fdno_set(), ast_channel_flags(), ast_channel_lock, ast_channel_name(), ast_channel_softhangup_internal_flag_add(), ast_channel_unlock, ast_channel_whentohangup(), ast_clear_flag, AST_FLAG_BLOCKING, AST_FLAG_EXCEPTION, ast_poll, ast_set_flag, AST_SOFTHANGUP_TIMEOUT, ast_test_suite_event_notify, ast_tvcmp(), ast_tvdiff_ms(), ast_tvnow(), ast_tvsub(), ast_tvzero(), c, CHECK_BLOCKING, errno, max, and NULL.

Referenced by ast_waitfor(), ast_waitfor_n(), ast_waitfor_n_fd(), ast_waitfordigit_full(), audiosocket_run(), bridge_channel_wait(), conf_run(), eivr_comm(), generic_fax_exec(), run_agi(), wait_for_signal_or_hangup(), and waitstream_core().

ast_waitfordigit()

int ast_waitfordigit	(	struct ast_channel *	c,
		int	ms
	)

Waits for a digit.

Parameters

c	channel to wait for a digit on
ms	how many milliseconds to wait (<0 for indefinite).

Returns

Returns <0 on error, 0 on no entry, and the digit on success.

Definition at line 3194 of file channel.c.

{
    return ast_waitfordigit_full(c, ms, NULL, -1, -1);
}

References ast_waitfordigit_full(), c, and NULL.

Referenced by __analog_ss_thread(), _while_exec(), adsi_get_cpeid(), adsi_get_cpeinfo(), adsi_print(), adsi_read_encoded_dtmf(), adsi_transmit_message_full(), advanced_options(), analog_my_getsigstr(), analog_ss_thread(), ast_app_dtget(), ast_record_review(), collect_digits(), common_exec(), control_streamfile(), cpeid_exec(), dialout(), directory_exec(), forward_message(), get_folder(), get_folder_ja(), ivr_dispatch(), my_getsigstr(), pbx_builtin_waitexten(), play_record_review(), read_exec(), read_newoption(), readexten_exec(), retrydial_exec(), select_item_menu(), select_item_pause(), select_item_seq(), sendnoise(), testclient_exec(), testserver_exec(), vm_execmain(), vm_forwardoptions(), vm_instructions_en(), vm_instructions_ja(), vm_options(), vm_tempgreeting(), wait_a_bit(), and wait_our_turn().

ast_waitfordigit_full()

int ast_waitfordigit_full	(	struct ast_channel *	c,
		int	ms,
		const char *	breakon,
		int	audiofd,
		int	ctrlfd
	)

Wait for a digit Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.

Parameters

c	channel to wait for a digit on
ms	how many milliseconds to wait (<0 for indefinite).
breakon	string of DTMF digits to break upon or NULL for any.
audiofd	audio file descriptor to write to if audio frames are received
ctrlfd	control file descriptor to monitor for reading

Returns

Returns 1 if ctrlfd becomes available

Definition at line 3258 of file channel.c.

{
    struct timeval start = ast_tvnow();
    int ms;
 
    /* Stop if we're a zombie or need a soft hangup */
    if (ast_test_flag(ast_channel_flags(c), AST_FLAG_ZOMBIE) || ast_check_hangup(c))
        return -1;
 
    /* Only look for the end of DTMF, don't bother with the beginning and don't emulate things */
    ast_channel_set_flag(c, AST_FLAG_END_DTMF_ONLY);
 
    /* Wait for a digit, no more than timeout_ms milliseconds total.
     * Or, wait indefinitely if timeout_ms is <0.
     */
    while ((ms = ast_remaining_ms(start, timeout_ms))) {
        struct ast_channel *rchan;
        int outfd = -1;
 
        errno = 0;
        /* While ast_waitfor_nandfds tries to help by reducing the timeout by how much was waited,
         * it is unhelpful if it waited less than a millisecond.
         */
        rchan = ast_waitfor_nandfds(&c, 1, &cmdfd, (cmdfd > -1) ? 1 : 0, NULL, &outfd, &ms);
 
        if (!rchan && outfd < 0 && ms) {
            if (errno == 0 || errno == EINTR)
                continue;
            ast_log(LOG_WARNING, "Wait failed (%s)\n", strerror(errno));
            ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
            return -1;
        } else if (outfd > -1) {
            /* The FD we were watching has something waiting */
            ast_log(LOG_WARNING, "The FD we were waiting for has something waiting. Waitfordigit returning numeric 1\n");
            ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
            return 1;
        } else if (rchan) {
            int res;
            struct ast_frame *f = ast_read(c);
 
            if (!f) {
                ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
 
                return -1;
            }
 
            switch (f->frametype) {
            case AST_FRAME_DTMF_BEGIN:
                break;
            case AST_FRAME_DTMF_END:
                res = f->subclass.integer;
                if (!breakon || strchr(breakon, res)) {
                    ast_frfree(f);
                    ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
                    return res;
                }
                break;
            case AST_FRAME_CONTROL:
                switch (f->subclass.integer) {
                case AST_CONTROL_HANGUP:
                    ast_frfree(f);
                    ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
                    return -1;
                case AST_CONTROL_STREAM_STOP:
                case AST_CONTROL_STREAM_SUSPEND:
                case AST_CONTROL_STREAM_RESTART:
                case AST_CONTROL_STREAM_REVERSE:
                case AST_CONTROL_STREAM_FORWARD:
                    /* Fall-through and treat as if it were a DTMF signal. Items
                     * that perform stream control will handle this. */
                    res = f->subclass.integer;
                    ast_frfree(f);
                    ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
                    return res;
                case AST_CONTROL_PVT_CAUSE_CODE:
                case AST_CONTROL_PROGRESS:
                case AST_CONTROL_RINGING:
                case AST_CONTROL_ANSWER:
                case AST_CONTROL_SRCUPDATE:
                case AST_CONTROL_SRCCHANGE:
                case AST_CONTROL_CONNECTED_LINE:
                case AST_CONTROL_REDIRECTING:
                case AST_CONTROL_UPDATE_RTP_PEER:
                case AST_CONTROL_HOLD:
                case AST_CONTROL_UNHOLD:
                case AST_CONTROL_FLASH:
                case -1:
                    /* Unimportant */
                    break;
                default:
                    ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", f->subclass.integer);
                    break;
                }
                break;
            case AST_FRAME_VOICE:
                /* Write audio if appropriate */
                if (audiofd > -1) {
                    if (write(audiofd, f->data.ptr, f->datalen) < 0) {
                        ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
                    }
                }
            default:
                /* Ignore */
                break;
            }
            ast_frfree(f);
        }
    }
 
    ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
 
    return 0; /* Time is up */
}

References ast_channel_clear_flag(), ast_channel_flags(), ast_channel_set_flag(), ast_check_hangup(), AST_CONTROL_ANSWER, AST_CONTROL_CONNECTED_LINE, AST_CONTROL_FLASH, AST_CONTROL_HANGUP, AST_CONTROL_HOLD, AST_CONTROL_PROGRESS, AST_CONTROL_PVT_CAUSE_CODE, AST_CONTROL_REDIRECTING, AST_CONTROL_RINGING, AST_CONTROL_SRCCHANGE, AST_CONTROL_SRCUPDATE, AST_CONTROL_STREAM_FORWARD, AST_CONTROL_STREAM_RESTART, AST_CONTROL_STREAM_REVERSE, AST_CONTROL_STREAM_STOP, AST_CONTROL_STREAM_SUSPEND, AST_CONTROL_UNHOLD, AST_CONTROL_UPDATE_RTP_PEER, AST_FLAG_END_DTMF_ONLY, AST_FLAG_ZOMBIE, AST_FRAME_CONTROL, AST_FRAME_DTMF_BEGIN, AST_FRAME_DTMF_END, AST_FRAME_VOICE, ast_frfree, ast_log, ast_read(), ast_remaining_ms(), ast_test_flag, ast_tvnow(), ast_waitfor_nandfds(), c, ast_frame::data, ast_frame::datalen, errno, ast_frame::frametype, ast_frame_subclass::integer, LOG_WARNING, NULL, ast_frame::ptr, and ast_frame::subclass.

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

ast_write()

int ast_write	(	struct ast_channel *	chan,
		struct ast_frame *	frame
	)

Write a frame to a channel This function writes the given frame to the indicated channel.

Parameters

chan	destination channel of the frame
frame	frame that will be written

Returns

It returns 0 on success, -1 on failure.

Definition at line 5163 of file channel.c.

{
    return ast_write_stream(chan, -1, fr);
}

References ast_write_stream().

Referenced by adsi_careful_send(), ast_prod(), ast_readaudio_callback(), ast_readvideo_callback(), AST_TEST_DEFINE(), ast_write_video(), audiosocket_run(), conf_queue_dtmf(), conf_run(), dictate_exec(), echo_exec(), fax_gateway_detect_v21(), gen_generate(), generic_fax_exec(), handle_jack_audio(), jb_get_and_deliver(), linear_generator(), manager_send_flash(), milliwatt_generate(), moh_files_generator(), moh_generate(), mp3_exec(), playtones_generator(), send_waveform_to_channel(), silence_generator_generate(), sms_generate(), spandsp_fax_gw_t30_gen(), spy_generate(), t38_tx_packet_handler(), tonepair_generator(), and wait_for_answer().

ast_write_stream()

int ast_write_stream	(	struct ast_channel *	chan,
		int	stream_num,
		struct ast_frame *	frame
	)

Write a frame to a stream This function writes the given frame to the indicated stream on the channel.

Parameters

chan	destination channel of the frame
stream_num	destination stream on the channel
frame	frame that will be written

Returns

It returns 0 on success, -1 on failure.

Note

If -1 is provided as the stream number and a media frame is provided the function will write to the default stream of the type of media.

Definition at line 5168 of file channel.c.

{
    struct ast_stream *stream = NULL, *default_stream = NULL;
    int res = -1;
    struct ast_frame *f = NULL;
    int count = 0;
    int hooked = 0;
 
    /*Deadlock avoidance*/
    while(ast_channel_trylock(chan)) {
        /*cannot goto done since the channel is not locked*/
        if(count++ > 10) {
            ast_debug(1, "Deadlock avoided for write to channel '%s'\n", ast_channel_name(chan));
            return 0;
        }
        usleep(1);
    }
 
    /* Stop if we're a zombie or need a soft hangup */
    if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
        goto done;
    }
 
    if (stream_num >= 0) {
        /* If we were told to write to an explicit stream then allow this frame through, no matter
         * if the type is expected or not (a framehook could change)
         */
        if (stream_num >= ast_stream_topology_get_count(ast_channel_get_stream_topology(chan))) {
            goto done;
        }
        stream = ast_stream_topology_get_stream(ast_channel_get_stream_topology(chan), stream_num);
        default_stream = ast_channel_get_default_stream(chan, ast_stream_get_type(stream));
    } else if (fr->frametype == AST_FRAME_VOICE || fr->frametype == AST_FRAME_VIDEO || fr->frametype == AST_FRAME_MODEM) {
        /* If we haven't been told of a stream then we need to figure out which once we need */
        enum ast_media_type type = AST_MEDIA_TYPE_UNKNOWN;
 
        /* Some frame types have a fixed media type */
        if (fr->frametype == AST_FRAME_VOICE || fr->frametype == AST_FRAME_VIDEO) {
            type = ast_format_get_type(fr->subclass.format);
        } else if (fr->frametype == AST_FRAME_MODEM) {
            type = AST_MEDIA_TYPE_IMAGE;
        }
 
        /* No stream was specified, so use the default one */
        stream = default_stream = ast_channel_get_default_stream(chan, type);
    }
 
    /* Perform the framehook write event here. After the frame enters the framehook list
     * there is no telling what will happen, how awesome is that!!! */
    if ((stream == default_stream) && !(fr = ast_framehook_list_write_event(ast_channel_framehooks(chan), fr))) {
        res = 0;
        goto done;
    }
 
    if (ast_channel_generatordata(chan) && (fr->frametype != AST_FRAME_RTCP) && (!fr->src || strcasecmp(fr->src, "ast_prod"))) {
        if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_WRITE_INT)) {
                ast_deactivate_generator(chan);
        } else {
            if (fr->frametype == AST_FRAME_DTMF_END) {
                /* There is a generator running while we're in the middle of a digit.
                 * It's probably inband DTMF, so go ahead and pass it so it can
                 * stop the generator */
                ast_channel_unlock(chan);
                res = ast_senddigit_end(chan, fr->subclass.integer, fr->len);
                ast_channel_lock(chan);
            } else if (fr->frametype == AST_FRAME_CONTROL
                && fr->subclass.integer == AST_CONTROL_UNHOLD) {
                /*
                 * This is a side case where Echo is basically being called
                 * and the person put themselves on hold and took themselves
                 * off hold.
                 */
                indicate_data_internal(chan, fr->subclass.integer, fr->data.ptr,
                    fr->datalen);
            }
            res = 0;    /* XXX explain, why 0 ? */
            goto done;
        }
    }
    /* High bit prints debugging */
    if (ast_channel_fout(chan) & DEBUGCHAN_FLAG)
        ast_frame_dump(ast_channel_name(chan), fr, ">>");
    switch (fr->frametype) {
    case AST_FRAME_CONTROL:
        indicate_data_internal(chan, fr->subclass.integer, fr->data.ptr, fr->datalen);
        res = 0;
        break;
    case AST_FRAME_DTMF_BEGIN:
        if (ast_channel_audiohooks(chan)) {
            struct ast_frame *old_frame = fr;
            fr = ast_audiohook_write_list(chan, ast_channel_audiohooks(chan), AST_AUDIOHOOK_DIRECTION_WRITE, fr);
            if (old_frame != fr)
                f = fr;
        }
        send_dtmf_begin_event(chan, DTMF_SENT, fr->subclass.integer);
        ast_channel_unlock(chan);
        res = ast_senddigit_begin(chan, fr->subclass.integer);
        ast_channel_lock(chan);
        break;
    case AST_FRAME_DTMF_END:
        if (ast_channel_audiohooks(chan)) {
            struct ast_frame *new_frame = fr;
 
            new_frame = ast_audiohook_write_list(chan, ast_channel_audiohooks(chan), AST_AUDIOHOOK_DIRECTION_WRITE, fr);
            if (new_frame != fr) {
                ast_frfree(new_frame);
            }
        }
        send_dtmf_end_event(chan, DTMF_SENT, fr->subclass.integer, fr->len);
        ast_channel_unlock(chan);
        res = ast_senddigit_end(chan, fr->subclass.integer, fr->len);
        ast_channel_lock(chan);
        break;
    case AST_FRAME_TEXT:
        CHECK_BLOCKING(chan);
        if (ast_format_cmp(fr->subclass.format, ast_format_t140) == AST_FORMAT_CMP_EQUAL) {
            res = (ast_channel_tech(chan)->write_text == NULL) ? 0 :
                ast_channel_tech(chan)->write_text(chan, fr);
        } else {
            res = (ast_channel_tech(chan)->send_text == NULL) ? 0 :
                ast_channel_tech(chan)->send_text(chan, (char *) fr->data.ptr);
        }
        ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
        break;
    case AST_FRAME_HTML:
        CHECK_BLOCKING(chan);
        res = (ast_channel_tech(chan)->send_html == NULL) ? 0 :
            ast_channel_tech(chan)->send_html(chan, fr->subclass.integer, (char *) fr->data.ptr, fr->datalen);
        ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
        break;
    case AST_FRAME_VIDEO:
        /* XXX Handle translation of video codecs one day XXX */
        CHECK_BLOCKING(chan);
        if (ast_channel_tech(chan)->write_stream) {
            if (stream) {
                res = ast_channel_tech(chan)->write_stream(chan, ast_stream_get_position(stream), fr);
            } else {
                res = 0;
            }
        } else if ((stream == default_stream) && ast_channel_tech(chan)->write_video) {
            res = ast_channel_tech(chan)->write_video(chan, fr);
        } else {
            res = 0;
        }
        ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
        break;
    case AST_FRAME_MODEM:
        CHECK_BLOCKING(chan);
        res = tech_write(chan, stream, default_stream, fr);
        ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
        break;
    case AST_FRAME_VOICE:
        if (ast_opt_generic_plc && ast_format_cmp(fr->subclass.format, ast_format_slin) == AST_FORMAT_CMP_EQUAL) {
            apply_plc(chan, fr);
        }
 
        f = fr;
 
        /*
         * Send frame to audiohooks if present, if frametype is linear (else, later as per
         * previous behavior)
         */
        if ((stream == default_stream) && ast_channel_audiohooks(chan)) {
            if (ast_format_cache_is_slinear(fr->subclass.format)) {
                hooked = 1;
                f = ast_audiohook_write_list(chan, ast_channel_audiohooks(chan), AST_AUDIOHOOK_DIRECTION_WRITE, fr);
            }
        }
 
        /* If the frame is in the raw write format, then it's easy... just use the frame - otherwise we will have to translate */
        if ((stream == default_stream) && ast_format_cmp(fr->subclass.format, ast_channel_rawwriteformat(chan)) != AST_FORMAT_CMP_EQUAL) {
            if (ast_format_cmp(ast_channel_writeformat(chan), fr->subclass.format) != AST_FORMAT_CMP_EQUAL) {
                struct ast_str *codec_buf = ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN);
 
                /*
                 * We are not setup to write this frame.  Things may have changed
                 * on the peer side of the world and we try to adjust the format to
                 * make it compatible again.  However, bad things can happen if we
                 * cannot setup a new translation path.  Problems range from no
                 * audio, one-way audio, to garbled audio.  The best we can do is
                 * request the call to hangup since we could not make it compatible.
                 *
                 * Being continuously spammed by this message likely indicates a
                 * problem with the peer because it cannot make up its mind about
                 * which format to use.
                 */
                ast_debug(1, "Channel %s changing write format from %s to %s, native formats %s\n",
                    ast_channel_name(chan),
                    ast_format_get_name(ast_channel_writeformat(chan)),
                    ast_format_get_name(fr->subclass.format),
                    ast_format_cap_get_names(ast_channel_nativeformats(chan), &codec_buf));
                if (ast_set_write_format(chan, fr->subclass.format)) {
                    /* Could not handle the new write format.  Induce a hangup. */
                    break;
                }
            }
 
            if (ast_channel_writetrans(chan)) {
                struct ast_frame *trans_frame = ast_translate(ast_channel_writetrans(chan), f, 0);
                if (trans_frame != f && f != fr) {
                    /*
                     * If translate gives us a new frame and so did the audio
                     * hook then we need to free the one from the audio hook.
                     */
                    ast_frfree(f);
                }
                f = trans_frame;
            }
        }
 
        if (!f) {
            res = 0;
            break;
        }
 
        if ((stream == default_stream) && ast_channel_audiohooks(chan) && !hooked) {
            struct ast_frame *prev = NULL, *new_frame, *cur, *dup;
            int freeoldlist = 0;
 
            if (f != fr) {
                freeoldlist = 1;
            }
 
            /* Since ast_audiohook_write may return a new frame, and the cur frame is
             * an item in a list of frames, create a new list adding each cur frame back to it
             * regardless if the cur frame changes or not. */
            for (cur = f; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
                new_frame = ast_audiohook_write_list(chan, ast_channel_audiohooks(chan), AST_AUDIOHOOK_DIRECTION_WRITE, cur);
 
                /* if this frame is different than cur, preserve the end of the list,
                 * free the old frames, and set cur to be the new frame */
                if (new_frame != cur) {
 
                    /* doing an ast_frisolate here seems silly, but we are not guaranteed the new_frame
                     * isn't part of local storage, meaning if ast_audiohook_write is called multiple
                     * times it may override the previous frame we got from it unless we dup it */
                    if ((dup = ast_frisolate(new_frame))) {
                        AST_LIST_NEXT(dup, frame_list) = AST_LIST_NEXT(cur, frame_list);
                        if (freeoldlist) {
                            AST_LIST_NEXT(cur, frame_list) = NULL;
                            ast_frfree(cur);
                        }
                        if (new_frame != dup) {
                            ast_frfree(new_frame);
                        }
                        cur = dup;
                    }
                }
 
                /* now, regardless if cur is new or not, add it to the new list,
                 * if the new list has not started, cur will become the first item. */
                if (prev) {
                    AST_LIST_NEXT(prev, frame_list) = cur;
                } else {
                    f = cur; /* set f to be the beginning of our new list */
                }
                prev = cur;
            }
        }
 
        /* the translator on chan->writetrans may have returned multiple frames
           from the single frame we passed in; if so, feed each one of them to the
           channel, freeing each one after it has been written */
        CHECK_BLOCKING(chan);
        if ((f != fr) && AST_LIST_NEXT(f, frame_list)) {
            struct ast_frame *cur, *next = NULL;
            unsigned int skip = 0;
 
            cur = f;
            while (cur) {
                next = AST_LIST_NEXT(cur, frame_list);
                AST_LIST_NEXT(cur, frame_list) = NULL;
                if (!skip) {
                    res = tech_write(chan, stream, default_stream, cur);
                    if (res < 0) {
                        ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_DEV);
                        skip = 1;
                    } else if (next) {
                        /* don't do this for the last frame in the list,
                           as the code outside the loop will do it once
                        */
                        ast_channel_fout_set(chan, FRAMECOUNT_INC(ast_channel_fout(chan)));
                    }
                }
                ast_frfree(cur);
                cur = next;
            }
 
            /* reset f so the code below doesn't attempt to free it */
            f = NULL;
        } else {
            res = tech_write(chan, stream, default_stream, f);
        }
        ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
        break;
    case AST_FRAME_NULL:
    case AST_FRAME_IAX:
        /* Ignore these */
        res = 0;
        break;
    case AST_FRAME_RTCP:
        /* RTCP information is on a per-stream basis and only available on multistream capable channels */
        CHECK_BLOCKING(chan);
        if (ast_channel_tech(chan)->write_stream && stream) {
            res = ast_channel_tech(chan)->write_stream(chan, ast_stream_get_position(stream), fr);
        } else {
            res = 0;
        }
        ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
        break;
    default:
        /* At this point, fr is the incoming frame and f is NULL.  Channels do
         * not expect to get NULL as a frame pointer and will segfault.  Hence,
         * we output the original frame passed in. */
        CHECK_BLOCKING(chan);
        res = ast_channel_tech(chan)->write(chan, fr);
        ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
        break;
    }
 
    if (f && f != fr)
        ast_frfree(f);
 
    /* Consider a write failure to force a soft hangup */
    if (res < 0) {
        ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_DEV);
    } else {
        ast_channel_fout_set(chan, FRAMECOUNT_INC(ast_channel_fout(chan)));
    }
done:
    if (ast_channel_audiohooks(chan) && ast_audiohook_write_list_empty(ast_channel_audiohooks(chan))) {
        /* The list gets recreated if audiohooks are added again later */
        ast_audiohook_detach_list(ast_channel_audiohooks(chan));
        ast_channel_audiohooks_set(chan, NULL);
    }
    ast_channel_unlock(chan);
    return res;
}

References apply_plc(), ast_audiohook_detach_list(), AST_AUDIOHOOK_DIRECTION_WRITE, ast_audiohook_write_list(), ast_audiohook_write_list_empty(), ast_channel_audiohooks(), ast_channel_audiohooks_set(), ast_channel_flags(), ast_channel_fout(), ast_channel_fout_set(), ast_channel_framehooks(), ast_channel_generatordata(), ast_channel_get_default_stream(), ast_channel_get_stream_topology(), ast_channel_lock, ast_channel_name(), ast_channel_nativeformats(), ast_channel_rawwriteformat(), ast_channel_softhangup_internal_flag_add(), ast_channel_tech(), ast_channel_trylock, ast_channel_unlock, ast_channel_writeformat(), ast_channel_writetrans(), ast_check_hangup(), ast_clear_flag, AST_CONTROL_UNHOLD, ast_deactivate_generator(), ast_debug, AST_FLAG_BLOCKING, AST_FLAG_WRITE_INT, AST_FLAG_ZOMBIE, ast_format_cache_is_slinear(), ast_format_cap_get_names(), AST_FORMAT_CAP_NAMES_LEN, ast_format_cmp(), AST_FORMAT_CMP_EQUAL, ast_format_get_name(), ast_format_get_type(), ast_format_slin, ast_format_t140, AST_FRAME_CONTROL, AST_FRAME_DTMF_BEGIN, AST_FRAME_DTMF_END, ast_frame_dump(), AST_FRAME_HTML, AST_FRAME_IAX, AST_FRAME_MODEM, AST_FRAME_NULL, AST_FRAME_RTCP, AST_FRAME_TEXT, AST_FRAME_VIDEO, AST_FRAME_VOICE, ast_framehook_list_write_event(), ast_frfree, ast_frisolate, AST_LIST_NEXT, AST_MEDIA_TYPE_IMAGE, AST_MEDIA_TYPE_UNKNOWN, ast_opt_generic_plc, ast_senddigit_begin(), ast_senddigit_end(), ast_set_write_format(), AST_SOFTHANGUP_DEV, ast_str_alloca, ast_stream_get_position(), ast_stream_get_type(), ast_stream_topology_get_count(), ast_stream_topology_get_stream(), ast_test_flag, ast_translate(), CHECK_BLOCKING, ast_frame::data, ast_frame::datalen, DEBUGCHAN_FLAG, done, DTMF_SENT, ast_frame_subclass::format, FRAMECOUNT_INC, ast_frame::frametype, indicate_data_internal(), ast_frame_subclass::integer, ast_frame::len, ast_frame::next, NULL, ast_frame::ptr, send_dtmf_begin_event(), send_dtmf_end_event(), ast_channel_tech::send_html, ast_channel_tech::send_text, ast_frame::src, ast_frame::stream_num, ast_frame::subclass, tech_write(), type, ast_channel_tech::write, write_stream(), ast_channel_tech::write_stream, ast_channel_tech::write_text, and ast_channel_tech::write_video.

Referenced by AST_TEST_DEFINE(), ast_write(), bridge_channel_handle_write(), and stream_echo_write().

ast_write_text()

int ast_write_text	(	struct ast_channel *	chan,
		struct ast_frame *	frame
	)

Write text frame to a channel This function writes the given frame to the indicated channel.

Parameters

chan	destination channel of the frame
frame	frame that will be written

Returns

It returns 1 on success, 0 if not implemented, and -1 on failure.

ast_write_video()

int ast_write_video	(	struct ast_channel *	chan,
		struct ast_frame *	frame
	)

Write video frame to a channel This function writes the given frame to the indicated channel.

Parameters

chan	destination channel of the frame
frame	frame that will be written

Returns

It returns 1 on success, 0 if not implemented, and -1 on failure.

Definition at line 5036 of file channel.c.

{
    int res;
    if (!ast_channel_tech(chan)->write_video)
        return 0;
    res = ast_write(chan, fr);
    if (!res)
        res = 1;
    return res;
}

References ast_channel_tech(), and ast_write().

DECLARE_STRINGFIELD_SETTERS_FOR() [1/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

accountcode

)

DECLARE_STRINGFIELD_SETTERS_FOR() [2/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

call_forward

)

DECLARE_STRINGFIELD_SETTERS_FOR() [3/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

dialcontext

)

DECLARE_STRINGFIELD_SETTERS_FOR() [4/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

hangupsource

)

DECLARE_STRINGFIELD_SETTERS_FOR() [5/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

language

)

DECLARE_STRINGFIELD_SETTERS_FOR() [6/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

latest_musicclass

)

DECLARE_STRINGFIELD_SETTERS_FOR() [7/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

linkedid

)

DECLARE_STRINGFIELD_SETTERS_FOR() [8/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

musicclass

)

DECLARE_STRINGFIELD_SETTERS_FOR() [9/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

name

)

The following string fields result in channel snapshot creation and should have the channel locked when called:

• language
• accountcode
• peeraccount
• linkedid

DECLARE_STRINGFIELD_SETTERS_FOR() [10/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

parkinglot

)

DECLARE_STRINGFIELD_SETTERS_FOR() [11/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

peeraccount

)

DECLARE_STRINGFIELD_SETTERS_FOR() [12/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

uniqueid

)

DECLARE_STRINGFIELD_SETTERS_FOR() [13/13]

DECLARE_STRINGFIELD_SETTERS_FOR

(

userfield

)

Variable Documentation

ast_kill_tech

const struct ast_channel_tech ast_kill_tech

extern

Kill the channel channel driver technology descriptor.

Kill the channel channel driver technology descriptor.

The purpose of this channel technology is to encourage the channel to hangup as quickly as possible.

Note

Used by DTMF atxfer and zombie channels.

Definition at line 434 of file channel.c.

ast_stream_topology_changed_external

const char ast_stream_topology_changed_external[] = "external"

static

Set as the change source reason when a channel stream topology has been changed externally as a result of the remote side renegotiating.

Definition at line 223 of file channel.h.

Referenced by ast_channel_stream_topology_changed_externally().

global_fin

unsigned long global_fin

extern

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

Definition at line 95 of file channel.c.

Referenced by __ast_channel_alloc_ap(), and handle_core_set_debug_channel().

global_fout

unsigned long global_fout

Definition at line 886 of file channel.h.

Referenced by handle_core_set_debug_channel().