Asterisk - The Open Source Telephony Project GIT-master-16bbc5e
Loading...
Searching...
No Matches
Data Structures | Macros | Typedefs | Enumerations | Functions | Variables
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.
 
#define AST_BRIDGE_DTMF_CHANNEL_1   (1 << 1)
 Report DTMF on channel 1.
 
#define AST_CHAN_WRITE_INFO_T_VERSION   1
 ast_chan_write_info_t version. Must be incremented if structure is changed
 
#define ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, assignedids, requestor, amaflag, ...)
 Create a channel structure.
 
#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.
 
#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.
 
#define AST_CHANNEL_INITIALIZERS_VERSION   1
 struct ABI version
 
#define ast_channel_lock(chan)   ao2_lock(chan)
 
#define ast_channel_lock_both(chan1, chan2)
 Lock two channels.
 
#define AST_CHANNEL_NAME   80
 
#define ast_channel_ref(c)   ({ ao2_ref(c, +1); (c); })
 Increase channel reference count.
 
#define ast_channel_trylock(chan)   ao2_trylock(chan)
 
#define ast_channel_unlock(chan)   ao2_unlock(chan)
 
#define ast_channel_unref(c)   ({ ao2_ref(c, -1); (struct ast_channel *) (NULL); })
 Decrease channel reference count.
 
#define ast_dummy_channel_alloc()   __ast_dummy_channel_alloc(__FILE__, __LINE__, __PRETTY_FUNCTION__)
 Create a fake channel structure.
 
#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.
 
#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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
int ast_activate_generator (struct ast_channel *chan, struct ast_generator *gen, void *params)
 
int ast_active_channels (void)
 returns number of active/allocated channels
 
static int ast_add_fd (struct pollfd *pfd, int fd)
 if fd is a valid descriptor, set *pfd with the descriptor
 
int ast_answer (struct ast_channel *chan)
 Answer a channel.
 
int ast_auto_answer (struct ast_channel *chan)
 Answer a channel, if it's not already answered.
 
void ast_autoservice_chan_hangup_peer (struct ast_channel *chan, struct ast_channel *peer)
 Put chan into autoservice while hanging up peer.
 
int ast_autoservice_ignore (struct ast_channel *chan, enum ast_frame_type ftype)
 Ignore certain frame types.
 
int ast_autoservice_start (struct ast_channel *chan)
 Automatically service a channel for us...
 
int ast_autoservice_stop (struct ast_channel *chan)
 Stop servicing a channel for us...
 
int ast_call (struct ast_channel *chan, const char *addr, int timeout)
 Make a call.
 
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.
 
const char * ast_cause2str (int cause) attribute_pure
 Gives the string form of a given cause code.
 
void ast_change_name (struct ast_channel *chan, const char *newname)
 Change channel name.
 
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.
 
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.
 
const char * ast_channel_call_forward (const struct ast_channel *chan)
 
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.
 
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.
 
void ast_channel_clear_softhangup (struct ast_channel *chan, int flag)
 Clear a set of softhangup flags from a channel.
 
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.
 
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.
 
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.
 
struct ast_datastore * ast_channel_datastore_find (struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid)
 Find a datastore on a channel.
 
int ast_channel_datastore_inherit (struct ast_channel *from, struct ast_channel *to)
 Inherit datastores from a parent to a child.
 
int ast_channel_datastore_remove (struct ast_channel *chan, struct ast_datastore *datastore)
 Remove a datastore from a channel.
 
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.
 
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.
 
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.
 
void ast_channel_dialed_causes_clear (const struct ast_channel *chan)
 Clear all cause information from the channel.
 
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.
 
struct ao2_iterator ast_channel_dialed_causes_iterator (const struct ast_channel *chan)
 Retrieve an iterator for dialed cause information.
 
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)
 
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.
 
struct ast_endpoint * ast_channel_endpoint (const struct ast_channel *chan)
 
void ast_channel_endpoint_set (struct ast_channel *chan, struct ast_endpoint *endpoint)
 
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.
 
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.
 
int ast_channel_fd_count (const struct ast_channel *chan)
 Retrieve the number of file decriptor positions present on the channel.
 
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.
 
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.
 
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.
 
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.
 
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().
 
struct ast_bridge * ast_channel_get_bridge (const struct ast_channel *chan)
 Get the bridge associated with a channel.
 
struct ast_bridge_channel * ast_channel_get_bridge_channel (struct ast_channel *chan)
 Get a reference to the channel's bridge pointer.
 
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.
 
struct ast_cc_config_params * ast_channel_get_cc_config_params (struct ast_channel *chan)
 Get the CCSS parameters from a channel.
 
const char * ast_channel_get_current_storage_driver_name (void)
 Get the name of the current channel storage driver.
 
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.
 
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.
 
int ast_channel_get_duration (struct ast_channel *chan)
 Obtain how long the channel since the channel was created.
 
int64_t ast_channel_get_duration_ms (struct ast_channel *chan)
 Obtain how long it's been, in milliseconds, since the channel was created.
 
int ast_channel_get_intercept_mode (void)
 Am I currently running an intercept dialplan routine.
 
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().
 
struct ast_stream_topology * ast_channel_get_stream_topology (const struct ast_channel *chan)
 Retrieve the topology of streams on a channel.
 
void * ast_channel_get_stream_topology_change_source (struct ast_channel *chan)
 Retrieve the source that initiated the last stream topology change.
 
static enum ast_t38_state ast_channel_get_t38_state (struct ast_channel *chan)
 Retrieves the current T38 state of a channel.
 
int ast_channel_get_up_time (struct ast_channel *chan)
 Obtain how long it has been since the channel was answered.
 
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.
 
struct varshead * ast_channel_get_vars (struct ast_channel *chan)
 Gets the variables for a given channel, as set using pbx_builtin_setvar_helper().
 
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.
 
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.
 
int ast_channel_has_audio_frame_or_monitor (struct ast_channel *chan)
 Check if the channel has active audiohooks, active framehooks, or a monitor.
 
int ast_channel_has_hook_requiring_audio (struct ast_channel *chan)
 Check if the channel has any active hooks that require audio.
 
int ast_channel_has_manager_vars (void)
 Return whether or not any manager variables have been set.
 
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.
 
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.
 
int ast_channel_internal_ari_reportable_vars_append (struct ast_channel *chan, char *key)
 
size_t ast_channel_internal_ari_reportable_vars_count (const struct ast_channel *chan)
 
char * ast_channel_internal_ari_reportable_vars_get (const struct ast_channel *chan, size_t index)
 
char * ast_channel_internal_ari_reportable_vars_remove (struct ast_channel *chan, size_t index)
 
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.
 
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.
 
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)
 
void ast_channel_internal_swap_endpoint_forward (struct ast_channel *a, struct ast_channel *b)
 Swap endpoint_forward between two channels.
 
void ast_channel_internal_swap_endpoints (struct ast_channel *a, struct ast_channel *b)
 Swap endpoints between two channels.
 
void ast_channel_internal_swap_snapshots (struct ast_channel *a, struct ast_channel *b)
 Swap snapshots beteween two channels.
 
void ast_channel_internal_swap_topics (struct ast_channel *a, struct ast_channel *b)
 Swap topics beteween two channels.
 
void ast_channel_internal_swap_uniqueid_and_linkedid (struct ast_channel *a, struct ast_channel *b)
 Swap uniqueid and linkedid beteween two channels.
 
int ast_channel_is_bridged (const struct ast_channel *chan)
 Determine if a channel is in a bridge.
 
int ast_channel_is_leaving_bridge (struct ast_channel *chan)
 Determine if a channel is leaving a bridge, but not hung up.
 
int ast_channel_is_multistream (struct ast_channel *chan)
 Determine if a channel is multi-stream capable.
 
int ast_channel_is_t38_active (struct ast_channel *chan)
 This function will check if T.38 is active on the channel.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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
 
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.
 
int ast_channel_register (const struct ast_channel_tech *tech)
 Register a channel technology (a new channel driver) Called by a channel module to register the kind of channels it supports.
 
struct ast_channel * ast_channel_release (struct ast_channel *chan)
 Unlink and release reference to a channel.
 
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().
 
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().
 
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.
 
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.
 
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.
 
int ast_channel_set_ari_var_reportable (struct ast_channel *chan, const char *variable, int report_events)
 Set whether a channel variable should be included in REST events on the channel.
 
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.
 
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.
 
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.
 
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.
 
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.
 
void ast_channel_set_is_t38_active (struct ast_channel *chan, int is_t38_active)
 Sets the is_t38_active flag.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
void ast_channel_setwhentohangup_tv (struct ast_channel *chan, struct timeval offset)
 Set when to hang a channel up.
 
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.
 
struct ast_silence_generator * ast_channel_start_silence_generator (struct ast_channel *chan)
 Starts a silence generator on the given channel.
 
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.
 
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.
 
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.
 
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.
 
int ast_channel_supports_html (struct ast_channel *channel)
 Checks for HTML support on a channel.
 
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.
 
const struct ast_channel_tech * ast_channel_tech (const struct ast_channel *chan)
 
int ast_channel_tech_hangupcause (const struct ast_channel *chan)
 
void ast_channel_tech_hangupcause_set (struct ast_channel *chan, int value)
 
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.
 
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.
 
int ast_channel_unbridged_nolock (struct ast_channel *chan)
 ast_channel_unbridged variant. Use this if the channel is already locked prior to calling.
 
void ast_channel_undefer_dtmf (struct ast_channel *chan)
 Unset defer DTMF flag on channel.
 
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.
 
void ast_channel_unregister (const struct ast_channel_tech *tech)
 Unregister a channel technology.
 
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.
 
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.
 
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.
 
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.
 
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
 
int ast_check_hangup (struct ast_channel *chan)
 Check to see if a channel is needing hang up.
 
int ast_check_hangup_locked (struct ast_channel *chan)
 
int ast_connected_line_build_data (unsigned char *data, size_t datalen, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update)
 Build the connected line information data frame.
 
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.
 
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.
 
int ast_connected_line_parse_data (const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected)
 Parse connected line indication frame data.
 
void ast_deactivate_generator (struct ast_channel *chan)
 
static int ast_fdisset (struct pollfd *pfds, int fd, int maximum, int *start)
 Helper function for migrating select to poll.
 
const struct ast_channel_tech * ast_get_channel_tech (const char *name)
 Get a channel technology structure by name.
 
ast_group_t ast_get_group (const char *s)
 
struct ast_namedgroups * ast_get_namedgroups (const char *s)
 Create an ast_namedgroups set with group names from comma separated string.
 
void ast_hangup (struct ast_channel *chan)
 Hang up a channel.
 
int ast_indicate (struct ast_channel *chan, int condition)
 Indicates condition of channel.
 
int ast_indicate_data (struct ast_channel *chan, int condition, const void *data, size_t datalen)
 Indicates condition of channel, with payload.
 
int ast_is_deferrable_frame (const struct ast_frame *frame)
 Should we keep this frame for later?
 
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.
 
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.
 
void ast_party_caller_free (struct ast_party_caller *doomed)
 Destroy the caller party contents.
 
void ast_party_caller_init (struct ast_party_caller *init)
 Initialize the given caller structure.
 
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.
 
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.
 
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.
 
void ast_party_connected_line_copy (struct ast_party_connected_line *dest, const struct ast_party_connected_line *src)
 Copy the source connected line information to the destination connected line.
 
void ast_party_connected_line_free (struct ast_party_connected_line *doomed)
 Destroy the connected line information contents.
 
void ast_party_connected_line_init (struct ast_party_connected_line *init)
 Initialize the given connected line structure.
 
void ast_party_connected_line_set (struct ast_party_connected_line *dest, const struct ast_party_connected_line *src, const struct ast_set_party_connected_line *update)
 Set the connected line information based on another connected line source.
 
void ast_party_connected_line_set_init (struct ast_party_connected_line *init, const struct ast_party_connected_line *guide)
 Initialize the given connected line structure using the given guide for a set update operation.
 
void ast_party_dialed_copy (struct ast_party_dialed *dest, const struct ast_party_dialed *src)
 Copy the source dialed party information to the destination dialed party.
 
void ast_party_dialed_free (struct ast_party_dialed *doomed)
 Destroy the dialed party contents.
 
void ast_party_dialed_init (struct ast_party_dialed *init)
 Initialize the given dialed structure.
 
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.
 
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.
 
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.
 
void ast_party_id_free (struct ast_party_id *doomed)
 Destroy the party id contents.
 
void ast_party_id_init (struct ast_party_id *init)
 Initialize the given party id structure.
 
void ast_party_id_invalidate (struct ast_party_id *id)
 Invalidate all components of the given party id.
 
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.
 
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.
 
int ast_party_id_presentation (const struct ast_party_id *id)
 Determine the overall presentation value for the given party.
 
void ast_party_id_reset (struct ast_party_id *id)
 Destroy and initialize the given party id structure.
 
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.
 
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.
 
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.
 
void ast_party_name_free (struct ast_party_name *doomed)
 Destroy the party name contents.
 
void ast_party_name_init (struct ast_party_name *init)
 Initialize the given name structure.
 
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.
 
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.
 
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.
 
void ast_party_number_free (struct ast_party_number *doomed)
 Destroy the party number contents.
 
void ast_party_number_init (struct ast_party_number *init)
 Initialize the given number structure.
 
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.
 
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.
 
void ast_party_redirecting_copy (struct ast_party_redirecting *dest, const struct ast_party_redirecting *src)
 Copy the source redirecting information to the destination redirecting.
 
void ast_party_redirecting_free (struct ast_party_redirecting *doomed)
 Destroy the redirecting information contents.
 
void ast_party_redirecting_init (struct ast_party_redirecting *init)
 Initialize the given redirecting structure.
 
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.
 
void ast_party_redirecting_reason_free (struct ast_party_redirecting_reason *doomed)
 Destroy the redirecting reason contents.
 
void ast_party_redirecting_reason_init (struct ast_party_redirecting_reason *init)
 Initialize the given redirecting reason structure.
 
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.
 
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.
 
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.
 
void ast_party_redirecting_set_init (struct ast_party_redirecting *init, const struct ast_party_redirecting *guide)
 Initialize the given redirecting id structure using the given guide for a set update operation.
 
void ast_party_subaddress_copy (struct ast_party_subaddress *dest, const struct ast_party_subaddress *src)
 Copy the source party subaddress information to the destination party subaddress.
 
void ast_party_subaddress_free (struct ast_party_subaddress *doomed)
 Destroy the party subaddress contents.
 
void ast_party_subaddress_init (struct ast_party_subaddress *init)
 Initialize the given subaddress structure.
 
void ast_party_subaddress_set (struct ast_party_subaddress *dest, const struct ast_party_subaddress *src)
 Set the source party subaddress information into the destination party subaddress.
 
void ast_party_subaddress_set_init (struct ast_party_subaddress *init, const struct ast_party_subaddress *guide)
 Initialize the given party subaddress structure using the given guide for a set update operation.
 
int ast_pre_call (struct ast_channel *chan, const char *sub_args)
 Execute a Gosub call on the channel before a call is placed.
 
char * ast_print_group (char *buf, int buflen, ast_group_t group)
 Print call and pickup groups into buffer.
 
char * ast_print_namedgroups (struct ast_str **buf, struct ast_namedgroups *groups)
 Print named call groups and named pickup groups.
 
int ast_prod (struct ast_channel *chan)
 Send empty audio to prime a channel driver.
 
int ast_queue_answer (struct ast_channel *chan, const struct ast_stream_topology *topology)
 Queue an ANSWER control frame with topology.
 
int ast_queue_control (struct ast_channel *chan, enum ast_control_frame_type control)
 Queue a control frame without payload.
 
int ast_queue_control_data (struct ast_channel *chan, enum ast_control_frame_type control, const void *data, size_t datalen)
 Queue a control frame with payload.
 
int ast_queue_frame (struct ast_channel *chan, struct ast_frame *f)
 Queue one or more frames to a channel's frame queue.
 
int ast_queue_frame_head (struct ast_channel *chan, struct ast_frame *f)
 Queue one or more frames to the head of a channel's frame queue.
 
int ast_queue_hangup (struct ast_channel *chan)
 Queue a hangup frame.
 
int ast_queue_hangup_with_cause (struct ast_channel *chan, int cause)
 Queue a hangup frame with hangupcause set.
 
int ast_queue_hold (struct ast_channel *chan, const char *musicclass)
 Queue a hold frame.
 
int ast_queue_unhold (struct ast_channel *chan)
 Queue an unhold frame.
 
int ast_raw_answer (struct ast_channel *chan)
 Answer a channel.
 
int ast_raw_answer_with_stream_topology (struct ast_channel *chan, struct ast_stream_topology *topology)
 Answer a channel passing in a stream topology.
 
struct ast_frame * ast_read (struct ast_channel *chan)
 Reads a frame.
 
struct ast_frame * ast_read_noaudio (struct ast_channel *chan)
 Reads a frame, returning AST_FRAME_NULL frame if audio.
 
struct ast_frame * ast_read_stream (struct ast_channel *chan)
 Reads a frame, but does not filter to just the default streams.
 
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.
 
int ast_readstring (struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders)
 Reads multiple digits.
 
int ast_readstring_full (struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd)
 
int ast_recvchar (struct ast_channel *chan, int timeout)
 Receives a text character from a channel.
 
char * ast_recvtext (struct ast_channel *chan, int timeout)
 Receives a text string from a channel Read a string of text from a channel.
 
int ast_redirecting_build_data (unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update)
 Build the redirecting id data frame.
 
int ast_redirecting_parse_data (const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting)
 Parse redirecting indication frame data.
 
struct ast_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.
 
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.
 
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)
 
int ast_safe_sleep (struct ast_channel *chan, int ms)
 Wait for a specified amount of time, looking for hangups.
 
int ast_safe_sleep_conditional (struct ast_channel *chan, int ms, int(*cond)(void *), void *data)
 Wait for a specified amount of time, looking for hangups and a condition argument.
 
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.
 
int ast_senddigit (struct ast_channel *chan, char digit, unsigned int duration)
 Send a DTMF digit to a channel.
 
int ast_senddigit_begin (struct ast_channel *chan, char digit)
 Send a DTMF digit to a channel.
 
int ast_senddigit_end (struct ast_channel *chan, char digit, unsigned int duration)
 Send a DTMF digit to a channel.
 
int ast_senddigit_external (struct ast_channel *chan, char digit, unsigned int duration)
 Send a DTMF digit to a channel from an external thread.
 
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.
 
int ast_senddigit_mf_begin (struct ast_channel *chan, char digit)
 Send an MF digit to a channel.
 
int ast_senddigit_mf_end (struct ast_channel *chan)
 End sending an MF digit to a channel.
 
int ast_sendtext (struct ast_channel *chan, const char *text)
 Sends text to a channel.
 
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.
 
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.
 
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.
 
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.
 
int ast_set_read_format (struct ast_channel *chan, struct ast_format *format)
 Sets read format on channel chan.
 
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.
 
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.
 
void ast_set_variables (struct ast_channel *chan, struct ast_variable *vars)
 adds a list of channel variables to a channel
 
int ast_set_write_format (struct ast_channel *chan, struct ast_format *format)
 Sets write format on channel chan.
 
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.
 
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)
 
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.
 
int ast_settimeout (struct ast_channel *c, unsigned int rate, int(*func)(const void *data), void *data)
 Enable or disable timer ticks for a channel.
 
int ast_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.
 
void ast_softhangup_all (void)
 Soft hangup all active channels.
 
int ast_softhangup_nolock (struct ast_channel *chan, int cause)
 Softly hangup up a channel (no channel lock)
 
const char * ast_state2str (enum ast_channel_state state)
 Gives the string form of a given channel state.
 
int ast_str2cause (const char *name) attribute_pure
 Convert the string form of a cause code to a number.
 
int ast_tonepair (struct ast_channel *chan, int freq1, int freq2, int duration, int vol)
 
int ast_tonepair_start (struct ast_channel *chan, int freq1, int freq2, int duration, int vol)
 
void ast_tonepair_stop (struct ast_channel *chan)
 
int ast_transfer (struct ast_channel *chan, char *dest)
 Transfer a channel (if supported).
 
int ast_transfer_protocol (struct ast_channel *chan, char *dest, int *protocol)
 Transfer a channel (if supported) receieve protocol result.
 
char * ast_transfercapability2str (int transfercapability) attribute_const
 Gives the string form of a given transfer capability.
 
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.
 
struct ast_channel * ast_waitfor_n (struct ast_channel **chan, int n, int *ms)
 Waits for input on a group of channels Wait for input on an array of channels for a given # of milliseconds.
 
int ast_waitfor_n_fd (int *fds, int n, int *ms, int *exception)
 Waits for input on an fd.
 
struct ast_channel * ast_waitfor_nandfds (struct ast_channel **c, int n, int *fds, int nfds, int *exception, int *outfd, int *ms)
 Waits for activity on a group of channels.
 
int ast_waitfordigit (struct ast_channel *c, int ms)
 Waits for a digit.
 
int ast_waitfordigit_full (struct ast_channel *c, int ms, 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.
 
int ast_write (struct ast_channel *chan, struct ast_frame *frame)
 Write a frame to a channel This function writes the given frame to the indicated channel.
 
int ast_write_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.
 
int ast_write_text (struct ast_channel *chan, struct ast_frame *frame)
 Write text frame to a channel This function writes the given frame to the indicated channel.
 
int ast_write_video (struct ast_channel *chan, struct ast_frame *frame)
 Write video frame to a channel This function writes the given frame to the indicated channel.
 
 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)
 
int internal_channel_set_current_storage_driver (const char *driver_name)
 
struct ast_channel_iterator * ast_channel_iterator_all_new (void)
 Create a new channel iterator.
 
struct ast_channel_iterator * ast_channel_iterator_by_exten_new (const char *exten, const char *context)
 Create a new channel iterator based on extension.
 
struct ast_channel_iterator * ast_channel_iterator_by_name_new (const char *name, size_t name_len)
 Create a new channel iterator based on name.
 
struct ast_channel_iterator * ast_channel_iterator_destroy (struct ast_channel_iterator *i)
 Destroy a channel iterator.
 
struct ast_channel * ast_channel_iterator_next (struct ast_channel_iterator *i)
 Get the next channel for a channel iterator.
 
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.
 
struct ast_channel * ast_channel_get_by_exten (const char *exten, const char *context)
 Find a channel by extension and context.
 
struct ast_channel * ast_channel_get_by_name (const char *search)
 Find a channel by name or uniqueid.
 
struct ast_channel * ast_channel_get_by_name_prefix (const char *name, size_t name_len)
 Find a channel by a name prefix.
 
struct ast_channel * ast_channel_get_by_uniqueid (const char *uniqueid)
 Find a channel by a uniqueid.
 

Variables

const struct ast_channel_tech ast_kill_tech
 Kill the channel channel driver technology descriptor.
 
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.
 
unsigned long global_fin
 
unsigned long global_fout
 

Detailed Description

General Asterisk PBX channel definitions.

See also:

Definition in file channel.h.

Macro Definition Documentation

◆ AST_AGENT_FD

#define AST_AGENT_FD   (AST_MAX_FDS-3)

unused - formerly 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 2420 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 2422 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__)
__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.
Definition channel.c:967
NULL
#define NULL
Definition resample.c:96

Create a channel structure.

Return values
NULLfailure
non-NULLsuccessfully 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.

1522 {
1523 /*! The requestor is the future bridge peer of the channel. */
1524 AST_CHANNEL_REQUESTOR_BRIDGE_PEER,
1525 /*! The requestor is to be replaced by the channel. */
1526 AST_CHANNEL_REQUESTOR_REPLACEMENT,
1527};
1528
1529/*!
1530 * \brief Setup new channel accountcodes from the requestor channel after ast_request().
1531 * \since 13.0.0
1532 *
1533 * \param chan New channel to get accountcodes setup.
1534 * \param requestor Requesting channel to get accountcodes from.
1535 * \param relationship What the new channel was created for.
1536 *
1537 * \pre The chan and requestor channels are already locked.
1538 *
1539 * \note Pre-existing accountcodes on chan will be overwritten.
1540 */
1541void ast_channel_req_accountcodes(struct ast_channel *chan, const struct ast_channel *requestor, enum ast_channel_requestor_relationship relationship);
1542
1543/*!
1544 * \brief Setup new channel accountcodes from the requestor channel after ast_request().
1545 * \since 13.0.0
1546 *
1547 * \param chan New channel to get accountcodes setup.
1548 * \param requestor Requesting channel to get accountcodes from.
1549 * \param relationship What the new channel was created for.
1550 *
1551 * \pre The chan and requestor channels are already locked.
1552 *
1553 * \note Pre-existing accountcodes on chan will not be overwritten.
1554 */
1555void ast_channel_req_accountcodes_precious(struct ast_channel *chan, const struct ast_channel *requestor, enum ast_channel_requestor_relationship relationship);
1556
1557/*!
1558 * \brief Request a channel of a given type, with data as optional information used
1559 * by the low level module and attempt to place a call on it
1560 *
1561 * \param type type of channel to request
1562 * \param cap format capabilities for requested channel
1563 * \param assignedids Unique Id to assign to channel
1564 * \param requestor channel asking for data
1565 * \param addr destination of the call
1566 * \param timeout maximum amount of time to wait for an answer
1567 * \param reason why unsuccessful (if unsuccessful)
1568 * \param cid_num Caller-ID Number
1569 * \param cid_name Caller-ID Name (ascii)
1570 *
1571 * \return Returns an ast_channel on success or no answer, NULL on failure. Check the value of chan->_state
1572 * to know if the call was answered or not.
1573 */
1574struct 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,
1575 int timeout, int *reason, const char *cid_num, const char *cid_name);
1576
1577/*!
1578 * \brief Request a channel of a given type, with data as optional information used
1579 * by the low level module and attempt to place a call on it
1580 * \param type type of channel to request
1581 * \param cap format capabilities for requested channel
1582 * \param assignedids Unique Id to assign to channel
1583 * \param requestor channel requesting data
1584 * \param addr destination of the call
1585 * \param timeout maximum amount of time to wait for an answer
1586 * \param reason why unsuccessful (if unsuccessful)
1587 * \param cid_num Caller-ID Number
1588 * \param cid_name Caller-ID Name (ascii)
1589 * \param oh Outgoing helper
1590 * \return Returns an ast_channel on success or no answer, NULL on failure. Check the value of chan->_state
1591 * to know if the call was answered or not.
1592 */
1593struct 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,
1594 int timeout, int *reason, const char *cid_num, const char *cid_name, struct outgoing_helper *oh);
1595
1596/*!
1597 * \brief 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.
1598 * \param caller in channel that requested orig
1599 * \param orig channel being replaced by the call forward channel
1600 * \param timeout maximum amount of time to wait for setup of new forward channel
1601 * \param cap format capabilities for requested channel
1602 * \param oh outgoing helper used with original channel
1603 * \param outstate reason why unsuccessful (if unsuccessful)
1604 * \return Returns the forwarded call's ast_channel on success or NULL on failure
1605 */
1606struct 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);
1607
1608/*!
1609 * \brief Register a channel technology (a new channel driver)
1610 * Called by a channel module to register the kind of channels it supports.
1611 * \param tech Structure defining channel technology or "type"
1612 * \return Returns 0 on success, -1 on failure.
1613 */
1614int ast_channel_register(const struct ast_channel_tech *tech);
1615
1616/*!
1617 * \brief Unregister a channel technology
1618 * \param tech Structure defining channel technology or "type" that was previously registered
1619 */
1620void ast_channel_unregister(const struct ast_channel_tech *tech);
1621
1622/*!
1623 * \brief Get a channel technology structure by name
1624 * \param name name of technology to find
1625 * \return a pointer to the structure, or NULL if no matching technology found
1626 */
1627const struct ast_channel_tech *ast_get_channel_tech(const char *name);
1628
1629/*!
1630 * \brief Hang up a channel
1631 * \note Absolutely _NO_ channel locks should be held before calling this function.
1632 * \note This function performs a hard hangup on a channel. Unlike the soft-hangup, this function
1633 * performs all stream stopping, etc, on the channel that needs to end.
1634 * chan is no longer valid after this call.
1635 * \param chan channel to hang up (NULL tolerant)
1636 */
1637void ast_hangup(struct ast_channel *chan);
1638
1639/*!
1640 * \brief Soft hangup all active channels.
1641 * \since 13.3.0
1642 */
1643void ast_softhangup_all(void);
1644
1645/*!
1646 * \brief Softly hangup up a channel
1647 *
1648 * \param chan channel to be soft-hung-up
1649 * \param cause an AST_SOFTHANGUP_* reason code
1650 *
1651 * \details
1652 * Call the protocol layer, but don't destroy the channel structure
1653 * (use this if you are trying to
1654 * safely hangup a channel managed by another thread.
1655 *
1656 * \note The channel passed to this function does not need to be locked.
1657 *
1658 * \return Returns 0 regardless
1659 */
1660int ast_softhangup(struct ast_channel *chan, int cause);
1661
1662/*!
1663 * \brief Softly hangup up a channel (no channel lock)
1664 * \param chan channel to be soft-hung-up
1665 * \param cause an AST_SOFTHANGUP_* reason code
1666 */
1667int ast_softhangup_nolock(struct ast_channel *chan, int cause);
1668
1669/*!
1670 * \brief Clear a set of softhangup flags from a channel
1671 *
1672 * Never clear a softhangup flag from a channel directly. Instead,
1673 * use this function. This ensures that all aspects of the softhangup
1674 * process are aborted.
1675 *
1676 * \param chan the channel to clear the flag on
1677 * \param flag the flag or flags to clear
1678 */
1679void ast_channel_clear_softhangup(struct ast_channel *chan, int flag);
1680
1681/*!
1682 * \brief Set the source of the hangup in this channel and it's bridge
1683 *
1684 * \param chan channel to set the field on
1685 * \param source a string describing the source of the hangup for this channel
1686 * \param force
1687 *
1688 * \note Absolutely _NO_ channel locks should be held before calling this function.
1689 *
1690 * \since 1.8
1691 *
1692 * Hangupsource is generally the channel name that caused the bridge to be
1693 * hung up, but it can also be other things such as "dialplan/agi"
1694 * This can then be logged in the CDR or CEL
1695 */
1696void ast_set_hangupsource(struct ast_channel *chan, const char *source, int force);
1697
1698/*! \brief Check to see if a channel is needing hang up
1699 * \param chan channel on which to check for hang up
1700 * This function determines if the channel is being requested to be hung up.
1701 * \return Returns 0 if not, or 1 if hang up is requested (including time-out).
1702 */
1703int ast_check_hangup(struct ast_channel *chan);
1704
1705int ast_check_hangup_locked(struct ast_channel *chan);
1706
1707/*! \brief This function will check if the bridge needs to be re-evaluated due to
1708 * external changes.
1709 *
1710 * \param chan Channel on which to check the unbridge_eval flag
1711 *
1712 * \return Returns 0 if the flag is down or 1 if the flag is up.
1713 */
1714int ast_channel_unbridged(struct ast_channel *chan);
1715
1716/*! \brief ast_channel_unbridged variant. Use this if the channel
1717 * is already locked prior to calling.
1718 *
1719 * \param chan Channel on which to check the unbridge flag
1720 *
1721 * \return Returns 0 if the flag is down or 1 if the flag is up.
1722 */
1723int ast_channel_unbridged_nolock(struct ast_channel *chan);
1724
1725/*! \brief Sets the unbridged flag and queues a NULL frame on the channel to trigger
1726 * a check by bridge_channel_wait
1727 *
1728 * \param chan Which channel is having its unbridged value set
1729 * \param value What the unbridge value is being set to
1730 */
1731void ast_channel_set_unbridged(struct ast_channel *chan, int value);
1732
1733/*! \brief Variant of ast_channel_set_unbridged. Use this if the channel
1734 * is already locked prior to calling.
1735 *
1736 * \param chan Which channel is having its unbridged value set
1737 * \param value What the unbridge value is being set to
1738 */
1739void ast_channel_set_unbridged_nolock(struct ast_channel *chan, int value);
1740
1741/*!
1742 * \brief This function will check if T.38 is active on the channel.
1743 *
1744 * \param chan Channel on which to check the unbridge_eval flag
1745 *
1746 * \return Returns 0 if the flag is down or 1 if the flag is up.
1747 */
1748int ast_channel_is_t38_active(struct ast_channel *chan);
1749
1750/*!
1751 * \brief ast_channel_is_t38_active variant. Use this if the channel
1752 * is already locked prior to calling.
1753 *
1754 * \param chan Channel on which to check the is_t38_active flag
1755 *
1756 * \return Returns 0 if the flag is down or 1 if the flag is up.
1757 */
1758int ast_channel_is_t38_active_nolock(struct ast_channel *chan);
1759
1760/*!
1761 * \brief Sets the is_t38_active flag
1762 *
1763 * \param chan Which channel is having its is_t38_active value set
1764 * \param is_t38_active Non-zero if T.38 is active
1765 */
1766void ast_channel_set_is_t38_active(struct ast_channel *chan, int is_t38_active);
1767
1768/*!
1769 * \brief Variant of ast_channel_set_is_t38_active. Use this if the channel
1770 * is already locked prior to calling.
1771 *
1772 * \param chan Which channel is having its is_t38_active value set
1773 * \param is_t38_active Non-zero if T.38 is active
1774 */
1775void ast_channel_set_is_t38_active_nolock(struct ast_channel *chan, int is_t38_active);
1776
1777/*!
1778 * \brief Lock the given channel, then request softhangup on the channel with the given causecode
1779 * \param chan channel on which to hang up
1780 * \param causecode cause code to use (Zero if don't use cause code)
1781 */
1782void ast_channel_softhangup_withcause_locked(struct ast_channel *chan, int causecode);
1783
1784/*!
1785 * \brief Compare a offset with the settings of when to hang a channel up
1786 * \param chan channel on which to check for hangup
1787 * \param offset offset in seconds and microseconds from current time
1788 * \retval 1
1789 * \retval 0
1790 * \retval -1
1791 * This function compares a offset from current time with the absolute time
1792 * out on a channel (when to hang up). If the absolute time out on a channel
1793 * is earlier than current time plus the offset, it returns 1, if the two
1794 * time values are equal, it return 0, otherwise, it return -1.
1795 * \since 1.6.1
1796 */
1797int ast_channel_cmpwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1798
1799/*!
1800 * \brief Set when to hang a channel up
1801 *
1802 * \param chan channel on which to check for hang up
1803 * \param offset offset in seconds and useconds relative to the current time of when to hang up
1804 *
1805 * This function sets the absolute time out on a channel (when to hang up).
1806 *
1807 * \pre chan is locked
1808 *
1809 * \since 1.6.1
1810 */
1811void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset);
1812
1813/*!
1814 * \brief Answer a channel
1815 *
1816 * \param chan channel to answer
1817 *
1818 * \details
1819 * This function answers a channel and handles all necessary call
1820 * setup functions.
1821 *
1822 * \note The channel passed does not need to be locked, but is locked
1823 * by the function when needed.
1824 *
1825 * \note This function will wait up to 500 milliseconds for media to
1826 * arrive on the channel before returning to the caller, so that the
1827 * caller can properly assume the channel is 'ready' for media flow.
1828 *
1829 * \retval 0 on success
1830 * \retval non-zero on failure
1831 */
1832int ast_answer(struct ast_channel *chan);
1833
1834/*!
1835 * \brief Answer a channel, if it's not already answered.
1836 *
1837 * \param chan channel to answer
1838 *
1839 * \details See ast_answer()
1840 *
1841 * \retval 0 on success
1842 * \retval non-zero on failure
1843 */
1844int ast_auto_answer(struct ast_channel *chan);
1845
1846/*!
1847 * \brief Answer a channel
1848 *
1849 * \param chan channel to answer
1850 *
1851 * This function answers a channel and handles all necessary call
1852 * setup functions.
1853 *
1854 * \note The channel passed does not need to be locked, but is locked
1855 * by the function when needed.
1856 *
1857 * \note Unlike ast_answer(), this function will not wait for media
1858 * flow to begin. The caller should be careful before sending media
1859 * to the channel before incoming media arrives, as the outgoing
1860 * media may be lost.
1861 *
1862 * \retval 0 on success
1863 * \retval non-zero on failure
1864 */
1865int ast_raw_answer(struct ast_channel *chan);
1866
1867/*!
1868 * \brief Answer a channel passing in a stream topology
1869 * \since 18.0.0
1870 *
1871 * \param chan channel to answer
1872 * \param topology the peer's stream topology
1873 *
1874 * This function answers a channel and handles all necessary call
1875 * setup functions.
1876 *
1877 * \note The channel passed does not need to be locked, but is locked
1878 * by the function when needed.
1879 *
1880 * \note Unlike ast_answer(), this function will not wait for media
1881 * flow to begin. The caller should be careful before sending media
1882 * to the channel before incoming media arrives, as the outgoing
1883 * media may be lost.
1884 *
1885 * \note The topology is usually that of the peer channel and may be NULL.
1886 *
1887 * \retval 0 on success
1888 * \retval non-zero on failure
1889 */
1890int ast_raw_answer_with_stream_topology(struct ast_channel *chan, struct ast_stream_topology *topology);
1891
1892/*!
1893 * \brief Answer a channel, with a selectable delay before returning
1894 *
1895 * \param chan channel to answer
1896 * \param delay maximum amount of time to wait for incoming media
1897 *
1898 * This function answers a channel and handles all necessary call
1899 * setup functions.
1900 *
1901 * \note The channel passed does not need to be locked, but is locked
1902 * by the function when needed.
1903 *
1904 * \note This function will wait up to 'delay' milliseconds for media to
1905 * arrive on the channel before returning to the caller, so that the
1906 * caller can properly assume the channel is 'ready' for media flow. If
1907 * 'delay' is less than 500, the function will wait up to 500 milliseconds.
1908 *
1909 * \retval 0 on success
1910 * \retval non-zero on failure
1911 */
1912int __ast_answer(struct ast_channel *chan, unsigned int delay);
1913
1914/*!
1915 * \brief Execute a Gosub call on the channel before a call is placed.
1916 * \since 11.0
1917 *
1918 * \details
1919 * This is called between ast_request() and ast_call() to
1920 * execute a predial routine on the newly created channel.
1921 *
1922 * \param chan Channel to execute Gosub.
1923 * \param sub_args Gosub application parameter string.
1924 *
1925 * \note Absolutely _NO_ channel locks should be held before calling this function.
1926 *
1927 * \retval 0 on success.
1928 * \retval -1 on error.
1929 */
1930int ast_pre_call(struct ast_channel *chan, const char *sub_args);
1931
1932/*!
1933 * \brief Make a call
1934 * \note Absolutely _NO_ channel locks should be held before calling this function.
1935 * \param chan which channel to make the call on
1936 * \param addr destination of the call
1937 * \param timeout time to wait on for connect (Doesn't seem to be used.)
1938 * \details
1939 * Place a call, take no longer than timeout ms.
1940 * \retval 0 on success
1941 * \retval -1 on failure
1942 */
1943int ast_call(struct ast_channel *chan, const char *addr, int timeout);
1944
1945/*!
1946 * \brief Indicates condition of channel
1947 * \note Absolutely _NO_ channel locks should be held before calling this function.
1948 * \note Indicate a condition such as AST_CONTROL_BUSY, AST_CONTROL_RINGING, or AST_CONTROL_CONGESTION on a channel
1949 * \param chan channel to change the indication
1950 * \param condition which condition to indicate on the channel
1951 * \return Returns 0 on success, -1 on failure
1952 */
1953int ast_indicate(struct ast_channel *chan, int condition);
1954
1955/*!
1956 * \brief Indicates condition of channel, with payload
1957 * \note Absolutely _NO_ channel locks should be held before calling this function.
1958 * \note Indicate a condition such as AST_CONTROL_HOLD with payload being music on hold class
1959 * \param chan channel to change the indication
1960 * \param condition which condition to indicate on the channel
1961 * \param data pointer to payload data
1962 * \param datalen size of payload data
1963 * \return Returns 0 on success, -1 on failure
1964 */
1965int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen);
1966
1967/* Misc stuff ------------------------------------------------ */
1968
1969/*!
1970 * \brief Wait for input on a channel
1971 * \param chan channel to wait on
1972 * \param ms length of time to wait on the channel
1973 * \details
1974 * Wait for input on a channel for a given # of milliseconds (<0 for indefinite).
1975 * \retval < 0 on failure
1976 * \retval 0 if nothing ever arrived
1977 * \retval the # of ms remaining otherwise
1978 */
1979int ast_waitfor(struct ast_channel *chan, int ms);
1980
1981/*!
1982 * \brief Should we keep this frame for later?
1983 *
1984 * There are functions such as ast_safe_sleep which will
1985 * service a channel to ensure that it does not have a
1986 * large backlog of queued frames. When this happens,
1987 * we want to hold on to specific frame types and just drop
1988 * others. This function will tell if the frame we just
1989 * read should be held onto.
1990 *
1991 * \param frame The frame we just read
1992 * \retval 1 frame should be kept
1993 * \retval 0 frame should be dropped
1994 */
1995int ast_is_deferrable_frame(const struct ast_frame *frame);
1996
1997/*!
1998 * \brief Wait for a specified amount of time, looking for hangups
1999 * \param chan channel to wait for
2000 * \param ms length of time in milliseconds to sleep. This should never be less than zero.
2001 * \details
2002 * Waits for a specified amount of time, servicing the channel as required.
2003 * \return returns -1 on hangup, otherwise 0.
2004 */
2005int ast_safe_sleep(struct ast_channel *chan, int ms);
2006
2007/*!
2008 * \brief Wait for a specified amount of time, looking for hangups, and do not generate silence
2009 * \param chan channel to wait for
2010 * \param ms length of time in milliseconds to sleep. This should never be less than zero.
2011 * \details
2012 * Waits for a specified amount of time, servicing the channel as required.
2013 * \return returns -1 on hangup, otherwise 0.
2014 * \note Unlike ast_safe_sleep this will not generate silence if Asterisk is configured to do so.
2015 */
2016int ast_safe_sleep_without_silence(struct ast_channel *chan, int ms);
2017
2018/*!
2019 * \brief Wait for a specified amount of time, looking for hangups and a condition argument
2020 * \param chan channel to wait for
2021 * \param ms length of time in milliseconds to sleep.
2022 * \param cond a function pointer for testing continue condition
2023 * \param data argument to be passed to the condition test function
2024 * \return returns -1 on hangup, otherwise 0.
2025 * \details
2026 * Waits for a specified amount of time, servicing the channel as required. If cond
2027 * returns 0, this function returns.
2028 */
2029int ast_safe_sleep_conditional(struct ast_channel *chan, int ms, int (*cond)(void*), void *data );
2030
2031/*!
2032 * \brief Waits for activity on a group of channels
2033 * \param c an array of pointers to channels
2034 * \param n number of channels that are to be waited upon
2035 * \param fds an array of fds to wait upon
2036 * \param nfds the number of fds to wait upon
2037 * \param exception exception flag
2038 * \param outfd fd that had activity on it
2039 * \param ms On invocation, max wait time. Upon returning, how long the wait
2040 * actually was (in/out parameter).
2041 * \details
2042 * Big momma function here. Wait for activity on any of the n channels, or any of the nfds
2043 * file descriptors. -1 can be passed as the ms timeout to wait forever, 0 to
2044 * return instantly if theres no activity immediantely available.
2045 * \return Returns the channel with activity, or NULL on error or if an FD
2046 * came first. If the FD came first, it will be returned in outfd, otherwise, outfd
2047 * will be -1
2048 */
2049struct ast_channel *ast_waitfor_nandfds(struct ast_channel **c, int n,
2050 int *fds, int nfds, int *exception, int *outfd, int *ms);
2051
2052/*!
2053 * \brief Waits for input on a group of channels
2054 * Wait for input on an array of channels for a given # of milliseconds.
2055 * \return Return channel with activity, or NULL if none has activity.
2056 * \param chan an array of pointers to channels
2057 * \param n number of channels that are to be waited upon
2058 * \param ms time "ms" is modified in-place, if applicable
2059 */
2060struct ast_channel *ast_waitfor_n(struct ast_channel **chan, int n, int *ms);
2061
2062/*!
2063 * \brief Waits for input on an fd
2064 * \note This version works on fd's only. Be careful with it.
2065 */
2066int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception);
2067
2068
2069/*!
2070 * \brief Reads a frame
2071 *
2072 * \param chan channel to read a frame from
2073 *
2074 * \return Returns a frame, or NULL on error. If it returns NULL, you
2075 * best just stop reading frames and assume the channel has been
2076 * disconnected.
2077 *
2078 * \note This function will filter frames received from the channel so
2079 * that only frames from the default stream for each media type
2080 * are returned. All other media frames from other streams will
2081 * be absorbed internally and a NULL frame returned instead.
2082 */
2083struct ast_frame *ast_read(struct ast_channel *chan);
2084
2085/*!
2086 * \brief Reads a frame, but does not filter to just the default streams
2087 *
2088 * \param chan channel to read a frame from
2089 *
2090 * \return Returns a frame, or NULL on error. If it returns NULL, you
2091 * best just stop reading frames and assume the channel has been
2092 * disconnected.
2093 *
2094 * \note This function will not perform any filtering and will return
2095 * media frames from all streams on the channel. To determine which
2096 * stream a frame originated from the stream_num on it can be
2097 * examined.
2098 */
2099struct ast_frame *ast_read_stream(struct ast_channel *chan);
2100
2101/*!
2102 * \brief Reads a frame, returning AST_FRAME_NULL frame if audio.
2103 * \param chan channel to read a frame from
2104 * \return Returns a frame, or NULL on error. If it returns NULL, you
2105 * best just stop reading frames and assume the channel has been
2106 * disconnected.
2107 * \note Audio is replaced with AST_FRAME_NULL to avoid
2108 * transcode when the resulting audio is not necessary.
2109 */
2110struct ast_frame *ast_read_noaudio(struct ast_channel *chan);
2111
2112/*!
2113 * \brief Reads a frame, but does not filter to just the default streams,
2114 * returning AST_FRAME_NULL frame if audio.
2115 *
2116 * \param chan channel to read a frame from
2117 *
2118 * \return Returns a frame, or NULL on error. If it returns NULL, you
2119 * best just stop reading frames and assume the channel has been
2120 * disconnected.
2121 *
2122 * \note This function will not perform any filtering and will return
2123 * media frames from all streams on the channel. To determine which
2124 * stream a frame originated from the stream_num on it can be
2125 * examined.
2126 *
2127 * \note Audio is replaced with AST_FRAME_NULL to avoid
2128 * transcode when the resulting audio is not necessary.
2129 */
2130struct ast_frame *ast_read_stream_noaudio(struct ast_channel *chan);
2131
2132/*!
2133 * \brief Write a frame to a channel
2134 * This function writes the given frame to the indicated channel.
2135 * \param chan destination channel of the frame
2136 * \param frame frame that will be written
2137 * \return It returns 0 on success, -1 on failure.
2138 */
2139int ast_write(struct ast_channel *chan, struct ast_frame *frame);
2140
2141/*!
2142 * \brief Write video frame to a channel
2143 * This function writes the given frame to the indicated channel.
2144 * \param chan destination channel of the frame
2145 * \param frame frame that will be written
2146 * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
2147 */
2148int ast_write_video(struct ast_channel *chan, struct ast_frame *frame);
2149
2150/*!
2151 * \brief Write text frame to a channel
2152 * This function writes the given frame to the indicated channel.
2153 * \param chan destination channel of the frame
2154 * \param frame frame that will be written
2155 * \return It returns 1 on success, 0 if not implemented, and -1 on failure.
2156 */
2157int ast_write_text(struct ast_channel *chan, struct ast_frame *frame);
2158
2159/*!
2160 * \brief Write a frame to a stream
2161 * This function writes the given frame to the indicated stream on the channel.
2162 * \param chan destination channel of the frame
2163 * \param stream_num destination stream on the channel
2164 * \param frame frame that will be written
2165 * \return It returns 0 on success, -1 on failure.
2166 * \note If -1 is provided as the stream number and a media frame is provided the
2167 * function will write to the default stream of the type of media.
2168 */
2169int ast_write_stream(struct ast_channel *chan, int stream_num, struct ast_frame *frame);
2170
2171/*! \brief Send empty audio to prime a channel driver */
2172int ast_prod(struct ast_channel *chan);
2173
2174/*!
2175 * \brief Set specific read path on channel.
2176 * \since 13.4.0
2177 *
2178 * \param chan Channel to setup read path.
2179 * \param raw_format Format to expect from the channel driver.
2180 * \param core_format What the core wants to read.
2181 *
2182 * \pre chan is locked
2183 *
2184 * \retval 0 on success.
2185 * \retval -1 on error.
2186 */
2187int ast_set_read_format_path(struct ast_channel *chan, struct ast_format *raw_format, struct ast_format *core_format);
2188
2189/*!
2190 * \brief Set specific write path on channel.
2191 * \since 13.13.0
2192 *
2193 * \param chan Channel to setup write path.
2194 * \param core_format What the core wants to write.
2195 * \param raw_format Raw write format.
2196 *
2197 * \pre chan is locked
2198 *
2199 * \retval 0 on success.
2200 * \retval -1 on error.
2201 */
2202int ast_set_write_format_path(struct ast_channel *chan, struct ast_format *core_format, struct ast_format *raw_format);
2203
2204/*!
2205 * \brief Sets read format on channel chan from capabilities
2206 * Set read format for channel to whichever component of "format" is best.
2207 * \param chan channel to change
2208 * \param formats new formats to pick from for reading
2209 * \return Returns 0 on success, -1 on failure
2210 */
2211int ast_set_read_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
2212
2213/*!
2214 * \brief Sets read format on channel chan
2215 * \param chan channel to change
2216 * \param format format to set for reading
2217 * \return Returns 0 on success, -1 on failure
2218 */
2219int ast_set_read_format(struct ast_channel *chan, struct ast_format *format);
2220
2221/*!
2222 * \brief Sets write format on channel chan
2223 * Set write format for channel to whichever component of "format" is best.
2224 * \param chan channel to change
2225 * \param formats new formats to pick from for writing
2226 * \return Returns 0 on success, -1 on failure
2227 */
2228int ast_set_write_format_from_cap(struct ast_channel *chan, struct ast_format_cap *formats);
2229
2230/*!
2231 * \brief Sets write format on channel chan
2232 * \param chan channel to change
2233 * \param format format to set for writing
2234 * \return Returns 0 on success, -1 on failure
2235 */
2236int ast_set_write_format(struct ast_channel *chan, struct ast_format *format);
2237
2238/*!
2239 * \brief Sets write format for a channel.
2240 * All internal data will than be handled in an interleaved format. (needed by binaural opus)
2241 *
2242 * \param chan channel to change
2243 * \param format format to set for writing
2244 * \return Returns 0 on success, -1 on failure
2245 */
2246int ast_set_write_format_interleaved_stereo(struct ast_channel *chan, struct ast_format *format);
2247
2248/*!
2249 * \brief Sends text to a channel
2250 *
2251 * \param chan channel to act upon
2252 * \param text string of text to send on the channel
2253 *
2254 * \details
2255 * Write text to a display on a channel
2256 *
2257 * \note The channel does not need to be locked before calling this function.
2258 *
2259 * \retval 0 on success
2260 * \retval -1 on failure
2261 */
2262int ast_sendtext(struct ast_channel *chan, const char *text);
2263
2264/*!
2265 * \brief Sends text to a channel in an ast_msg_data structure wrapper with ast_sendtext as fallback
2266 * \since 13.22.0
2267 * \since 15.5.0
2268 *
2269 * \param chan channel to act upon
2270 * \param msg ast_msg_data structure
2271 *
2272 * \details
2273 * Write text to a display on a channel. If the channel driver doesn't support the
2274 * send_text_data callback. then the original send_text callback will be used if
2275 * available.
2276 *
2277 * \note The channel does not need to be locked before calling this function.
2278 *
2279 * \retval 0 on success
2280 * \retval -1 on failure
2281 */
2282int ast_sendtext_data(struct ast_channel *chan, struct ast_msg_data *msg);
2283
2284/*!
2285 * \brief Receives a text character from a channel
2286 * \param chan channel to act upon
2287 * \param timeout timeout in milliseconds (0 for infinite wait)
2288 * \details
2289 * Read a char of text from a channel
2290 * \return 0 on success, -1 on failure
2291 */
2292int ast_recvchar(struct ast_channel *chan, int timeout);
2293
2294/*!
2295 * \brief End sending an MF digit to a channel.
2296 * \param chan channel to act upon
2297 * \return Returns 0 on success, -1 on failure
2298 */
2299int ast_senddigit_mf_end(struct ast_channel *chan);
2300
2301/*!
2302 * \brief Send an MF digit to a channel.
2303 *
2304 * \param chan channel to act upon
2305 * \param digit the MF digit to send, encoded in ASCII
2306 * \param duration the duration of a numeric digit ending in ms
2307 * \param durationkp the duration of a KP digit ending in ms
2308 * \param durationst the duration of a ST, STP, ST2P, or ST3P digit ending in ms
2309 * \param is_external 1 if called by a thread that is not the channel's media
2310 * handler thread, 0 if called by the channel's media handler
2311 * thread.
2312 *
2313 * \return 0 on success, -1 on failure
2314 */
2315int ast_senddigit_mf(struct ast_channel *chan, char digit, unsigned int duration,
2316 unsigned int durationkp, unsigned int durationst, int is_external);
2317
2318/*!
2319 * \brief Send a DTMF digit to a channel.
2320 *
2321 * \param chan channel to act upon
2322 * \param digit the DTMF digit to send, encoded in ASCII
2323 * \param duration the duration of the digit ending in ms
2324 *
2325 * \pre This must only be called by the channel's media handler thread.
2326 *
2327 * \return 0 on success, -1 on failure
2328 */
2329int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration);
2330
2331/*!
2332 * \brief Send a DTMF digit to a channel from an external thread.
2333 *
2334 * \param chan channel to act upon
2335 * \param digit the DTMF digit to send, encoded in ASCII
2336 * \param duration the duration of the digit ending in ms
2337 *
2338 * \pre This must only be called by threads that are not the channel's
2339 * media handler thread.
2340 *
2341 * \return 0 on success, -1 on failure
2342 */
2343int ast_senddigit_external(struct ast_channel *chan, char digit, unsigned int duration);
2344
2345/*!
2346 * \brief Send an MF digit to a channel.
2347 * \param chan channel to act upon
2348 * \param digit the MF digit to send, encoded in ASCII
2349 * \return 0 on success, -1 on failure
2350 */
2351int ast_senddigit_mf_begin(struct ast_channel *chan, char digit);
2352
2353/*!
2354 * \brief Send a DTMF digit to a channel.
2355 * \param chan channel to act upon
2356 * \param digit the DTMF digit to send, encoded in ASCII
2357 * \return 0 on success, -1 on failure
2358 */
2359int ast_senddigit_begin(struct ast_channel *chan, char digit);
2360
2361/*!
2362 * \brief Send a DTMF digit to a channel.
2363 * \param chan channel to act upon
2364 * \param digit the DTMF digit to send, encoded in ASCII
2365 * \param duration the duration of the digit ending in ms
2366 * \return Returns 0 on success, -1 on failure
2367 */
2368int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration);
2369
2370/*!
2371 * \brief Receives a text string from a channel
2372 * Read a string of text from a channel
2373 * \param chan channel to act upon
2374 * \param timeout timeout in milliseconds (0 for infinite wait)
2375 * \return the received text, or NULL to signify failure.
2376 */
2377char *ast_recvtext(struct ast_channel *chan, int timeout);
2378
2379/*!
2380 * \brief Waits for a digit
2381 * \param c channel to wait for a digit on
2382 * \param ms how many milliseconds to wait (<0 for indefinite).
2383 * \return Returns <0 on error, 0 on no entry, and the digit on success.
2384 */
2385int ast_waitfordigit(struct ast_channel *c, int ms);
2386
2387/*!
2388 * \brief Wait for a digit
2389 * Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to monitor for reading.
2390 * \param c channel to wait for a digit on
2391 * \param ms how many milliseconds to wait (<0 for indefinite).
2392 * \param breakon string of DTMF digits to break upon or NULL for any.
2393 * \param audiofd audio file descriptor to write to if audio frames are received
2394 * \param ctrlfd control file descriptor to monitor for reading
2395 * \return Returns 1 if ctrlfd becomes available
2396 */
2397int ast_waitfordigit_full(struct ast_channel *c, int ms, const char *breakon, int audiofd, int ctrlfd);
2398
2399/*!
2400 * \brief Reads multiple digits
2401 * \param c channel to read from
2402 * \param s string to read in to. Must be at least the size of your length
2403 * \param len how many digits to read (maximum)
2404 * \param timeout how long to timeout between digits
2405 * \param rtimeout timeout to wait on the first digit
2406 * \param enders digits to end the string
2407 * \details
2408 * Read in a digit string "s", max length "len", maximum timeout between
2409 * digits "timeout" (-1 for none), terminated by anything in "enders". Give them rtimeout
2410 * for the first digit.
2411 * \return Returns 0 on normal return, or 1 on a timeout. In the case of
2412 * a timeout, any digits that were read before the timeout will still be available in s.
2413 * RETURNS 2 in full version when ctrlfd is available, NOT 1
2414 */
2415int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders);
2416int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders, int audiofd, int ctrlfd);
2417
2418/*! \brief Report DTMF on channel 0 */
2419#define AST_BRIDGE_DTMF_CHANNEL_0 (1 << 0)
2420/*! \brief Report DTMF on channel 1 */
2421#define AST_BRIDGE_DTMF_CHANNEL_1 (1 << 1)
2422
2423
2424/*!
2425 * \brief Make the frame formats of two channels compatible.
2426 *
2427 * \param chan First channel to make compatible. Should be the calling party.
2428 * \param peer Other channel to make compatible. Should be the called party.
2429 *
2430 * \note Absolutely _NO_ channel locks should be held before calling this function.
2431 *
2432 * \details
2433 * Set two channels to compatible frame formats in both
2434 * directions. The path from peer to chan is made compatible
2435 * first to allow for in-band audio in case the other direction
2436 * cannot be made compatible.
2437 *
2438 * \retval 0 on success.
2439 * \retval -1 on error.
2440 */
2441int ast_channel_make_compatible(struct ast_channel *chan, struct ast_channel *peer);
2442
2443/*!
2444 * \brief Bridge two channels together (early)
2445 * \param c0 first channel to bridge
2446 * \param c1 second channel to bridge
2447 * \details
2448 * Bridge two channels (c0 and c1) together early. This implies either side may not be answered yet.
2449 * \return Returns 0 on success and -1 if it could not be done
2450 */
2451int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1);
2452
2453/*!
2454 * \brief Gives the string form of a given cause code.
2455 *
2456 * \param cause cause to get the description of
2457 * \return the text form of the binary cause code given
2458 */
2459const char *ast_cause2str(int cause) attribute_pure;
2460
2461/*!
2462 * \brief Convert the string form of a cause code to a number
2463 *
2464 * \param name string form of the cause
2465 * \return the cause code
2466 */
2467int ast_str2cause(const char *name) attribute_pure;
2468
2469/*!
2470 * \brief Gives the string form of a given channel state
2471 *
2472 * \param state state to get the name of
2473 * \return the text form of the binary state given
2474 *
2475 * \note This function is not reentrant.
2476 */
2477const char *ast_state2str(enum ast_channel_state state);
2478
2479/*!
2480 * \brief Gives the string form of a given transfer capability
2481 *
2482 * \param transfercapability transfer capability to get the name of
2483 * \return the text form of the binary transfer capability
2484 */
2485char *ast_transfercapability2str(int transfercapability) attribute_const;
2486
2487/*
2488 * Options: Some low-level drivers may implement "options" allowing fine tuning of the
2489 * low level channel. See frame.h for options. Note that many channel drivers may support
2490 * none or a subset of those features, and you should not count on this if you want your
2491 * asterisk application to be portable. They're mainly useful for tweaking performance
2492 */
2493
2494/*!
2495 * \brief Sets an option on a channel
2496 *
2497 * \param channel channel to set options on
2498 * \param option option to change
2499 * \param data data specific to option
2500 * \param datalen length of the data
2501 * \param block blocking or not
2502 * \details
2503 * Set an option on a channel (see frame.h), optionally blocking awaiting the reply
2504 * \return 0 on success and -1 on failure
2505 */
2506int ast_channel_setoption(struct ast_channel *channel, int option, void *data, int datalen, int block);
2507
2508/*!
2509 * \brief Checks the value of an option
2510 *
2511 * Query the value of an option
2512 * Works similarly to setoption except only reads the options.
2513 */
2514int ast_channel_queryoption(struct ast_channel *channel, int option, void *data, int *datalen, int block);
2515
2516/*!
2517 * \brief Checks for HTML support on a channel
2518 * \return 0 if channel does not support HTML or non-zero if it does
2519 */
2520int ast_channel_supports_html(struct ast_channel *channel);
2521
2522/*!
2523 * \brief Sends HTML on given channel
2524 * Send HTML or URL on link.
2525 * \return 0 on success or -1 on failure
2526 */
2527int ast_channel_sendhtml(struct ast_channel *channel, int subclass, const char *data, int datalen);
2528
2529/*!
2530 * \brief Sends a URL on a given link
2531 * Send URL on link.
2532 * \return 0 on success or -1 on failure
2533 */
2534int ast_channel_sendurl(struct ast_channel *channel, const char *url);
2535
2536/*!
2537 * \brief Defers DTMF so that you only read things like hangups and audio.
2538 * \return non-zero if channel was already DTMF-deferred or
2539 * 0 if channel is just now being DTMF-deferred
2540 */
2541int ast_channel_defer_dtmf(struct ast_channel *chan);
2542
2543/*! Undo defer. ast_read will return any DTMF characters that were queued */
2544void ast_channel_undefer_dtmf(struct ast_channel *chan);
2545
2546/*! \return number of channels available for lookup */
2547int ast_active_channels(void);
2548
2549/*! \return the number of channels not yet destroyed */
2550int ast_undestroyed_channels(void);
2551
2552/*! Activate a given generator */
2553int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params);
2554
2555/*! Deactivate an active generator */
2556void ast_deactivate_generator(struct ast_channel *chan);
2557
2558/*!
2559 * \since 13.27.0
2560 * \since 16.4.0
2561 * \brief Obtain how long it's been, in milliseconds, since the channel was created
2562 *
2563 * \param chan The channel object
2564 *
2565 * \retval 0 if the time value cannot be computed (or you called this really fast)
2566 * \retval The number of milliseconds since channel creation
2567 */
2568int64_t ast_channel_get_duration_ms(struct ast_channel *chan);
2569
2570/*!
2571 * \since 12
2572 * \brief Obtain how long the channel since the channel was created
2573 *
2574 * \param chan The channel object
2575 *
2576 * \retval 0 if the time value cannot be computed (or you called this really fast)
2577 * \retval The number of seconds the channel has been up
2578 */
2579int ast_channel_get_duration(struct ast_channel *chan);
2580
2581/*!
2582 * \since 13.27.0
2583 * \since 16.4.0
2584 * \brief Obtain how long it has been since the channel was answered in ms
2585 *
2586 * \param chan The channel object
2587 *
2588 * \retval 0 if the channel isn't answered (or you called this really fast)
2589 * \retval The number of milliseconds the channel has been up
2590 */
2591int64_t ast_channel_get_up_time_ms(struct ast_channel *chan);
2592
2593/*!
2594 * \since 12
2595 * \brief Obtain how long it has been since the channel was answered
2596 *
2597 * \param chan The channel object
2598 *
2599 * \retval 0 if the channel isn't answered (or you called this really fast)
2600 * \retval The number of seconds the channel has been up
2601 */
2602int ast_channel_get_up_time(struct ast_channel *chan);
2603
2604/*!
2605 * \brief Set caller ID number, name and ANI and generate AMI event.
2606 *
2607 * \note Use ast_channel_set_caller() and ast_channel_set_caller_event() instead.
2608 * \note The channel does not need to be locked before calling this function.
2609 */
2610void ast_set_callerid(struct ast_channel *chan, const char *cid_num, const char *cid_name, const char *cid_ani);
2611
2612/*!
2613 * \brief Set the caller id information in the Asterisk channel
2614 * \since 1.8
2615 *
2616 * \param chan Asterisk channel to set caller id information
2617 * \param caller Caller id information
2618 * \param update What caller information to update. NULL if all.
2619 *
2620 * \note The channel does not need to be locked before calling this function.
2621 */
2622void ast_channel_set_caller(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2623
2624/*!
2625 * \brief Set the caller id information in the Asterisk channel and generate an AMI event
2626 * if the caller id name or number changed.
2627 * \since 1.8
2628 *
2629 * \param chan Asterisk channel to set caller id information
2630 * \param caller Caller id information
2631 * \param update What caller information to update. NULL if all.
2632 *
2633 * \note The channel does not need to be locked before calling this function.
2634 */
2635void ast_channel_set_caller_event(struct ast_channel *chan, const struct ast_party_caller *caller, const struct ast_set_party_caller *update);
2636
2637/*! Set the file descriptor on the channel */
2638void ast_channel_set_fd(struct ast_channel *chan, int which, int fd);
2639
2640/*! Start a tone going */
2641int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2642/*! Stop a tone from playing */
2643void ast_tonepair_stop(struct ast_channel *chan);
2644/*! Play a tone pair for a given amount of time */
2645int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol);
2646
2647/*!
2648 * \brief Automatically service a channel for us...
2649 *
2650 * \retval 0 success
2651 * \retval -1 failure, or the channel is already being autoserviced
2652 */
2653int ast_autoservice_start(struct ast_channel *chan);
2654
2655/*!
2656 * \brief Stop servicing a channel for us...
2657 *
2658 * \note if chan is locked prior to calling ast_autoservice_stop, it
2659 * is likely that there will be a deadlock between the thread that calls
2660 * ast_autoservice_stop and the autoservice thread. It is important
2661 * that chan is not locked prior to this call
2662 *
2663 * \param chan
2664 * \retval 0 success
2665 * \retval -1 error, or the channel has been hungup
2666 */
2667int ast_autoservice_stop(struct ast_channel *chan);
2668
2669/*!
2670 * \brief Put chan into autoservice while hanging up peer.
2671 * \since 11.0
2672 *
2673 * \param chan Chan to put into autoservice.
2674 * \param peer Chan to run hangup handlers and hangup.
2675 */
2676void ast_autoservice_chan_hangup_peer(struct ast_channel *chan, struct ast_channel *peer);
2677
2678/*!
2679 * \brief Ignore certain frame types
2680 * \note Normally, we cache DTMF, IMAGE, HTML, TEXT, and CONTROL frames
2681 * while a channel is in autoservice and queue them up when taken out of
2682 * autoservice. When this is not desireable, this API may be used to
2683 * cause the channel to ignore those frametypes after the channel is put
2684 * into autoservice, but before autoservice is stopped.
2685 * \retval 0 success
2686 * \retval -1 channel is not in autoservice
2687 */
2688int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype);
2689
2690/*!
2691 * \brief Enable or disable timer ticks for a channel
2692 *
2693 * \param c channel
2694 * \param rate number of timer ticks per second
2695 * \param func callback function
2696 * \param data
2697 *
2698 * \details
2699 * If timers are supported, force a scheduled expiration on the
2700 * timer fd, at which point we call the callback function / data
2701 *
2702 * \note Call this function with a rate of 0 to turn off the timer ticks
2703 *
2704 * \version 1.6.1 changed samples parameter to rate, accommodates new timing methods
2705 */
2706int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data);
2707int ast_settimeout_full(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data, unsigned int is_ao2_obj);
2708
2709/*!
2710 * \brief Transfer a channel (if supported).
2711 * \retval -1 on error
2712 * \retval 0 if not supported
2713 * \retval 1 if supported and requested
2714 * \param chan current channel
2715 * \param dest destination extension for transfer
2716 */
2717int ast_transfer(struct ast_channel *chan, char *dest);
2718
2719/*!
2720 * \brief Transfer a channel (if supported) receieve protocol result.
2721 * \retval -1 on error
2722 * \retval 0 if not supported
2723 * \retval 1 if supported and requested
2724 * \param chan channel to transfer
2725 * \param dest destination extension to transfer to
2726 * \param protocol protocol is the protocol result
2727 * SIP example, 0=success, 3xx-6xx is SIP error code
2728 */
2729int ast_transfer_protocol(struct ast_channel *chan, char *dest, int *protocol);
2730
2731/*!
2732 * \brief Inherits channel variable from parent to child channel
2733 * \param parent Parent channel
2734 * \param child Child channel
2735 *
2736 * \details
2737 * Scans all channel variables in the parent channel, looking for those
2738 * that should be copied into the child channel.
2739 * Variables whose names begin with a single '_' are copied into the
2740 * child channel with the prefix removed.
2741 * Variables whose names begin with '__' are copied into the child
2742 * channel with their names unchanged.
2743 */
2744void ast_channel_inherit_variables(const struct ast_channel *parent, struct ast_channel *child);
2745
2746/*!
2747 * \brief adds a list of channel variables to a channel
2748 * \param chan the channel
2749 * \param vars a linked list of variables
2750 *
2751 * \warning The channel must not be locked if there's a possibility that
2752 * a dialplan function would be invoked.
2753 *
2754 * \details
2755 * Variable names can be for a regular channel variable or a dialplan function
2756 * that has the ability to be written to.
2757 */
2758void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars);
2759
2760/*!
2761 * \brief An opaque 'object' structure use by silence generators on channels.
2762 */
2763struct ast_silence_generator;
2764
2765/*!
2766 * \brief Starts a silence generator on the given channel.
2767 * \param chan The channel to generate silence on
2768 * \return An ast_silence_generator pointer, or NULL if an error occurs
2769 *
2770 * \details
2771 * This function will cause SLINEAR silence to be generated on the supplied
2772 * channel until it is disabled; if the channel cannot be put into SLINEAR
2773 * mode then the function will fail.
2774 *
2775 * \note
2776 * The pointer returned by this function must be preserved and passed to
2777 * ast_channel_stop_silence_generator when you wish to stop the silence
2778 * generation.
2779 */
2780struct ast_silence_generator *ast_channel_start_silence_generator(struct ast_channel *chan);
2781
2782/*!
2783 * \brief Stops a previously-started silence generator on the given channel.
2784 * \param chan The channel to operate on
2785 * \param state The ast_silence_generator pointer return by a previous call to
2786 * ast_channel_start_silence_generator.
2787 *
2788 * \details
2789 * This function will stop the operating silence generator and return the channel
2790 * to its previous write format.
2791 */
2792void ast_channel_stop_silence_generator(struct ast_channel *chan, struct ast_silence_generator *state);
2793
2794/*!
2795 * \brief Determine which channel has an older linkedid
2796 * \param a First channel
2797 * \param b Second channel
2798 * \return Returns an ast_channel structure that has oldest linkedid
2799 */
2800struct ast_channel *ast_channel_internal_oldest_linkedid(struct ast_channel *a, struct ast_channel *b);
2801
2802/*!
2803 * \brief Copy the full linkedid channel id structure from one channel to another
2804 * \param dest Destination to copy linkedid to
2805 * \param source Source channel to copy linkedid from
2806 */
2807void ast_channel_internal_copy_linkedid(struct ast_channel *dest, struct ast_channel *source);
2808
2809/*!
2810 * \brief Swap uniqueid and linkedid beteween two channels
2811 * \param a First channel
2812 * \param b Second channel
2813 *
2814 * \note
2815 * This is used in masquerade to exchange identities
2816 */
2817void ast_channel_internal_swap_uniqueid_and_linkedid(struct ast_channel *a, struct ast_channel *b);
2818
2819/*!
2820 * \brief Swap topics beteween two channels
2821 * \param a First channel
2822 * \param b Second channel
2823 *
2824 * \note
2825 * This is used in masquerade to exchange topics for message routing
2826 */
2827void ast_channel_internal_swap_topics(struct ast_channel *a, struct ast_channel *b);
2828
2829/*!
2830 * \brief Swap endpoint_forward between two channels
2831 * \param a First channel
2832 * \param b Second channel
2833 *
2834 * \note
2835 * This is used in masquerade to exchange endpoint details if one of the two or both
2836 * the channels were created with endpoint
2837 */
2838void ast_channel_internal_swap_endpoint_forward(struct ast_channel *a, struct ast_channel *b);
2839
2840/*!
2841 * \brief Swap snapshots beteween two channels
2842 * \param a First channel
2843 * \param b Second channel
2844 *
2845 * \note
2846 * This is used in masquerade to exchange snapshots
2847 */
2848void ast_channel_internal_swap_snapshots(struct ast_channel *a, struct ast_channel *b);
2849
2850/*!
2851 * \brief Swap endpoints between two channels
2852 * \param a First channel
2853 * \param b Second channel
2854 *
2855 * \note
2856 * This is used in masquerade to exchange endpoints
2857 */
2858void ast_channel_internal_swap_endpoints(struct ast_channel *a, struct ast_channel *b);
2859
2860/*!
2861 * \brief Set uniqueid and linkedid string value only (not time)
2862 * \param chan The channel to set the uniqueid to
2863 * \param uniqueid The uniqueid to set
2864 * \param linkedid The linkedid to set
2865 *
2866 * \note
2867 * This is used only by ast_cel_fabricate_channel_from_event()
2868 * to create a temporary fake channel - time values are invalid
2869 */
2870void ast_channel_internal_set_fake_ids(struct ast_channel *chan, const char *uniqueid, const char *linkedid);
2871
2872/* Misc. functions below */
2873
2874/*!
2875 * \brief if fd is a valid descriptor, set *pfd with the descriptor
2876 * \return Return 1 (not -1!) if added, 0 otherwise (so we can add the
2877 * return value to the index into the array)
2878 */
2879static inline int ast_add_fd(struct pollfd *pfd, int fd)
2880{
2881 pfd->fd = fd;
2882 pfd->events = POLLIN | POLLPRI;
2883 return fd >= 0;
2884}
2885
2886/*! \brief Helper function for migrating select to poll */
2887static inline int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
2888{
2889 int x;
2890 int dummy = 0;
2891
2892 if (fd < 0)
2893 return 0;
2894 if (!start)
2895 start = &dummy;
2896 for (x = *start; x < maximum; x++)
2897 if (pfds[x].fd == fd) {
2898 if (x == *start)
2899 (*start)++;
2900 return pfds[x].revents;
2901 }
2902 return 0;
2903}
2904
2905/*!
2906 * \brief Retrieves the current T38 state of a channel
2907 *
2908 * \note Absolutely _NO_ channel locks should be held before calling this function.
2909 */
2910static inline enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
2911{
2912 enum ast_t38_state state = T38_STATE_UNAVAILABLE;
2913 int datalen = sizeof(state);
2914
2915 ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
2916
2917 return state;
2918}
2919
2920/*!
2921 * \brief Set the blocking indication on the channel.
2922 *
2923 * \details
2924 * Indicate that the thread handling the channel is about to do a blocking
2925 * operation to wait for media on the channel. (poll, read, or write)
2926 *
2927 * Masquerading and ast_queue_frame() use this indication to wake up the thread.
2928 *
2929 * \pre The channel needs to be locked
2930 */
2931#define CHECK_BLOCKING(c) \
2932 do { \
2933 if (ast_test_flag(ast_channel_flags(c), AST_FLAG_BLOCKING)) { \
2934 /* This should not happen as there should only be one thread handling a channel's media at a time. */ \
2935 ast_log(LOG_DEBUG, "Thread LWP %d is blocking '%s', already blocked by thread LWP %d in procedure %s\n", \
2936 ast_get_tid(), ast_channel_name(c), \
2937 ast_channel_blocker_tid(c), ast_channel_blockproc(c)); \
2938 ast_assert(0); \
2939 } \
2940 ast_channel_blocker_tid_set((c), ast_get_tid()); \
2941 ast_channel_blocker_set((c), pthread_self()); \
2942 ast_channel_blockproc_set((c), __PRETTY_FUNCTION__); \
2943 ast_set_flag(ast_channel_flags(c), AST_FLAG_BLOCKING); \
2944 } while (0)
2945
2946ast_group_t ast_get_group(const char *s);
2947
2948/*! \brief Print call and pickup groups into buffer */
2949char *ast_print_group(char *buf, int buflen, ast_group_t group);
2950
2951/*! \brief Opaque struct holding a namedgroups set, i.e. a set of group names */
2952struct ast_namedgroups;
2953
2954/*! \brief Create an ast_namedgroups set with group names from comma separated string */
2955struct ast_namedgroups *ast_get_namedgroups(const char *s);
2956struct ast_namedgroups *ast_unref_namedgroups(struct ast_namedgroups *groups);
2957struct ast_namedgroups *ast_ref_namedgroups(struct ast_namedgroups *groups);
2958/*! \brief Return TRUE if group a and b contain at least one common groupname */
2959int ast_namedgroups_intersect(struct ast_namedgroups *a, struct ast_namedgroups *b);
2960
2961/*! \brief Print named call groups and named pickup groups */
2962char *ast_print_namedgroups(struct ast_str **buf, struct ast_namedgroups *groups);
2963
2964/*! \brief return an ast_variable list of channeltypes */
2965struct ast_variable *ast_channeltype_list(void);
2966
2967/*!
2968 * \brief return an english explanation of the code returned thru __ast_request_and_dial's 'outstate' argument
2969 * \param reason The integer argument, usually taken from AST_CONTROL_ macros
2970 * \return char pointer explaining the code
2971 */
2972const char *ast_channel_reason2str(int reason);
2973
2974/*! \brief channel group info */
2975struct ast_group_info {
2976 struct ast_channel *chan;
2977 char *category;
2978 char *group;
2979 AST_LIST_ENTRY(ast_group_info) group_list;
2980};
2981
2982#define ast_channel_lock(chan) ao2_lock(chan)
2983#define ast_channel_unlock(chan) ao2_unlock(chan)
2984#define ast_channel_trylock(chan) ao2_trylock(chan)
2985
2986/*!
2987 * \brief Lock two channels.
2988 */
2989#define ast_channel_lock_both(chan1, chan2) do { \
2990 ast_channel_lock(chan1); \
2991 while (ast_channel_trylock(chan2)) { \
2992 ast_channel_unlock(chan1); \
2993 sched_yield(); \
2994 ast_channel_lock(chan1); \
2995 } \
2996 } while (0)
2997
2998/*!
2999 * \brief Increase channel reference count
3000 *
3001 * \param c the channel
3002 *
3003 * \retval c always
3004 *
3005 * \since 1.8
3006 */
3007#define ast_channel_ref(c) ({ ao2_ref(c, +1); (c); })
3008
3009/*!
3010 * \brief Decrease channel reference count
3011 *
3012 * \param c the channel
3013 *
3014 * \retval NULL always
3015 *
3016 * \since 1.8
3017 */
3018#define ast_channel_unref(c) ({ ao2_ref(c, -1); (struct ast_channel *) (NULL); })
3019
3020/*!
3021 * \brief Cleanup a channel reference
3022 *
3023 * \param c the channel (NULL tolerant)
3024 *
3025 * \retval NULL always
3026 *
3027 * \since 12.0.0
3028 */
3029#define ast_channel_cleanup(c) ({ ao2_cleanup(c); (struct ast_channel *) (NULL); })
3030
3031/*! Channel Iterating @{ */
3032
3033/*!
3034 * \brief A channel iterator
3035 *
3036 * This is an opaque type.
3037 */
3038struct ast_channel_iterator;
3039
3040/*!
3041 * \brief Destroy a channel iterator
3042 *
3043 * \param i the itereator to destroy
3044 *
3045 * \details
3046 * This function is used to destroy a channel iterator that was retrieved by
3047 * using one of the channel_iterator_xxx_new() functions.
3048 *
3049 * \retval NULL for convenience to clear out the pointer to the iterator that
3050 * was just destroyed.
3051 *
3052 * \since 1.8
3053 */
3054struct ast_channel_iterator *ast_channel_iterator_destroy(struct ast_channel_iterator *i);
3055
3056/*!
3057 * \brief Create a new channel iterator based on extension
3058 *
3059 * \param exten The extension that channels must be in
3060 * \param context The context that channels must be in
3061 *
3062 * \details
3063 * After creating an iterator using this function, the ast_channel_iterator_next()
3064 * function can be used to iterate through all channels that are currently
3065 * in the specified context and extension.
3066 *
3067 * \note You must call ast_channel_iterator_destroy() when done.
3068 *
3069 * \retval NULL on failure
3070 * \retval a new channel iterator based on the specified parameters
3071 *
3072 * \since 1.8
3073 */
3074struct ast_channel_iterator *ast_channel_iterator_by_exten_new(const char *exten, const char *context);
3075
3076/*!
3077 * \brief Create a new channel iterator based on name
3078 *
3079 * \param name channel name or channel uniqueid to match
3080 * \param name_len number of characters in the channel name to match on. This
3081 * would be used to match based on name prefix. If matching on the full
3082 * channel name is desired, then this parameter should be 0.
3083 *
3084 * \details
3085 * After creating an iterator using this function, the ast_channel_iterator_next()
3086 * function can be used to iterate through all channels that exist that have
3087 * the specified name or name prefix.
3088 *
3089 * \note You must call ast_channel_iterator_destroy() when done.
3090 *
3091 * \retval NULL on failure
3092 * \retval a new channel iterator based on the specified parameters
3093 *
3094 * \since 1.8
3095 */
3096struct ast_channel_iterator *ast_channel_iterator_by_name_new(const char *name, size_t name_len);
3097
3098/*!
3099 * \brief Create a new channel iterator
3100 *
3101 * \details
3102 * After creating an iterator using this function, the ast_channel_iterator_next()
3103 * function can be used to iterate through all channels that exist.
3104 *
3105 * \note You must call ast_channel_iterator_destroy() when done.
3106 *
3107 * \retval NULL on failure
3108 * \retval a new channel iterator
3109 *
3110 * \since 1.8
3111 */
3112struct ast_channel_iterator *ast_channel_iterator_all_new(void);
3113
3114/*!
3115 * \brief Get the next channel for a channel iterator
3116 *
3117 * \param i the channel iterator that was created using one of the
3118 * channel_iterator_xxx_new() functions.
3119 *
3120 * \details
3121 * This function should be used to iterate through all channels that match a
3122 * specified set of parameters that were provided when the iterator was created.
3123 *
3124 * \retval the next channel that matches the parameters used when the iterator
3125 * was created.
3126 * \retval NULL if no more channels match the iterator parameters.
3127 *
3128 * \since 1.8
3129 */
3130struct ast_channel *ast_channel_iterator_next(struct ast_channel_iterator *i);
3131
3132/*! @} End channel iterator definitions. */
3133
3134/*! @{ Channel search functions */
3135
3136/*!
3137* \warning Absolutely _NO_ channel locks should be held while calling any of
3138* these functions.
3139*/
3140
3141/*!
3142 * \brief Call a function with every active channel
3143 *
3144 * \details
3145 * This function executes a callback one time for each active channel on the
3146 * system. The channel is provided as an argument to the function.
3147 *
3148 * \since 1.8
3149 */
3150struct ast_channel *ast_channel_callback(ao2_callback_data_fn *cb_fn, void *arg,
3151 void *data, int ao2_flags);
3152
3153/*!
3154 * \brief Find a channel by name or uniqueid
3155 *
3156 * \param search the name or uniqueid of the channel to search for
3157 *
3158 * \details
3159 * First searches for a channel with a matching name. If not found
3160 * a search for a channel with a matching uniqueid is done.
3161 *
3162 * \retval a channel with a matching name or uniqueid
3163 * \retval NULL if no channel was found
3164 *
3165 *\note The fallback search by uniqueid is a historical thing. If you
3166 * know the search term is a uniqueid, use \ref ast_channel_get_by_uniqueid
3167 * instead.
3168 *
3169 * \since 1.8
3170 */
3171struct ast_channel *ast_channel_get_by_name(const char *search);
3172
3173/*!
3174 * \brief Find a channel by a name prefix
3175 *
3176 * \param search The channel name or uniqueid prefix to search for
3177 * \param len Only search for up to this many characters from the search term
3178 *
3179 * \details
3180 * Search for a channel that has the same name prefix as specified by the
3181 * search term. If not found, search for an exact match on the uniqueid.
3182 * Searching by partial uniqueid doesn't make any sense as it's usually
3183 * a system-name plus a timestamp and is not supported.
3184 *
3185 * \retval a channel with a matching name or uniqueid
3186 * \retval NULL if no channel was found
3187 *
3188 *\note The fallback search by uniqueid is a historical thing. If you
3189 * know the search term is a uniqueid, use \ref ast_channel_get_by_uniqueid
3190 * instead.
3191 *
3192 * \since 1.8
3193 */
3194struct ast_channel *ast_channel_get_by_name_prefix(const char *name, size_t name_len);
3195
3196/*!
3197 * \brief Find a channel by extension and context
3198 *
3199 * \param exten the extension to search for
3200 * \param context the context to search for
3201 *
3202 * \details
3203 * Return a channel that is currently at the specified extension and context.
3204 *
3205 * \retval a channel that is at the specified extension and context
3206 * \retval NULL if no channel was found
3207 *
3208 * \since 1.8
3209 */
3210struct ast_channel *ast_channel_get_by_exten(const char *exten, const char *context);
3211
3212/*!
3213 * \brief Find a channel by a uniqueid
3214 *
3215 * \param uniqueid The uniqueid to search for
3216 *
3217 * \retval a channel with the uniqueid specified by the arguments
3218 * \retval NULL if no channel was found
3219 */
3220struct ast_channel *ast_channel_get_by_uniqueid(const char *uniqueid);
3221
3222/*! @} End channel search functions. */
3223
3224/*!
3225 * \brief Initialize the given name structure.
3226 * \since 1.8
3227 *
3228 * \param init Name structure to initialize.
3229 */
3230void ast_party_name_init(struct ast_party_name *init);
3231
3232/*!
3233 * \brief Copy the source party name information to the destination party name.
3234 * \since 1.8
3235 *
3236 * \param dest Destination party name
3237 * \param src Source party name
3238 */
3239void ast_party_name_copy(struct ast_party_name *dest, const struct ast_party_name *src);
3240
3241/*!
3242 * \brief Initialize the given party name structure using the given guide
3243 * for a set update operation.
3244 * \since 1.8
3245 *
3246 * \details
3247 * The initialization is needed to allow a set operation to know if a
3248 * value needs to be updated. Simple integers need the guide's original
3249 * value in case the set operation is not trying to set a new value.
3250 * String values are simply set to NULL pointers if they are not going
3251 * to be updated.
3252 *
3253 * \param init Party name structure to initialize.
3254 * \param guide Source party name to use as a guide in initializing.
3255 */
3256void ast_party_name_set_init(struct ast_party_name *init, const struct ast_party_name *guide);
3257
3258/*!
3259 * \brief Set the source party name information into the destination party name.
3260 * \since 1.8
3261 *
3262 * \param dest The name one wishes to update
3263 * \param src The new name values to update the dest
3264 */
3265void ast_party_name_set(struct ast_party_name *dest, const struct ast_party_name *src);
3266
3267/*!
3268 * \brief Destroy the party name contents
3269 * \since 1.8
3270 *
3271 * \param doomed The party name to destroy.
3272 */
3273void ast_party_name_free(struct ast_party_name *doomed);
3274
3275/*!
3276 * \brief Initialize the given number structure.
3277 * \since 1.8
3278 *
3279 * \param init Number structure to initialize.
3280 */
3281void ast_party_number_init(struct ast_party_number *init);
3282
3283/*!
3284 * \brief Copy the source party number information to the destination party number.
3285 * \since 1.8
3286 *
3287 * \param dest Destination party number
3288 * \param src Source party number
3289 */
3290void ast_party_number_copy(struct ast_party_number *dest, const struct ast_party_number *src);
3291
3292/*!
3293 * \brief Initialize the given party number structure using the given guide
3294 * for a set update operation.
3295 * \since 1.8
3296 *
3297 * \details
3298 * The initialization is needed to allow a set operation to know if a
3299 * value needs to be updated. Simple integers need the guide's original
3300 * value in case the set operation is not trying to set a new value.
3301 * String values are simply set to NULL pointers if they are not going
3302 * to be updated.
3303 *
3304 * \param init Party number structure to initialize.
3305 * \param guide Source party number to use as a guide in initializing.
3306 */
3307void ast_party_number_set_init(struct ast_party_number *init, const struct ast_party_number *guide);
3308
3309/*!
3310 * \brief Set the source party number information into the destination party number.
3311 * \since 1.8
3312 *
3313 * \param dest The number one wishes to update
3314 * \param src The new number values to update the dest
3315 */
3316void ast_party_number_set(struct ast_party_number *dest, const struct ast_party_number *src);
3317
3318/*!
3319 * \brief Destroy the party number contents
3320 * \since 1.8
3321 *
3322 * \param doomed The party number to destroy.
3323 */
3324void ast_party_number_free(struct ast_party_number *doomed);
3325
3326/*!
3327 * \since 1.8
3328 * \brief Initialize the given subaddress structure.
3329 *
3330 * \param init Subaddress structure to initialize.
3331 */
3332void ast_party_subaddress_init(struct ast_party_subaddress *init);
3333
3334/*!
3335 * \since 1.8
3336 * \brief Copy the source party subaddress information to the destination party subaddress.
3337 *
3338 * \param dest Destination party subaddress
3339 * \param src Source party subaddress
3340 */
3341void ast_party_subaddress_copy(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
3342
3343/*!
3344 * \since 1.8
3345 * \brief Initialize the given party subaddress structure using the given guide
3346 * for a set update operation.
3347 *
3348 * \details
3349 * The initialization is needed to allow a set operation to know if a
3350 * value needs to be updated. Simple integers need the guide's original
3351 * value in case the set operation is not trying to set a new value.
3352 * String values are simply set to NULL pointers if they are not going
3353 * to be updated.
3354 *
3355 * \param init Party subaddress structure to initialize.
3356 * \param guide Source party subaddress to use as a guide in initializing.
3357 */
3358void ast_party_subaddress_set_init(struct ast_party_subaddress *init, const struct ast_party_subaddress *guide);
3359
3360/*!
3361 * \since 1.8
3362 * \brief Set the source party subaddress information into the destination party subaddress.
3363 *
3364 * \param dest The subaddress one wishes to update
3365 * \param src The new subaddress values to update the dest
3366 */
3367void ast_party_subaddress_set(struct ast_party_subaddress *dest, const struct ast_party_subaddress *src);
3368
3369/*!
3370 * \since 1.8
3371 * \brief Destroy the party subaddress contents
3372 *
3373 * \param doomed The party subaddress to destroy.
3374 */
3375void ast_party_subaddress_free(struct ast_party_subaddress *doomed);
3376
3377/*!
3378 * \brief Set the update marker to update all information of a corresponding party id.
3379 * \since 11.0
3380 *
3381 * \param update_id The update marker for a corresponding party id.
3382 */
3383void ast_set_party_id_all(struct ast_set_party_id *update_id);
3384
3385/*!
3386 * \brief Initialize the given party id structure.
3387 * \since 1.8
3388 *
3389 * \param init Party id structure to initialize.
3390 */
3391void ast_party_id_init(struct ast_party_id *init);
3392
3393/*!
3394 * \brief Copy the source party id information to the destination party id.
3395 * \since 1.8
3396 *
3397 * \param dest Destination party id
3398 * \param src Source party id
3399 */
3400void ast_party_id_copy(struct ast_party_id *dest, const struct ast_party_id *src);
3401
3402/*!
3403 * \brief Initialize the given party id structure using the given guide
3404 * for a set update operation.
3405 * \since 1.8
3406 *
3407 * \details
3408 * The initialization is needed to allow a set operation to know if a
3409 * value needs to be updated. Simple integers need the guide's original
3410 * value in case the set operation is not trying to set a new value.
3411 * String values are simply set to NULL pointers if they are not going
3412 * to be updated.
3413 *
3414 * \param init Party id structure to initialize.
3415 * \param guide Source party id to use as a guide in initializing.
3416 */
3417void ast_party_id_set_init(struct ast_party_id *init, const struct ast_party_id *guide);
3418
3419/*!
3420 * \brief Set the source party id information into the destination party id.
3421 * \since 1.8
3422 *
3423 * \param dest The id one wishes to update
3424 * \param src The new id values to update the dest
3425 * \param update What id information to update. NULL if all.
3426 */
3427void ast_party_id_set(struct ast_party_id *dest, const struct ast_party_id *src, const struct ast_set_party_id *update);
3428
3429/*!
3430 * \brief Destroy the party id contents
3431 * \since 1.8
3432 *
3433 * \param doomed The party id to destroy.
3434 */
3435void ast_party_id_free(struct ast_party_id *doomed);
3436
3437/*!
3438 * \brief Determine the overall presentation value for the given party.
3439 * \since 1.8
3440 *
3441 * \param id Party to determine the overall presentation value.
3442 *
3443 * \return Overall presentation value for the given party.
3444 */
3445int ast_party_id_presentation(const struct ast_party_id *id);
3446
3447/*!
3448 * \brief Invalidate all components of the given party id.
3449 * \since 11.0
3450 *
3451 * \param id The party id to invalidate.
3452 */
3453void ast_party_id_invalidate(struct ast_party_id *id);
3454
3455/*!
3456 * \brief Destroy and initialize the given party id structure.
3457 * \since 11.0
3458 *
3459 * \param id The party id to reset.
3460 */
3461void ast_party_id_reset(struct ast_party_id *id);
3462
3463/*!
3464 * \brief Merge a given party id into another given party id.
3465 * \since 11.0
3466 *
3467 * \details
3468 * This function will generate an effective party id.
3469 *
3470 * Each party id component of the party id 'base' is overwritten
3471 * by components of the party id 'overlay' if the overlay
3472 * component is marked as valid. However the component 'tag' of
3473 * the base party id remains untouched.
3474 *
3475 * \param base The party id which is merged.
3476 * \param overlay The party id which is used to merge into.
3477 *
3478 * \return The merged party id as a struct, not as a pointer.
3479 * \note The merged party id returned is a shallow copy and must not be freed.
3480 */
3481struct ast_party_id ast_party_id_merge(struct ast_party_id *base, struct ast_party_id *overlay);
3482
3483/*!
3484 * \brief Copy a merge of a given party id into another given party id to a given destination party id.
3485 * \since 11.0
3486 *
3487 * \details
3488 * Each party id component of the party id 'base' is overwritten by components
3489 * of the party id 'overlay' if the 'overlay' component is marked as valid.
3490 * However the component 'tag' of the 'base' party id remains untouched.
3491 * The result is copied into the given party id 'dest'.
3492 *
3493 * \note The resulting merged party id is a real copy and has to be freed.
3494 *
3495 * \param dest The resulting merged party id.
3496 * \param base The party id which is merged.
3497 * \param overlay The party id which is used to merge into.
3498 */
3499void ast_party_id_merge_copy(struct ast_party_id *dest, struct ast_party_id *base, struct ast_party_id *overlay);
3500
3501/*!
3502 * \brief Initialize the given dialed structure.
3503 * \since 1.8
3504 *
3505 * \param init Dialed structure to initialize.
3506 */
3507void ast_party_dialed_init(struct ast_party_dialed *init);
3508
3509/*!
3510 * \brief Copy the source dialed party information to the destination dialed party.
3511 * \since 1.8
3512 *
3513 * \param dest Destination dialed party
3514 * \param src Source dialed party
3515 */
3516void ast_party_dialed_copy(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
3517
3518/*!
3519 * \brief Initialize the given dialed structure using the given
3520 * guide for a set update operation.
3521 * \since 1.8
3522 *
3523 * \details
3524 * The initialization is needed to allow a set operation to know if a
3525 * value needs to be updated. Simple integers need the guide's original
3526 * value in case the set operation is not trying to set a new value.
3527 * String values are simply set to NULL pointers if they are not going
3528 * to be updated.
3529 *
3530 * \param init Caller structure to initialize.
3531 * \param guide Source dialed to use as a guide in initializing.
3532 */
3533void ast_party_dialed_set_init(struct ast_party_dialed *init, const struct ast_party_dialed *guide);
3534
3535/*!
3536 * \brief Set the dialed information based on another dialed source
3537 * \since 1.8
3538 *
3539 * This is similar to ast_party_dialed_copy, except that NULL values for
3540 * strings in the src parameter indicate not to update the corresponding dest values.
3541 *
3542 * \param dest The dialed one wishes to update
3543 * \param src The new dialed values to update the dest
3544 */
3545void ast_party_dialed_set(struct ast_party_dialed *dest, const struct ast_party_dialed *src);
3546
3547/*!
3548 * \brief Destroy the dialed party contents
3549 * \since 1.8
3550 *
3551 * \param doomed The dialed party to destroy.
3552 */
3553void ast_party_dialed_free(struct ast_party_dialed *doomed);
3554
3555/*!
3556 * \since 1.8
3557 * \brief Initialize the given caller structure.
3558 *
3559 * \param init Caller structure to initialize.
3560 */
3561void ast_party_caller_init(struct ast_party_caller *init);
3562
3563/*!
3564 * \since 1.8
3565 * \brief Copy the source caller information to the destination caller.
3566 *
3567 * \param dest Destination caller
3568 * \param src Source caller
3569 */
3570void ast_party_caller_copy(struct ast_party_caller *dest, const struct ast_party_caller *src);
3571
3572/*!
3573 * \brief Initialize the given caller structure using the given
3574 * guide for a set update operation.
3575 * \since 1.8
3576 *
3577 * \details
3578 * The initialization is needed to allow a set operation to know if a
3579 * value needs to be updated. Simple integers need the guide's original
3580 * value in case the set operation is not trying to set a new value.
3581 * String values are simply set to NULL pointers if they are not going
3582 * to be updated.
3583 *
3584 * \param init Caller structure to initialize.
3585 * \param guide Source caller to use as a guide in initializing.
3586 */
3587void ast_party_caller_set_init(struct ast_party_caller *init, const struct ast_party_caller *guide);
3588
3589/*!
3590 * \brief Set the caller information based on another caller source
3591 * \since 1.8
3592 *
3593 * This is similar to ast_party_caller_copy, except that NULL values for
3594 * strings in the src parameter indicate not to update the corresponding dest values.
3595 *
3596 * \param dest The caller one wishes to update
3597 * \param src The new caller values to update the dest
3598 * \param update What caller information to update. NULL if all.
3599 */
3600void ast_party_caller_set(struct ast_party_caller *dest, const struct ast_party_caller *src, const struct ast_set_party_caller *update);
3601
3602/*!
3603 * \brief Destroy the caller party contents
3604 * \since 1.8
3605 *
3606 * \param doomed The caller party to destroy.
3607 */
3608void ast_party_caller_free(struct ast_party_caller *doomed);
3609
3610/*!
3611 * \since 1.8
3612 * \brief Initialize the given connected line structure.
3613 *
3614 * \param init Connected line structure to initialize.
3615 */
3616void ast_party_connected_line_init(struct ast_party_connected_line *init);
3617
3618/*!
3619 * \since 1.8
3620 * \brief Copy the source connected line information to the destination connected line.
3621 *
3622 * \param dest Destination connected line
3623 * \param src Source connected line
3624 */
3625void ast_party_connected_line_copy(struct ast_party_connected_line *dest, const struct ast_party_connected_line *src);
3626
3627/*!
3628 * \since 1.8
3629 * \brief Initialize the given connected line structure using the given
3630 * guide for a set update operation.
3631 *
3632 * \details
3633 * The initialization is needed to allow a set operation to know if a
3634 * value needs to be updated. Simple integers need the guide's original
3635 * value in case the set operation is not trying to set a new value.
3636 * String values are simply set to NULL pointers if they are not going
3637 * to be updated.
3638 *
3639 * \param init Connected line structure to initialize.
3640 * \param guide Source connected line to use as a guide in initializing.
3641 */
3642void ast_party_connected_line_set_init(struct ast_party_connected_line *init, const struct ast_party_connected_line *guide);
3643
3644/*!
3645 * \since 1.8
3646 * \brief Set the connected line information based on another connected line source
3647 *
3648 * This is similar to ast_party_connected_line_copy, except that NULL values for
3649 * strings in the src parameter indicate not to update the corresponding dest values.
3650 *
3651 * \param dest The connected line one wishes to update
3652 * \param src The new connected line values to update the dest
3653 * \param update What connected line information to update. NULL if all.
3654 */
3655void 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);
3656
3657/*!
3658 * \since 1.8
3659 * \brief Collect the caller party information into a connected line structure.
3660 *
3661 * \param connected Collected caller information for the connected line
3662 * \param caller Caller information.
3663 *
3664 * \warning This is a shallow copy.
3665 * \warning DO NOT call ast_party_connected_line_free() on the filled in
3666 * connected line structure!
3667 */
3668void ast_party_connected_line_collect_caller(struct ast_party_connected_line *connected, struct ast_party_caller *caller);
3669
3670/*!
3671 * \since 1.8
3672 * \brief Destroy the connected line information contents
3673 *
3674 * \param doomed The connected line information to destroy.
3675 */
3676void ast_party_connected_line_free(struct ast_party_connected_line *doomed);
3677
3678/*!
3679 * \brief Initialize the given redirecting reason structure
3680 *
3681 * \param init Redirecting reason structure to initialize
3682 */
3683void ast_party_redirecting_reason_init(struct ast_party_redirecting_reason *init);
3684
3685/*!
3686 * \brief Copy the source redirecting reason information to the destination redirecting reason.
3687 *
3688 * \param dest Destination redirecting reason
3689 * \param src Source redirecting reason
3690 */
3691void ast_party_redirecting_reason_copy(struct ast_party_redirecting_reason *dest,
3692 const struct ast_party_redirecting_reason *src);
3693
3694/*!
3695 * \brief Initialize the given redirecting reason structure using the given guide
3696 * for a set update operation.
3697 *
3698 * \details
3699 * The initialization is needed to allow a set operation to know if a
3700 * value needs to be updated. Simple integers need the guide's original
3701 * value in case the set operation is not trying to set a new value.
3702 * String values are simply set to NULL pointers if they are not going
3703 * to be updated.
3704 *
3705 * \param init Redirecting reason structure to initialize.
3706 * \param guide Source redirecting reason to use as a guide in initializing.
3707 */
3708void ast_party_redirecting_reason_set_init(struct ast_party_redirecting_reason *init,
3709 const struct ast_party_redirecting_reason *guide);
3710
3711/*!
3712 * \brief Set the redirecting reason information based on another redirecting reason source
3713 *
3714 * This is similar to ast_party_redirecting_reason_copy, except that NULL values for
3715 * strings in the src parameter indicate not to update the corresponding dest values.
3716 *
3717 * \param dest The redirecting reason one wishes to update
3718 * \param src The new redirecting reason values to update the dest
3719 */
3720void ast_party_redirecting_reason_set(struct ast_party_redirecting_reason *dest,
3721 const struct ast_party_redirecting_reason *src);
3722
3723/*!
3724 * \brief Destroy the redirecting reason contents
3725 *
3726 * \param doomed The redirecting reason to destroy.
3727 */
3728void ast_party_redirecting_reason_free(struct ast_party_redirecting_reason *doomed);
3729
3730/*!
3731 * \brief Initialize the given redirecting structure.
3732 * \since 1.8
3733 *
3734 * \param init Redirecting structure to initialize.
3735 */
3736void ast_party_redirecting_init(struct ast_party_redirecting *init);
3737
3738/*!
3739 * \since 1.8
3740 * \brief Copy the source redirecting information to the destination redirecting.
3741 *
3742 * \param dest Destination redirecting
3743 * \param src Source redirecting
3744 */
3745void ast_party_redirecting_copy(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src);
3746
3747/*!
3748 * \since 1.8
3749 * \brief Initialize the given redirecting id structure using the given guide
3750 * for a set update operation.
3751 *
3752 * \details
3753 * The initialization is needed to allow a set operation to know if a
3754 * value needs to be updated. Simple integers need the guide's original
3755 * value in case the set operation is not trying to set a new value.
3756 * String values are simply set to NULL pointers if they are not going
3757 * to be updated.
3758 *
3759 * \param init Redirecting id structure to initialize.
3760 * \param guide Source redirecting id to use as a guide in initializing.
3761 */
3762void ast_party_redirecting_set_init(struct ast_party_redirecting *init, const struct ast_party_redirecting *guide);
3763
3764/*!
3765 * \brief Set the redirecting information based on another redirecting source
3766 * \since 1.8
3767 *
3768 * This is similar to ast_party_redirecting_copy, except that NULL values for
3769 * strings in the src parameter indicate not to update the corresponding dest values.
3770 *
3771 * \param dest The redirecting one wishes to update
3772 * \param src The new redirecting values to update the dest
3773 * \param update What redirecting information to update. NULL if all.
3774 */
3775void ast_party_redirecting_set(struct ast_party_redirecting *dest, const struct ast_party_redirecting *src, const struct ast_set_party_redirecting *update);
3776
3777/*!
3778 * \since 1.8
3779 * \brief Destroy the redirecting information contents
3780 *
3781 * \param doomed The redirecting information to destroy.
3782 */
3783void ast_party_redirecting_free(struct ast_party_redirecting *doomed);
3784
3785/*!
3786 * \since 1.8
3787 * \brief Copy the caller information to the connected line information.
3788 *
3789 * \param dest Destination connected line information
3790 * \param src Source caller information
3791 *
3792 * \note Assumes locks are already acquired
3793 */
3794void ast_connected_line_copy_from_caller(struct ast_party_connected_line *dest, const struct ast_party_caller *src);
3795
3796/*!
3797 * \since 1.8
3798 * \brief Copy the connected line information to the caller information.
3799 *
3800 * \param dest Destination caller information
3801 * \param src Source connected line information
3802 *
3803 * \note Assumes locks are already acquired
3804 */
3805void ast_connected_line_copy_to_caller(struct ast_party_caller *dest, const struct ast_party_connected_line *src);
3806
3807/*!
3808 * \since 1.8
3809 * \brief Set the connected line information in the Asterisk channel
3810 *
3811 * \param chan Asterisk channel to set connected line information
3812 * \param connected Connected line information
3813 * \param update What connected line information to update. NULL if all.
3814 *
3815 * \note The channel does not need to be locked before calling this function.
3816 */
3817void ast_channel_set_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
3818
3819/*!
3820 * \since 1.8
3821 * \brief Build the connected line information data frame.
3822 *
3823 * \param data Buffer to fill with the frame data
3824 * \param datalen Size of the buffer to fill
3825 * \param connected Connected line information
3826 * \param update What connected line information to build. NULL if all.
3827 *
3828 * \retval -1 if error
3829 * \retval Amount of data buffer used
3830 */
3831int 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);
3832
3833/*!
3834 * \since 1.8
3835 * \brief Parse connected line indication frame data
3836 *
3837 * \param data Buffer with the frame data to parse
3838 * \param datalen Size of the buffer
3839 * \param connected Extracted connected line information
3840 *
3841 * \retval 0 on success.
3842 * \retval -1 on error.
3843 *
3844 * \note The filled in connected line structure needs to be initialized by
3845 * ast_party_connected_line_set_init() before calling. If defaults are not
3846 * required use ast_party_connected_line_init().
3847 * \note The filled in connected line structure needs to be destroyed by
3848 * ast_party_connected_line_free() when it is no longer needed.
3849 */
3850int ast_connected_line_parse_data(const unsigned char *data, size_t datalen, struct ast_party_connected_line *connected);
3851
3852/*!
3853 * \since 1.8
3854 * \brief Indicate that the connected line information has changed
3855 *
3856 * \param chan Asterisk channel to indicate connected line information
3857 * \param connected Connected line information
3858 * \param update What connected line information to update. NULL if all.
3859 */
3860void ast_channel_update_connected_line(struct ast_channel *chan, const struct ast_party_connected_line *connected, const struct ast_set_party_connected_line *update);
3861
3862/*!
3863 * \since 1.8
3864 * \brief Queue a connected line update frame on a channel
3865 *
3866 * \param chan Asterisk channel to indicate connected line information
3867 * \param connected Connected line information
3868 * \param update What connected line information to update. NULL if all.
3869 */
3870void 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);
3871
3872/*!
3873 * \since 1.8
3874 * \brief Set the redirecting id information in the Asterisk channel
3875 *
3876 * \param chan Asterisk channel to set redirecting id information
3877 * \param redirecting Redirecting id information
3878 * \param update What redirecting information to update. NULL if all.
3879 *
3880 * \note The channel does not need to be locked before calling this function.
3881 */
3882void ast_channel_set_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3883
3884/*!
3885 * \since 1.8
3886 * \brief Build the redirecting id data frame.
3887 *
3888 * \param data Buffer to fill with the frame data
3889 * \param datalen Size of the buffer to fill
3890 * \param redirecting Redirecting id information
3891 * \param update What redirecting information to build. NULL if all.
3892 *
3893 * \retval -1 if error
3894 * \retval Amount of data buffer used
3895 */
3896int ast_redirecting_build_data(unsigned char *data, size_t datalen, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3897
3898/*!
3899 * \since 1.8
3900 * \brief Parse redirecting indication frame data
3901 *
3902 * \param data Buffer with the frame data to parse
3903 * \param datalen Size of the buffer
3904 * \param redirecting Extracted redirecting id information
3905 *
3906 * \retval 0 on success.
3907 * \retval -1 on error.
3908 *
3909 * \note The filled in id structure needs to be initialized by
3910 * ast_party_redirecting_set_init() before calling.
3911 * \note The filled in id structure needs to be destroyed by
3912 * ast_party_redirecting_free() when it is no longer needed.
3913 */
3914int ast_redirecting_parse_data(const unsigned char *data, size_t datalen, struct ast_party_redirecting *redirecting);
3915
3916/*!
3917 * \since 1.8
3918 * \brief Indicate that the redirecting id has changed
3919 *
3920 * \param chan Asterisk channel to indicate redirecting id information
3921 * \param redirecting Redirecting id information
3922 * \param update What redirecting information to update. NULL if all.
3923 */
3924void ast_channel_update_redirecting(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3925
3926/*!
3927 * \since 1.8
3928 * \brief Queue a redirecting update frame on a channel
3929 *
3930 * \param chan Asterisk channel to indicate redirecting id information
3931 * \param redirecting Redirecting id information
3932 * \param update What redirecting information to update. NULL if all.
3933 */
3934void ast_channel_queue_redirecting_update(struct ast_channel *chan, const struct ast_party_redirecting *redirecting, const struct ast_set_party_redirecting *update);
3935
3936/*!
3937 * \since 11
3938 * \brief Run a connected line interception subroutine and update a channel's connected line
3939 * information
3940 *
3941 * Whenever we want to update a channel's connected line information, we may need to run
3942 * a subroutine so that an administrator can manipulate the information before sending it
3943 * out. This function both runs the subroutine specified by CONNECTED_LINE_SEND_SUB and
3944 * sends the update to the channel.
3945 *
3946 * \param autoservice_chan Channel to place into autoservice while the sub is running.
3947 * It is perfectly safe for this to be NULL
3948 * \param sub_chan The channel to run the subroutine on. Also the channel from which we
3949 * determine which subroutine we need to run.
3950 * \param connected_info Either an ast_party_connected_line or ast_frame pointer of type
3951 * AST_CONTROL_CONNECTED_LINE
3952 * \param frame If true, then connected_info is an ast_frame pointer, otherwise it is an
3953 * ast_party_connected_line pointer.
3954 * \retval 0 Success
3955 * \retval -1 Either the subroutine does not exist, or there was an error while attempting to
3956 * run the subroutine
3957 */
3958int ast_channel_connected_line_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *connected_info, int frame);
3959
3960/*!
3961 * \since 11
3962 * \brief Run a redirecting interception subroutine and update a channel's redirecting information
3963 *
3964 * \details
3965 * Whenever we want to update a channel's redirecting information, we may need to run
3966 * a subroutine so that an administrator can manipulate the information before sending it
3967 * out. This function both runs the subroutine specified by REDIRECTING_SEND_SUB and
3968 * sends the update to the channel.
3969 *
3970 * \param autoservice_chan Channel to place into autoservice while the subroutine is running.
3971 * It is perfectly safe for this to be NULL
3972 * \param sub_chan The channel to run the subroutine on. Also the channel from which we
3973 * determine which subroutine we need to run.
3974 * \param redirecting_info Either an ast_party_redirecting or ast_frame pointer of type
3975 * AST_CONTROL_REDIRECTING
3976 * \param is_frame If true, then redirecting_info is an ast_frame pointer, otherwise it is an
3977 * ast_party_redirecting pointer.
3978 *
3979 * \retval 0 Success
3980 * \retval -1 Either the subroutine does not exist, or there was an error while attempting to
3981 * run the subroutine
3982 */
3983int ast_channel_redirecting_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const void *redirecting_info, int is_frame);
3984
3985#include "asterisk/ccss.h"
3986
3987/*!
3988 * \since 1.8
3989 * \brief Set up datastore with CCSS parameters for a channel
3990 *
3991 * \note
3992 * If base_params is NULL, the channel will get the default
3993 * values for all CCSS parameters.
3994 *
3995 * \details
3996 * This function makes use of datastore operations on the channel, so
3997 * it is important to lock the channel before calling this function.
3998 *
3999 * \warning You should call this function only if \ref ast_cc_is_enabled()
4000 * returns true.
4001 *
4002 * \param chan The channel to create the datastore on
4003 * \param base_params CCSS parameters we wish to copy into the channel
4004 * \retval 0 Success
4005 * \retval -1 Failure or CCSS is globally disabled.
4006 */
4007int ast_channel_cc_params_init(struct ast_channel *chan,
4008 const struct ast_cc_config_params *base_params);
4009
4010/*!
4011 * \since 1.8
4012 * \brief Get the CCSS parameters from a channel
4013 *
4014 * \details
4015 * This function makes use of datastore operations on the channel, so
4016 * it is important to lock the channel before calling this function.
4017 *
4018 * \warning You should call this function only if \ref ast_cc_is_enabled()
4019 * returns true.
4020 *
4021 * \param chan Channel to retrieve parameters from
4022 * \retval NULL Failure or CCSS is globally disabled.
4023 * \retval non-NULL The parameters desired
4024 */
4025struct ast_cc_config_params *ast_channel_get_cc_config_params(struct ast_channel *chan);
4026
4027
4028/*!
4029 * \since 1.8
4030 * \brief Get a device name given its channel structure
4031 *
4032 * \details
4033 * A common practice in Asterisk is to determine the device being talked
4034 * to by dissecting the channel name. For certain channel types, this is not
4035 * accurate. For instance, an ISDN channel is named based on what B channel is
4036 * used, not the device being communicated with.
4037 *
4038 * This function interfaces with a channel tech's queryoption callback to
4039 * retrieve the name of the device being communicated with. If the channel does not
4040 * implement this specific option, then the traditional method of using the channel
4041 * name is used instead.
4042 *
4043 * \param chan The channel to retrieve the information from
4044 * \param[out] device_name The buffer to place the device's name into
4045 * \param name_buffer_length The allocated space for the device_name
4046 * \return 0 always
4047 */
4048int ast_channel_get_device_name(struct ast_channel *chan, char *device_name, size_t name_buffer_length);
4049
4050/*!
4051 * \since 1.8
4052 * \brief Find the appropriate CC agent type to use given a channel
4053 *
4054 * \details
4055 * During call completion, we will need to create a call completion agent structure. To
4056 * figure out the type of agent to construct, we need to ask the channel driver for the
4057 * appropriate type.
4058 *
4059 * Prior to adding this function, the call completion core attempted to figure this
4060 * out for itself by stripping the technology off the channel's name. However, in the
4061 * case of chan_dahdi, there are multiple agent types registered, and so simply searching
4062 * for an agent type called "DAHDI" is not possible. In a case where multiple agent types
4063 * are defined, the channel driver must have a queryoption callback defined in its
4064 * channel_tech, and the queryoption callback must handle AST_OPTION_CC_AGENT_TYPE
4065 *
4066 * If a channel driver does not have a queryoption callback or if the queryoption callback
4067 * does not handle AST_OPTION_CC_AGENT_TYPE, then the old behavior of using the technology
4068 * portion of the channel name is used instead. This is perfectly suitable for channel drivers
4069 * whose channel technologies are a one-to-one match with the agent types defined within.
4070 *
4071 * Note that this function is only called when the agent policy on a given channel is set
4072 * to "native." Generic agents' type can be determined automatically by the core.
4073 *
4074 * \param chan The channel for which we wish to retrieve the agent type
4075 * \param[out] agent_type The type of agent the channel driver wants us to use
4076 * \param size The size of the buffer to write to
4077 */
4078int ast_channel_get_cc_agent_type(struct ast_channel *chan, char *agent_type, size_t size);
4079#if defined(__cplusplus) || defined(c_plusplus)
4080}
4081#endif
4082
4083/*!
4084 * \brief Remove a channel from the global channels container
4085 *
4086 * \param chan channel to remove
4087 *
4088 * In a case where it is desired that a channel not be available in any lookups
4089 * in the global channels conatiner, use this function.
4090 */
4091void ast_channel_unlink(struct ast_channel *chan);
4092
4093/*!
4094 * \brief Sets the HANGUPCAUSE hash and optionally the SIP_CAUSE hash
4095 * on the given channel
4096 *
4097 * \param chan channel on which to set the cause information
4098 * \param cause_code ast_control_pvt_cause_code structure containing cause information
4099 * \param datalen total length of the structure since it may vary
4100 */
4101void ast_channel_hangupcause_hash_set(struct ast_channel *chan, const struct ast_control_pvt_cause_code *cause_code, int datalen);
4102
4103/*!
4104 * \since 12
4105 * \brief Convert a string to a detail record AMA flag
4106 *
4107 * \param flag string form of flag
4108 *
4109 * \retval the enum (integer) form of the flag
4110 */
4111enum ama_flags ast_channel_string2amaflag(const char *flag);
4112
4113/*!
4114 * \since 12
4115 * \brief Convert the enum representation of an AMA flag to a string representation
4116 *
4117 * \param flags integer flag
4118 *
4119 * \retval A string representation of the flag
4120 */
4121const char *ast_channel_amaflags2string(enum ama_flags flags);
4122
4123enum AST_MONITORING_STATE {
4124 AST_MONITOR_RUNNING,
4125 AST_MONITOR_PAUSED
4126};
4127
4128/* ACCESSOR FUNCTIONS */
4129
4130#define DECLARE_STRINGFIELD_SETTERS_FOR(field) \
4131 void ast_channel_##field##_set(struct ast_channel *chan, const char *field); \
4132 void ast_channel_##field##_build_va(struct ast_channel *chan, const char *fmt, va_list ap) __attribute__((format(printf, 2, 0))); \
4133 void ast_channel_##field##_build(struct ast_channel *chan, const char *fmt, ...) __attribute__((format(printf, 2, 3)))
4134
4135/*!
4136 * The following string fields result in channel snapshot creation and
4137 * should have the channel locked when called:
4138 *
4139 * \li language
4140 * \li accountcode
4141 * \li peeraccount
4142 * \li linkedid
4143 */
4144DECLARE_STRINGFIELD_SETTERS_FOR(name);
4145DECLARE_STRINGFIELD_SETTERS_FOR(language);
4146DECLARE_STRINGFIELD_SETTERS_FOR(musicclass);
4147DECLARE_STRINGFIELD_SETTERS_FOR(latest_musicclass);
4148DECLARE_STRINGFIELD_SETTERS_FOR(accountcode);
4149DECLARE_STRINGFIELD_SETTERS_FOR(peeraccount);
4150DECLARE_STRINGFIELD_SETTERS_FOR(userfield);
4151DECLARE_STRINGFIELD_SETTERS_FOR(call_forward);
4152DECLARE_STRINGFIELD_SETTERS_FOR(uniqueid);
4153DECLARE_STRINGFIELD_SETTERS_FOR(linkedid);
4154DECLARE_STRINGFIELD_SETTERS_FOR(parkinglot);
4155DECLARE_STRINGFIELD_SETTERS_FOR(hangupsource);
4156DECLARE_STRINGFIELD_SETTERS_FOR(dialcontext);
4157
4158const char *ast_channel_name(const struct ast_channel *chan);
4159const char *ast_channel_language(const struct ast_channel *chan);
4160const char *ast_channel_musicclass(const struct ast_channel *chan);
4161const char *ast_channel_latest_musicclass(const struct ast_channel *chan);
4162const char *ast_channel_accountcode(const struct ast_channel *chan);
4163const char *ast_channel_peeraccount(const struct ast_channel *chan);
4164const char *ast_channel_userfield(const struct ast_channel *chan);
4165const char *ast_channel_call_forward(const struct ast_channel *chan);
4166const char *ast_channel_uniqueid(const struct ast_channel *chan);
4167const char *ast_channel_linkedid(const struct ast_channel *chan);
4168const char *ast_channel_tenantid(const struct ast_channel *chan);
4169void ast_channel_tenantid_set(struct ast_channel *chan, const char *value);
4170const char *ast_channel_parkinglot(const struct ast_channel *chan);
4171const char *ast_channel_hangupsource(const struct ast_channel *chan);
4172const char *ast_channel_dialcontext(const struct ast_channel *chan);
4173
4174const char *ast_channel_appl(const struct ast_channel *chan);
4175void ast_channel_appl_set(struct ast_channel *chan, const char *value);
4176const char *ast_channel_blockproc(const struct ast_channel *chan);
4177void ast_channel_blockproc_set(struct ast_channel *chan, const char *value);
4178const char *ast_channel_data(const struct ast_channel *chan);
4179void ast_channel_data_set(struct ast_channel *chan, const char *value);
4180
4181const char *ast_channel_lastcontext(const struct ast_channel *chan);
4182const char *ast_channel_context(const struct ast_channel *chan);
4183void ast_channel_context_set(struct ast_channel *chan, const char *value);
4184const char *ast_channel_lastexten(const struct ast_channel *chan);
4185const char *ast_channel_exten(const struct ast_channel *chan);
4186void ast_channel_exten_set(struct ast_channel *chan, const char *value);
4187
4188char ast_channel_dtmf_digit_to_emulate(const struct ast_channel *chan);
4189void ast_channel_dtmf_digit_to_emulate_set(struct ast_channel *chan, char value);
4190char ast_channel_sending_dtmf_digit(const struct ast_channel *chan);
4191void ast_channel_sending_dtmf_digit_set(struct ast_channel *chan, char value);
4192struct timeval ast_channel_sending_dtmf_tv(const struct ast_channel *chan);
4193void ast_channel_sending_dtmf_tv_set(struct ast_channel *chan, struct timeval value);
4194enum ama_flags ast_channel_amaflags(const struct ast_channel *chan);
4195
4196/*!
4197 * \pre chan is locked
4198 */
4199void ast_channel_amaflags_set(struct ast_channel *chan, enum ama_flags value);
4200int ast_channel_epfd(const struct ast_channel *chan);
4201void ast_channel_epfd_set(struct ast_channel *chan, int value);
4202int ast_channel_fdno(const struct ast_channel *chan);
4203void ast_channel_fdno_set(struct ast_channel *chan, int value);
4204int ast_channel_hangupcause(const struct ast_channel *chan);
4205void ast_channel_hangupcause_set(struct ast_channel *chan, int value);
4206int ast_channel_tech_hangupcause(const struct ast_channel *chan);
4207void ast_channel_tech_hangupcause_set(struct ast_channel *chan, int value);
4208int ast_channel_priority(const struct ast_channel *chan);
4209void ast_channel_priority_set(struct ast_channel *chan, int value);
4210int ast_channel_rings(const struct ast_channel *chan);
4211void ast_channel_rings_set(struct ast_channel *chan, int value);
4212int ast_channel_streamid(const struct ast_channel *chan);
4213void ast_channel_streamid_set(struct ast_channel *chan, int value);
4214int ast_channel_timingfd(const struct ast_channel *chan);
4215void ast_channel_timingfd_set(struct ast_channel *chan, int value);
4216int ast_channel_visible_indication(const struct ast_channel *chan);
4217void ast_channel_visible_indication_set(struct ast_channel *chan, int value);
4218int ast_channel_hold_state(const struct ast_channel *chan);
4219void ast_channel_hold_state_set(struct ast_channel *chan, int value);
4220int ast_channel_vstreamid(const struct ast_channel *chan);
4221void ast_channel_vstreamid_set(struct ast_channel *chan, int value);
4222unsigned short ast_channel_transfercapability(const struct ast_channel *chan);
4223void ast_channel_transfercapability_set(struct ast_channel *chan, unsigned short value);
4224unsigned int ast_channel_emulate_dtmf_duration(const struct ast_channel *chan);
4225void ast_channel_emulate_dtmf_duration_set(struct ast_channel *chan, unsigned int value);
4226unsigned int ast_channel_fin(const struct ast_channel *chan);
4227void ast_channel_fin_set(struct ast_channel *chan, unsigned int value);
4228unsigned int ast_channel_fout(const struct ast_channel *chan);
4229void ast_channel_fout_set(struct ast_channel *chan, unsigned int value);
4230unsigned long ast_channel_insmpl(const struct ast_channel *chan);
4231void ast_channel_insmpl_set(struct ast_channel *chan, unsigned long value);
4232unsigned long ast_channel_outsmpl(const struct ast_channel *chan);
4233void ast_channel_outsmpl_set(struct ast_channel *chan, unsigned long value);
4234void *ast_channel_generatordata(const struct ast_channel *chan);
4235void ast_channel_generatordata_set(struct ast_channel *chan, void *value);
4236void *ast_channel_music_state(const struct ast_channel *chan);
4237void ast_channel_music_state_set(struct ast_channel *chan, void *value);
4238void *ast_channel_tech_pvt(const struct ast_channel *chan);
4239void ast_channel_tech_pvt_set(struct ast_channel *chan, void *value);
4240void *ast_channel_timingdata(const struct ast_channel *chan);
4241void ast_channel_timingdata_set(struct ast_channel *chan, void *value);
4242struct ast_audiohook_list *ast_channel_audiohooks(const struct ast_channel *chan);
4243void ast_channel_audiohooks_set(struct ast_channel *chan, struct ast_audiohook_list *value);
4244struct ast_cdr *ast_channel_cdr(const struct ast_channel *chan);
4245void ast_channel_cdr_set(struct ast_channel *chan, struct ast_cdr *value);
4246struct ast_channel *ast_channel__bridge(const struct ast_channel *chan);
4247void ast_channel__bridge_set(struct ast_channel *chan, struct ast_channel *value);
4248struct ast_channel *ast_channel_masq(const struct ast_channel *chan);
4249void ast_channel_masq_set(struct ast_channel *chan, struct ast_channel *value);
4250struct ast_channel *ast_channel_masqr(const struct ast_channel *chan);
4251void ast_channel_masqr_set(struct ast_channel *chan, struct ast_channel *value);
4252struct ast_filestream *ast_channel_stream(const struct ast_channel *chan);
4253void ast_channel_stream_set(struct ast_channel *chan, struct ast_filestream *value);
4254struct ast_filestream *ast_channel_vstream(const struct ast_channel *chan);
4255void ast_channel_vstream_set(struct ast_channel *chan, struct ast_filestream *value);
4256struct ast_format_cap *ast_channel_nativeformats(const struct ast_channel *chan);
4257void ast_channel_nativeformats_set(struct ast_channel *chan, struct ast_format_cap *value);
4258struct ast_framehook_list *ast_channel_framehooks(const struct ast_channel *chan);
4259void ast_channel_framehooks_set(struct ast_channel *chan, struct ast_framehook_list *value);
4260struct ast_generator *ast_channel_generator(const struct ast_channel *chan);
4261void ast_channel_generator_set(struct ast_channel *chan, struct ast_generator *value);
4262struct ast_pbx *ast_channel_pbx(const struct ast_channel *chan);
4263void ast_channel_pbx_set(struct ast_channel *chan, struct ast_pbx *value);
4264struct ast_sched_context *ast_channel_sched(const struct ast_channel *chan);
4265void ast_channel_sched_set(struct ast_channel *chan, struct ast_sched_context *value);
4266struct ast_timer *ast_channel_timer(const struct ast_channel *chan);
4267void ast_channel_timer_set(struct ast_channel *chan, struct ast_timer *value);
4268struct ast_tone_zone *ast_channel_zone(const struct ast_channel *chan);
4269void ast_channel_zone_set(struct ast_channel *chan, struct ast_tone_zone *value);
4270struct ast_trans_pvt *ast_channel_readtrans(const struct ast_channel *chan);
4271void ast_channel_readtrans_set(struct ast_channel *chan, struct ast_trans_pvt *value);
4272struct ast_trans_pvt *ast_channel_writetrans(const struct ast_channel *chan);
4273void ast_channel_writetrans_set(struct ast_channel *chan, struct ast_trans_pvt *value);
4274const struct ast_channel_tech *ast_channel_tech(const struct ast_channel *chan);
4275void ast_channel_tech_set(struct ast_channel *chan, const struct ast_channel_tech *value);
4276enum ast_channel_adsicpe ast_channel_adsicpe(const struct ast_channel *chan);
4277void ast_channel_adsicpe_set(struct ast_channel *chan, enum ast_channel_adsicpe value);
4278enum ast_channel_state ast_channel_state(const struct ast_channel *chan);
4279ast_callid ast_channel_callid(const struct ast_channel *chan);
4280struct ast_channel_snapshot *ast_channel_snapshot(const struct ast_channel *chan);
4281void ast_channel_snapshot_set(struct ast_channel *chan, struct ast_channel_snapshot *snapshot);
4282struct ast_flags *ast_channel_snapshot_segment_flags(struct ast_channel *chan);
4283struct ast_endpoint *ast_channel_endpoint(const struct ast_channel *chan);
4284void ast_channel_endpoint_set(struct ast_channel *chan, struct ast_endpoint *endpoint);
4285
4286/*!
4287 * \pre chan is locked
4288 */
4289void ast_channel_callid_set(struct ast_channel *chan, ast_callid value);
4290
4291/* XXX Internal use only, make sure to move later */
4292void ast_channel_state_set(struct ast_channel *chan, enum ast_channel_state);
4293void ast_channel_softhangup_internal_flag_set(struct ast_channel *chan, int value);
4294void ast_channel_softhangup_internal_flag_add(struct ast_channel *chan, int value);
4295void ast_channel_softhangup_internal_flag_clear(struct ast_channel *chan, int value);
4296void ast_channel_callid_cleanup(struct ast_channel *chan);
4297int ast_channel_softhangup_internal_flag(struct ast_channel *chan);
4298
4299/* Format getters */
4300struct ast_format *ast_channel_oldwriteformat(struct ast_channel *chan);
4301struct ast_format *ast_channel_rawreadformat(struct ast_channel *chan);
4302struct ast_format *ast_channel_rawwriteformat(struct ast_channel *chan);
4303struct ast_format *ast_channel_readformat(struct ast_channel *chan);
4304struct ast_format *ast_channel_writeformat(struct ast_channel *chan);
4305
4306/* Format setters - all of these functions will increment the reference count of the format passed in */
4307void ast_channel_set_oldwriteformat(struct ast_channel *chan, struct ast_format *format);
4308void ast_channel_set_rawreadformat(struct ast_channel *chan, struct ast_format *format);
4309void ast_channel_set_rawwriteformat(struct ast_channel *chan, struct ast_format *format);
4310void ast_channel_set_readformat(struct ast_channel *chan, struct ast_format *format);
4311void ast_channel_set_writeformat(struct ast_channel *chan, struct ast_format *format);
4312
4313/* Other struct getters */
4314struct ast_frame *ast_channel_dtmff(struct ast_channel *chan);
4315struct ast_jb *ast_channel_jb(struct ast_channel *chan);
4316struct ast_party_caller *ast_channel_caller(struct ast_channel *chan);
4317struct ast_party_connected_line *ast_channel_connected(struct ast_channel *chan);
4318struct ast_party_connected_line *ast_channel_connected_indicated(struct ast_channel *chan);
4319struct ast_party_id ast_channel_connected_effective_id(struct ast_channel *chan);
4320struct ast_party_dialed *ast_channel_dialed(struct ast_channel *chan);
4321struct ast_party_redirecting *ast_channel_redirecting(struct ast_channel *chan);
4322struct ast_party_id ast_channel_redirecting_effective_orig(struct ast_channel *chan);
4323struct ast_party_id ast_channel_redirecting_effective_from(struct ast_channel *chan);
4324struct ast_party_id ast_channel_redirecting_effective_to(struct ast_channel *chan);
4325struct timeval *ast_channel_dtmf_tv(struct ast_channel *chan);
4326struct timeval *ast_channel_whentohangup(struct ast_channel *chan);
4327struct varshead *ast_channel_varshead(struct ast_channel *chan);
4328
4329void ast_channel_dtmff_set(struct ast_channel *chan, struct ast_frame *value);
4330void ast_channel_jb_set(struct ast_channel *chan, struct ast_jb *value);
4331void ast_channel_caller_set(struct ast_channel *chan, struct ast_party_caller *value);
4332void ast_channel_connected_set(struct ast_channel *chan, struct ast_party_connected_line *value);
4333void ast_channel_dialed_set(struct ast_channel *chan, struct ast_party_dialed *value);
4334void ast_channel_redirecting_set(struct ast_channel *chan, struct ast_party_redirecting *value);
4335void ast_channel_dtmf_tv_set(struct ast_channel *chan, struct timeval *value);
4336
4337/*!
4338 * \pre chan is locked
4339 */
4340void ast_channel_whentohangup_set(struct ast_channel *chan, struct timeval *value);
4341void ast_channel_varshead_set(struct ast_channel *chan, struct varshead *value);
4342struct timeval ast_channel_creationtime(struct ast_channel *chan);
4343void ast_channel_creationtime_set(struct ast_channel *chan, struct timeval *value);
4344struct timeval ast_channel_answertime(struct ast_channel *chan);
4345void ast_channel_answertime_set(struct ast_channel *chan, struct timeval *value);
4346
4347/* List getters */
4348struct ast_hangup_handler_list *ast_channel_hangup_handlers(struct ast_channel *chan);
4349struct ast_datastore_list *ast_channel_datastores(struct ast_channel *chan);
4350struct ast_autochan_list *ast_channel_autochans(struct ast_channel *chan);
4351struct ast_readq_list *ast_channel_readq(struct ast_channel *chan);
4352
4353/* Typedef accessors */
4354ast_group_t ast_channel_callgroup(const struct ast_channel *chan);
4355/*!
4356 * \pre chan is locked
4357 */
4358void ast_channel_callgroup_set(struct ast_channel *chan, ast_group_t value);
4359ast_group_t ast_channel_pickupgroup(const struct ast_channel *chan);
4360/*!
4361 * \pre chan is locked
4362 */
4363void ast_channel_pickupgroup_set(struct ast_channel *chan, ast_group_t value);
4364struct ast_namedgroups *ast_channel_named_callgroups(const struct ast_channel *chan);
4365void ast_channel_named_callgroups_set(struct ast_channel *chan, struct ast_namedgroups *value);
4366struct ast_namedgroups *ast_channel_named_pickupgroups(const struct ast_channel *chan);
4367void ast_channel_named_pickupgroups_set(struct ast_channel *chan, struct ast_namedgroups *value);
4368
4369/* Alertpipe accessors--the "internal" functions for channel.c use only */
4370int ast_channel_alert_write(struct ast_channel *chan);
4371int ast_channel_alert_writable(struct ast_channel *chan);
4372ast_alert_status_t ast_channel_internal_alert_flush(struct ast_channel *chan);
4373ast_alert_status_t ast_channel_internal_alert_read(struct ast_channel *chan);
4374int ast_channel_internal_alert_readable(struct ast_channel *chan);
4375void ast_channel_internal_alertpipe_clear(struct ast_channel *chan);
4376void ast_channel_internal_alertpipe_close(struct ast_channel *chan);
4377int ast_channel_internal_alert_readfd(struct ast_channel *chan);
4378int ast_channel_internal_alertpipe_init(struct ast_channel *chan);
4379/*! \brief Swap the interal alertpipe between two channels
4380 * \note Handle all of the necessary locking before calling this
4381 */
4382void ast_channel_internal_alertpipe_swap(struct ast_channel *chan1, struct ast_channel *chan2);
4383
4384/* file descriptor array accessors */
4385void ast_channel_internal_fd_clear(struct ast_channel *chan, int which);
4386void ast_channel_internal_fd_clear_all(struct ast_channel *chan);
4387void ast_channel_internal_fd_set(struct ast_channel *chan, int which, int value);
4388int ast_channel_fd(const struct ast_channel *chan, int which);
4389int ast_channel_fd_isset(const struct ast_channel *chan, int which);
4390
4391/*!
4392 * \since 15
4393 * \brief Retrieve the number of file decriptor positions present on the channel
4394 *
4395 * \param chan The channel to get the count of
4396 *
4397 * \pre chan is locked
4398 *
4399 * \return The number of file descriptor positions
4400 */
4401int ast_channel_fd_count(const struct ast_channel *chan);
4402
4403/*!
4404 * \since 15
4405 * \brief Add a file descriptor to the channel without a fixed position
4406 *
4407 * \param chan The channel to add the file descriptor to
4408 * \param value The file descriptor
4409 *
4410 * \pre chan is locked
4411 *
4412 * \return The position of the file descriptor
4413 */
4414int ast_channel_fd_add(struct ast_channel *chan, int value);
4415
4416/* ARI reportable variables accessors */
4417size_t ast_channel_internal_ari_reportable_vars_count(const struct ast_channel *chan);
4418char *ast_channel_internal_ari_reportable_vars_get(const struct ast_channel *chan, size_t index);
4419int ast_channel_internal_ari_reportable_vars_append(struct ast_channel *chan, char *key);
4420char *ast_channel_internal_ari_reportable_vars_remove(struct ast_channel *chan, size_t index);
4421
4422pthread_t ast_channel_blocker(const struct ast_channel *chan);
4423void ast_channel_blocker_set(struct ast_channel *chan, pthread_t value);
4424
4425int ast_channel_blocker_tid(const struct ast_channel *chan);
4426void ast_channel_blocker_tid_set(struct ast_channel *chan, int tid);
4427
4428ast_timing_func_t ast_channel_timingfunc(const struct ast_channel *chan);
4429void ast_channel_timingfunc_set(struct ast_channel *chan, ast_timing_func_t value);
4430
4431struct ast_bridge *ast_channel_internal_bridge(const struct ast_channel *chan);
4432/*!
4433 * \pre chan is locked
4434 */
4435void ast_channel_internal_bridge_set(struct ast_channel *chan, struct ast_bridge *value);
4436
4437struct ast_bridge_channel *ast_channel_internal_bridge_channel(const struct ast_channel *chan);
4438void ast_channel_internal_bridge_channel_set(struct ast_channel *chan, struct ast_bridge_channel *value);
4439
4440struct ast_channel *ast_channel_internal_bridged_channel(const struct ast_channel *chan);
4441void ast_channel_internal_bridged_channel_set(struct ast_channel *chan, struct ast_channel *value);
4442
4443/*!
4444 * \since 11
4445 * \brief Retrieve a comma-separated list of channels for which dialed cause information is available
4446 *
4447 * \details
4448 * This function makes use of datastore operations on the channel, so
4449 * it is important to lock the channel before calling this function.
4450 *
4451 * \param chan The channel from which to retrieve information
4452 * \retval NULL on allocation failure
4453 * \retval Pointer to an ast_str object containing the desired information which must be freed
4454 */
4455struct ast_str *ast_channel_dialed_causes_channels(const struct ast_channel *chan);
4456
4457/*!
4458 * \since 20.19.0
4459 * \since 22.9.0
4460 * \since 23.3.0
4461 * \brief Retrieve an iterator for dialed cause information
4462 *
4463 * \details
4464 * Each call to ao2_iterator_next() will return a pointer to an ast_control_pvt_cause_code
4465 * structure containing the dialed cause information for one channel. One of the entries
4466 * may be for the channel itself if the channel was hung up because of a non-2XX SIP
4467 * response code. The rest of the entries will be for channels bridged to the channel for
4468 * which dialed cause information is being retrieved. The caller is responsible for
4469 * cleaning up the reference count of each entry returned and destroying the returned
4470 * iterator with ao2_iterator_destroy() when it is finished with it.
4471 *
4472 * \param chan The channel from which to retrieve cause information
4473 * \retval ao2_iterator
4474 */
4475struct ao2_iterator ast_channel_dialed_causes_iterator(const struct ast_channel *chan);
4476
4477/*!
4478 * \since 11
4479 * \brief Retrieve a ref-counted cause code information structure
4480 *
4481 * \details
4482 * This function makes use of datastore operations on the channel, so
4483 * it is important to lock the channel before calling this function.
4484 * This function increases the ref count of the returned object, so the
4485 * calling function must decrease the reference count when it is finished
4486 * with the object.
4487 *
4488 * \param chan The channel from which to retrieve information
4489 * \param chan_name The name of the channel about which to retrieve information
4490 * \retval NULL on search failure
4491 * \retval Pointer to a ref-counted ast_control_pvt_cause_code object containing the desired information
4492 */
4493struct ast_control_pvt_cause_code *ast_channel_dialed_causes_find(const struct ast_channel *chan, const char *chan_name);
4494
4495/*!
4496 * \since 11
4497 * \brief Add cause code information to the channel
4498 *
4499 * \details
4500 * This function makes use of datastore operations on the channel, so
4501 * it is important to lock the channel before calling this function.
4502 * The passed in data is copied and so is still owned by the caller.
4503 *
4504 * \param chan The channel on which to add information
4505 * \param cause_code The cause information to be added to the channel
4506 * \param datalen The total length of the structure since its length is variable
4507 * \retval 0 on success
4508 * \retval -1 on error
4509 */
4510int ast_channel_dialed_causes_add(const struct ast_channel *chan, const struct ast_control_pvt_cause_code *cause_code, int datalen);
4511
4512/*!
4513 * \since 11
4514 * \brief Clear all cause information from the channel
4515 *
4516 * \details
4517 * This function makes use of datastore operations on the channel, so
4518 * it is important to lock the channel before calling this function.
4519 *
4520 * \param chan The channel from which to clear information
4521 */
4522void ast_channel_dialed_causes_clear(const struct ast_channel *chan);
4523
4524struct ast_flags *ast_channel_flags(struct ast_channel *chan);
4525
4526/*!
4527 * \since 13.17.0
4528 * \brief Set a flag on a channel
4529 *
4530 * \param chan The channel to set the flag on
4531 * \param flag The flag to set
4532 *
4533 * \note This will lock the channel internally. If the channel is already
4534 * locked it is still safe to call.
4535 */
4536
4537void ast_channel_set_flag(struct ast_channel *chan, unsigned int flag);
4538
4539/*!
4540 * \since 13.17.0
4541 * \brief Clear a flag on a channel
4542 *
4543 * \param chan The channel to clear the flag from
4544 * \param flag The flag to clear
4545 *
4546 * \note This will lock the channel internally. If the channel is already
4547 * locked it is still safe to call.
4548 */
4549void ast_channel_clear_flag(struct ast_channel *chan, unsigned int flag);
4550
4551/*!
4552 * \since 12.4.0
4553 * \brief Return whether or not any manager variables have been set
4554 *
4555 * \retval 0 if no manager variables are expected
4556 * \retval 1 if manager variables are expected
4557 */
4558int ast_channel_has_manager_vars(void);
4559
4560/*!
4561 * \since 12
4562 * \brief Sets the variables to be stored in the \a manager_vars field of all
4563 * snapshots.
4564 * \param varc Number of variable names.
4565 * \param vars Array of variable names.
4566 */
4567void ast_channel_set_manager_vars(size_t varc, char **vars);
4568
4569/*!
4570 * \since 12
4571 * \brief Gets the variables for a given channel, as specified by ast_channel_set_manager_vars().
4572 *
4573 * The returned variable list is an AO2 object, so ao2_cleanup() to free it.
4574 *
4575 * \param chan Channel to get variables for.
4576 * \return List of channel variables.
4577 * \retval NULL on error
4578 */
4579struct varshead *ast_channel_get_manager_vars(struct ast_channel *chan);
4580
4581/*!
4582 * \since 14.2.0
4583 * \brief Return whether or not any ARI variables have been set
4584 *
4585 * \retval 0 if no ARI variables are expected
4586 * \retval 1 if ARI variables are expected
4587 */
4588int ast_channel_has_ari_vars(void);
4589
4590/*!
4591 * \since 14.2.0
4592 * \brief Sets the variables to be stored in the \a ari_vars field of all
4593 * snapshots.
4594 * \param varc Number of variable names.
4595 * \param vars Array of variable names.
4596 */
4597void ast_channel_set_ari_vars(size_t varc, char **vars);
4598
4599/*!
4600 * \since 14.2.0
4601 * \brief Gets the variables for a given channel, as specified by ast_channel_set_ari_vars().
4602 *
4603 * The returned variable list is an AO2 object, so ao2_cleanup() to free it.
4604 *
4605 * \param chan Channel to get variables for.
4606 * \return List of channel variables.
4607 * \retval NULL on error
4608 */
4609struct varshead *ast_channel_get_ari_vars(struct ast_channel *chan);
4610
4611/*!
4612 * \since 20.20.0
4613 * \since 22.10.0
4614 * \since 23.4.0
4615 * \brief Set whether a channel variable should be included in REST events on the channel.
4616 *
4617 * \param chan Channel to update.
4618 * \param variable Variable name or dialplan function expression.
4619 * \param report_events Non-zero to include in REST events, zero to omit.
4620 * \retval 0 on success
4621 * \retval -1 on failure
4622 */
4623int ast_channel_set_ari_var_reportable(struct ast_channel *chan, const char *variable, int report_events);
4624
4625/*!
4626 * \since 12
4627 * \brief Gets the variables for a given channel, as set using pbx_builtin_setvar_helper().
4628 *
4629 * The returned variable list is an AO2 object, so ao2_cleanup() to free it.
4630 *
4631 * \param chan Channel to get variables for
4632 * \return List of channel variables.
4633 * \retval NULL on error
4634 */
4635struct varshead *ast_channel_get_vars(struct ast_channel *chan);
4636
4637/*!
4638 * \since 12
4639 * \brief A topic which publishes the events for a particular channel.
4640 *
4641 * If the given \a chan is \c NULL, ast_channel_topic_all() is returned.
4642 *
4643 * \param chan Channel, or \c NULL.
4644 *
4645 * \retval Topic for channel's events.
4646 * \retval ast_channel_topic_all() if \a chan is \c NULL.
4647 */
4648struct stasis_topic *ast_channel_topic(struct ast_channel *chan);
4649
4650/*!
4651 * \brief Get the bridge associated with a channel
4652 * \since 12.0.0
4653 *
4654 * \param chan The channel whose bridge we want
4655 *
4656 * \details
4657 * The bridge returned has its reference count incremented. Use
4658 * ao2_cleanup() or ao2_ref() in order to decrement the
4659 * reference count when you are finished with the bridge.
4660 *
4661 * \note This function expects the channel to be locked prior to
4662 * being called and will not grab the channel lock.
4663 *
4664 * \retval NULL No bridge present on the channel
4665 * \retval non-NULL The bridge the channel is in
4666 */
4667struct ast_bridge *ast_channel_get_bridge(const struct ast_channel *chan);
4668
4669/*!
4670 * \brief Determine if a channel is in a bridge
4671 * \since 12.0.0
4672 *
4673 * \param chan The channel to test
4674 *
4675 * \note This function expects the channel to be locked prior to
4676 * being called and will not grab the channel lock.
4677 *
4678 * \retval 0 The channel is not bridged
4679 * \retval non-zero The channel is bridged
4680 */
4681int ast_channel_is_bridged(const struct ast_channel *chan);
4682
4683/*!
4684 * \brief Determine if a channel is leaving a bridge, but \em not hung up
4685 * \since 12.4.0
4686 *
4687 * \param chan The channel to test
4688 *
4689 * \note If a channel is hung up, it is implicitly leaving any bridge it
4690 * may be in. This function is used to test if a channel is leaving a bridge
4691 * but may survive the experience, if it has a place to go to (dialplan or
4692 * otherwise)
4693 *
4694 * \retval 0 The channel is not leaving the bridge or is hung up
4695 * \retval non-zero The channel is leaving the bridge
4696 */
4697int ast_channel_is_leaving_bridge(struct ast_channel *chan);
4698
4699/*!
4700 * \brief Get the channel's bridge peer only if the bridge is two-party.
4701 * \since 12.0.0
4702 *
4703 * \param chan Channel desiring the bridge peer channel.
4704 *
4705 * \note The returned peer channel is the current peer in the
4706 * bridge when called.
4707 *
4708 * \note Absolutely _NO_ channel locks should be held when calling this function.
4709 *
4710 * \retval NULL Channel not in a bridge or the bridge is not two-party.
4711 * \retval non-NULL Reffed peer channel at time of calling.
4712 */
4713struct ast_channel *ast_channel_bridge_peer(struct ast_channel *chan);
4714
4715/*!
4716 * \brief Get a reference to the channel's bridge pointer.
4717 * \since 12.0.0
4718 *
4719 * \param chan The channel whose bridge channel is desired
4720 *
4721 * \note This increases the reference count of the bridge_channel.
4722 * Use ao2_ref() or ao2_cleanup() to decrement the refcount when
4723 * you are finished with it.
4724 *
4725 * \note It is expected that the channel is locked prior to
4726 * placing this call.
4727 *
4728 * \retval NULL The channel has no bridge_channel
4729 * \retval non-NULL A reference to the bridge_channel
4730 */
4731struct ast_bridge_channel *ast_channel_get_bridge_channel(struct ast_channel *chan);
4732
4733/*!
4734 * \since 12
4735 * \brief Gain control of a channel in the system
4736 *
4737 * The intention of this function is to take a channel that currently
4738 * is running in one thread and gain control of it in the current thread.
4739 * This can be used to redirect a channel to a different place in the dialplan,
4740 * for instance.
4741 *
4742 * \note This function is NOT intended to be used on bridged channels. If you
4743 * need to control a bridged channel, you can set a callback to be called
4744 * once the channel exits the bridge, and run your controlling logic in that
4745 * callback
4746 *
4747 * XXX Put name of callback-setting function in above paragraph once it is written
4748 *
4749 * \note When this function returns successfully, the yankee channel is in a state where
4750 * it cannot be used any further. Always use the returned channel instead.
4751 *
4752 * \note absolutely _NO_ channel locks should be held before calling this function.
4753 *
4754 * \note The dialplan location on the returned channel is where the channel
4755 * should be started in the dialplan if it is returned to it.
4756 *
4757 * \param yankee The channel to gain control of
4758 * \retval NULL Could not gain control of the channel
4759 * \retval non-NULL The channel
4760 */
4761struct ast_channel *ast_channel_yank(struct ast_channel *yankee);
4762
4763/*!
4764 * \since 12
4765 * \brief Move a channel from its current location to a new location
4766 *
4767 * The intention of this function is to have the destination channel
4768 * take on the identity of the source channel.
4769 *
4770 * \note This function is NOT intended to be used on bridged channels. If you
4771 * wish to move an unbridged channel into the place of a bridged channel, then
4772 * use ast_bridge_join() or ast_bridge_impart(). If you wish to move a bridged
4773 * channel into the place of another bridged channel, then use ast_bridge_move().
4774 *
4775 * \note When this function returns succesfully, the source channel is in a
4776 * state where its continued use is unreliable.
4777 *
4778 * \note absolutely _NO_ channel locks should be held before calling this function.
4779 *
4780 * \param dest The place to move the source channel
4781 * \param source The channel to move
4782 * \retval 0 Success
4783 * \retval non-zero Failure
4784 */
4785int ast_channel_move(struct ast_channel *dest, struct ast_channel *source);
4786
4787/*!
4788 * \since 12
4789 * \brief Forward channel stasis messages to the given endpoint
4790 *
4791 * \param chan The channel to forward from
4792 * \param endpoint The endpoint to forward to
4793 *
4794 * \retval 0 Success
4795 * \retval non-zero Failure
4796 */
4797int ast_channel_forward_endpoint(struct ast_channel *chan, struct ast_endpoint *endpoint);
4798
4799/*!
4800 * \brief Return the oldest linkedid between two channels.
4801 *
4802 * A channel linkedid is derived from the channel uniqueid which is formed like this:
4803 * [systemname-]ctime.seq
4804 *
4805 * The systemname, and the dash are optional, followed by the epoch time followed by an
4806 * integer sequence. Note that this is not a decimal number, since 1.2 is less than 1.11
4807 * in uniqueid land.
4808 *
4809 * To compare two uniqueids, we parse out the integer values of the time and the sequence
4810 * numbers and compare them, with time trumping sequence.
4811 *
4812 * \param a The linkedid value of the first channel to compare
4813 * \param b The linkedid value of the second channel to compare
4814 *
4815 * \retval NULL on failure
4816 * \retval The oldest linkedid value
4817 * \since 12.0.0
4818*/
4819const char *ast_channel_oldest_linkedid(const char *a, const char *b);
4820
4821/*!
4822 * \brief Check if the channel has active audiohooks, active framehooks, or a monitor.
4823 * \since 12.0.0
4824 *
4825 * \param chan The channel to check.
4826 *
4827 * \retval non-zero if channel has active audiohooks, framehooks, or monitor.
4828 */
4829int ast_channel_has_audio_frame_or_monitor(struct ast_channel *chan);
4830
4831/*!
4832 * \brief Check if the channel has any active hooks that require audio.
4833 * \since 12.3.0
4834 *
4835 * \param chan The channel to check.
4836 *
4837 * \retval non-zero if channel has active audiohooks, audio framehooks, or monitor.
4838 */
4839int ast_channel_has_hook_requiring_audio(struct ast_channel *chan);
4840
4841/*!
4842 * \brief Removes the trailing identifiers from a channel name string
4843 * \since 12.0.0
4844 *
4845 * \param channel_name string that you wish to turn into a dial string.
4846 * This string will be edited in place.
4847 */
4848void ast_channel_name_to_dial_string(char *channel_name);
4849
4850#define AST_MUTE_DIRECTION_READ (1 << 0)
4851#define AST_MUTE_DIRECTION_WRITE (1 << 1)
4852
4853/*!
4854 * \brief Suppress passing of a frame type on a channel
4855 *
4856 * \note The channel should be locked before calling this function.
4857 *
4858 * \param chan The channel to suppress
4859 * \param direction The direction in which to suppress
4860 * \param frametype The type of frame (AST_FRAME_VOICE, etc) to suppress
4861 *
4862 * \retval 0 Success
4863 * \retval -1 Failure
4864 */
4865int ast_channel_suppress(struct ast_channel *chan, unsigned int direction, enum ast_frame_type frametype);
4866
4867/*!
4868 * \brief Stop suppressing of a frame type on a channel
4869 *
4870 * \note The channel should be locked before calling this function.
4871 *
4872 * \param chan The channel to stop suppressing
4873 * \param direction The direction in which to stop suppressing
4874 * \param frametype The type of frame (AST_FRAME_VOICE, etc) to stop suppressing
4875 *
4876 * \retval 0 Success
4877 * \retval -1 Failure
4878 */
4879int ast_channel_unsuppress(struct ast_channel *chan, unsigned int direction, enum ast_frame_type frametype);
4880
4881/*!
4882 * \brief Simulate a DTMF end on a broken bridge channel.
4883 *
4884 * \param chan Channel sending DTMF that has not ended.
4885 * \param digit DTMF digit to stop.
4886 * \param start DTMF digit start time.
4887 * \param why Reason bridge broken.
4888 */
4889void ast_channel_end_dtmf(struct ast_channel *chan, char digit, struct timeval start, const char *why);
4890
4891struct ast_bridge_features;
4892
4893/*!
4894 * \brief Gets the channel-attached features a channel has access to upon being bridged.
4895 *
4896 * \note The channel must be locked when calling this function.
4897 *
4898 * \param chan Which channel to get features for
4899 *
4900 * \retval non-NULL The features currently set for this channel
4901 * \retval NULL if the features have not been set
4902 */
4903struct ast_bridge_features *ast_channel_feature_hooks_get(struct ast_channel *chan);
4904
4905/*!
4906 * \brief Appends to the channel-attached features a channel has access to upon being bridged.
4907 *
4908 * \note The channel must be locked when calling this function.
4909 *
4910 * \param chan Which channel to set features for
4911 * \param features The feature set to append to the channel's features
4912 *
4913 * \retval 0 on success
4914 * \retval -1 on failure
4915 */
4916int ast_channel_feature_hooks_append(struct ast_channel *chan, struct ast_bridge_features *features);
4917
4918/*!
4919 * \brief Sets the channel-attached features a channel has access to upon being bridged.
4920 *
4921 * \note The channel must be locked when calling this function.
4922 *
4923 * \param chan Which channel to set features for
4924 * \param features The feature set with which to replace the channel's features
4925 *
4926 * \retval 0 on success
4927 * \retval -1 on failure
4928 */
4929int ast_channel_feature_hooks_replace(struct ast_channel *chan, struct ast_bridge_features *features);
4930
4931enum ast_channel_error {
4932 /* Unable to determine what error occurred. */
4933 AST_CHANNEL_ERROR_UNKNOWN,
4934 /* Channel with this ID already exists */
4935 AST_CHANNEL_ERROR_ID_EXISTS,
4936};
4937
4938/*!
4939 * \brief Get error code for latest channel operation.
4940 */
4941enum ast_channel_error ast_channel_errno(void);
4942
4943/*!
4944 * \brief Am I currently running an intercept dialplan routine.
4945 * \since 13.14.0
4946 *
4947 * \details
4948 * A dialplan intercept routine is equivalent to an interrupt
4949 * routine. As such, the routine must be done quickly and you
4950 * do not have access to the media stream. These restrictions
4951 * are necessary because the media stream is the responsibility
4952 * of some other code and interfering with or delaying that
4953 * processing is bad.
4954 *
4955 * \retval 0 Not in an intercept routine.
4956 * \retval 1 In an intercept routine.
4957 */
4958int ast_channel_get_intercept_mode(void);
4959
4960/*!
4961 * \brief Retrieve the topology of streams on a channel
4962 *
4963 * \param chan The channel to get the stream topology of
4964 *
4965 * \pre chan is locked
4966 *
4967 * \retval non-NULL success
4968 * \retval NULL failure
4969 */
4970struct ast_stream_topology *ast_channel_get_stream_topology(
4971 const struct ast_channel *chan);
4972
4973/*!
4974 * \brief Set the topology of streams on a channel
4975 *
4976 * \param chan The channel to set the stream topology on
4977 * \param topology The stream topology to set
4978 *
4979 * \pre chan is locked
4980 *
4981 * \note If topology is NULL a new empty topology will be created
4982 * and returned.
4983 *
4984 * \retval non-NULL Success
4985 * \retval NULL failure
4986 */
4987struct ast_stream_topology *ast_channel_set_stream_topology(
4988 struct ast_channel *chan, struct ast_stream_topology *topology);
4989
4990/*!
4991 * \brief Retrieve the default stream of a specific media type on a channel
4992 *
4993 * \param chan The channel to get the stream from
4994 * \param type The media type of the default stream
4995 *
4996 * \pre chan is locked
4997 *
4998 * \retval non-NULL success
4999 * \retval NULL failure
5000 */
5001struct ast_stream *ast_channel_get_default_stream(struct ast_channel *chan, enum ast_media_type type);
5002
5003/*!
5004 * \brief Determine if a channel is multi-stream capable
5005 *
5006 * \param chan The channel to test
5007 *
5008 * \pre chan is locked
5009 *
5010 * \retval true if the channel is multi-stream capable.
5011 */
5012int ast_channel_is_multistream(struct ast_channel *chan);
5013
5014/*!
5015 * \brief Request that the stream topology of a channel change
5016 *
5017 * \param chan The channel to change
5018 * \param topology The new stream topology
5019 * \param change_source The source that initiated the change
5020 *
5021 * \note Absolutely _NO_ channel locks should be held before calling this function.
5022 *
5023 * \retval 0 request has been accepted to be attempted
5024 * \retval -1 request could not be attempted
5025 *
5026 * \note This function initiates an asynchronous request to change the stream topology. It is not
5027 * guaranteed that the topology will change and until an AST_CONTROL_STREAM_TOPOLOGY_CHANGED
5028 * frame is received from the channel the current handler of the channel must tolerate the
5029 * stream topology as it currently exists.
5030 *
5031 * \note This interface is provided for applications and resources to request that the topology change.
5032 * It is not for use by the channel driver itself.
5033 */
5034int ast_channel_request_stream_topology_change(struct ast_channel *chan,
5035 struct ast_stream_topology *topology, void *change_source);
5036
5037/*!
5038 * \brief Provide notice to a channel that the stream topology has changed
5039 *
5040 * \param chan The channel to provide notice to
5041 * \param topology The new stream topology
5042 *
5043 * \pre chan is locked Absolutely _NO_ other channels can be locked.
5044 *
5045 * \retval 0 success
5046 * \retval -1 failure
5047 *
5048 * \note This interface is provided for applications and resources to accept a topology change.
5049 * It is not for use by the channel driver itself.
5050 */
5051int ast_channel_stream_topology_changed(struct ast_channel *chan, struct ast_stream_topology *topology);
5052
5053/*!
5054 * \brief Provide notice from a channel that the topology has changed on it as a result
5055 * of the remote party renegotiating.
5056 *
5057 * \param chan The channel to provide notice from
5058 *
5059 * \retval 0 success
5060 * \retval -1 failure
5061 *
5062 * \note This interface is provided for channels to provide notice that a topology change
5063 * has occurred as a result of a remote party renegotiating the stream topology.
5064 */
5065int ast_channel_stream_topology_changed_externally(struct ast_channel *chan);
5066
5067/*!
5068 * \brief Retrieve the source that initiated the last stream topology change
5069 *
5070 * \param chan The channel
5071 *
5072 * \retval The channel's stream topology change source
5073 */
5074void *ast_channel_get_stream_topology_change_source(struct ast_channel *chan);
5075
5076/*!
5077 * \brief Checks if a channel's technology implements a particular callback function
5078 * \since 18.0.0
5079 *
5080 * \param chan The channel
5081 * \param function The function to look for
5082 *
5083 * \retval 1 if the channel has a technology set and it implements the function
5084 * \retval 0 if the channel doesn't have a technology set or it doesn't implement the function
5085 */
5086#define ast_channel_has_tech_function(chan, function) \
5087 (ast_channel_tech(chan) ? ast_channel_tech(chan)->function != NULL : 0)
5088
5089/*!
5090 * \brief Get the name of the current channel storage driver
5091 *
5092 * \return The name of the current channel storage driver
5093 */
5094const char *ast_channel_get_current_storage_driver_name(void);
5095
5096/*!
5097 * \internal
5098 * \brief Set the current channel storage driver
5099 *
5100 * \param driver_name The name of the driver to set as the current driver
5101 *
5102 * \return 0 on success, -1 on failure
5103 *
5104 * \warning Changing the channel storage driver while Asterisk is running is
5105 * not supported. This function will return an error if called while
5106 * the ast_fully_booted flag is set. The function is exposed only
5107 * because options.c needs it to set the driver when reading
5108 * asterisk.conf.
5109 */
5110int internal_channel_set_current_storage_driver(const char *driver_name);
5111
5112#endif /* _ASTERISK_CHANNEL_H */
ast_alert_status_t
ast_alert_status_t
Definition alertpipe.h:24
agent_type
static struct aco_type agent_type
Definition app_agent_pool.c:510
digit
char digit
Definition app_alarmreceiver.c:131
gen
static struct ast_generator gen
Definition app_externalivr.c:300
cond
ast_cond_t cond
Definition app_sla.c:336
dialcontext
static char dialcontext[AST_MAX_CONTEXT]
Definition app_voicemail.c:1196
ao2_callback_data_fn
int() ao2_callback_data_fn(void *obj, void *arg, void *data, int flags)
Type of a generic callback function.
Definition astobj2.h:1244
ccss.h
Call Completion Supplementary Services API.
connected
static int connected
Definition cdr_pgsql.c:73
language
static char language[MAX_LANGUAGE]
Definition chan_iax2.c:361
accountcode
static char accountcode[AST_MAX_ACCOUNT_CODE]
Definition chan_iax2.c:510
type
static const char type[]
Definition chan_ooh323.c:109
dummy
static void dummy(char *unused,...)
Definition chan_unistim.c:220
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.
Definition channel.c:1692
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.
Definition channel_internal_api.c:1022
ast_channel_exten_set
void ast_channel_exten_set(struct ast_channel *chan, const char *value)
Definition channel_internal_api.c:240
ast_channel_dialed_causes_iterator
struct ao2_iterator ast_channel_dialed_causes_iterator(const struct ast_channel *chan)
Retrieve an iterator for dialed cause information.
Definition channel_internal_api.c:1171
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().
Definition channel.c:8032
ast_senddigit_mf_begin
int ast_senddigit_mf_begin(struct ast_channel *chan, char digit)
Send an MF digit to a channel.
Definition channel.c:4858
ast_waitfordigit
int ast_waitfordigit(struct ast_channel *c, int ms)
Waits for a digit.
Definition channel.c:3179
ast_str2cause
int ast_str2cause(const char *name) attribute_pure
Convert the string form of a cause code to a number.
Definition channel.c:626
ast_channel_linkedid
const char * ast_channel_linkedid(const struct ast_channel *chan)
Definition channel_internal_api.c:167
ast_channel_name
const char * ast_channel_name(const struct ast_channel *chan)
ast_fdisset
static int ast_fdisset(struct pollfd *pfds, int fd, int maximum, int *start)
Helper function for migrating select to poll.
Definition channel.h:2888
ast_channel_tech_hangupcause
int ast_channel_tech_hangupcause(const struct ast_channel *chan)
Definition channel_internal_api.c:307
ast_autoservice_stop
int ast_autoservice_stop(struct ast_channel *chan)
Stop servicing a channel for us...
Definition autoservice.c:266
ast_print_namedgroups
char * ast_print_namedgroups(struct ast_str **buf, struct ast_namedgroups *groups)
Print named call groups and named pickup groups.
Definition channel.c:8232
ast_channel_internal_bridge
struct ast_bridge * ast_channel_internal_bridge(const struct ast_channel *chan)
Definition channel_internal_api.c:1136
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.
Definition channel_internal_api.c:539
ast_channel_answertime
struct timeval ast_channel_answertime(struct ast_channel *chan)
Definition channel_internal_api.c:853
ast_softhangup_all
void ast_softhangup_all(void)
Soft hangup all active channels.
Definition channel.c:494
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.
Definition channel.c:11146
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.
Definition channel.c:11049
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.
Definition channel.c:2072
ast_channel_rings_set
void ast_channel_rings_set(struct ast_channel *chan, int value)
Definition channel_internal_api.c:329
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.
Definition channel_internal_api.c:1334
ast_channel_named_pickupgroups_set
void ast_channel_named_pickupgroups_set(struct ast_channel *chan, struct ast_namedgroups *value)
Definition channel_internal_api.c:970
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.
Definition channel.c:1430
ast_timing_func_t
int(* ast_timing_func_t)(const void *data)
Definition channel.h:919
ast_channel_masq
struct ast_channel * ast_channel_masq(const struct ast_channel *chan)
Definition channel_internal_api.c:472
ast_party_name_init
void ast_party_name_init(struct ast_party_name *init)
Initialize the given name structure.
Definition channel.c:1578
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.
Definition channel.c:4740
ast_channel_errno
enum ast_channel_error ast_channel_errno(void)
Get error code for latest channel operation.
Definition channel.c:11141
ast_activate_generator
int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params)
Definition channel.c:2955
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.
Definition channel.c:1336
ast_channel_blocker_tid
int ast_channel_blocker_tid(const struct ast_channel *chan)
Definition channel_internal_api.c:1118
ast_channel_stream_set
void ast_channel_stream_set(struct ast_channel *chan, struct ast_filestream *value)
Definition channel_internal_api.c:492
ast_channel_appl_set
void ast_channel_appl_set(struct ast_channel *chan, const char *value)
Definition channel_internal_api.c:192
ast_channel_dtmff_set
void ast_channel_dtmff_set(struct ast_channel *chan, struct ast_frame *value)
Definition channel_internal_api.c:803
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.
Definition channel.c:1937
ast_channel_internal_bridged_channel_set
void ast_channel_internal_bridged_channel_set(struct ast_channel *chan, struct ast_channel *value)
ast_channel_visible_indication_set
void ast_channel_visible_indication_set(struct ast_channel *chan, int value)
Definition channel_internal_api.c:353
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.
Definition channel.c:10676
ast_channel_blockproc
const char * ast_channel_blockproc(const struct ast_channel *chan)
Definition channel_internal_api.c:197
ast_channel_caller_set
void ast_channel_caller_set(struct ast_channel *chan, struct ast_party_caller *value)
Definition channel_internal_api.c:811
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.
Definition channel_internal_api.c:1539
ast_transfercapability2str
char * ast_transfercapability2str(int transfercapability) attribute_const
Gives the string form of a given transfer capability.
Definition channel.c:673
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.
Definition channel_internal_api.c:895
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.
Definition channel.c:2992
ast_auto_answer
int ast_auto_answer(struct ast_channel *chan)
Answer a channel, if it's not already answered.
Definition channel.c:2811
ast_channel_named_pickupgroups
struct ast_namedgroups * ast_channel_named_pickupgroups(const struct ast_channel *chan)
Definition channel_internal_api.c:966
ast_party_redirecting_init
void ast_party_redirecting_init(struct ast_party_redirecting *init)
Initialize the given redirecting structure.
Definition channel.c:2109
ast_channel_tech_pvt
void * ast_channel_tech_pvt(const struct ast_channel *chan)
Definition channel_internal_api.c:437
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)
Definition channel_internal_api.c:1411
ast_channel_get_t38_state
static enum ast_t38_state ast_channel_get_t38_state(struct ast_channel *chan)
Retrieves the current T38 state of a channel.
Definition channel.h:2911
ast_call
int ast_call(struct ast_channel *chan, const char *addr, int timeout)
Make a call.
Definition channel.c:6480
ast_channel_data
const char * ast_channel_data(const struct ast_channel *chan)
Definition channel_internal_api.c:205
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.
Definition channel.c:9295
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 channel.c:6582
ast_channel_dialed_set
void ast_channel_dialed_set(struct ast_channel *chan, struct ast_party_dialed *value)
Definition channel_internal_api.c:821
ast_channel_clear_flag
void ast_channel_clear_flag(struct ast_channel *chan, unsigned int flag)
Clear a flag on a channel.
Definition channel.c:11214
ast_channel_redirecting_effective_to
struct ast_party_id ast_channel_redirecting_effective_to(struct ast_channel *chan)
Definition channel_internal_api.c:787
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.
Definition channel_internal_api.c:1189
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....
Definition channel.c:5921
ast_channel_rawreadformat
struct ast_format * ast_channel_rawreadformat(struct ast_channel *chan)
Definition channel_internal_api.c:715
ast_channel_redirecting_effective_from
struct ast_party_id ast_channel_redirecting_effective_from(struct ast_channel *chan)
Definition channel_internal_api.c:783
ast_party_id_init
void ast_party_id_init(struct ast_party_id *init)
Initialize the given party id structure.
Definition channel.c:1744
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.
Definition channel.c:5511
ast_channel_clear_softhangup
void ast_channel_clear_softhangup(struct ast_channel *chan, int flag)
Clear a set of softhangup flags from a channel.
Definition channel.c:2423
ast_channel_music_state
void * ast_channel_music_state(const struct ast_channel *chan)
Definition channel_internal_api.c:429
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.
Definition channel.c:1368
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().
Definition channel.c:7960
ast_channel_blockproc_set
void ast_channel_blockproc_set(struct ast_channel *chan, const char *value)
Definition channel_internal_api.c:201
ast_prod
int ast_prod(struct ast_channel *chan)
Send empty audio to prime a channel driver.
Definition channel.c:5023
ast_channel_fin
unsigned int ast_channel_fin(const struct ast_channel *chan)
Definition channel_internal_api.c:389
ast_channel_tech_hangupcause_set
void ast_channel_tech_hangupcause_set(struct ast_channel *chan, int value)
Definition channel_internal_api.c:311
__ast_answer
int __ast_answer(struct ast_channel *chan, unsigned int delay)
Answer a channel, with a selectable delay before returning.
Definition channel.c:2695
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.
Definition channel.c:10514
ast_channel_latest_musicclass
const char * ast_channel_latest_musicclass(const struct ast_channel *chan)
ast_channel_callid_cleanup
void ast_channel_callid_cleanup(struct ast_channel *chan)
Definition channel_internal_api.c:935
ast_channel_insmpl_set
void ast_channel_insmpl_set(struct ast_channel *chan, unsigned long value)
Definition channel_internal_api.c:409
ast_party_number_init
void ast_party_number_init(struct ast_party_number *init)
Initialize the given number structure.
Definition channel.c:1631
ast_channel_set_oldwriteformat
void ast_channel_set_oldwriteformat(struct ast_channel *chan, struct ast_format *format)
Definition channel_internal_api.c:691
ast_channel_softhangup_internal_flag_clear
void ast_channel_softhangup_internal_flag_clear(struct ast_channel *chan, int value)
Definition channel_internal_api.c:876
ast_hangup
void ast_hangup(struct ast_channel *chan)
Hang up a channel.
Definition channel.c:2540
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.
Definition channel.c:7395
ast_channel_varshead
struct varshead * ast_channel_varshead(struct ast_channel *chan)
Definition channel_internal_api.c:799
ast_channel_rings
int ast_channel_rings(const struct ast_channel *chan)
Definition channel_internal_api.c:325
DECLARE_STRINGFIELD_SETTERS_FOR
#define DECLARE_STRINGFIELD_SETTERS_FOR(field)
Definition channel.h:4131
ast_channel_generator_set
void ast_channel_generator_set(struct ast_channel *chan, struct ast_generator *value)
Definition channel_internal_api.c:584
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.
Definition channel.c:5040
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.
Definition channel.c:2638
ast_channel_blocker_set
void ast_channel_blocker_set(struct ast_channel *chan, pthread_t value)
Definition channel_internal_api.c:1113
ast_channel_tenantid_set
void ast_channel_tenantid_set(struct ast_channel *chan, const char *value)
Definition channel_internal_api.c:179
ast_channel_sending_dtmf_digit_set
void ast_channel_sending_dtmf_digit_set(struct ast_channel *chan, char value)
Definition channel_internal_api.c:263
ast_channel_timingdata
void * ast_channel_timingdata(const struct ast_channel *chan)
Definition channel_internal_api.c:448
ast_channel_iterator_destroy
struct ast_channel_iterator * ast_channel_iterator_destroy(struct ast_channel_iterator *i)
Destroy a channel iterator.
Definition channel.c:1349
ast_channel_internal_alert_readfd
int ast_channel_internal_alert_readfd(struct ast_channel *chan)
Definition channel_internal_api.c:1017
ast_channel_requestor_relationship
ast_channel_requestor_relationship
Definition channel.h:1523
AST_CHANNEL_REQUESTOR_BRIDGE_PEER
@ AST_CHANNEL_REQUESTOR_BRIDGE_PEER
Definition channel.h:1525
AST_CHANNEL_REQUESTOR_REPLACEMENT
@ AST_CHANNEL_REQUESTOR_REPLACEMENT
Definition channel.h:1527
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.
Definition channel.c:10744
ast_transfer_protocol
int ast_transfer_protocol(struct ast_channel *chan, char *dest, int *protocol)
Transfer a channel (if supported) receieve protocol result.
Definition channel.c:6517
ast_channel_tenantid
const char * ast_channel_tenantid(const struct ast_channel *chan)
Definition channel_internal_api.c:173
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.
Definition channel.c:1706
ast_channel_dtmf_tv_set
void ast_channel_dtmf_tv_set(struct ast_channel *chan, struct timeval *value)
Definition channel_internal_api.c:831
ast_channel_snapshot_segment_flags
struct ast_flags * ast_channel_snapshot_segment_flags(struct ast_channel *chan)
Definition channel_internal_api.c:1607
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.
Definition channel.c:8484
ast_senddigit_begin
int ast_senddigit_begin(struct ast_channel *chan, char digit)
Send a DTMF digit to a channel.
Definition channel.c:4897
ast_party_id_presentation
int ast_party_id_presentation(const struct ast_party_id *id)
Determine the overall presentation value for the given party.
Definition channel.c:1808
ast_channel_get_by_uniqueid
struct ast_channel * ast_channel_get_by_uniqueid(const char *uniqueid)
Find a channel by a uniqueid.
Definition channel.c:1442
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.
Definition channel.c:1639
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.
Definition channel_internal_api.c:1384
ast_channel_nativeformats_set
void ast_channel_nativeformats_set(struct ast_channel *chan, struct ast_format_cap *value)
Definition channel_internal_api.c:544
ast_channel_musicclass
const char * ast_channel_musicclass(const struct ast_channel *chan)
ast_channel_unlink
void ast_channel_unlink(struct ast_channel *chan)
Remove a channel from the global channels container.
Definition channel.c:10709
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.
Definition channel.c:6647
ast_channel_fdno
int ast_channel_fdno(const struct ast_channel *chan)
Definition channel_internal_api.c:290
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.
Definition channel.c:1661
ast_channel_internal_fd_clear_all
void ast_channel_internal_fd_clear_all(struct ast_channel *chan)
Definition channel_internal_api.c:1049
ast_party_subaddress_init
void ast_party_subaddress_init(struct ast_party_subaddress *init)
Initialize the given subaddress structure.
Definition channel.c:1684
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.
Definition channel.c:2523
ast_party_connected_line_free
void ast_party_connected_line_free(struct ast_party_connected_line *doomed)
Destroy the connected line information contents.
Definition channel.c:2059
ast_channel_internal_bridge_channel_set
void ast_channel_internal_bridge_channel_set(struct ast_channel *chan, struct ast_bridge_channel *value)
Definition channel_internal_api.c:1151
ast_channel_internal_alertpipe_close
void ast_channel_internal_alertpipe_close(struct ast_channel *chan)
Definition channel_internal_api.c:1007
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.
Definition channel.c:2835
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.
Definition channel.c:7896
ast_channel_topic
struct stasis_topic * ast_channel_topic(struct ast_channel *chan)
A topic which publishes the events for a particular channel.
Definition channel_internal_api.c:1450
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.
Definition channel.c:4774
ast_channel_answertime_set
void ast_channel_answertime_set(struct ast_channel *chan, struct timeval *value)
Definition channel_internal_api.c:858
ast_tonepair_start
int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol)
Definition channel.c:7618
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...
Definition channel.c:7408
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 millis...
Definition channel.c:3161
ast_channel_hold_state_set
void ast_channel_hold_state_set(struct ast_channel *chan, int value)
Definition channel_internal_api.c:361
ast_senddigit
int ast_senddigit(struct ast_channel *chan, char digit, unsigned int duration)
Send a DTMF digit to a channel.
Definition channel.c:4997
ast_channel_readtrans
struct ast_trans_pvt * ast_channel_readtrans(const struct ast_channel *chan)
Definition channel_internal_api.c:620
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.
Definition channel.c:2153
ast_channel_lastexten
const char * ast_channel_lastexten(const struct ast_channel *chan)
Definition channel_internal_api.c:236
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.
Definition channel.c:6739
ast_channel_nativeformats
struct ast_format_cap * ast_channel_nativeformats(const struct ast_channel *chan)
Definition channel_internal_api.c:504
ast_t38_state
ast_t38_state
Possible T38 states on channels.
Definition channel.h:898
T38_STATE_UNAVAILABLE
@ T38_STATE_UNAVAILABLE
Definition channel.h:899
ast_channel_data_set
void ast_channel_data_set(struct ast_channel *chan, const char *value)
Definition channel_internal_api.c:209
ast_channel_sending_dtmf_tv
struct timeval ast_channel_sending_dtmf_tv(const struct ast_channel *chan)
Definition channel_internal_api.c:268
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().
Definition channel.c:8037
ast_channel_jb_set
void ast_channel_jb_set(struct ast_channel *chan, struct ast_jb *value)
Definition channel_internal_api.c:807
ast_channel_redirecting
struct ast_party_redirecting * ast_channel_redirecting(struct ast_channel *chan)
Definition channel_internal_api.c:775
ast_channel_snapshot_set
void ast_channel_snapshot_set(struct ast_channel *chan, struct ast_channel_snapshot *snapshot)
Definition channel_internal_api.c:1601
ast_party_id_free
void ast_party_id_free(struct ast_party_id *doomed)
Destroy the party id contents.
Definition channel.c:1798
ast_channel_unregister
void ast_channel_unregister(const struct ast_channel_tech *tech)
Unregister a channel technology.
Definition channel.c:571
ast_channel_writetrans
struct ast_trans_pvt * ast_channel_writetrans(const struct ast_channel *chan)
Definition channel_internal_api.c:628
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.
Definition channel.c:1714
ast_waitfor_n_fd
int ast_waitfor_n_fd(int *fds, int n, int *ms, int *exception)
Waits for input on an fd.
Definition channel.c:2984
ast_channel_transfercapability
unsigned short ast_channel_transfercapability(const struct ast_channel *chan)
Definition channel_internal_api.c:373
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.
Definition channel.c:11176
ast_channel_named_callgroups
struct ast_namedgroups * ast_channel_named_callgroups(const struct ast_channel *chan)
Definition channel_internal_api.c:957
ast_channel_pickupgroup
ast_group_t ast_channel_pickupgroup(const struct ast_channel *chan)
Definition channel_internal_api.c:949
ast_channel_blocker_tid_set
void ast_channel_blocker_tid_set(struct ast_channel *chan, int tid)
Definition channel_internal_api.c:1122
ast_channel_vstreamid_set
void ast_channel_vstreamid_set(struct ast_channel *chan, int value)
Definition channel_internal_api.c:369
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.
Definition channel.c:1775
ast_channel_iterator_next
struct ast_channel * ast_channel_iterator_next(struct ast_channel_iterator *i)
Get the next channel for a channel iterator.
Definition channel.c:1388
ast_set_variables
void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars)
adds a list of channel variables to a channel
Definition channel.c:8291
ast_ref_namedgroups
struct ast_namedgroups * ast_ref_namedgroups(struct ast_namedgroups *groups)
Definition channel.c:7774
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.
Definition channel.c:11136
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.
Definition channel.c:8340
internal_channel_set_current_storage_driver
int internal_channel_set_current_storage_driver(const char *driver_name)
Definition channel.c:8155
ast_channel_timingdata_set
void ast_channel_timingdata_set(struct ast_channel *chan, void *value)
Definition channel_internal_api.c:452
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.
Definition channel.c:2018
ast_recvchar
int ast_recvchar(struct ast_channel *chan, int timeout)
Receives a text character from a channel.
Definition channel.c:4729
ast_channel_oldwriteformat
struct ast_format * ast_channel_oldwriteformat(struct ast_channel *chan)
Definition channel_internal_api.c:711
ast_channel_internal_alert_readable
int ast_channel_internal_alert_readable(struct ast_channel *chan)
Definition channel_internal_api.c:997
ast_channel_cdr
struct ast_cdr * ast_channel_cdr(const struct ast_channel *chan)
Definition channel_internal_api.c:464
ast_channel_yank
struct ast_channel * ast_channel_yank(struct ast_channel *yankee)
Gain control of a channel in the system.
Definition channel.c:10773
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.
Definition channel.c:7478
ast_waitfor
int ast_waitfor(struct ast_channel *chan, int ms)
Wait for input on a channel.
Definition channel.c:3166
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.
Definition channel.c:10627
ast_channel_flags
struct ast_flags * ast_channel_flags(struct ast_channel *chan)
Definition channel_internal_api.c:1156
__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...
Definition channel.c:5997
ast_channel_redirecting_set
void ast_channel_redirecting_set(struct ast_channel *chan, struct ast_party_redirecting *value)
Definition channel_internal_api.c:826
ast_group_t
unsigned long long ast_group_t
Definition channel.h:215
ast_channel_error
ast_channel_error
Definition channel.h:4932
AST_CHANNEL_ERROR_ID_EXISTS
@ AST_CHANNEL_ERROR_ID_EXISTS
Definition channel.h:4936
AST_CHANNEL_ERROR_UNKNOWN
@ AST_CHANNEL_ERROR_UNKNOWN
Definition channel.h:4934
ast_channel_get_intercept_mode
int ast_channel_get_intercept_mode(void)
Am I currently running an intercept dialplan routine.
Definition channel.c:10509
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.
Definition channel.c:2041
ast_channel_priority
int ast_channel_priority(const struct ast_channel *chan)
Definition channel_internal_api.c:316
ast_channel_writetrans_set
void ast_channel_writetrans_set(struct ast_channel *chan, struct ast_trans_pvt *value)
Definition channel_internal_api.c:632
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.
Definition channel.c:8386
ast_settimeout_full
int ast_settimeout_full(struct ast_channel *c, unsigned int rate, int(*func)(const void *data), void *data, unsigned int is_ao2_obj)
Definition channel.c:3189
ast_channel_streamid_set
void ast_channel_streamid_set(struct ast_channel *chan, int value)
Definition channel_internal_api.c:337
ast_channel_generatordata_set
void ast_channel_generatordata_set(struct ast_channel *chan, void *value)
Definition channel_internal_api.c:425
ast_party_dialed_init
void ast_party_dialed_init(struct ast_party_dialed *init)
Initialize the given dialed structure.
Definition channel.c:1915
ast_channel_get_current_storage_driver_name
const char * ast_channel_get_current_storage_driver_name(void)
Get the name of the current channel storage driver.
Definition channel.c:8149
ast_channel_connected
struct ast_party_connected_line * ast_channel_connected(struct ast_channel *chan)
Definition channel_internal_api.c:759
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.
Definition channel.c:1973
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.
Definition channel_internal_api.c:1176
ast_channel_softhangup_internal_flag_set
void ast_channel_softhangup_internal_flag_set(struct ast_channel *chan, int value)
Definition channel_internal_api.c:868
ast_channel_callid
ast_callid ast_channel_callid(const struct ast_channel *chan)
Definition channel_internal_api.c:660
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.
Definition channel.c:2089
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 channel.c:8266
ast_channel_uniqueid
const char * ast_channel_uniqueid(const struct ast_channel *chan)
Definition channel_internal_api.c:161
ast_channel_accountcode
const char * ast_channel_accountcode(const struct ast_channel *chan)
ast_channel_internal_swap_endpoints
void ast_channel_internal_swap_endpoints(struct ast_channel *a, struct ast_channel *b)
Swap endpoints between two channels.
Definition channel_internal_api.c:1402
ast_channel__bridge
struct ast_channel * ast_channel__bridge(const struct ast_channel *chan)
ast_channel_undefer_dtmf
void ast_channel_undefer_dtmf(struct ast_channel *chan)
Unset defer DTMF flag on channel.
Definition channel.c:1329
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().
Definition channel.c:6453
ast_channel_context
const char * ast_channel_context(const struct ast_channel *chan)
Definition channel_internal_api.c:215
ast_channel_userfield
const char * ast_channel_userfield(const struct ast_channel *chan)
ast_channel_dtmf_digit_to_emulate
char ast_channel_dtmf_digit_to_emulate(const struct ast_channel *chan)
Definition channel_internal_api.c:250
ast_channel_insmpl
unsigned long ast_channel_insmpl(const struct ast_channel *chan)
Definition channel_internal_api.c:405
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.
Definition channel_internal_api.c:1096
ast_deactivate_generator
void ast_deactivate_generator(struct ast_channel *chan)
Definition channel.c:2892
ast_channel_internal_alert_flush
ast_alert_status_t ast_channel_internal_alert_flush(struct ast_channel *chan)
Definition channel_internal_api.c:982
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.
Definition channel.c:1907
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.
Definition channel.c:1357
ast_check_hangup_locked
int ast_check_hangup_locked(struct ast_channel *chan)
Definition channel.c:460
ast_channel_timingfd_set
void ast_channel_timingfd_set(struct ast_channel *chan, int value)
Definition channel_internal_api.c:345
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.
Definition channel.c:524
ast_channel_endpoint_set
void ast_channel_endpoint_set(struct ast_channel *chan, struct ast_endpoint *endpoint)
Definition channel_internal_api.c:1617
ast_print_group
char * ast_print_group(char *buf, int buflen, ast_group_t group)
Print call and pickup groups into buffer.
Definition channel.c:8207
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.
Definition channel.c:1400
ast_channel_blocker
pthread_t ast_channel_blocker(const struct ast_channel *chan)
Definition channel_internal_api.c:1109
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.
Definition channel.c:2083
ama_flags
ama_flags
Channel AMA Flags.
Definition channel.h:1197
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....
Definition channel.c:5808
ast_channel_sending_dtmf_tv_set
void ast_channel_sending_dtmf_tv_set(struct ast_channel *chan, struct timeval value)
Definition channel_internal_api.c:272
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.
Definition channel.c:5167
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.
Definition channel.c:1994
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.
Definition channel.c:10957
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.
Definition channel.c:11131
ast_autoservice_start
int ast_autoservice_start(struct ast_channel *chan)
Automatically service a channel for us...
Definition autoservice.c:200
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.
Definition channel.c:469
ast_channel_epfd
int ast_channel_epfd(const struct ast_channel *chan)
ast_undestroyed_channels
int ast_undestroyed_channels(void)
Definition channel.c:505
ast_read
struct ast_frame * ast_read(struct ast_channel *chan)
Reads a frame.
Definition channel.c:4278
ast_channel_internal_ari_reportable_vars_count
size_t ast_channel_internal_ari_reportable_vars_count(const struct ast_channel *chan)
Definition channel_internal_api.c:1067
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.
Definition channel.c:2050
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.
Definition channel.c:11083
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.
Definition channel.c:9269
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.
Definition channel_internal_api.c:908
ast_senddigit_mf_end
int ast_senddigit_mf_end(struct ast_channel *chan)
End sending an MF digit to a channel.
Definition channel.c:4966
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.
Definition channel.c:10846
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.
Definition channel.c:10473
ast_party_redirecting_reason_init
void ast_party_redirecting_reason_init(struct ast_party_redirecting_reason *init)
Initialize the given redirecting reason structure.
Definition channel.c:2066
ast_channel_parkinglot
const char * ast_channel_parkinglot(const struct ast_channel *chan)
ast_channel_adsicpe
ast_channel_adsicpe
Definition channel.h:888
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.
Definition channel.c:5010
ast_channel_internal_swap_topics
void ast_channel_internal_swap_topics(struct ast_channel *a, struct ast_channel *b)
Swap topics beteween two channels.
Definition channel_internal_api.c:1370
ast_sendtext
int ast_sendtext(struct ast_channel *chan, const char *text)
Sends text to a channel.
Definition channel.c:4832
ast_channel_appl
const char * ast_channel_appl(const struct ast_channel *chan)
Definition channel_internal_api.c:188
ast_channel_set_ari_var_reportable
int ast_channel_set_ari_var_reportable(struct ast_channel *chan, const char *variable, int report_events)
Set whether a channel variable should be included in REST events on the channel.
Definition channel.c:7906
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.
Definition channel.c:4283
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.
Definition channel.c:1986
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.
Definition channel_internal_api.c:881
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.
Definition channel.c:1767
ast_party_name_free
void ast_party_name_free(struct ast_party_name *doomed)
Destroy the party name contents.
Definition channel.c:1625
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.
Definition channel.c:7901
ast_channel_peeraccount
const char * ast_channel_peeraccount(const struct ast_channel *chan)
ast_party_dialed_free
void ast_party_dialed_free(struct ast_party_dialed *doomed)
Destroy the dialed party contents.
Definition channel.c:1958
ast_channel_framehooks_set
void ast_channel_framehooks_set(struct ast_channel *chan, struct ast_framehook_list *value)
Definition channel_internal_api.c:576
ast_channel_creationtime
struct timeval ast_channel_creationtime(struct ast_channel *chan)
Definition channel_internal_api.c:843
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.
Definition channel.c:7370
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.
Definition channel.c:10559
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.
Definition channel.c:6795
ast_channel_get_by_name
struct ast_channel * ast_channel_get_by_name(const char *search)
Find a channel by name or uniqueid.
Definition channel.c:1417
ast_channel_internal_bridge_channel
struct ast_bridge_channel * ast_channel_internal_bridge_channel(const struct ast_channel *chan)
Definition channel_internal_api.c:1147
ast_channel_framehooks
struct ast_framehook_list * ast_channel_framehooks(const struct ast_channel *chan)
Definition channel_internal_api.c:572
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 aud...
Definition channel.c:4293
ast_channel_audiohooks_set
void ast_channel_audiohooks_set(struct ast_channel *chan, struct ast_audiohook_list *value)
Definition channel_internal_api.c:460
ast_channel_fd
int ast_channel_fd(const struct ast_channel *chan, int which)
Definition channel_internal_api.c:1053
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.
Definition channel.c:2140
ast_channel_timer_set
void ast_channel_timer_set(struct ast_channel *chan, struct ast_timer *value)
Definition channel_internal_api.c:608
ast_set_read_format
int ast_set_read_format(struct ast_channel *chan, struct ast_format *format)
Sets read format on channel chan.
Definition channel.c:5785
ast_channel_internal_fd_set
void ast_channel_internal_fd_set(struct ast_channel *chan, int which, int value)
Definition channel_internal_api.c:1028
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.
Definition channel.c:1600
ast_channel_fin_set
void ast_channel_fin_set(struct ast_channel *chan, unsigned int value)
Definition channel_internal_api.c:393
ast_channel_set_rawreadformat
void ast_channel_set_rawreadformat(struct ast_channel *chan, struct ast_format *format)
Definition channel_internal_api.c:695
ast_channel_audiohooks
struct ast_audiohook_list * ast_channel_audiohooks(const struct ast_channel *chan)
Definition channel_internal_api.c:456
ast_channel_tech_pvt_set
void ast_channel_tech_pvt_set(struct ast_channel *chan, void *value)
Definition channel_internal_api.c:441
ast_channel_amaflags
enum ama_flags ast_channel_amaflags(const struct ast_channel *chan)
Definition channel_internal_api.c:277
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.
Definition channel.c:8961
ast_party_caller_free
void ast_party_caller_free(struct ast_party_caller *doomed)
Destroy the caller party contents.
Definition channel.c:2002
ast_channel_readtrans_set
void ast_channel_readtrans_set(struct ast_channel *chan, struct ast_trans_pvt *value)
Definition channel_internal_api.c:624
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.
Definition channel.c:1923
ast_active_channels
int ast_active_channels(void)
returns number of active/allocated channels
Definition channel.c:500
ast_get_namedgroups
struct ast_namedgroups * ast_get_namedgroups(const char *s)
Create an ast_namedgroups set with group names from comma separated string.
Definition channel.c:7711
ast_channel_supports_html
int ast_channel_supports_html(struct ast_channel *channel)
Checks for HTML support on a channel.
Definition channel.c:6642
ast_channel_callgroup_set
void ast_channel_callgroup_set(struct ast_channel *chan, ast_group_t value)
Definition channel_internal_api.c:945
ast_channel_internal_bridge_set
void ast_channel_internal_bridge_set(struct ast_channel *chan, struct ast_bridge *value)
Definition channel_internal_api.c:1140
ast_channel_generatordata
void * ast_channel_generatordata(const struct ast_channel *chan)
Definition channel_internal_api.c:421
ast_channel_rawwriteformat
struct ast_format * ast_channel_rawwriteformat(struct ast_channel *chan)
Definition channel_internal_api.c:719
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.
Definition channel_internal_api.c:923
ast_channel_hangupsource
const char * ast_channel_hangupsource(const struct ast_channel *chan)
AST_MONITORING_STATE
AST_MONITORING_STATE
Definition channel.h:4124
AST_MONITOR_PAUSED
@ AST_MONITOR_PAUSED
Definition channel.h:4126
AST_MONITOR_RUNNING
@ AST_MONITOR_RUNNING
Definition channel.h:4125
ast_channel_fout
unsigned int ast_channel_fout(const struct ast_channel *chan)
Definition channel_internal_api.c:397
ast_channel_dialcontext
const char * ast_channel_dialcontext(const struct ast_channel *chan)
ast_check_hangup
int ast_check_hangup(struct ast_channel *chan)
Check to see if a channel is needing hang up.
Definition channel.c:446
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.
Definition channel_internal_api.c:1531
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_w...
Definition channel_internal_api.c:901
ast_channel_outsmpl_set
void ast_channel_outsmpl_set(struct ast_channel *chan, unsigned long value)
Definition channel_internal_api.c:417
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.
Definition channel.c:1608
ast_channel_hangupcause
int ast_channel_hangupcause(const struct ast_channel *chan)
Definition channel_internal_api.c:298
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.
Definition channel.c:1737
ast_channel_is_bridged
int ast_channel_is_bridged(const struct ast_channel *chan)
Determine if a channel is in a bridge.
Definition channel.c:10725
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.
Definition channel.c:1945
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
Definition channel.c:5849
ast_channel_timingfd
int ast_channel_timingfd(const struct ast_channel *chan)
Definition channel_internal_api.c:341
ast_channel_fdno_set
void ast_channel_fdno_set(struct ast_channel *chan, int value)
Definition channel_internal_api.c:294
ast_read_noaudio
struct ast_frame * ast_read_noaudio(struct ast_channel *chan)
Reads a frame, returning AST_FRAME_NULL frame if audio.
Definition channel.c:4288
ast_channel_internal_ari_reportable_vars_get
char * ast_channel_internal_ari_reportable_vars_get(const struct ast_channel *chan, size_t index)
Definition channel_internal_api.c:1072
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.
Definition channel.c:2820
ast_channel_get_bridge
struct ast_bridge * ast_channel_get_bridge(const struct ast_channel *chan)
Get the bridge associated with a channel.
Definition channel.c:10714
ast_channel_set_rawwriteformat
void ast_channel_set_rawwriteformat(struct ast_channel *chan, struct ast_format *format)
Definition channel_internal_api.c:699
ast_channel_dialed
struct ast_party_dialed * ast_channel_dialed(struct ast_channel *chan)
Definition channel_internal_api.c:771
ast_channel_internal_bridged_channel
struct ast_channel * ast_channel_internal_bridged_channel(const struct ast_channel *chan)
ast_channel_creationtime_set
void ast_channel_creationtime_set(struct ast_channel *chan, struct timeval *value)
Definition channel_internal_api.c:847
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.
Definition channel.c:4676
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.
Definition channel.c:9444
ast_channel_zone
struct ast_tone_zone * ast_channel_zone(const struct ast_channel *chan)
Definition channel_internal_api.c:612
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.
Definition channel.c:2498
ast_channel_set_flag
void ast_channel_set_flag(struct ast_channel *chan, unsigned int flag)
Set a flag on a channel.
Definition channel.c:11207
ast_softhangup
int ast_softhangup(struct ast_channel *chan, int cause)
Softly hangup up a channel.
Definition channel.c:2462
ast_channel_redirecting_effective_orig
struct ast_party_id ast_channel_redirecting_effective_orig(struct ast_channel *chan)
Definition channel_internal_api.c:779
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.
Definition channel.c:6863
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.
Definition channel_internal_api.c:1194
ast_channel_named_callgroups_set
void ast_channel_named_callgroups_set(struct ast_channel *chan, struct ast_namedgroups *value)
Definition channel_internal_api.c:961
ast_channel_alert_write
int ast_channel_alert_write(struct ast_channel *chan)
Definition channel_internal_api.c:977
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.
Definition channel.c:4368
ast_channel_lastcontext
const char * ast_channel_lastcontext(const struct ast_channel *chan)
Definition channel_internal_api.c:219
ast_channel_vstreamid
int ast_channel_vstreamid(const struct ast_channel *chan)
Definition channel_internal_api.c:365
ast_channel_readq
struct ast_readq_list * ast_channel_readq(struct ast_channel *chan)
Definition channel_internal_api.c:743
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.
Definition channel.c:10460
ast_channel_has_manager_vars
int ast_channel_has_manager_vars(void)
Return whether or not any manager variables have been set.
Definition channel.c:7864
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.
Definition channel_internal_api.c:928
ast_channel_jb
struct ast_jb * ast_channel_jb(struct ast_channel *chan)
Definition channel_internal_api.c:751
ast_party_id_reset
void ast_party_id_reset(struct ast_party_id *id)
Destroy and initialize the given party id structure.
Definition channel.c:1883
ast_channel_amaflags2string
const char * ast_channel_amaflags2string(enum ama_flags flags)
Convert the enum representation of an AMA flag to a string representation.
Definition channel.c:4395
ast_channel__bridge_set
void ast_channel__bridge_set(struct ast_channel *chan, struct ast_channel *value)
ast_party_id_invalidate
void ast_party_id_invalidate(struct ast_party_id *id)
Invalidate all components of the given party id.
Definition channel.c:1876
ast_channel_timingfunc
ast_timing_func_t ast_channel_timingfunc(const struct ast_channel *chan)
Definition channel_internal_api.c:1127
ast_channel_set_readformat
void ast_channel_set_readformat(struct ast_channel *chan, struct ast_format *format)
Definition channel_internal_api.c:703
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.
Definition channel.c:8873
ast_senddigit_end
int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration)
Send a DTMF digit to a channel.
Definition channel.c:4947
ast_channel_has_ari_vars
int ast_channel_has_ari_vars(void)
Return whether or not any ARI variables have been set.
Definition channel.c:7869
ast_channel_dtmf_digit_to_emulate_set
void ast_channel_dtmf_digit_to_emulate_set(struct ast_channel *chan, char value)
Definition channel_internal_api.c:254
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 ...
Definition channel.c:540
ast_channel_softhangup_internal_flag_add
void ast_channel_softhangup_internal_flag_add(struct ast_channel *chan, int value)
Definition channel_internal_api.c:872
ast_channel_whentohangup
struct timeval * ast_channel_whentohangup(struct ast_channel *chan)
Definition channel_internal_api.c:795
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.
Definition channel.c:1889
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.
Definition channel_internal_api.c:1567
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...
Definition channel.c:6193
ast_channel_vstream
struct ast_filestream * ast_channel_vstream(const struct ast_channel *chan)
Definition channel_internal_api.c:496
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 ren...
Definition channel.c:11188
ast_channel_internal_alert_read
ast_alert_status_t ast_channel_internal_alert_read(struct ast_channel *chan)
Definition channel_internal_api.c:987
ast_channel_writeformat
struct ast_format * ast_channel_writeformat(struct ast_channel *chan)
Definition channel_internal_api.c:727
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.
Definition channel.c:1653
ast_settimeout
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.
Definition channel.c:3184
ast_set_write_format
int ast_set_write_format(struct ast_channel *chan, struct ast_format *format)
Sets write format on channel chan.
Definition channel.c:5826
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.
Definition channel.c:1752
ast_party_number_free
void ast_party_number_free(struct ast_party_number *doomed)
Destroy the party number contents.
Definition channel.c:1678
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.
Definition channel_internal_api.c:1346
ast_channel_generator
struct ast_generator * ast_channel_generator(const struct ast_channel *chan)
Definition channel_internal_api.c:580
ast_channel_callgroup
ast_group_t ast_channel_callgroup(const struct ast_channel *chan)
Definition channel_internal_api.c:941
ast_channel_connected_effective_id
struct ast_party_id ast_channel_connected_effective_id(struct ast_channel *chan)
Definition channel_internal_api.c:767
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.
Definition channel_internal_api.c:886
ast_party_connected_line_init
void ast_party_connected_line_init(struct ast_party_connected_line *init)
Initialize the given connected line structure.
Definition channel.c:2009
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.
Definition channel.c:2845
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.
Definition channel.c:10730
ast_channel_setwhentohangup_tv
void ast_channel_setwhentohangup_tv(struct ast_channel *chan, struct timeval offset)
Set when to hang a channel up.
Definition channel.c:511
ast_channel_hold_state
int ast_channel_hold_state(const struct ast_channel *chan)
Definition channel_internal_api.c:357
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.
Definition channel.c:6654
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.
Definition channel.c:9655
ast_channel_emulate_dtmf_duration_set
void ast_channel_emulate_dtmf_duration_set(struct ast_channel *chan, unsigned int value)
Definition channel_internal_api.c:385
ast_safe_sleep_conditional
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.
Definition channel.c:1555
ast_channel_amaflags_set
void ast_channel_amaflags_set(struct ast_channel *chan, enum ama_flags value)
Definition channel_internal_api.c:282
ast_channeltype_list
struct ast_variable * ast_channeltype_list(void)
return an ast_variable list of channeltypes
Definition channel.c:189
ast_channel_oldest_linkedid
const char * ast_channel_oldest_linkedid(const char *a, const char *b)
Return the oldest linkedid between two channels.
ast_channel_language
const char * ast_channel_language(const struct ast_channel *chan)
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.
Definition channel.c:10762
ast_cause2str
const char * ast_cause2str(int cause) attribute_pure
Gives the string form of a given cause code.
Definition channel.c:613
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.
Definition channel.c:4975
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.
ast_channel_connected_indicated
struct ast_party_connected_line * ast_channel_connected_indicated(struct ast_channel *chan)
Definition channel_internal_api.c:763
ast_channel_endpoint
struct ast_endpoint * ast_channel_endpoint(const struct ast_channel *chan)
Definition channel_internal_api.c:1612
ast_transfer
int ast_transfer(struct ast_channel *chan, char *dest)
Transfer a channel (if supported).
Definition channel.c:6504
ast_channel_cdr_set
void ast_channel_cdr_set(struct ast_channel *chan, struct ast_cdr *value)
Definition channel_internal_api.c:468
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.
Definition channel.c:11019
ast_party_redirecting_free
void ast_party_redirecting_free(struct ast_party_redirecting *doomed)
Destroy the redirecting information contents.
Definition channel.c:2166
ast_channel_context_set
void ast_channel_context_set(struct ast_channel *chan, const char *value)
Definition channel_internal_api.c:223
ast_channel_set_fd
void ast_channel_set_fd(struct ast_channel *chan, int which, int fd)
Definition channel.c:2417
ast_channel_streamid
int ast_channel_streamid(const struct ast_channel *chan)
Definition channel_internal_api.c:333
ast_channel_connected_set
void ast_channel_connected_set(struct ast_channel *chan, struct ast_party_connected_line *value)
Definition channel_internal_api.c:816
ast_state2str
const char * ast_state2str(enum ast_channel_state state)
Gives the string form of a given channel state.
Definition channel.c:637
ast_channel_timingfunc_set
void ast_channel_timingfunc_set(struct ast_channel *chan, ast_timing_func_t value)
Definition channel_internal_api.c:1131
ast_channel_sched
struct ast_sched_context * ast_channel_sched(const struct ast_channel *chan)
Definition channel_internal_api.c:596
ast_channel_state_set
void ast_channel_state_set(struct ast_channel *chan, enum ast_channel_state)
Definition channel_internal_api.c:687
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.
Definition channel.c:8469
ast_softhangup_nolock
int ast_softhangup_nolock(struct ast_channel *chan, int cause)
Softly hangup up a channel (no channel lock)
Definition channel.c:2449
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.
Definition channel_internal_api.c:1459
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.
Definition channel_internal_api.c:1062
ast_channel_string2amaflag
enum ama_flags ast_channel_string2amaflag(const char *flag)
Convert a string to a detail record AMA flag.
Definition channel.c:4382
ast_channel_dtmff
struct ast_frame * ast_channel_dtmff(struct ast_channel *chan)
Definition channel_internal_api.c:747
ast_channel_internal_swap_snapshots
void ast_channel_internal_swap_snapshots(struct ast_channel *a, struct ast_channel *b)
Swap snapshots beteween two channels.
Definition channel_internal_api.c:1393
ast_channel_music_state_set
void ast_channel_music_state_set(struct ast_channel *chan, void *value)
Definition channel_internal_api.c:433
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().
Definition channel.c:6458
ast_channel_emulate_dtmf_duration
unsigned int ast_channel_emulate_dtmf_duration(const struct ast_channel *chan)
Definition channel_internal_api.c:381
ast_add_fd
static int ast_add_fd(struct pollfd *pfd, int fd)
if fd is a valid descriptor, set *pfd with the descriptor
Definition channel.h:2880
ast_channel_call_forward
const char * ast_channel_call_forward(const struct ast_channel *chan)
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.
Definition channel.c:5547
ast_channel_stream
struct ast_filestream * ast_channel_stream(const struct ast_channel *chan)
Definition channel_internal_api.c:488
ast_channel_internal_fd_clear
void ast_channel_internal_fd_clear(struct ast_channel *chan, int which)
Definition channel_internal_api.c:1041
ast_channel_pbx
struct ast_pbx * ast_channel_pbx(const struct ast_channel *chan)
Definition channel_internal_api.c:588
ast_channel_fout_set
void ast_channel_fout_set(struct ast_channel *chan, unsigned int value)
Definition channel_internal_api.c:401
ast_channel_autochans
struct ast_autochan_list * ast_channel_autochans(struct ast_channel *chan)
Definition channel_internal_api.c:739
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.
Definition channel.c:6463
ast_channel_zone_set
void ast_channel_zone_set(struct ast_channel *chan, struct ast_tone_zone *value)
Definition channel_internal_api.c:616
ast_channel_masqr
struct ast_channel * ast_channel_masqr(const struct ast_channel *chan)
Definition channel_internal_api.c:480
ast_unref_namedgroups
struct ast_namedgroups * ast_unref_namedgroups(struct ast_namedgroups *groups)
Definition channel.c:7768
ast_party_subaddress_free
void ast_party_subaddress_free(struct ast_party_subaddress *doomed)
Destroy the party subaddress contents.
Definition channel.c:1731
ast_channel_softhangup_internal_flag
int ast_channel_softhangup_internal_flag(struct ast_channel *chan)
Definition channel_internal_api.c:864
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.
Definition channel.c:7458
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...
Definition channel.c:5803
ast_channel_dtmf_tv
struct timeval * ast_channel_dtmf_tv(struct ast_channel *chan)
Definition channel_internal_api.c:791
ast_channel_get_duration
int ast_channel_get_duration(struct ast_channel *chan)
Obtain how long the channel since the channel was created.
Definition channel.c:2830
ast_channel_caller
struct ast_party_caller * ast_channel_caller(struct ast_channel *chan)
Definition channel_internal_api.c:755
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.
Definition channel.c:9282
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.
Definition channel.c:2032
ast_channel_sending_dtmf_digit
char ast_channel_sending_dtmf_digit(const struct ast_channel *chan)
Definition channel_internal_api.c:259
ast_channel_visible_indication
int ast_channel_visible_indication(const struct ast_channel *chan)
Definition channel_internal_api.c:349
ast_channel_timer
struct ast_timer * ast_channel_timer(const struct ast_channel *chan)
Definition channel_internal_api.c:604
ast_channel_hangup_handlers
struct ast_hangup_handler_list * ast_channel_hangup_handlers(struct ast_channel *chan)
Definition channel_internal_api.c:731
ast_channel_transfercapability_set
void ast_channel_transfercapability_set(struct ast_channel *chan, unsigned short value)
Definition channel_internal_api.c:377
ast_channel_outsmpl
unsigned long ast_channel_outsmpl(const struct ast_channel *chan)
Definition channel_internal_api.c:413
ast_channel_masqr_set
void ast_channel_masqr_set(struct ast_channel *chan, struct ast_channel *value)
Definition channel_internal_api.c:484
ast_channel_callid_set
void ast_channel_callid_set(struct ast_channel *chan, ast_callid value)
Definition channel_internal_api.c:664
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...
Definition channel.c:5172
ast_channel_internal_alertpipe_clear
void ast_channel_internal_alertpipe_clear(struct ast_channel *chan)
Definition channel_internal_api.c:1002
ast_channel_priority_set
void ast_channel_priority_set(struct ast_channel *chan, int value)
Definition channel_internal_api.c:320
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.
Definition channel.c:1566
ast_autoservice_ignore
int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype)
Ignore certain frame types.
Definition autoservice.c:359
ast_readstring
int ast_readstring(struct ast_channel *c, char *s, int len, int timeout, int rtimeout, char *enders)
Reads multiple digits.
Definition channel.c:6577
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.
Definition channel.c:8476
ast_channel_hangupcause_set
void ast_channel_hangupcause_set(struct ast_channel *chan, int value)
Definition channel_internal_api.c:302
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.
Definition autoservice.c:349
ast_channel_whentohangup_set
void ast_channel_whentohangup_set(struct ast_channel *chan, struct timeval *value)
Definition channel_internal_api.c:835
ast_channel_pickupgroup_set
void ast_channel_pickupgroup_set(struct ast_channel *chan, ast_group_t value)
Definition channel_internal_api.c:953
ast_get_channel_tech
const struct ast_channel_tech * ast_get_channel_tech(const char *name)
Get a channel technology structure by name.
Definition channel.c:593
ast_channel_fd_isset
int ast_channel_fd_isset(const struct ast_channel *chan, int which)
Definition channel_internal_api.c:1057
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.
Definition channel.c:1315
ast_tonepair
int ast_tonepair(struct ast_channel *chan, int freq1, int freq2, int duration, int vol)
Definition channel.c:7636
ast_answer
int ast_answer(struct ast_channel *chan)
Answer a channel.
Definition channel.c:2805
ast_channel_adsicpe_set
void ast_channel_adsicpe_set(struct ast_channel *chan, enum ast_channel_adsicpe value)
Definition channel_internal_api.c:652
ast_channel_dialed_causes_clear
void ast_channel_dialed_causes_clear(const struct ast_channel *chan)
Clear all cause information from the channel.
Definition channel_internal_api.c:1210
ast_channel_epfd_set
void ast_channel_epfd_set(struct ast_channel *chan, int value)
ast_get_group
ast_group_t ast_get_group(const char *s)
Definition channel.c:7654
ast_channel_is_multistream
int ast_channel_is_multistream(struct ast_channel *chan)
Determine if a channel is multi-stream capable.
Definition channel_internal_api.c:1591
ast_channel_early_bridge
int ast_channel_early_bridge(struct ast_channel *c0, struct ast_channel *c1)
Bridge two channels together (early)
Definition channel.c:7448
ast_channel_internal_alertpipe_init
int ast_channel_internal_alertpipe_init(struct ast_channel *chan)
Definition channel_internal_api.c:1012
ast_indicate
int ast_indicate(struct ast_channel *chan, int condition)
Indicates condition of channel.
Definition channel.c:4298
ast_channel_sched_set
void ast_channel_sched_set(struct ast_channel *chan, struct ast_sched_context *value)
Definition channel_internal_api.c:600
ast_is_deferrable_frame
int ast_is_deferrable_frame(const struct ast_frame *frame)
Should we keep this frame for later?
Definition channel.c:1454
ast_channel_tech_set
void ast_channel_tech_set(struct ast_channel *chan, const struct ast_channel_tech *value)
Definition channel_internal_api.c:640
ast_channel_iterator_all_new
struct ast_channel_iterator * ast_channel_iterator_all_new(void)
Create a new channel iterator.
Definition channel.c:1380
ast_safe_sleep
int ast_safe_sleep(struct ast_channel *chan, int ms)
Wait for a specified amount of time, looking for hangups.
Definition channel.c:1561
ast_channel_exten
const char * ast_channel_exten(const struct ast_channel *chan)
Definition channel_internal_api.c:232
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.
Definition channel_internal_api.c:913
ast_channel_datastores
struct ast_datastore_list * ast_channel_datastores(struct ast_channel *chan)
Definition channel_internal_api.c:735
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.
Definition channel.c:10650
ast_channel_masq_set
void ast_channel_masq_set(struct ast_channel *chan, struct ast_channel *value)
Definition channel_internal_api.c:476
ast_raw_answer
int ast_raw_answer(struct ast_channel *chan)
Answer a channel.
Definition channel.c:2690
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 mon...
Definition channel.c:3244
ast_channel_varshead_set
void ast_channel_varshead_set(struct ast_channel *chan, struct varshead *value)
Definition channel_internal_api.c:839
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.
Definition channel.c:2122
ast_channel_internal_ari_reportable_vars_append
int ast_channel_internal_ari_reportable_vars_append(struct ast_channel *chan, char *key)
Definition channel_internal_api.c:1080
ast_channel_pbx_set
void ast_channel_pbx_set(struct ast_channel *chan, struct ast_pbx *value)
Definition channel_internal_api.c:592
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.
Definition channel_internal_api.c:1317
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.
Definition channel.c:1586
ast_channel_internal_ari_reportable_vars_remove
char * ast_channel_internal_ari_reportable_vars_remove(struct ast_channel *chan, size_t index)
Definition channel_internal_api.c:1086
ast_channel_set_writeformat
void ast_channel_set_writeformat(struct ast_channel *chan, struct ast_format *format)
Definition channel_internal_api.c:707
ast_channel_vstream_set
void ast_channel_vstream_set(struct ast_channel *chan, struct ast_filestream *value)
Definition channel_internal_api.c:500
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.
Definition channel.c:10693
ast_party_redirecting_reason_free
void ast_party_redirecting_reason_free(struct ast_party_redirecting_reason *doomed)
Destroy the redirecting reason contents.
Definition channel.c:2103
ast_party_caller_init
void ast_party_caller_init(struct ast_party_caller *init)
Initialize the given caller structure.
Definition channel.c:1965
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 ...
Definition channel.c:5844
ast_channel_readformat
struct ast_format * ast_channel_readformat(struct ast_channel *chan)
Definition channel_internal_api.c:723
ast_channel_alert_writable
int ast_channel_alert_writable(struct ast_channel *chan)
Definition channel_internal_api.c:992
ast_tonepair_stop
void ast_tonepair_stop(struct ast_channel *chan)
Definition channel.c:7631
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.
Definition channel.c:2517
ast_channel_state
ast_channel_state
ast_channel states
Definition channelstate.h:35
ast_media_type
ast_media_type
Types of media.
Definition codec.h:30
update
static void update(int code_size, int y, int wi, int fi, int dq, int sr, int dqsez, struct g726_state *state_ptr)
Definition codec_g726.c:367
attribute_pure
#define attribute_pure
Definition compiler.h:35
attribute_const
#define attribute_const
Definition compiler.h:41
buf
char buf[BUFSIZE]
Definition eagi_proxy.c:66
flag
long int flag
Definition f2c.h:83
name
static const char name[]
Definition format_mp3.c:68
direction
direction
Definition func_frame_drop.c:147
len
static int len(struct ast_channel *chan, const char *cmd, char *data, char *buf, size_t buflen)
Definition func_strings.c:1669
AST_OPTION_T38_STATE
#define AST_OPTION_T38_STATE
Definition include/asterisk/frame.h:489
ast_frame_type
ast_frame_type
Frame types.
Definition include/asterisk/frame.h:97
ast_callid
unsigned int ast_callid
Definition include/asterisk/logger.h:96
AST_LIST_ENTRY
#define AST_LIST_ENTRY(type)
Declare a forward link structure inside a list entry.
Definition linkedlists.h:410
url
static char url[512]
Definition res_config_ldap.c:74
ao2_iterator
When we need to walk through a container, we use an ao2_iterator to keep track of the current positio...
Definition astobj2.h:1821
ast_assigned_ids
Structure to pass both assignedid values to channel drivers.
Definition channel.h:606
ast_audiohook_list
Definition audiohook.c:55
ast_autochan_list
Definition channel.h:916
ast_bridge_channel
Structure that contains information regarding a channel in a bridge.
Definition bridge_channel.h:84
ast_bridge_channel::chan
struct ast_channel * chan
Definition bridge_channel.h:91
ast_bridge_features
Structure that contains features information.
Definition bridge_features.h:254
ast_bridge
Structure that contains information about a bridge.
Definition bridge.h:355
ast_cc_config_params
Definition ccss.c:177
ast_cdr
Responsible for call detail data.
Definition cdr.h:281
ast_channel_iterator
Definition channelstorage_ao2_legacy.c:134
ast_channel_snapshot
Structure representing a snapshot of channel state.
Definition stasis_channels.h:150
ast_channel_tech
Structure to describe a channel "technology", ie a channel driver See for examples:
Definition channel.h:648
ast_channel
Main Channel structure associated with a channel.
Definition channel_private.h:48
ast_channel::uniqueid
struct ast_channel_id uniqueid
Definition channel_private.h:89
ast_channel::exten
char exten[AST_MAX_EXTENSION]
Definition channel_private.h:184
ast_channel::data
const char * data
Definition channel_private.h:58
ast_channel::tech
const struct ast_channel_tech * tech
Definition channel_private.h:49
ast_channel::endpoint
struct ast_endpoint * endpoint
Definition channel_private.h:202
ast_channel::x
char x
Definition extconf.c:81
ast_channel::linkedid
struct ast_channel_id linkedid
Definition channel_private.h:90
ast_channel::state
enum ast_channel_state state
Definition channel_private.h:152
ast_channel::context
char context[AST_MAX_CONTEXT]
Definition channel_private.h:183
ast_channel::caller
struct ast_party_caller caller
Channel Caller ID information.
Definition channel_private.h:107
ast_control_pvt_cause_code
Definition include/asterisk/frame.h:417
ast_control_pvt_cause_code::chan_name
char chan_name[AST_CHANNEL_NAME]
Definition include/asterisk/frame.h:418
ast_datastore_list
Definition channel.h:915
ast_endpoint
Definition main/endpoints.c:53
ast_filestream
This structure is allocated by file.c in one chunk, together with buf_size and desc_size bytes of mem...
Definition mod_format.h:101
ast_flags
Structure used to handle boolean flags.
Definition utils.h:220
ast_format_cap
Format capabilities structure, holds formats + preference order + etc.
Definition format_cap.c:54
ast_format
Definition of a media format.
Definition format.c:43
ast_frame
Data structure associated with a single frame of data.
Definition include/asterisk/frame.h:165
ast_frame::data
union ast_frame::@236 data
ast_frame::subclass
struct ast_frame_subclass subclass
Definition include/asterisk/frame.h:169
ast_frame::stream_num
int stream_num
Definition include/asterisk/frame.h:197
ast_frame::datalen
int datalen
Definition include/asterisk/frame.h:171
ast_framehook_list
Definition framehook.c:49
ast_generator
Definition channel.h:227
ast_group_info
channel group info
Definition channel.h:2976
ast_group_info::category
char * category
Definition channel.h:2978
ast_group_info::group
char * group
Definition channel.h:2979
ast_group_info::group_list
struct ast_group_info::@220 group_list
ast_group_info::chan
struct ast_channel * chan
Definition channel.h:2977
ast_hangup_handler_list
Definition channel.h:914
ast_jb
General jitterbuffer state.
Definition abstract_jb.h:141
ast_msg_data
Structure used to transport a message through the frame core.
Definition main/message.c:1446
ast_party_caller
Caller Party information.
Definition channel.h:420
ast_party_connected_line
Connected Line/Party information.
Definition channel.h:458
ast_party_dialed
Dialed/Called Party information.
Definition channel.h:380
ast_party_id
Information needed to identify an endpoint in a call.
Definition channel.h:340
ast_party_name
Information needed to specify a name in a call.
Definition channel.h:264
ast_party_number
Information needed to specify a number in a call.
Definition channel.h:291
ast_party_redirecting_reason
Redirecting reason information.
Definition channel.h:503
ast_party_redirecting
Redirecting Line information. RDNIS (Redirecting Directory Number Information Service) Where a call d...
Definition channel.h:524
ast_party_subaddress
Information needed to specify a subaddress in a call.
Definition channel.h:309
ast_pbx
Definition pbx.h:216
ast_readq_list
Definition channel.h:917
ast_sched_context
Definition sched.c:111
ast_set_party_caller
Indicate what information in ast_party_caller should be set.
Definition channel.h:442
ast_set_party_connected_line
Indicate what information in ast_party_connected_line should be set.
Definition channel.h:491
ast_set_party_id
Indicate what information in ast_party_id should be set.
Definition channel.h:363
ast_set_party_redirecting
Indicate what information in ast_party_redirecting should be set.
Definition channel.h:557
ast_silence_generator
Definition channel.c:8336
ast_str
Support for dynamic strings.
Definition strings.h:623
ast_stream_topology
Definition stream.c:123
ast_stream
Definition stream.c:81
ast_timer
Definition timing.c:54
ast_tone_zone
A set of tones for a given locale.
Definition indications.h:74
ast_trans_pvt
Default structure for translators, with the basic fields and buffers, all allocated as part of the sa...
Definition translate.h:213
ast_variable
Structure for variables, used for configurations and for channel variables.
Definition include/asterisk/config.h:83
formats
Definition file.c:70
outgoing_helper
Definition channel.h:1124
stasis_topic
Definition stasis.c:438
value
int value
Definition syslog.c:37
b
static struct test_val b
Definition test_linkedlists.c:47
a
static struct test_val a
Definition test_linkedlists.c:46
c
static struct test_val c
Definition test_linkedlists.c:48

◆ 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__)
__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.
Definition channel.c:986

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
cthe channel (NULL tolerant)
Return values
NULLalways
Since
12.0.0

Definition at line 3030 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
chanThe channel
functionThe function to look for
Return values
1if the channel has a technology set and it implements the function
0if the channel doesn't have a technology set or it doesn't implement the function

Definition at line 5087 of file channel.h.

5088 : 0)

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

◆ ast_channel_lock_both

#define ast_channel_lock_both (   chan1,
  chan2 
)

Lock two channels.

Definition at line 2990 of file channel.h.

2990 { \
2991 ast_channel_lock(chan1); \
2992 while (ast_channel_trylock(chan2)) { \
2993 ast_channel_unlock(chan1); \
2994 sched_yield(); \
2995 ast_channel_lock(chan1); \
2996 } \
2997 } while (0)
ast_channel_trylock
#define ast_channel_trylock(chan)
Definition channel.h:2985

◆ 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
cthe channel
Return values
calways
Since
1.8

Definition at line 3008 of file channel.h.

◆ ast_channel_trylock

#define ast_channel_trylock (   chan)    ao2_trylock(chan)

Definition at line 2985 of file channel.h.

◆ ast_channel_unlock

#define ast_channel_unlock (   chan)    ao2_unlock(chan)

Definition at line 2984 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
cthe channel
Return values
NULLalways
Since
1.8

Definition at line 3019 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
NULLfailure
non-NULLsuccessfully 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)
AST_FEATURE_AUTOMIXMON
@ AST_FEATURE_AUTOMIXMON
Definition channel.h:1089
AST_FEATURE_REDIRECT
@ AST_FEATURE_REDIRECT
Definition channel.h:1084
AST_FEATURE_ATXFER
@ AST_FEATURE_ATXFER
Definition channel.h:1086
AST_FEATURE_PARKCALL
@ AST_FEATURE_PARKCALL
Definition channel.h:1088
AST_FEATURE_AUTOMON
@ AST_FEATURE_AUTOMON
Definition channel.h:1087
AST_FEATURE_DISCONNECT
@ AST_FEATURE_DISCONNECT
Definition channel.h:1085

Definition at line 1092 of file channel.h.

◆ AST_GENERATOR_FD

#define AST_GENERATOR_FD   (AST_MAX_FDS-4)

unused - formerly 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 4851 of file channel.h.

◆ AST_MUTE_DIRECTION_WRITE

#define AST_MUTE_DIRECTION_WRITE   (1 << 1)

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

2933 { \
2934 if (ast_test_flag(ast_channel_flags(c), AST_FLAG_BLOCKING)) { \
2935 /* This should not happen as there should only be one thread handling a channel's media at a time. */ \
2936 ast_log(LOG_DEBUG, "Thread LWP %d is blocking '%s', already blocked by thread LWP %d in procedure %s\n", \
2937 ast_get_tid(), ast_channel_name(c), \
2938 ast_channel_blocker_tid(c), ast_channel_blockproc(c)); \
2939 ast_assert(0); \
2940 } \
2941 ast_channel_blocker_tid_set((c), ast_get_tid()); \
2942 ast_channel_blocker_set((c), pthread_self()); \
2943 ast_channel_blockproc_set((c), __PRETTY_FUNCTION__); \
2944 ast_set_flag(ast_channel_flags(c), AST_FLAG_BLOCKING); \
2945 } while (0)
AST_FLAG_BLOCKING
@ AST_FLAG_BLOCKING
Definition channel.h:1005
LOG_DEBUG
#define LOG_DEBUG
Definition include/asterisk/logger.h:247
ast_test_flag
#define ast_test_flag(p, flag)
Definition utils.h:64
ast_get_tid
int ast_get_tid(void)
Get current thread ID.
Definition utils.c:2786

◆ 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 4131 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.

975 {
976 /*!
977 * \brief Channels have this property if they can accept input with jitter;
978 * i.e. most VoIP channels
979 */
980 AST_CHAN_TP_WANTSJITTER = (1 << 0),
981 /*!
982 * \brief Channels have this property if they can create jitter;
983 * i.e. most VoIP channels
984 */
985 AST_CHAN_TP_CREATESJITTER = (1 << 1),
986 /*!
987 * \brief Channels with this particular technology are an implementation detail of
988 * Asterisk and should generally not be exposed or manipulated by the outside
989 * world
990 */
991 AST_CHAN_TP_INTERNAL = (1 << 2),
992 /*!
993 * \brief Channels have this property if they implement send_text_data
994 */
995 AST_CHAN_TP_SEND_TEXT_DATA = (1 << 3),
996};
AST_CHAN_TP_INTERNAL
@ AST_CHAN_TP_INTERNAL
Channels with this particular technology are an implementation detail of Asterisk and should generall...
Definition channel.h:991
AST_CHAN_TP_SEND_TEXT_DATA
@ AST_CHAN_TP_SEND_TEXT_DATA
Channels have this property if they implement send_text_data.
Definition channel.h:995
AST_CHAN_TP_WANTSJITTER
@ AST_CHAN_TP_WANTSJITTER
Channels have this property if they can accept input with jitter; i.e. most VoIP channels.
Definition channel.h:980
AST_CHAN_TP_CREATESJITTER
@ AST_CHAN_TP_CREATESJITTER
Channels have this property if they can create jitter; i.e. most VoIP channels.
Definition channel.h:985

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

999 {
1000 /*! Queue incoming DTMF, to be released when this flag is turned off */
1001 AST_FLAG_DEFER_DTMF = (1 << 1),
1002 /*! write should be interrupt generator */
1003 AST_FLAG_WRITE_INT = (1 << 2),
1004 /*! a thread is blocking on this channel */
1005 AST_FLAG_BLOCKING = (1 << 3),
1006 /*! This is a zombie channel */
1007 AST_FLAG_ZOMBIE = (1 << 4),
1008 /*! There is an exception pending */
1009 AST_FLAG_EXCEPTION = (1 << 5),
1010 /*! Listening to moh XXX anthm promises me this will disappear XXX */
1011 AST_FLAG_MOH = (1 << 6),
1012 /*! This channel is spying on another channel */
1013 AST_FLAG_SPYING = (1 << 7),
1014 /*! the channel is in an auto-incrementing dialplan processor,
1015 * so when ->priority is set, it will get incremented before
1016 * finding the next priority to run */
1017 AST_FLAG_IN_AUTOLOOP = (1 << 9),
1018 /*! This is an outgoing call */
1019 AST_FLAG_OUTGOING = (1 << 10),
1020 /*! A DTMF_BEGIN frame has been read from this channel, but not yet an END */
1021 AST_FLAG_IN_DTMF = (1 << 12),
1022 /*! A DTMF_END was received when not IN_DTMF, so the length of the digit is
1023 * currently being emulated */
1024 AST_FLAG_EMULATE_DTMF = (1 << 13),
1025 /*! This is set to tell the channel not to generate DTMF begin frames, and
1026 * to instead only generate END frames. */
1027 AST_FLAG_END_DTMF_ONLY = (1 << 14),
1028 /* OBSOLETED in favor of AST_CAUSE_ANSWERED_ELSEWHERE
1029 * Flag to show channels that this call is hangup due to the fact that the call
1030 * was indeed answered, but in another channel */
1031 /* AST_FLAG_ANSWERED_ELSEWHERE = (1 << 15), */
1032 /*! This flag indicates that on a masquerade, an active stream should not
1033 * be carried over */
1034 AST_FLAG_MASQ_NOSTREAM = (1 << 16),
1035 /*! This flag indicates that the hangup exten was run when the bridge terminated,
1036 * a message aimed at preventing a subsequent hangup exten being run at the pbx_run
1037 * level */
1038 AST_FLAG_BRIDGE_HANGUP_RUN = (1 << 17),
1039 /*! Disable certain workarounds. This reintroduces certain bugs, but allows
1040 * some non-traditional dialplans (like AGI) to continue to function.
1041 */
1042 AST_FLAG_DISABLE_WORKAROUNDS = (1 << 20),
1043 /*!
1044 * Disable device state event caching. This allows channel
1045 * drivers to selectively prevent device state events from being
1046 * cached by certain channels such as anonymous calls which have
1047 * no persistent represenatation that can be tracked.
1048 */
1049 AST_FLAG_DISABLE_DEVSTATE_CACHE = (1 << 21),
1050 /*!
1051 * This flag indicates that a dual channel redirect is in
1052 * progress. The bridge needs to wait until the flag is cleared
1053 * to continue.
1054 */
1055 AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT = (1 << 22),
1056 /*!
1057 * This flag indicates that the channel was originated.
1058 */
1059 AST_FLAG_ORIGINATED = (1 << 23),
1060 /*!
1061 * The channel is well and truly dead. Once this is set and published, no further
1062 * actions should be taken upon the channel, and no further publications should
1063 * occur.
1064 */
1065 AST_FLAG_DEAD = (1 << 24),
1066 /*!
1067 * Channel snapshot should not be published, it is being staged for an explicit
1068 * publish.
1069 */
1070 AST_FLAG_SNAPSHOT_STAGE = (1 << 25),
1071 /*!
1072 * The data on chan->timingdata is an astobj2 object.
1073 */
1074 AST_FLAG_TIMINGDATA_IS_AO2_OBJ = (1 << 26),
1075 /*!
1076 * The channel is executing a subroutine or macro
1077 */
1078 AST_FLAG_SUBROUTINE_EXEC = (1 << 27),
1079};
AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT
@ AST_FLAG_BRIDGE_DUAL_REDIRECT_WAIT
Definition channel.h:1055
AST_FLAG_ZOMBIE
@ AST_FLAG_ZOMBIE
Definition channel.h:1007
AST_FLAG_DISABLE_DEVSTATE_CACHE
@ AST_FLAG_DISABLE_DEVSTATE_CACHE
Definition channel.h:1049
AST_FLAG_SNAPSHOT_STAGE
@ AST_FLAG_SNAPSHOT_STAGE
Definition channel.h:1070
AST_FLAG_OUTGOING
@ AST_FLAG_OUTGOING
Definition channel.h:1019
AST_FLAG_BRIDGE_HANGUP_RUN
@ AST_FLAG_BRIDGE_HANGUP_RUN
Definition channel.h:1038
AST_FLAG_MASQ_NOSTREAM
@ AST_FLAG_MASQ_NOSTREAM
Definition channel.h:1034
AST_FLAG_IN_AUTOLOOP
@ AST_FLAG_IN_AUTOLOOP
Definition channel.h:1017
AST_FLAG_END_DTMF_ONLY
@ AST_FLAG_END_DTMF_ONLY
Definition channel.h:1027
AST_FLAG_DEAD
@ AST_FLAG_DEAD
Definition channel.h:1065
AST_FLAG_EXCEPTION
@ AST_FLAG_EXCEPTION
Definition channel.h:1009
AST_FLAG_EMULATE_DTMF
@ AST_FLAG_EMULATE_DTMF
Definition channel.h:1024
AST_FLAG_IN_DTMF
@ AST_FLAG_IN_DTMF
Definition channel.h:1021
AST_FLAG_WRITE_INT
@ AST_FLAG_WRITE_INT
Definition channel.h:1003
AST_FLAG_DEFER_DTMF
@ AST_FLAG_DEFER_DTMF
Definition channel.h:1001
AST_FLAG_SPYING
@ AST_FLAG_SPYING
Definition channel.h:1013
AST_FLAG_DISABLE_WORKAROUNDS
@ AST_FLAG_DISABLE_WORKAROUNDS
Definition channel.h:1042
AST_FLAG_SUBROUTINE_EXEC
@ AST_FLAG_SUBROUTINE_EXEC
Definition channel.h:1078
AST_FLAG_ORIGINATED
@ AST_FLAG_ORIGINATED
Definition channel.h:1059
AST_FLAG_TIMINGDATA_IS_AO2_OBJ
@ AST_FLAG_TIMINGDATA_IS_AO2_OBJ
Definition channel.h:1074
AST_FLAG_MOH
@ AST_FLAG_MOH
Definition channel.h:1011

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

1082 {
1083 AST_FEATURE_PLAY_WARNING = (1 << 0),
1084 AST_FEATURE_REDIRECT = (1 << 1),
1085 AST_FEATURE_DISCONNECT = (1 << 2),
1086 AST_FEATURE_ATXFER = (1 << 3),
1087 AST_FEATURE_AUTOMON = (1 << 4),
1088 AST_FEATURE_PARKCALL = (1 << 5),
1089 AST_FEATURE_AUTOMIXMON = (1 << 6),
1090};
AST_FEATURE_PLAY_WARNING
@ AST_FEATURE_PLAY_WARNING
Definition channel.h:1083

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

1136 {
1137 /*!
1138 * Soft hangup requested by device or other internal reason.
1139 * Actual hangup needed.
1140 */
1141 AST_SOFTHANGUP_DEV = (1 << 0),
1142 /*!
1143 * Used to break the normal frame flow so an async goto can be
1144 * done instead of actually hanging up.
1145 */
1146 AST_SOFTHANGUP_ASYNCGOTO = (1 << 1),
1147 /*!
1148 * Soft hangup requested by system shutdown. Actual hangup
1149 * needed.
1150 */
1151 AST_SOFTHANGUP_SHUTDOWN = (1 << 2),
1152 /*!
1153 * Used to break the normal frame flow after a timeout so an
1154 * implicit async goto can be done to the 'T' exten if it exists
1155 * instead of actually hanging up. If the exten does not exist
1156 * then actually hangup.
1157 */
1158 AST_SOFTHANGUP_TIMEOUT = (1 << 3),
1159 /*!
1160 * Soft hangup requested by application/channel-driver being
1161 * unloaded. Actual hangup needed.
1162 */
1163 AST_SOFTHANGUP_APPUNLOAD = (1 << 4),
1164 /*!
1165 * Soft hangup requested by non-associated party. Actual hangup
1166 * needed.
1167 */
1168 AST_SOFTHANGUP_EXPLICIT = (1 << 5),
1169 /*!
1170 * Used to indicate that the channel is currently executing hangup
1171 * logic in the dialplan. The channel has been hungup when this is
1172 * set.
1173 */
1174 AST_SOFTHANGUP_HANGUP_EXEC = (1 << 7),
1175 /*!
1176 * \brief All softhangup flags.
1177 *
1178 * This can be used as an argument to ast_channel_clear_softhangup()
1179 * to clear all softhangup flags from a channel.
1180 */
1181 AST_SOFTHANGUP_ALL = (0xFFFFFFFF)
1182};
AST_SOFTHANGUP_ASYNCGOTO
@ AST_SOFTHANGUP_ASYNCGOTO
Definition channel.h:1146
AST_SOFTHANGUP_EXPLICIT
@ AST_SOFTHANGUP_EXPLICIT
Definition channel.h:1168
AST_SOFTHANGUP_DEV
@ AST_SOFTHANGUP_DEV
Definition channel.h:1141
AST_SOFTHANGUP_HANGUP_EXEC
@ AST_SOFTHANGUP_HANGUP_EXEC
Definition channel.h:1174
AST_SOFTHANGUP_ALL
@ AST_SOFTHANGUP_ALL
All softhangup flags.
Definition channel.h:1181
AST_SOFTHANGUP_TIMEOUT
@ AST_SOFTHANGUP_TIMEOUT
Definition channel.h:1158
AST_SOFTHANGUP_SHUTDOWN
@ AST_SOFTHANGUP_SHUTDOWN
Definition channel.h:1151
AST_SOFTHANGUP_APPUNLOAD
@ AST_SOFTHANGUP_APPUNLOAD
Definition channel.h:1163

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

1197 {
1198 AST_AMA_NONE = 0,
1199 AST_AMA_OMIT,
1200 AST_AMA_BILLING,
1201 AST_AMA_DOCUMENTATION,
1202};
AST_AMA_DOCUMENTATION
@ AST_AMA_DOCUMENTATION
Definition channel.h:1201
AST_AMA_OMIT
@ AST_AMA_OMIT
Definition channel.h:1199
AST_AMA_NONE
@ AST_AMA_NONE
Definition channel.h:1198
AST_AMA_BILLING
@ AST_AMA_BILLING
Definition channel.h:1200

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

208 {
209 AST_BRIDGE_COMPLETE = 0,
210 AST_BRIDGE_FAILED = -1,
211 AST_BRIDGE_FAILED_NOWARN = -2,
212 AST_BRIDGE_RETRY = -3,
213};
AST_BRIDGE_FAILED_NOWARN
@ AST_BRIDGE_FAILED_NOWARN
Definition channel.h:211
AST_BRIDGE_RETRY
@ AST_BRIDGE_RETRY
Definition channel.h:212
AST_BRIDGE_COMPLETE
@ AST_BRIDGE_COMPLETE
Definition channel.h:209
AST_BRIDGE_FAILED
@ AST_BRIDGE_FAILED
Definition channel.h:210

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

888 {
889 AST_ADSI_UNKNOWN,
890 AST_ADSI_AVAILABLE,
891 AST_ADSI_UNAVAILABLE,
892 AST_ADSI_OFFHOOKONLY,
893};
AST_ADSI_UNKNOWN
@ AST_ADSI_UNKNOWN
Definition channel.h:889
AST_ADSI_UNAVAILABLE
@ AST_ADSI_UNAVAILABLE
Definition channel.h:891
AST_ADSI_AVAILABLE
@ AST_ADSI_AVAILABLE
Definition channel.h:890
AST_ADSI_OFFHOOKONLY
@ AST_ADSI_OFFHOOKONLY
Definition channel.h:892

◆ ast_channel_error

enum ast_channel_error
Enumerator
AST_CHANNEL_ERROR_UNKNOWN 
AST_CHANNEL_ERROR_ID_EXISTS 

Definition at line 4932 of file channel.h.

4932 {
4933 /* Unable to determine what error occurred. */
4934 AST_CHANNEL_ERROR_UNKNOWN,
4935 /* Channel with this ID already exists */
4936 AST_CHANNEL_ERROR_ID_EXISTS,
4937};

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

1523 {
1524 /*! The requestor is the future bridge peer of the channel. */
1525 AST_CHANNEL_REQUESTOR_BRIDGE_PEER,
1526 /*! The requestor is to be replaced by the channel. */
1527 AST_CHANNEL_REQUESTOR_REPLACEMENT,
1528};

◆ AST_MONITORING_STATE

enum AST_MONITORING_STATE
Enumerator
AST_MONITOR_RUNNING 
AST_MONITOR_PAUSED 

Definition at line 4124 of file channel.h.

4124 {
4125 AST_MONITOR_RUNNING,
4126 AST_MONITOR_PAUSED
4127};

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

244 {
245 AST_PARTY_CHAR_SET_UNKNOWN = 0,
246 AST_PARTY_CHAR_SET_ISO8859_1 = 1,
247 AST_PARTY_CHAR_SET_WITHDRAWN = 2,/* ITU withdrew this enum value. */
248 AST_PARTY_CHAR_SET_ISO8859_2 = 3,
249 AST_PARTY_CHAR_SET_ISO8859_3 = 4,
250 AST_PARTY_CHAR_SET_ISO8859_4 = 5,
251 AST_PARTY_CHAR_SET_ISO8859_5 = 6,
252 AST_PARTY_CHAR_SET_ISO8859_7 = 7,
253 AST_PARTY_CHAR_SET_ISO10646_BMPSTRING = 8,
254 AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING = 9,
255};
AST_PARTY_CHAR_SET_UNKNOWN
@ AST_PARTY_CHAR_SET_UNKNOWN
Definition channel.h:245
AST_PARTY_CHAR_SET_ISO8859_4
@ AST_PARTY_CHAR_SET_ISO8859_4
Definition channel.h:250
AST_PARTY_CHAR_SET_WITHDRAWN
@ AST_PARTY_CHAR_SET_WITHDRAWN
Definition channel.h:247
AST_PARTY_CHAR_SET_ISO8859_5
@ AST_PARTY_CHAR_SET_ISO8859_5
Definition channel.h:251
AST_PARTY_CHAR_SET_ISO8859_7
@ AST_PARTY_CHAR_SET_ISO8859_7
Definition channel.h:252
AST_PARTY_CHAR_SET_ISO8859_2
@ AST_PARTY_CHAR_SET_ISO8859_2
Definition channel.h:248
AST_PARTY_CHAR_SET_ISO8859_1
@ AST_PARTY_CHAR_SET_ISO8859_1
Definition channel.h:246
AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING
@ AST_PARTY_CHAR_SET_ISO10646_UTF_8STRING
Definition channel.h:254
AST_PARTY_CHAR_SET_ISO10646_BMPSTRING
@ AST_PARTY_CHAR_SET_ISO10646_BMPSTRING
Definition channel.h:253
AST_PARTY_CHAR_SET_ISO8859_3
@ AST_PARTY_CHAR_SET_ISO8859_3
Definition channel.h:249

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

898 {
899 T38_STATE_UNAVAILABLE, /*!< T38 is unavailable on this channel or disabled by configuration */
900 T38_STATE_UNKNOWN, /*!< The channel supports T38 but the current status is unknown */
901 T38_STATE_NEGOTIATING, /*!< T38 is being negotiated */
902 T38_STATE_REJECTED, /*!< Remote side has rejected our offer */
903 T38_STATE_NEGOTIATED, /*!< T38 established */
904};
T38_STATE_UNKNOWN
@ T38_STATE_UNKNOWN
Definition channel.h:900
T38_STATE_REJECTED
@ T38_STATE_REJECTED
Definition channel.h:902
T38_STATE_NEGOTIATED
@ T38_STATE_NEGOTIATED
Definition channel.h:903
T38_STATE_NEGOTIATING
@ T38_STATE_NEGOTIATING
Definition channel.h:901

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

1186 {
1187 CHANNEL_MODULE_LOAD,
1188 CHANNEL_MODULE_RELOAD,
1189 CHANNEL_CLI_RELOAD,
1190 CHANNEL_MANAGER_RELOAD,
1191 CHANNEL_ACL_RELOAD,
1192};
CHANNEL_CLI_RELOAD
@ CHANNEL_CLI_RELOAD
Definition channel.h:1189
CHANNEL_MODULE_RELOAD
@ CHANNEL_MODULE_RELOAD
Definition channel.h:1188
CHANNEL_MODULE_LOAD
@ CHANNEL_MODULE_LOAD
Definition channel.h:1187
CHANNEL_ACL_RELOAD
@ CHANNEL_ACL_RELOAD
Definition channel.h:1191
CHANNEL_MANAGER_RELOAD
@ CHANNEL_MANAGER_RELOAD
Definition channel.h:1190

Function Documentation

◆ __ast_answer()

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

Answer a channel, with a selectable delay before returning.

Parameters
chanchannel to answer
delaymaximum 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
0on success
non-zeroon failure

Definition at line 2695 of file channel.c.

2696{
2697 int res = 0;
2698 enum ast_channel_state old_state;
2699 SCOPE_TRACE(1, "%s\n", ast_channel_name(chan));
2700
2701 old_state = ast_channel_state(chan);
2702 if ((res = ast_raw_answer(chan))) {
2703 return res;
2704 }
2705
2706 switch (old_state) {
2707 case AST_STATE_RINGING:
2708 case AST_STATE_RING:
2709 /* wait for media to start flowing, but don't wait any longer
2710 * than 'delay' or 500 milliseconds, whichever is longer
2711 */
2712 do {
2713 AST_LIST_HEAD_NOLOCK(, ast_frame) frames;
2714 struct ast_frame *cur;
2715 struct ast_frame *new_frame;
2716 int timeout_ms = MAX(delay, 500);
2717 unsigned int done = 0;
2718 struct timeval start;
2719
2720 AST_LIST_HEAD_INIT_NOLOCK(&frames);
2721
2722 start = ast_tvnow();
2723 for (;;) {
2724 int ms = ast_remaining_ms(start, timeout_ms);
2725 ms = ast_waitfor(chan, ms);
2726 if (ms < 0) {
2727 ast_log(LOG_WARNING, "Error condition occurred when polling channel %s for a voice frame: %s\n", ast_channel_name(chan), strerror(errno));
2728 res = -1;
2729 break;
2730 }
2731 if (ms == 0) {
2732 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));
2733 break;
2734 }
2735 cur = ast_read(chan);
2736 if (!cur || ((cur->frametype == AST_FRAME_CONTROL) &&
2737 (cur->subclass.integer == AST_CONTROL_HANGUP))) {
2738 if (cur) {
2739 ast_frfree(cur);
2740 }
2741 res = -1;
2742 ast_debug(2, "Hangup of channel %s detected in answer routine\n", ast_channel_name(chan));
2743 break;
2744 }
2745
2746 if ((new_frame = ast_frisolate(cur)) != cur) {
2747 ast_frfree(cur);
2748 }
2749
2750 AST_LIST_INSERT_HEAD(&frames, new_frame, frame_list);
2751
2752 /* if a specific delay period was requested, continue
2753 * until that delay has passed. don't stop just because
2754 * incoming media has arrived.
2755 */
2756 if (delay) {
2757 continue;
2758 }
2759
2760 switch (new_frame->frametype) {
2761 /* all of these frametypes qualify as 'media' */
2762 case AST_FRAME_VOICE:
2763 case AST_FRAME_VIDEO:
2764 case AST_FRAME_TEXT:
2765 case AST_FRAME_TEXT_DATA:
2766 case AST_FRAME_DTMF_BEGIN:
2767 case AST_FRAME_DTMF_END:
2768 case AST_FRAME_IMAGE:
2769 case AST_FRAME_HTML:
2770 case AST_FRAME_MODEM:
2771 case AST_FRAME_RTCP:
2772 done = 1;
2773 break;
2774 case AST_FRAME_CONTROL:
2775 case AST_FRAME_IAX:
2776 case AST_FRAME_BRIDGE_ACTION:
2777 case AST_FRAME_BRIDGE_ACTION_SYNC:
2778 case AST_FRAME_NULL:
2779 case AST_FRAME_CNG:
2780 break;
2781 }
2782
2783 if (done) {
2784 break;
2785 }
2786 }
2787
2788 ast_channel_lock(chan);
2789 while ((cur = AST_LIST_REMOVE_HEAD(&frames, frame_list))) {
2790 if (res == 0) {
2791 ast_queue_frame_head(chan, cur);
2792 }
2793 ast_frfree(cur);
2794 }
2795 ast_channel_unlock(chan);
2796 } while (0);
2797 break;
2798 default:
2799 break;
2800 }
2801
2802 return res;
2803}
ast_log
#define ast_log
Definition astobj2.c:42
ast_read
struct ast_frame * ast_read(struct ast_channel *chan)
Reads a frame.
Definition channel.c:4278
ast_queue_frame_head
int ast_queue_frame_head(struct ast_channel *chan, struct ast_frame *fin)
Queue one or more frames to the head of a channel's frame queue.
Definition channel.c:1176
ast_waitfor
int ast_waitfor(struct ast_channel *c, int ms)
Wait for input on a channel.
Definition channel.c:3166
ast_raw_answer
int ast_raw_answer(struct ast_channel *chan)
Answer a channel.
Definition channel.c:2690
ast_channel_lock
#define ast_channel_lock(chan)
Definition channel.h:2983
ast_channel_unlock
#define ast_channel_unlock(chan)
Definition channel.h:2984
AST_STATE_RING
@ AST_STATE_RING
Definition channelstate.h:40
AST_STATE_RINGING
@ AST_STATE_RINGING
Definition channelstate.h:41
SCOPE_TRACE
#define SCOPE_TRACE(__level,...)
Definition include/asterisk/logger.h:1006
ast_frisolate
#define ast_frisolate(fr)
Makes a frame independent of any static storage.
Definition include/asterisk/frame.h:586
ast_frfree
#define ast_frfree(fr)
Definition include/asterisk/frame.h:565
AST_FRAME_DTMF_END
@ AST_FRAME_DTMF_END
Definition include/asterisk/frame.h:99
AST_FRAME_DTMF_BEGIN
@ AST_FRAME_DTMF_BEGIN
Definition include/asterisk/frame.h:125
AST_FRAME_BRIDGE_ACTION_SYNC
@ AST_FRAME_BRIDGE_ACTION_SYNC
Definition include/asterisk/frame.h:133
AST_FRAME_TEXT_DATA
@ AST_FRAME_TEXT_DATA
Definition include/asterisk/frame.h:137
AST_FRAME_CONTROL
@ AST_FRAME_CONTROL
Definition include/asterisk/frame.h:105
AST_FRAME_BRIDGE_ACTION
@ AST_FRAME_BRIDGE_ACTION
Definition include/asterisk/frame.h:127
AST_CONTROL_HANGUP
@ AST_CONTROL_HANGUP
Definition include/asterisk/frame.h:278
ast_debug
#define ast_debug(level,...)
Log a DEBUG message.
Definition include/asterisk/logger.h:456
LOG_WARNING
#define LOG_WARNING
Definition include/asterisk/logger.h:280
AST_LIST_HEAD_INIT_NOLOCK
#define AST_LIST_HEAD_INIT_NOLOCK(head)
Initializes a list head structure.
Definition linkedlists.h:681
AST_LIST_HEAD_NOLOCK
#define AST_LIST_HEAD_NOLOCK(name, type)
Defines a structure to be used to hold a list of specified type (with no lock).
Definition linkedlists.h:225
AST_LIST_INSERT_HEAD
#define AST_LIST_INSERT_HEAD(head, elm, field)
Inserts a list entry at the head of a list.
Definition linkedlists.h:711
AST_LIST_REMOVE_HEAD
#define AST_LIST_REMOVE_HEAD(head, field)
Removes and returns the head entry from a list.
Definition linkedlists.h:833
errno
int errno
frames
static int frames
Definition parser.c:51
ast_frame_subclass::integer
int integer
Definition include/asterisk/frame.h:152
ast_frame::frametype
enum ast_frame_type frametype
Definition include/asterisk/frame.h:167
frame_list
Definition res_rtp_asterisk.c:644
done
int done
Definition test_amihooks.c:48
ast_remaining_ms
int ast_remaining_ms(struct timeval start, int max_ms)
Calculate remaining milliseconds given a starting timestamp and upper bound.
Definition utils.c:2315
ast_tvnow
struct timeval ast_tvnow(void)
Returns current timeval. Meant to replace calls to gettimeofday().
Definition time.h:159
MAX
#define MAX(a, b)
Definition utils.h:254

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
NULLfailure
non-NULLsuccessfully 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 967 of file channel.c.

974{
975 va_list ap;
976 struct ast_channel *result;
977
978 va_start(ap, name_fmt);
979 result = __ast_channel_alloc_ap(needqueue, state, cid_num, cid_name, acctcode, exten, context,
980 assignedids, requestor, amaflag, endpoint, NULL, file, line, function, name_fmt, ap);
981 va_end(ap);
982
983 return result;
984}
result
static PGresult * result
Definition cel_pgsql.c:84
__ast_channel_alloc_ap
static struct ast_channel * __ast_channel_alloc_ap(int needqueue, int state, const char *cid_num, const char *cid_name, const char *acctcode, const char *exten, const char *context, const 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, va_list ap)
Create a new channel structure.
Definition channel.c:746

References __ast_channel_alloc_ap(), ast_channel::context, ast_channel::endpoint, ast_channel::exten, 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
NULLfailure
non-NULLsuccessfully 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 986 of file channel.c.

993{
994 va_list ap;
995 struct ast_channel *result;
996
997 va_start(ap, name_fmt);
998 result = __ast_channel_alloc_ap(needqueue, state, cid_num, cid_name, acctcode, exten, context,
999 assignedids, requestor, amaflag, endpoint, initializers, file, line, function, name_fmt, ap);
1000 va_end(ap);
1001
1002 return result;
1003}

References __ast_channel_alloc_ap(), ast_channel::context, ast_channel::endpoint, ast_channel::exten, and result.

◆ __ast_dummy_channel_alloc()

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

Definition at line 1007 of file channel.c.

1008{
1009 struct ast_channel *tmp;
1010 struct varshead *headp;
1011
1012 tmp = __ast_channel_internal_alloc(ast_dummy_channel_destructor, NULL, NULL,
1013 file, line, function);
1014 if (!tmp) {
1015 /* Dummy channel structure allocation failure. */
1016 return NULL;
1017 }
1018
1019 ast_pbx_hangup_handler_init(tmp);
1020 AST_LIST_HEAD_INIT_NOLOCK(ast_channel_datastores(tmp));
1021
1022 /*
1023 * Init file descriptors to unopened state just in case
1024 * autoservice is called on the channel or something tries to
1025 * read a frame from it.
1026 */
1027 ast_channel_timingfd_set(tmp, -1);
1028 ast_channel_internal_alertpipe_clear(tmp);
1029 ast_channel_internal_fd_clear_all(tmp);
1030
1031 ast_channel_hold_state_set(tmp, AST_CONTROL_UNHOLD);
1032
1033 ast_channel_internal_setup_topics(tmp);
1034
1035 headp = ast_channel_varshead(tmp);
1036 AST_LIST_HEAD_INIT_NOLOCK(headp);
1037
1038 return tmp;
1039}
ast_dummy_channel_destructor
static void ast_dummy_channel_destructor(void *obj)
Free a dummy channel structure.
Definition channel.c:2324
__ast_channel_internal_alloc
struct ast_channel * __ast_channel_internal_alloc(void(*destructor)(void *obj), const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *file, int line, const char *function)
Definition channel_internal_api.c:1311
ast_channel_internal_setup_topics
int ast_channel_internal_setup_topics(struct ast_channel *chan)
Definition channel_internal_api.c:1475
AST_CONTROL_UNHOLD
@ AST_CONTROL_UNHOLD
Definition include/asterisk/frame.h:294
ast_pbx_hangup_handler_init
void ast_pbx_hangup_handler_init(struct ast_channel *chan)
Init the hangup handler container on a channel.
Definition pbx_hangup_handler.c:95

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(), and NULL.

◆ __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
typetype of channel to request
capformat capabilities for requested channel
assignedidsUnique Id to assign to channel
requestorchannel requesting data
addrdestination of the call
timeoutmaximum amount of time to wait for an answer
reasonwhy unsuccessful (if unsuccessful)
cid_numCaller-ID Number
cid_nameCaller-ID Name (ascii)
ohOutgoing 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 5997 of file channel.c.

5998{
5999 int dummy_outstate;
6000 int cause = 0;
6001 struct ast_channel *chan;
6002 int res = 0;
6003 int last_subclass = 0;
6004 struct ast_party_connected_line connected;
6005
6006 if (outstate)
6007 *outstate = 0;
6008 else
6009 outstate = &dummy_outstate; /* make outstate always a valid pointer */
6010
6011 chan = ast_request(type, cap, assignedids, requestor, addr, &cause);
6012 if (!chan) {
6013 ast_log(LOG_NOTICE, "Unable to request channel %s/%s\n", type, addr);
6014 handle_cause(cause, outstate);
6015 return NULL;
6016 }
6017
6018 if (oh) {
6019 if (oh->vars) {
6020 ast_set_variables(chan, oh->vars);
6021 }
6022 if (!ast_strlen_zero(oh->cid_num) && !ast_strlen_zero(oh->cid_name)) {
6023 /*
6024 * Use the oh values instead of the function parameters for the
6025 * outgoing CallerID.
6026 */
6027 cid_num = oh->cid_num;
6028 cid_name = oh->cid_name;
6029 }
6030 if (oh->parent_channel) {
6031 /* Safely inherit variables and datastores from the parent channel. */
6032 ast_channel_lock_both(oh->parent_channel, chan);
6033 ast_channel_inherit_variables(oh->parent_channel, chan);
6034 ast_channel_datastore_inherit(oh->parent_channel, chan);
6035 ast_max_forwards_decrement(chan);
6036 ast_channel_unlock(oh->parent_channel);
6037 ast_channel_unlock(chan);
6038 }
6039 if (!ast_strlen_zero(oh->account)) {
6040 ast_channel_lock(chan);
6041 ast_channel_stage_snapshot(chan);
6042 ast_channel_accountcode_set(chan, oh->account);
6043 ast_channel_peeraccount_set(chan, oh->account);
6044 ast_channel_stage_snapshot_done(chan);
6045 ast_channel_unlock(chan);
6046 }
6047 }
6048
6049 /*
6050 * It seems strange to set the CallerID on an outgoing call leg
6051 * to whom we are calling, but this function's callers are doing
6052 * various Originate methods. This call leg goes to the local
6053 * user. Once the local user answers, the dialplan needs to be
6054 * able to access the CallerID from the CALLERID function as if
6055 * the local user had placed this call.
6056 */
6057 ast_set_callerid(chan, cid_num, cid_name, cid_num);
6058
6059 ast_channel_lock(chan);
6060 ast_set_flag(ast_channel_flags(chan), AST_FLAG_ORIGINATED);
6061 ast_channel_unlock(chan);
6062 ast_party_connected_line_set_init(&connected, ast_channel_connected(chan));
6063 if (cid_num) {
6064 connected.id.number.valid = 1;
6065 connected.id.number.str = (char *) cid_num;
6066 connected.id.number.presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
6067 }
6068 if (cid_name) {
6069 connected.id.name.valid = 1;
6070 connected.id.name.str = (char *) cid_name;
6071 connected.id.name.presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
6072 }
6073 ast_channel_set_connected_line(chan, &connected, NULL);
6074 if (requestor) {
6075 ast_channel_lock_both(chan, (struct ast_channel *) requestor);
6076 ast_channel_req_accountcodes(chan, requestor, AST_CHANNEL_REQUESTOR_BRIDGE_PEER);
6077 ast_channel_unlock(chan);
6078 ast_channel_unlock((struct ast_channel *) requestor);
6079 }
6080
6081 if (ast_call(chan, addr, 0)) { /* ast_call failed... */
6082 ast_log(LOG_NOTICE, "Unable to call channel %s/%s\n", type, addr);
6083 } else {
6084 struct timeval start = ast_tvnow();
6085 res = 1; /* mark success in case chan->_state is already AST_STATE_UP */
6086 while (timeout && ast_channel_state(chan) != AST_STATE_UP) {
6087 struct ast_frame *f;
6088 int ms = ast_remaining_ms(start, timeout);
6089
6090 res = ast_waitfor(chan, ms);
6091 if (res == 0) { /* timeout, treat it like ringing */
6092 *outstate = AST_CONTROL_RINGING;
6093 break;
6094 }
6095 if (res < 0) /* error or done */
6096 break;
6097 if (!ast_strlen_zero(ast_channel_call_forward(chan))) {
6098 if (!(chan = ast_call_forward(NULL, chan, NULL, cap, oh, outstate))) {
6099 return NULL;
6100 }
6101 continue;
6102 }
6103
6104 f = ast_read(chan);
6105 if (!f) {
6106 *outstate = AST_CONTROL_HANGUP;
6107 res = 0;
6108 break;
6109 }
6110 if (f->frametype == AST_FRAME_CONTROL) {
6111 switch (f->subclass.integer) {
6112 case AST_CONTROL_RINGING: /* record but keep going */
6113 *outstate = f->subclass.integer;
6114 break;
6115
6116 case AST_CONTROL_BUSY:
6117 *outstate = f->subclass.integer;
6118 timeout = 0;
6119 break;
6120
6121 case AST_CONTROL_INCOMPLETE:
6122 *outstate = AST_CONTROL_CONGESTION;
6123 timeout = 0;
6124 break;
6125
6126 case AST_CONTROL_CONGESTION:
6127 *outstate = f->subclass.integer;
6128 timeout = 0;
6129 break;
6130
6131 case AST_CONTROL_ANSWER:
6132 *outstate = f->subclass.integer;
6133 timeout = 0; /* trick to force exit from the while() */
6134 break;
6135
6136 case AST_CONTROL_PVT_CAUSE_CODE:
6137 ast_channel_hangupcause_hash_set(chan, f->data.ptr, f->datalen);
6138 break;
6139
6140 case AST_CONTROL_PROGRESS:
6141 if (oh && oh->connect_on_early_media) {
6142 *outstate = f->subclass.integer;
6143 timeout = 0; /* trick to force exit from the while() */
6144 break;
6145 }
6146 /* Fallthrough */
6147 /* Ignore these */
6148 case AST_CONTROL_PROCEEDING:
6149 case AST_CONTROL_HOLD:
6150 case AST_CONTROL_UNHOLD:
6151 case AST_CONTROL_VIDUPDATE:
6152 case AST_CONTROL_SRCUPDATE:
6153 case AST_CONTROL_SRCCHANGE:
6154 case AST_CONTROL_CONNECTED_LINE:
6155 case AST_CONTROL_REDIRECTING:
6156 case AST_CONTROL_CC:
6157 case -1: /* Ignore -- just stopping indications */
6158 break;
6159
6160 default:
6161 ast_log(LOG_NOTICE, "Don't know what to do with control frame %d\n", f->subclass.integer);
6162 }
6163 last_subclass = f->subclass.integer;
6164 }
6165 ast_frfree(f);
6166 }
6167 }
6168
6169 /* Final fixups */
6170 if (oh) {
6171 if (!ast_strlen_zero(oh->context))
6172 ast_channel_context_set(chan, oh->context);
6173 if (!ast_strlen_zero(oh->exten))
6174 ast_channel_exten_set(chan, oh->exten);
6175 if (oh->priority)
6176 ast_channel_priority_set(chan, oh->priority);
6177 }
6178 if (ast_channel_state(chan) == AST_STATE_UP)
6179 *outstate = AST_CONTROL_ANSWER;
6180
6181 if (res <= 0) {
6182 ast_channel_lock(chan);
6183 if (AST_CONTROL_RINGING == last_subclass) {
6184 ast_channel_hangupcause_set(chan, AST_CAUSE_NO_ANSWER);
6185 }
6186 ast_channel_unlock(chan);
6187 ast_hangup(chan);
6188 chan = NULL;
6189 }
6190 return chan;
6191}
AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED
#define AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED
Definition callerid.h:437
AST_CAUSE_NO_ANSWER
#define AST_CAUSE_NO_ANSWER
Definition causes.h:109
ast_call
int ast_call(struct ast_channel *chan, const char *addr, int timeout)
Make a call.
Definition channel.c:6480
handle_cause
static void handle_cause(int cause, int *outstate)
Definition channel.c:5872
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....
Definition channel.c:5921
ast_hangup
void ast_hangup(struct ast_channel *chan)
Hangup a channel.
Definition channel.c:2540
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.
Definition channel.c:8484
ast_set_variables
void ast_set_variables(struct ast_channel *chan, struct ast_variable *vars)
adds a list of channel variables to a channel
Definition channel.c:8291
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.
Definition channel.c:2359
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().
Definition channel.c:6453
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.
Definition channel.c:7370
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.
Definition channel.c:6795
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.
Definition channel.c:4368
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.
Definition channel.c:2032
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.
Definition channel.c:6373
ast_channel_lock_both
#define ast_channel_lock_both(chan1, chan2)
Lock two channels.
Definition channel.h:2990
AST_STATE_UP
@ AST_STATE_UP
Definition channelstate.h:42
ast_channel_stage_snapshot_done
void ast_channel_stage_snapshot_done(struct ast_channel *chan)
Clear flag to indicate channel snapshot is being staged, and publish snapshot.
Definition stasis_channels.c:1071
ast_channel_stage_snapshot
void ast_channel_stage_snapshot(struct ast_channel *chan)
Set flag to indicate channel snapshot is being staged.
Definition stasis_channels.c:1066
AST_CONTROL_SRCUPDATE
@ AST_CONTROL_SRCUPDATE
Definition include/asterisk/frame.h:297
AST_CONTROL_PROGRESS
@ AST_CONTROL_PROGRESS
Definition include/asterisk/frame.h:291
AST_CONTROL_VIDUPDATE
@ AST_CONTROL_VIDUPDATE
Definition include/asterisk/frame.h:295
AST_CONTROL_PROCEEDING
@ AST_CONTROL_PROCEEDING
Definition include/asterisk/frame.h:292
AST_CONTROL_REDIRECTING
@ AST_CONTROL_REDIRECTING
Definition include/asterisk/frame.h:300
AST_CONTROL_CONGESTION
@ AST_CONTROL_CONGESTION
Definition include/asterisk/frame.h:285
AST_CONTROL_ANSWER
@ AST_CONTROL_ANSWER
Definition include/asterisk/frame.h:281
AST_CONTROL_RINGING
@ AST_CONTROL_RINGING
Definition include/asterisk/frame.h:280
AST_CONTROL_CONNECTED_LINE
@ AST_CONTROL_CONNECTED_LINE
Definition include/asterisk/frame.h:299
AST_CONTROL_SRCCHANGE
@ AST_CONTROL_SRCCHANGE
Definition include/asterisk/frame.h:303
AST_CONTROL_INCOMPLETE
@ AST_CONTROL_INCOMPLETE
Definition include/asterisk/frame.h:307
AST_CONTROL_PVT_CAUSE_CODE
@ AST_CONTROL_PVT_CAUSE_CODE
Definition include/asterisk/frame.h:310
LOG_NOTICE
#define LOG_NOTICE
Definition include/asterisk/logger.h:269
ast_max_forwards_decrement
int ast_max_forwards_decrement(struct ast_channel *chan)
Decrement the max forwards count for a particular channel.
Definition max_forwards.c:135
ast_strlen_zero
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition strings.h:65
ast_frame::ptr
void * ptr
Definition include/asterisk/frame.h:183
outgoing_helper::cid_num
const char * cid_num
Definition channel.h:1129
outgoing_helper::vars
struct ast_variable * vars
Definition channel.h:1132
outgoing_helper::connect_on_early_media
int connect_on_early_media
Definition channel.h:1128
outgoing_helper::account
const char * account
Definition channel.h:1131
outgoing_helper::cid_name
const char * cid_name
Definition channel.h:1130
outgoing_helper::exten
const char * exten
Definition channel.h:1126
outgoing_helper::context
const char * context
Definition channel.h:1125
outgoing_helper::parent_channel
struct ast_channel * parent_channel
Definition channel.h:1133
outgoing_helper::priority
int priority
Definition channel.h:1127
ast_set_flag
#define ast_set_flag(p, flag)
Definition utils.h:71

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

2956{
2957 int res = 0;
2958 void *generatordata = NULL;
2959
2960 ast_channel_lock(chan);
2961 if (ast_channel_generatordata(chan)) {
2962 struct ast_generator *generator_old = ast_channel_generator(chan);
2963
2964 if (generator_old && generator_old->release) {
2965 generator_old->release(chan, ast_channel_generatordata(chan));
2966 }
2967 }
2968 if (gen->alloc && !(generatordata = gen->alloc(chan, params))) {
2969 res = -1;
2970 }
2971 ast_channel_generatordata_set(chan, generatordata);
2972 if (!res) {
2973 ast_settimeout(chan, 50, generator_force, chan);
2974 ast_channel_generator_set(chan, gen);
2975 }
2976 ast_channel_unlock(chan);
2977
2978 ast_prod(chan);
2979
2980 return res;
2981}
ast_prod
int ast_prod(struct ast_channel *chan)
Send empty audio to prime a channel driver.
Definition channel.c:5023
generator_force
static int generator_force(const void *data)
Definition channel.c:2920
ast_settimeout
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.
Definition channel.c:3184
ast_generator::alloc
void *(* alloc)(struct ast_channel *chan, void *params)
Definition channel.h:228
ast_generator::release
void(* release)(struct ast_channel *chan, void *data)
Definition channel.h:230

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

501{
502 return current_channel_storage_instance ? CHANNELSTORAGE_API(current_channel_storage_instance, active_channels, 1) : 0;
503}
current_channel_storage_instance
struct ast_channelstorage_instance * current_channel_storage_instance
The current channel storage instance.
Definition channel_internal_api.c:57
CHANNELSTORAGE_API
#define CHANNELSTORAGE_API(_instance, _func,...)
Definition channelstorage.h:72
active_channels
static int active_channels(struct ast_channelstorage_instance *driver, int rdlock)
returns number of active/allocated channels
Definition channelstorage_ao2_legacy.c:61

References active_channels(), CHANNELSTORAGE_API, and current_channel_storage_instance.

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

2881{
2882 pfd->fd = fd;
2883 pfd->events = POLLIN | POLLPRI;
2884 return fd >= 0;
2885}

Referenced by ast_waitfor_nandfds().

◆ ast_answer()

int ast_answer ( struct ast_channel *  chan)

Answer a channel.

Parameters
chanchannel 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
0on success
non-zeroon failure

Definition at line 2805 of file channel.c.

2806{
2807 SCOPE_TRACE(1, "%s\n", ast_channel_name(chan));
2808 return __ast_answer(chan, 0);
2809}
__ast_answer
int __ast_answer(struct ast_channel *chan, unsigned int delay)
Answer a channel, with a selectable delay before returning.
Definition channel.c:2695

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

Referenced by agent_login_exec(), agi_exec_full(), alarmreceiver_exec(), announce_request(), app_exec(), 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
chanchannel to answer

See ast_answer()

Return values
0on success
non-zeroon failure

Definition at line 2811 of file channel.c.

2812{
2813 if (ast_channel_state(chan) == AST_STATE_UP) {
2814 /* Already answered */
2815 return 0;
2816 }
2817 return ast_answer(chan);
2818}
ast_answer
int ast_answer(struct ast_channel *chan)
Answer a channel.
Definition channel.c:2805

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
chanChan to put into autoservice.
peerChan to run hangup handlers and hangup.

Definition at line 349 of file autoservice.c.

350{
351 if (chan && !ast_autoservice_start(chan)) {
352 ast_hangup(peer);
353 ast_autoservice_stop(chan);
354 } else {
355 ast_hangup(peer);
356 }
357}
ast_autoservice_stop
int ast_autoservice_stop(struct ast_channel *chan)
Stop servicing a channel for us...
Definition autoservice.c:266
ast_autoservice_start
int ast_autoservice_start(struct ast_channel *chan)
Automatically service a channel for us...
Definition autoservice.c:200

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
0success
-1channel is not in autoservice

Definition at line 359 of file autoservice.c.

360{
361 struct asent *as;
362 int res = -1;
363
364 AST_LIST_LOCK(&aslist);
365 AST_LIST_TRAVERSE(&aslist, as, list) {
366 if (as->chan == chan) {
367 res = 0;
368 as->ignore_frame_types |= (1 << ftype);
369 break;
370 }
371 }
372 AST_LIST_UNLOCK(&aslist);
373 return res;
374}
AST_LIST_TRAVERSE
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition linkedlists.h:491
AST_LIST_LOCK
#define AST_LIST_LOCK(head)
Locks a list.
Definition linkedlists.h:40
AST_LIST_UNLOCK
#define AST_LIST_UNLOCK(head)
Attempts to unlock a list.
Definition linkedlists.h:140
asent::ignore_frame_types
unsigned int ignore_frame_types
Definition autoservice.c:62
asent::list
struct asent::@325 list
asent::chan
struct ast_channel * chan
Definition autoservice.c:55

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
0success
-1failure, or the channel is already being autoserviced

Definition at line 200 of file autoservice.c.

201{
202 int res = 0;
203 struct asent *as;
204
205 if (ast_thread_is_user_interface()) {
206 /* User interface threads do not handle channel media. */
207 ast_debug(1, "Thread is a user interface, not putting channel %s into autoservice\n",
208 ast_channel_name(chan));
209 return 0;
210 }
211
212 AST_LIST_LOCK(&aslist);
213 AST_LIST_TRAVERSE(&aslist, as, list) {
214 if (as->chan == chan) {
215 as->use_count++;
216 break;
217 }
218 }
219 AST_LIST_UNLOCK(&aslist);
220
221 if (as) {
222 /* Entry exists, autoservice is already handling this channel */
223 return 0;
224 }
225
226 if (!(as = ast_calloc(1, sizeof(*as))))
227 return -1;
228
229 /* New entry created */
230 as->chan = chan;
231 as->use_count = 1;
232
233 ast_channel_lock(chan);
234 as->orig_end_dtmf_flag = ast_test_flag(ast_channel_flags(chan), AST_FLAG_END_DTMF_ONLY) ? 1 : 0;
235 if (!as->orig_end_dtmf_flag)
236 ast_set_flag(ast_channel_flags(chan), AST_FLAG_END_DTMF_ONLY);
237 ast_channel_unlock(chan);
238
239 AST_LIST_LOCK(&aslist);
240
241 if (AST_LIST_EMPTY(&aslist) && asthread != AST_PTHREADT_NULL) {
242 ast_cond_signal(&as_cond);
243 }
244
245 AST_LIST_INSERT_HEAD(&aslist, as, list);
246
247 if (asthread == AST_PTHREADT_NULL) { /* need start the thread */
248 if (ast_pthread_create_background(&asthread, NULL, autoservice_run, NULL)) {
249 ast_log(LOG_WARNING, "Unable to create autoservice thread :(\n");
250 /* There will only be a single member in the list at this point,
251 the one we just added. */
252 AST_LIST_REMOVE(&aslist, as, list);
253 ast_free(as);
254 asthread = AST_PTHREADT_NULL;
255 res = -1;
256 } else {
257 pthread_kill(asthread, SIGURG);
258 }
259 }
260
261 AST_LIST_UNLOCK(&aslist);
262
263 return res;
264}
ast_free
#define ast_free(a)
Definition astmm.h:180
ast_calloc
#define ast_calloc(num, len)
A wrapper for calloc()
Definition astmm.h:202
autoservice_run
static void * autoservice_run(void *ign)
Definition autoservice.c:78
as_cond
static ast_cond_t as_cond
Definition autoservice.c:71
asthread
static pthread_t asthread
Definition autoservice.c:73
AST_LIST_EMPTY
#define AST_LIST_EMPTY(head)
Checks whether the specified list contains any entries.
Definition linkedlists.h:450
AST_LIST_REMOVE
#define AST_LIST_REMOVE(head, elm, field)
Removes a specific entry from a list.
Definition linkedlists.h:856
AST_PTHREADT_NULL
#define AST_PTHREADT_NULL
Definition lock.h:73
ast_cond_signal
#define ast_cond_signal(cond)
Definition lock.h:210
asent::use_count
unsigned int use_count
Definition autoservice.c:59
asent::orig_end_dtmf_flag
unsigned int orig_end_dtmf_flag
Definition autoservice.c:60
ast_thread_is_user_interface
int ast_thread_is_user_interface(void)
Indicates whether the current thread is a user interface.
Definition utils.c:3282
ast_pthread_create_background
#define ast_pthread_create_background(a, b, c, d)
Definition utils.h:632

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
0success
-1error, or the channel has been hungup

Definition at line 266 of file autoservice.c.

267{
268 int res = -1;
269 struct asent *as, *removed = NULL;
270 struct ast_frame *f;
271 int chan_list_state;
272
273 if (ast_thread_is_user_interface()) {
274 /* User interface threads do not handle channel media. */
275 ast_debug(1, "Thread is a user interface, not removing channel %s from autoservice\n",
276 ast_channel_name(chan));
277 return 0;
278 }
279
280 AST_LIST_LOCK(&aslist);
281
282 /* Save the autoservice channel list state. We _must_ verify that the channel
283 * list has been rebuilt before we return. Because, after we return, the channel
284 * could get destroyed and we don't want our poor autoservice thread to step on
285 * it after its gone! */
286 chan_list_state = as_chan_list_state;
287
288 /* Find the entry, but do not free it because it still can be in the
289 autoservice thread array */
290 AST_LIST_TRAVERSE_SAFE_BEGIN(&aslist, as, list) {
291 if (as->chan == chan) {
292 as->use_count--;
293 if (as->use_count < 1) {
294 AST_LIST_REMOVE_CURRENT(list);
295 removed = as;
296 }
297 break;
298 }
299 }
300 AST_LIST_TRAVERSE_SAFE_END;
301
302 if (removed && asthread != AST_PTHREADT_NULL) {
303 pthread_kill(asthread, SIGURG);
304 }
305
306 AST_LIST_UNLOCK(&aslist);
307
308 if (!removed) {
309 return 0;
310 }
311
312 if (asthread != AST_PTHREADT_NULL && pthread_equal(pthread_self(), asthread)) {
313 /* Do not sleep if ast_autoservice_stop is called within the autoservice thread,
314 otherwise the thread will be stuck in an endless sleep. */
315 ast_debug(1, "ast_autoservice_stop is called within the autoservice thread, channel %s\n",
316 ast_channel_name(chan));
317 } else {
318 /* Wait while autoservice thread rebuilds its list. */
319 while (chan_list_state == as_chan_list_state) {
320 usleep(1000);
321 }
322 }
323
324 /* Now autoservice thread should have no references to our entry
325 and we can safely destroy it */
326
327 if (!ast_channel_softhangup_internal_flag(chan)) {
328 res = 0;
329 }
330
331 ast_channel_lock(chan);
332 if (!as->orig_end_dtmf_flag) {
333 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_END_DTMF_ONLY);
334 }
335
336 while ((f = AST_LIST_REMOVE_HEAD(&as->deferred_frames, frame_list))) {
337 if (!((1 << f->frametype) & as->ignore_frame_types)) {
338 ast_queue_frame_head(chan, f);
339 }
340 ast_frfree(f);
341 }
342 ast_channel_unlock(chan);
343
344 ast_free(as);
345
346 return res;
347}
as_chan_list_state
static int as_chan_list_state
Definition autoservice.c:76
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.
Definition channel.c:1176
AST_LIST_TRAVERSE_SAFE_END
#define AST_LIST_TRAVERSE_SAFE_END
Closes a safe loop traversal block.
Definition linkedlists.h:615
AST_LIST_TRAVERSE_SAFE_BEGIN
#define AST_LIST_TRAVERSE_SAFE_BEGIN(head, var, field)
Loops safely over (traverses) the entries in a list.
Definition linkedlists.h:529
AST_LIST_REMOVE_CURRENT
#define AST_LIST_REMOVE_CURRENT(field)
Removes the current entry from a list during a traversal.
Definition linkedlists.h:557
asent::deferred_frames
struct asent::@324 deferred_frames
ast_clear_flag
#define ast_clear_flag(p, flag)
Definition utils.h:78

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
chanwhich channel to make the call on
addrdestination of the call
timeouttime to wait on for connect (Doesn't seem to be used.)

Place a call, take no longer than timeout ms.

Return values
0on success
-1on failure

Definition at line 6480 of file channel.c.

6481{
6482 /* Place an outgoing call, but don't wait any longer than timeout ms before returning.
6483 If the remote end does not answer within the timeout, then do NOT hang up, but
6484 return anyway. */
6485 int res = -1;
6486 /* Stop if we're a zombie or need a soft hangup */
6487 ast_channel_lock(chan);
6488 if (!ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
6489 if (ast_channel_tech(chan)->call)
6490 res = ast_channel_tech(chan)->call(chan, addr, timeout);
6491 ast_set_flag(ast_channel_flags(chan), AST_FLAG_OUTGOING);
6492 }
6493 ast_channel_unlock(chan);
6494 return res;
6495}
call
static int call(void *data)
Definition chan_pjsip.c:2403
ast_check_hangup
int ast_check_hangup(struct ast_channel *chan)
Checks to see if a channel is needing hang up.
Definition channel.c:446
ast_channel_tech::call
int(*const call)(struct ast_channel *chan, const char *addr, int timeout)
Make a call.
Definition channel.h:721

References ast_channel_flags(), ast_channel_lock, 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
callerin channel that requested orig
origchannel being replaced by the call forward channel
timeoutmaximum amount of time to wait for setup of new forward channel
capformat capabilities for requested channel
ohoutgoing helper used with original channel
outstatereason why unsuccessful (if unsuccessful)
Returns
Returns the forwarded call's ast_channel on success or NULL on failure

Definition at line 5921 of file channel.c.

5922{
5923 char tmpchan[256];
5924 char forwarder[AST_CHANNEL_NAME];
5925 struct ast_channel *new_chan = NULL;
5926 char *data, *type;
5927 int cause = 0;
5928 int res;
5929
5930 /* gather data and request the new forward channel */
5931 ast_copy_string(tmpchan, ast_channel_call_forward(orig), sizeof(tmpchan));
5932 ast_copy_string(forwarder, ast_channel_name(orig), sizeof(forwarder));
5933 if ((data = strchr(tmpchan, '/'))) {
5934 *data++ = '\0';
5935 type = tmpchan;
5936 } else {
5937 const char *forward_context;
5938 ast_channel_lock(orig);
5939 forward_context = pbx_builtin_getvar_helper(orig, "FORWARD_CONTEXT");
5940 snprintf(tmpchan, sizeof(tmpchan), "%s@%s", ast_channel_call_forward(orig), S_OR(forward_context, ast_channel_context(orig)));
5941 ast_channel_unlock(orig);
5942 data = tmpchan;
5943 type = "Local";
5944 }
5945 if (!(new_chan = ast_request(type, cap, NULL, orig, data, &cause))) {
5946 ast_log(LOG_NOTICE, "Unable to create channel for call forward to '%s/%s' (cause = %d)\n", type, data, cause);
5947 handle_cause(cause, outstate);
5948 ast_hangup(orig);
5949 return NULL;
5950 }
5951
5952 /* Copy/inherit important information into new channel */
5953 if (oh) {
5954 if (oh->vars) {
5955 ast_set_variables(new_chan, oh->vars);
5956 }
5957 if (oh->parent_channel) {
5958 call_forward_inherit(new_chan, oh->parent_channel, orig);
5959 }
5960 if (!ast_strlen_zero(oh->account)) {
5961 ast_channel_lock(new_chan);
5962 ast_channel_stage_snapshot(new_chan);
5963 ast_channel_accountcode_set(new_chan, oh->account);
5964 ast_channel_peeraccount_set(new_chan, oh->account);
5965 ast_channel_stage_snapshot_done(new_chan);
5966 ast_channel_unlock(new_chan);
5967 }
5968 } else if (caller) { /* no outgoing helper so use caller if available */
5969 call_forward_inherit(new_chan, caller, orig);
5970 }
5971
5972 ast_channel_lock_both(orig, new_chan);
5973 ast_channel_set_flag(new_chan, AST_FLAG_ORIGINATED);
5974 pbx_builtin_setvar_helper(new_chan, "FORWARDERNAME", forwarder);
5975 ast_party_connected_line_copy(ast_channel_connected(new_chan), ast_channel_connected(orig));
5976 ast_party_redirecting_copy(ast_channel_redirecting(new_chan), ast_channel_redirecting(orig));
5977 ast_channel_req_accountcodes(new_chan, orig, AST_CHANNEL_REQUESTOR_REPLACEMENT);
5978 ast_channel_unlock(new_chan);
5979 ast_channel_unlock(orig);
5980
5981 /* call new channel */
5982 res = ast_call(new_chan, data, 0);
5983 if (timeout) {
5984 *timeout = res;
5985 }
5986 if (res) {
5987 ast_log(LOG_NOTICE, "Unable to call forward to channel %s/%s\n", type, (char *)data);
5988 ast_hangup(orig);
5989 ast_hangup(new_chan);
5990 return NULL;
5991 }
5992 ast_hangup(orig);
5993
5994 return new_chan;
5995}
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.
Definition channel.c:2018
call_forward_inherit
static void call_forward_inherit(struct ast_channel *new_chan, struct ast_channel *parent, struct ast_channel *orig)
Definition channel.c:5893
ast_channel_set_flag
void ast_channel_set_flag(struct ast_channel *chan, unsigned int flag)
Set a flag on a channel.
Definition channel.c:11207
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.
Definition channel.c:2122
AST_CHANNEL_NAME
#define AST_CHANNEL_NAME
Definition channel.h:173
pbx_builtin_getvar_helper
const char * pbx_builtin_getvar_helper(struct ast_channel *chan, const char *name)
Return a pointer to the value of the corresponding channel variable.
Definition pbx_variables.c:1162
pbx_builtin_setvar_helper
int pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value)
Add a variable to the channel variable stack, removing the most recently set value for the same name.
Definition pbx_variables.c:1233
S_OR
#define S_OR(a, b)
returns the equivalent of logic or for strings: first one if not empty, otherwise second one.
Definition strings.h:80
ast_copy_string
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition strings.h:425

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

614{
615 int x;
616
617 for (x = 0; x < ARRAY_LEN(causes); x++) {
618 if (causes[x].cause == cause)
619 return causes[x].desc;
620 }
621
622 return "Unknown";
623}
causes
static const struct causes_map causes[]
Definition channel.c:137
causes_map::desc
const char * desc
Definition channel.c:134
ARRAY_LEN
#define ARRAY_LEN(a)
Definition utils.h:706

References ARRAY_LEN, causes, and causes_map::desc.

Referenced by _websocket_request_hangup(), 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 and the channel storage backend MUST be unlocked before calling this function.
Parameters
chanthe channel to change the name of
newnamethe name to change to
Note
this function must NEVER be used when any channels or the channel storage backend 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 6783 of file channel.c.

6784{
6785 /* We must re-link, as the hash value will change here. */
6786 CHANNELSTORAGE_API(current_channel_storage_instance, wrlock);
6787 ast_channel_lock(chan);
6788 CHANNELSTORAGE_API(current_channel_storage_instance, remove, chan, 0);
6789 __ast_change_name_nolink(chan, newname);
6790 CHANNELSTORAGE_API(current_channel_storage_instance, insert, chan, 0, 0);
6791 ast_channel_unlock(chan);
6792 CHANNELSTORAGE_API(current_channel_storage_instance, unlock);
6793}
__ast_change_name_nolink
static void __ast_change_name_nolink(struct ast_channel *chan, const char *newname)
this function simply changes the name of the channel and issues a manager_event with out unlinking an...
Definition channel.c:6761
remove
#define remove
Definition main/stdtime/private.h:218

References __ast_change_name_nolink(), ast_channel_lock, ast_channel_unlock, CHANNELSTORAGE_API, current_channel_storage_instance, and remove.

◆ 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 648 of file channel_internal_api.c.

649{
650 return chan->adsicpe;
651}
ast_channel::adsicpe
enum ast_channel_adsicpe adsicpe
Definition channel_private.h:156

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 652 of file channel_internal_api.c.

653{
654 chan->adsicpe = value;
655}

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(), ast_unreal_call_setup(), begin_dial_prerun(), chan_pjsip_new(), channel_do_masquerade(), dahdi_new(), dial_exec_full(), func_channel_write_real(), 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 992 of file channel_internal_api.c.

993{
994 return ast_alertpipe_writable(chan->alertpipe);
995}
ast_alertpipe_writable
int attribute_pure ast_alertpipe_writable(int alert_pipe[2])
Determine if the alert pipe is writable.
Definition alertpipe.h:130
ast_channel::alertpipe
int alertpipe[2]
Definition channel_private.h:167

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 977 of file channel_internal_api.c.

978{
979 return ast_alertpipe_write(chan->alertpipe);
980}
ast_alertpipe_write
ssize_t ast_alertpipe_write(int alert_pipe[2])
Write an event to an alert pipe.
Definition alertpipe.c:120

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 277 of file channel_internal_api.c.

278{
279 return chan->amaflags;
280}
ast_channel::amaflags
int amaflags
Definition channel_private.h:155

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
flagsinteger flag
Return values
Astring representation of the flag

Definition at line 4395 of file channel.c.

4396{
4397 switch (flag) {
4398 case AST_AMA_OMIT:
4399 return "OMIT";
4400 case AST_AMA_BILLING:
4401 return "BILLING";
4402 case AST_AMA_DOCUMENTATION:
4403 return "DOCUMENTATION";
4404 default:
4405 return "Unknown";
4406 }
4407}

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(), build_radius_record(), cdr_read_callback(), cel_bs_put(), format_amaflags(), handle_cli_ooh323_show_config(), handle_cli_ooh323_show_peer(), handle_cli_ooh323_show_user(), manager_log(), manager_log(), tds_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 282 of file channel_internal_api.c.

283{
284 if (chan->amaflags == value) {
285 return;
286 }
287 chan->amaflags = value;
288 ast_channel_publish_snapshot(chan);
289}
ast_channel_publish_snapshot
void ast_channel_publish_snapshot(struct ast_channel *chan)
Publish a ast_channel_snapshot for a channel.
Definition stasis_channels.c:1083

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 853 of file channel_internal_api.c.

854{
855 return chan->answertime;
856}
ast_channel::answertime
struct timeval answertime
Definition channel_private.h:131

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 858 of file channel_internal_api.c.

859{
860 chan->answertime = *value;
861}

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 188 of file channel_internal_api.c.

189{
190 return chan->appl;
191}
ast_channel::appl
const char * appl
Definition channel_private.h:57

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 192 of file channel_internal_api.c.

193{
194 chan->appl = value;
195 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN);
196}
ast_channel_snapshot_invalidate_segment
void ast_channel_snapshot_invalidate_segment(struct ast_channel *chan, enum ast_channel_snapshot_segment_invalidation segment)
Invalidate a channel snapshot segment from being reused.
Definition stasis_channels.c:1077
AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN
@ AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN
Definition stasis_channels.h:40

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 456 of file channel_internal_api.c.

457{
458 return chan->audiohooks;
459}
ast_channel::audiohooks
struct ast_audiohook_list * audiohooks
Definition channel_private.h:67

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 460 of file channel_internal_api.c.

461{
462 chan->audiohooks = value;
463}

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 739 of file channel_internal_api.c.

740{
741 return &chan->autochans;
742}
ast_channel::autochans
struct ast_autochan_list autochans
Definition channel_private.h:137

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 1109 of file channel_internal_api.c.

1110{
1111 return chan->blocker;
1112}
ast_channel::blocker
pthread_t blocker
Definition channel_private.h:93

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 1113 of file channel_internal_api.c.

1114{
1115 chan->blocker = value;
1116}

References ast_channel::blocker, and value.

◆ ast_channel_blocker_tid()

int ast_channel_blocker_tid ( const struct ast_channel *  chan)

Definition at line 1118 of file channel_internal_api.c.

1119{
1120 return chan->blocker_tid;
1121}
ast_channel::blocker_tid
int blocker_tid
Definition channel_private.h:141

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 1122 of file channel_internal_api.c.

1123{
1124 chan->blocker_tid = value;
1125}

References ast_channel::blocker_tid, and value.

◆ ast_channel_blockproc()

const char * ast_channel_blockproc ( const struct ast_channel *  chan)

Definition at line 197 of file channel_internal_api.c.

198{
199 return chan->blockproc;
200}
ast_channel::blockproc
const char * blockproc
Definition channel_private.h:56

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 201 of file channel_internal_api.c.

202{
203 chan->blockproc = value;
204}

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
chanChannel 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
NULLChannel not in a bridge or the bridge is not two-party.
non-NULLReffed peer channel at time of calling.

Definition at line 10744 of file channel.c.

10745{
10746 struct ast_channel *peer;
10747 struct ast_bridge *bridge;
10748
10749 /* Get the bridge the channel is in. */
10750 ast_channel_lock(chan);
10751 bridge = ast_channel_get_bridge(chan);
10752 ast_channel_unlock(chan);
10753 if (!bridge) {
10754 return NULL;
10755 }
10756
10757 peer = ast_bridge_peer(bridge, chan);
10758 ao2_ref(bridge, -1);
10759 return peer;
10760}
ao2_ref
#define ao2_ref(o, delta)
Reference/unreference an object and return the old refcount.
Definition astobj2.h:459
ast_bridge_peer
struct ast_channel * ast_bridge_peer(struct ast_bridge *bridge, struct ast_channel *chan)
Get the channel's bridge peer only if the bridge is two-party.
Definition bridge.c:4284
ast_channel_get_bridge
struct ast_bridge * ast_channel_get_bridge(const struct ast_channel *chan)
Get the bridge associated with a channel.
Definition channel.c:10714

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

Channel search functions

Warning
Absolutely NO channel locks should be held while calling any of these functions.

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

Since
1.8

Definition at line 1336 of file channel.c.

1338{
1339 if (!current_channel_storage_instance) {
1340 return NULL;
1341 }
1342 if (!cb_fn) {
1343 ast_log(LOG_ERROR, "callback function must be provided\n");
1344 return NULL;
1345 }
1346 return CHANNELSTORAGE_API(current_channel_storage_instance, callback, cb_fn, arg, data, ao2_flags, 1);
1347}
callback
static struct ast_channel * callback(struct ast_channelstorage_instance *driver, ao2_callback_data_fn *cb_fn, void *arg, void *data, int ao2_flags, int rdlock)
Definition channelstorage_ao2_legacy.c:66
LOG_ERROR
#define LOG_ERROR
Definition include/asterisk/logger.h:291

References ast_log, callback(), CHANNELSTORAGE_API, current_channel_storage_instance, ast_channel::data, LOG_ERROR, and NULL.

Referenced by ast_pickup_find_by_group(), ast_softhangup_all(), 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 755 of file channel_internal_api.c.

756{
757 return &chan->caller;
758}

References ast_channel::caller.

Referenced by __analog_handle_event(), __analog_ss_thread(), __ast_channel_alloc_ap(), __ast_goto_if_exists(), __ast_pbx_run(), 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(), 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(), send_broadcast_event(), 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_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 811 of file channel_internal_api.c.

812{
813 chan->caller = *value;
814 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER);
815}
AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER
@ AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER
Definition stasis_channels.h:44

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 941 of file channel_internal_api.c.

942{
943 return chan->callgroup;
944}
ast_channel::callgroup
ast_group_t callgroup
Definition channel_private.h:126

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 945 of file channel_internal_api.c.

946{
947 chan->callgroup = value;
948}

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 660 of file channel_internal_api.c.

661{
662 return chan->callid;
663}
ast_channel::callid
ast_callid callid
Definition channel_private.h:72

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 935 of file channel_internal_api.c.

936{
937 chan->callid = 0;
938}

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 664 of file channel_internal_api.c.

665{
666 char call_identifier_from[AST_CALLID_BUFFER_LENGTH];
667 char call_identifier_to[AST_CALLID_BUFFER_LENGTH];
668 call_identifier_from[0] = '\0';
669 ast_callid_strnprint(call_identifier_to, sizeof(call_identifier_to), callid);
670 if (chan->callid) {
671 ast_callid_strnprint(call_identifier_from, sizeof(call_identifier_from), chan->callid);
672 ast_debug(3, "Channel Call ID changing from %s to %s\n", call_identifier_from, call_identifier_to);
673 }
674
675 chan->callid = callid;
676
677 ast_test_suite_event_notify("CallIDChange",
678 "State: CallIDChange\r\n"
679 "Channel: %s\r\n"
680 "CallID: %s\r\n"
681 "PriorCallID: %s",
682 ast_channel_name(chan),
683 call_identifier_to,
684 call_identifier_from);
685}
ast_callid_strnprint
void ast_callid_strnprint(char *buffer, size_t buffer_size, ast_callid callid)
copy a string representation of the callid into a target string
Definition logger.c:2258
AST_CALLID_BUFFER_LENGTH
#define AST_CALLID_BUFFER_LENGTH
Definition include/asterisk/logger.h:55
ast_test_suite_event_notify
#define ast_test_suite_event_notify(s, f,...)
Definition test.h:189

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.

Warning
You should call this function only if ast_cc_is_enabled() returns true.
Parameters
chanThe channel to create the datastore on
base_paramsCCSS parameters we wish to copy into the channel
Return values
0Success
-1Failure or CCSS is globally disabled.

Definition at line 10627 of file channel.c.

10629{
10630 struct ast_cc_config_params *cc_params;
10631 struct ast_datastore *cc_datastore;
10632
10633 if (!(cc_params = ast_cc_config_params_init())) {
10634 return -1;
10635 }
10636
10637 if (!(cc_datastore = ast_datastore_alloc(&cc_channel_datastore_info, NULL))) {
10638 ast_cc_config_params_destroy(cc_params);
10639 return -1;
10640 }
10641
10642 if (base_params) {
10643 ast_cc_copy_config_params(cc_params, base_params);
10644 }
10645 cc_datastore->data = cc_params;
10646 ast_channel_datastore_add(chan, cc_datastore);
10647 return 0;
10648}
ast_cc_config_params_init
#define ast_cc_config_params_init()
Allocate and initialize an ast_cc_config_params structure.
Definition ccss.h:135
ast_cc_config_params_destroy
void ast_cc_config_params_destroy(struct ast_cc_config_params *params)
Free memory from CCSS configuration params.
Definition ccss.c:714
ast_cc_copy_config_params
void ast_cc_copy_config_params(struct ast_cc_config_params *dest, const struct ast_cc_config_params *src)
copy CCSS configuration parameters from one structure to another
Definition ccss.c:876
ast_channel_datastore_add
int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore)
Add a datastore to a channel.
Definition channel.c:2376
cc_channel_datastore_info
static const struct ast_datastore_info cc_channel_datastore_info
Definition channel.c:10621
ast_datastore_alloc
#define ast_datastore_alloc(info, uid)
Definition datastore.h:85
ast_datastore
Structure for a data store object.
Definition datastore.h:64
ast_datastore::data
void * data
Definition datastore.h:66

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 464 of file channel_internal_api.c.

465{
466 return chan->cdr;
467}
ast_channel::cdr
struct ast_cdr * cdr
Definition channel_private.h:69

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 468 of file channel_internal_api.c.

469{
470 chan->cdr = value;
471}

References ast_channel::cdr, and value.

Referenced by ast_channel_destructor(), ast_dummy_channel_destructor(), dummy_chan_alloc_cdr(), and manager_log().

◆ 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
chanThe channel to clear the flag from
flagThe 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 11214 of file channel.c.

11215{
11216 ast_channel_lock(chan);
11217 ast_clear_flag(ast_channel_flags(chan), flag);
11218 ast_channel_unlock(chan);
11219}

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
chanthe channel to clear the flag on
flagthe flag or flags to clear

Definition at line 2423 of file channel.c.

2424{
2425 ast_channel_lock(chan);
2426
2427 ast_channel_softhangup_internal_flag_clear(chan, flag);
2428
2429 if (!ast_channel_softhangup_internal_flag(chan)) {
2430 struct ast_frame *fr;
2431
2432 /* If we have completely cleared the softhangup flag,
2433 * then we need to fully abort the hangup process. This requires
2434 * pulling the END_OF_Q frame out of the channel frame queue if it
2435 * still happens to be there. */
2436
2437 fr = AST_LIST_LAST(ast_channel_readq(chan));
2438 if (fr && fr->frametype == AST_FRAME_CONTROL &&
2439 fr->subclass.integer == AST_CONTROL_END_OF_Q) {
2440 AST_LIST_REMOVE(ast_channel_readq(chan), fr, frame_list);
2441 ast_frfree(fr);
2442 }
2443 }
2444
2445 ast_channel_unlock(chan);
2446}
AST_CONTROL_END_OF_Q
@ AST_CONTROL_END_OF_Q
Definition include/asterisk/frame.h:306
AST_LIST_LAST
#define AST_LIST_LAST(head)
Returns the last entry contained in a list.
Definition linkedlists.h:429

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
chanchannel on which to check for hangup
offsetoffset in seconds and microseconds from current time
Return values
1
0
-1This 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 524 of file channel.c.

525{
526 struct timeval whentohangup;
527
528 if (ast_tvzero(*ast_channel_whentohangup(chan)))
529 return ast_tvzero(offset) ? 0 : -1;
530
531 if (ast_tvzero(offset))
532 return 1;
533
534 whentohangup = ast_tvadd(offset, ast_tvnow());
535
536 return ast_tvdiff_ms(whentohangup, *ast_channel_whentohangup(chan));
537}
ast_tvzero
int ast_tvzero(const struct timeval t)
Returns true if the argument is 0,0.
Definition time.h:117
ast_tvadd
struct timeval ast_tvadd(struct timeval a, struct timeval b)
Returns the sum of two timevals a + b.
Definition extconf.c:2280
ast_tvdiff_ms
int64_t ast_tvdiff_ms(struct timeval end, struct timeval start)
Computes the difference (in milliseconds) between two struct timeval instances.
Definition time.h:107

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 759 of file channel_internal_api.c.

760{
761 return &chan->connected;
762}
ast_channel::connected
struct ast_party_connected_line connected
Channel Connected Line ID information.
Definition channel_private.h:114

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(), wait_for_answer(), 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 767 of file channel_internal_api.c.

768{
769 return ast_party_id_merge(&chan->connected.id, &chan->connected.priv);
770}
ast_party_connected_line::priv
struct ast_party_id priv
Private connected party ID.
Definition channel.h:470
ast_party_connected_line::id
struct ast_party_id id
Connected party ID.
Definition channel.h:460

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 763 of file channel_internal_api.c.

764{
765 return &chan->connected_indicated;
766}
ast_channel::connected_indicated
struct ast_party_connected_line connected_indicated
Channel Connected Line ID information that was last indicated.
Definition channel_private.h:119

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_chanChannel to place into autoservice while the sub is running. It is perfectly safe for this to be NULL
sub_chanThe channel to run the subroutine on. Also the channel from which we determine which subroutine we need to run.
connected_infoEither an ast_party_connected_line or ast_frame pointer of type AST_CONTROL_CONNECTED_LINE
frameIf true, then connected_info is an ast_frame pointer, otherwise it is an ast_party_connected_line pointer.
Return values
0Success
-1Either the subroutine does not exist, or there was an error while attempting to run the subroutine

Definition at line 10514 of file channel.c.

10515{
10516 const char *sub;
10517 const char *sub_args;
10518 int retval;
10519
10520 ast_channel_lock(sub_chan);
10521 sub = pbx_builtin_getvar_helper(sub_chan, "CONNECTED_LINE_SEND_SUB");
10522 sub = ast_strdupa(S_OR(sub, ""));
10523 sub_args = pbx_builtin_getvar_helper(sub_chan, "CONNECTED_LINE_SEND_SUB_ARGS");
10524 sub_args = ast_strdupa(S_OR(sub_args, ""));
10525
10526 if (ast_strlen_zero(sub)) {
10527 ast_channel_unlock(sub_chan);
10528 return -1;
10529 }
10530
10531 if (is_frame) {
10532 const struct ast_frame *frame = connected_info;
10533
10534 ast_connected_line_parse_data(frame->data.ptr, frame->datalen, ast_channel_connected(sub_chan));
10535 } else {
10536 const struct ast_party_connected_line *connected = connected_info;
10537
10538 ast_party_connected_line_copy(ast_channel_connected(sub_chan), connected);
10539 }
10540 ast_channel_unlock(sub_chan);
10541
10542 channel_set_intercept_mode(1);
10543 retval = ast_app_run_sub(autoservice_chan, sub_chan, sub, sub_args, 0);
10544 channel_set_intercept_mode(0);
10545 if (!retval) {
10546 struct ast_party_connected_line saved_connected;
10547
10548 ast_party_connected_line_init(&saved_connected);
10549 ast_channel_lock(sub_chan);
10550 ast_party_connected_line_copy(&saved_connected, ast_channel_connected(sub_chan));
10551 ast_channel_unlock(sub_chan);
10552 ast_channel_update_connected_line(sub_chan, &saved_connected, NULL);
10553 ast_party_connected_line_free(&saved_connected);
10554 }
10555
10556 return retval;
10557}
ast_strdupa
#define ast_strdupa(s)
duplicate a string in memory from the stack
Definition astmm.h:298
ast_party_connected_line_free
void ast_party_connected_line_free(struct ast_party_connected_line *doomed)
Destroy the connected line information contents.
Definition channel.c:2059
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.
Definition channel.c:9269
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.
Definition channel.c:8961
channel_set_intercept_mode
static void channel_set_intercept_mode(int in_intercept_mode)
Definition channel.c:10498
ast_party_connected_line_init
void ast_party_connected_line_init(struct ast_party_connected_line *init)
Initialize the given connected line structure.
Definition channel.c:2009
ast_app_run_sub
int ast_app_run_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const char *sub_location, const char *sub_args, int ignore_hangup)
Run a subroutine on a channel, placing an optional second channel into autoservice.
Definition main/app.c:328
sub
static struct stasis_subscription * sub
Statsd channel stats. Exmaple of how to subscribe to Stasis events.
Definition res_chan_stats.c:44

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, 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(), update_connected_line_from_peer(), wait_for_answer(), 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 816 of file channel_internal_api.c.

817{
818 chan->connected = *value;
819 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CONNECTED);
820}
AST_CHANNEL_SNAPSHOT_INVALIDATE_CONNECTED
@ AST_CHANNEL_SNAPSHOT_INVALIDATE_CONNECTED
Definition stasis_channels.h:42

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 215 of file channel_internal_api.c.

216{
217 return chan->context;
218}

References ast_channel::context.

Referenced by __analog_ss_thread(), __ast_goto_if_exists(), __ast_pbx_run(), _while_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_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(), by_exten_cb(), cc_generic_agent_init(), cc_interfaces_datastore_init(), chan_pjsip_cng_tone_detected(), channel_snapshot_dialplan_create(), channelstorage_exten_cb(), 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(), 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(), 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 223 of file channel_internal_api.c.

224{
225 if (!*chan->lastcontext || strcmp(value, chan->context)) {
226 /* only copy to last context when it changes, unless it's empty to begin with */
227 ast_copy_string(chan->lastcontext, chan->context, sizeof(chan->lastcontext));
228 }
229 ast_copy_string(chan->context, value, sizeof(chan->context));
230 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN);
231}
ast_channel::lastcontext
char lastcontext[AST_MAX_CONTEXT]
Definition channel_private.h:185

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(), AST_TEST_DEFINE(), 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 843 of file channel_internal_api.c.

844{
845 return chan->creationtime;
846}
ast_channel::creationtime
struct timeval creationtime
Definition channel_private.h:130

Referenced by ast_channel_get_duration_ms(), ast_pickup_find_by_group(), AST_TEST_DEFINE(), 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 847 of file channel_internal_api.c.

848{
849 chan->creationtime = *value;
850 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_BASE);
851}
AST_CHANNEL_SNAPSHOT_INVALIDATE_BASE
@ AST_CHANNEL_SNAPSHOT_INVALIDATE_BASE
Definition stasis_channels.h:50

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 205 of file channel_internal_api.c.

206{
207 return chan->data;
208}

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 209 of file channel_internal_api.c.

210{
211 chan->data = value;
212 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN);
213}

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
0success
non-zerofailure

Definition at line 2376 of file channel.c.

2377{
2378 int res = 0;
2379
2380 AST_LIST_INSERT_HEAD(ast_channel_datastores(chan), datastore, entry);
2381
2382 return res;
2383}

References ast_channel_datastores(), AST_LIST_INSERT_HEAD, and ast_datastore::entry.

Referenced by __after_bridge_set_goto(), acf_curlopt_write(), acf_iaxvar_write(), acf_odbc_read(), add_eprofile_to_channel(), add_features_datastore(), add_inheritable_header(), 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(), func_write_attestation(), 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(), record_exec(), 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_broadcast_channel(), 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
pointerto the datastore if found
NULLif not found

Definition at line 2390 of file channel.c.

2391{
2392 struct ast_datastore *datastore = NULL;
2393
2394 if (info == NULL)
2395 return NULL;
2396
2397 AST_LIST_TRAVERSE(ast_channel_datastores(chan), datastore, entry) {
2398 if (datastore->info != info) {
2399 continue;
2400 }
2401
2402 if (uid == NULL) {
2403 /* matched by type only */
2404 break;
2405 }
2406
2407 if ((datastore->uid != NULL) && !strcasecmp(uid, datastore->uid)) {
2408 /* Matched by type AND uid */
2409 break;
2410 }
2411 }
2412
2413 return datastore;
2414}
ast_datastore::info
const struct ast_datastore_info * info
Definition datastore.h:67
ast_datastore::uid
const char * uid
Definition datastore.h:65
ast_datastore::entry
struct ast_datastore::@224 entry

References ast_channel_datastores(), AST_LIST_TRAVERSE, ast_datastore::entry, 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_inheritable_header(), 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(), ast_stir_shaken_add_result_to_channel(), ast_stir_shaken_get_attestation_datastore(), 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(), func_read_verification(), func_write_attestation(), 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(), outgoing_request(), pitchshift_cb(), pitchshift_helper(), pop_exec(), raise_exception(), record_exec(), recording_info_read(), remb_hook_event_cb(), remove_detect(), remove_dtmf_store(), remove_framehook(), remove_hold_intercept(), remove_inheritable_header(), 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_broadcast_channel(), stasis_app_channel_is_internal(), stasis_app_channel_is_stasis_end_published(), stop_mixmonitor_full(), t38_attach_framehook(), talk_detect_audiohook_cb(), unlock_read(), update_inheritable_header(), 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 2359 of file channel.c.

2360{
2361 struct ast_datastore *datastore = NULL, *datastore2;
2362
2363 AST_LIST_TRAVERSE(ast_channel_datastores(from), datastore, entry) {
2364 if (datastore->inheritance > 0) {
2365 datastore2 = ast_datastore_alloc(datastore->info, datastore->uid);
2366 if (datastore2) {
2367 datastore2->data = datastore->info->duplicate ? datastore->info->duplicate(datastore->data) : NULL;
2368 datastore2->inheritance = datastore->inheritance == DATASTORE_INHERIT_FOREVER ? DATASTORE_INHERIT_FOREVER : datastore->inheritance - 1;
2369 AST_LIST_INSERT_TAIL(ast_channel_datastores(to), datastore2, entry);
2370 }
2371 }
2372 }
2373 return 0;
2374}
DATASTORE_INHERIT_FOREVER
#define DATASTORE_INHERIT_FOREVER
Definition channel.h:194
AST_LIST_INSERT_TAIL
#define AST_LIST_INSERT_TAIL(head, elm, field)
Appends a list entry to the tail of a list.
Definition linkedlists.h:731
ast_datastore_info::duplicate
void *(* duplicate)(void *data)
Definition datastore.h:33
ast_datastore::inheritance
unsigned int inheritance
Definition datastore.h:69

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::entry, 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
0success
non-zerofailure

Definition at line 2385 of file channel.c.

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

References ast_channel_datastores(), AST_LIST_REMOVE, and ast_datastore::entry.

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(), stasis_app_broadcast_channel(), 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 735 of file channel_internal_api.c.

736{
737 return &chan->datastores;
738}
ast_channel::datastores
struct ast_datastore_list datastores
Definition channel_private.h:136

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(), 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 1315 of file channel.c.

1316{
1317 int pre = 0;
1318
1319 if (chan) {
1320 ast_channel_lock(chan);
1321 pre = ast_test_flag(ast_channel_flags(chan), AST_FLAG_DEFER_DTMF);
1322 ast_set_flag(ast_channel_flags(chan), AST_FLAG_DEFER_DTMF);
1323 ast_channel_unlock(chan);
1324 }
1325 return pre;
1326}

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 771 of file channel_internal_api.c.

772{
773 return &chan->dialed;
774}
ast_channel::dialed
struct ast_party_dialed dialed
Dialed/Called information.
Definition channel_private.h:100

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
chanThe channel on which to add information
cause_codeThe cause information to be added to the channel
datalenThe total length of the structure since its length is variable
Return values
0on success
-1on error

Definition at line 1194 of file channel_internal_api.c.

1195{
1196 struct ast_control_pvt_cause_code *ao2_cause_code;
1197 ao2_find(chan->dialed_causes, cause_code->chan_name, OBJ_KEY | OBJ_UNLINK | OBJ_NODATA);
1198 ao2_cause_code = ao2_alloc(datalen, NULL);
1199
1200 if (ao2_cause_code) {
1201 memcpy(ao2_cause_code, cause_code, datalen);
1202 ao2_link(chan->dialed_causes, ao2_cause_code);
1203 ao2_ref(ao2_cause_code, -1);
1204 return 0;
1205 } else {
1206 return -1;
1207 }
1208}
ao2_link
#define ao2_link(container, obj)
Add an object to a container.
Definition astobj2.h:1532
OBJ_KEY
#define OBJ_KEY
Definition astobj2.h:1151
ao2_find
#define ao2_find(container, arg, flags)
Definition astobj2.h:1736
OBJ_NODATA
@ OBJ_NODATA
Definition astobj2.h:1044
OBJ_UNLINK
@ OBJ_UNLINK
Definition astobj2.h:1039
ao2_alloc
#define ao2_alloc(data_size, destructor_fn)
Definition astobj2.h:409
ast_channel::dialed_causes
struct ao2_container * dialed_causes
Definition channel_private.h:73

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
chanThe channel from which to retrieve information
Return values
NULLon allocation failure
Pointerto an ast_str object containing the desired information which must be freed

Definition at line 1176 of file channel_internal_api.c.

1177{
1178 struct ast_str *chanlist = ast_str_create(128);
1179
1180 if (!chanlist) {
1181 return NULL;
1182 }
1183
1184 ao2_callback(chan->dialed_causes, 0, collect_names_cb, &chanlist);
1185
1186 return chanlist;
1187}
ao2_callback
#define ao2_callback(c, flags, cb_fn, arg)
ao2_callback() is a generic function that applies cb_fn() to all objects in a container,...
Definition astobj2.h:1693
collect_names_cb
static int collect_names_cb(void *obj, void *arg, int flags)
Definition channel_internal_api.c:1161
ast_str_create
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition strings.h:659
chanlist
List of channel drivers.
Definition app_dial.c:804

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
chanThe channel from which to clear information

Definition at line 1210 of file channel_internal_api.c.

1211{
1212 ao2_callback(chan->dialed_causes, OBJ_UNLINK | OBJ_NODATA | OBJ_MULTIPLE, NULL, NULL);
1213}
OBJ_MULTIPLE
@ OBJ_MULTIPLE
Definition astobj2.h:1049

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
chanThe channel from which to retrieve information
chan_nameThe name of the channel about which to retrieve information
Return values
NULLon search failure
Pointerto a ref-counted ast_control_pvt_cause_code object containing the desired information

Definition at line 1189 of file channel_internal_api.c.

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

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

Referenced by hangupcause_read().

◆ ast_channel_dialed_causes_iterator()

struct ao2_iterator ast_channel_dialed_causes_iterator ( const struct ast_channel *  chan)

Retrieve an iterator for dialed cause information.

Since
20.19.0
22.9.0
23.3.0

Each call to ao2_iterator_next() will return a pointer to an ast_control_pvt_cause_code structure containing the dialed cause information for one channel. One of the entries may be for the channel itself if the channel was hung up because of a non-2XX SIP response code. The rest of the entries will be for channels bridged to the channel for which dialed cause information is being retrieved. The caller is responsible for cleaning up the reference count of each entry returned and destroying the returned iterator with ao2_iterator_destroy() when it is finished with it.

Parameters
chanThe channel from which to retrieve cause information
Return values
ao2_iterator

Definition at line 1171 of file channel_internal_api.c.

1172{
1173 return ao2_iterator_init(chan->dialed_causes, 0);
1174}
ao2_iterator_init
struct ao2_iterator ao2_iterator_init(struct ao2_container *c, int flags) attribute_warn_unused_result
Create an iterator for a container.
Definition astobj2_container.c:485

References ao2_iterator_init().

Referenced by chan_pjsip_session_end().

◆ ast_channel_dialed_set()

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

Definition at line 821 of file channel_internal_api.c.

822{
823 chan->dialed = *value;
824 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER);
825}

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 250 of file channel_internal_api.c.

251{
252 return chan->dtmf_digit_to_emulate;
253}
ast_channel::dtmf_digit_to_emulate
char dtmf_digit_to_emulate
Definition channel_private.h:190

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 254 of file channel_internal_api.c.

255{
256 chan->dtmf_digit_to_emulate = value;
257}

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 791 of file channel_internal_api.c.

792{
793 return &chan->dtmf_tv;
794}
ast_channel::dtmf_tv
struct timeval dtmf_tv
Definition channel_private.h:134

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 831 of file channel_internal_api.c.

832{
833 chan->dtmf_tv = *value;
834}

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 747 of file channel_internal_api.c.

748{
749 return &chan->dtmff;
750}
ast_channel::dtmff
struct ast_frame dtmff
Definition channel_private.h:124

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 803 of file channel_internal_api.c.

804{
805 chan->dtmff = *value;
806}

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
c0first channel to bridge
c1second 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 7448 of file channel.c.

7449{
7450 /* Make sure we can early bridge, if not error out */
7451 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)))
7452 return -1;
7453
7454 return ast_channel_tech(c0)->early_bridge(c0, c1);
7455}
ast_channel_tech::early_bridge
enum ast_bridge_result(*const early_bridge)(struct ast_channel *c0, struct ast_channel *c1)
Bridge two channels of the same type together (early)
Definition channel.h:788

References 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 381 of file channel_internal_api.c.

382{
383 return chan->emulate_dtmf_duration;
384}
ast_channel::emulate_dtmf_duration
unsigned int emulate_dtmf_duration
Definition channel_private.h:173

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 385 of file channel_internal_api.c.

386{
387 chan->emulate_dtmf_duration = value;
388}

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
chanChannel sending DTMF that has not ended.
digitDTMF digit to stop.
startDTMF digit start time.
whyReason bridge broken.

Definition at line 11049 of file channel.c.

11050{
11051 int dead;
11052 long duration;
11053
11054 ast_channel_lock(chan);
11055 dead = ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE)
11056 || (ast_channel_softhangup_internal_flag(chan)
11057 & ~AST_SOFTHANGUP_ASYNCGOTO);
11058 ast_channel_unlock(chan);
11059 if (dead) {
11060 /* Channel is a zombie or a real hangup. */
11061 return;
11062 }
11063
11064 duration = ast_tvdiff_ms(ast_tvnow(), start);
11065 if (duration < option_dtmfminduration) {
11066 duration = option_dtmfminduration;
11067 }
11068 ast_senddigit_end(chan, digit, duration);
11069 ast_log(LOG_DTMF, "DTMF end '%c' simulated on %s due to %s, duration %ld ms\n",
11070 digit, ast_channel_name(chan), why, duration);
11071}
ast_senddigit_end
int ast_senddigit_end(struct ast_channel *chan, char digit, unsigned int duration)
Send a DTMF digit to a channel.
Definition channel.c:4947
option_dtmfminduration
unsigned int option_dtmfminduration
Definition options.c:84
LOG_DTMF
#define LOG_DTMF
Definition include/asterisk/logger.h:313

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_endpoint()

struct ast_endpoint * ast_channel_endpoint ( const struct ast_channel *  chan)

Definition at line 1612 of file channel_internal_api.c.

1613{
1614 return chan->endpoint;
1615}

References ast_channel::endpoint.

◆ ast_channel_endpoint_set()

void ast_channel_endpoint_set ( struct ast_channel *  chan,
struct ast_endpoint *  endpoint 
)

Definition at line 1617 of file channel_internal_api.c.

1618{
1619 if (chan->endpoint) {
1620 ast_endpoint_remove_channel(chan->endpoint, chan);
1621 ao2_ref(chan->endpoint, -1);
1622 }
1623
1624 chan->endpoint = ao2_bump(endpoint);
1625
1626 if (chan->endpoint) {
1627 ast_endpoint_add_channel(chan->endpoint, chan);
1628 }
1629}
ao2_bump
#define ao2_bump(obj)
Bump refcount on an AO2 object by one, returning the object.
Definition astobj2.h:480
ast_endpoint_add_channel
int ast_endpoint_add_channel(struct ast_endpoint *endpoint, struct ast_channel *chan)
Adds a channel to the given endpoint.
Definition main/endpoints.c:165
ast_endpoint_remove_channel
int ast_endpoint_remove_channel(struct ast_endpoint *endpoint, struct ast_channel *chan)
Removes a channel from the given endpoint.
Definition main/endpoints.c:183

References ao2_bump, ao2_ref, ast_endpoint_add_channel(), ast_endpoint_remove_channel(), and ast_channel::endpoint.

Referenced by __ast_channel_alloc_ap(), and ast_channel_destructor().

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

11142{
11143 return ast_channel_internal_errno();
11144}
ast_channel_internal_errno
enum ast_channel_error ast_channel_internal_errno(void)
Definition channel_internal_api.c:1521

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 232 of file channel_internal_api.c.

233{
234 return chan->exten;
235}

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_log(), ast_channel_yank(), ast_pbx_h_exten_run(), ast_str_retrieve_variable(), AST_TEST_DEFINE(), ast_var_channels_table(), bridge_exec(), by_exten_cb(), cc_generic_agent_init(), cc_interfaces_datastore_init(), chan_pjsip_cng_tone_detected(), channel_snapshot_dialplan_create(), channelstorage_exten_cb(), 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(), 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(), send_broadcast_event(), serialize_showchan(), setup_env(), setup_peer_after_bridge_goto(), 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 240 of file channel_internal_api.c.

241{
242 if (!*chan->lastexten || strcmp(value, chan->exten)) {
243 /* only copy to last exten when it changes, unless it's empty to begin with */
244 ast_copy_string(chan->lastexten, chan->exten, sizeof(chan->lastexten));
245 }
246 ast_copy_string(chan->exten, value, sizeof(chan->exten));
247 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN);
248}
ast_channel::lastexten
char lastexten[AST_MAX_EXTENSION]
Definition channel_private.h:186

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(), AST_TEST_DEFINE(), 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 1053 of file channel_internal_api.c.

1054{
1055 return (which >= AST_VECTOR_SIZE(&chan->fds)) ? -1 : AST_VECTOR_GET(&chan->fds, which);
1056}
AST_VECTOR_SIZE
#define AST_VECTOR_SIZE(vec)
Get the number of elements in a vector.
Definition vector.h:620
AST_VECTOR_GET
#define AST_VECTOR_GET(vec, idx)
Get an element from a vector.
Definition vector.h:691

References AST_VECTOR_GET, and AST_VECTOR_SIZE.

Referenced by __dahdi_exception(), analog_exception(), ast_channel_fd_isset(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), ast_waitfor_nandfds(), build_conf(), channel_do_masquerade(), conf_run(), flash_exec(), 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
chanThe channel to add the file descriptor to
valueThe file descriptor
Precondition
chan is locked
Returns
The position of the file descriptor

Definition at line 1096 of file channel_internal_api.c.

1097{
1098 int pos = AST_EXTENDED_FDS;
1099
1100 while (ast_channel_fd_isset(chan, pos)) {
1101 pos += 1;
1102 }
1103
1104 AST_VECTOR_REPLACE(&chan->fds, pos, value);
1105
1106 return pos;
1107}
AST_EXTENDED_FDS
#define AST_EXTENDED_FDS
Definition channel.h:197
ast_channel_fd_isset
int ast_channel_fd_isset(const struct ast_channel *chan, int which)
Definition channel_internal_api.c:1057
AST_VECTOR_REPLACE
#define AST_VECTOR_REPLACE(vec, idx, elem)
Replace an element at a specific position in a vector, growing the vector if needed.
Definition vector.h:295

References ast_channel_fd_isset(), AST_EXTENDED_FDS, AST_VECTOR_REPLACE, 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
chanThe channel to get the count of
Precondition
chan is locked
Returns
The number of file descriptor positions

Definition at line 1062 of file channel_internal_api.c.

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

References AST_VECTOR_SIZE.

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 1057 of file channel_internal_api.c.

1058{
1059 return ast_channel_fd(chan, which) > -1;
1060}
ast_channel_fd
int ast_channel_fd(const struct ast_channel *chan, int which)
Definition channel_internal_api.c:1053

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 290 of file channel_internal_api.c.

291{
292 return chan->fdno;
293}
ast_channel::fdno
int fdno
Definition channel_private.h:147

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(), unistim_rtp_read(), and webchan_read().

◆ ast_channel_fdno_set()

void ast_channel_fdno_set ( struct ast_channel *  chan,
int  value 
)

Definition at line 294 of file channel_internal_api.c.

295{
296 chan->fdno = value;
297}

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
chanWhich channel to set features for
featuresThe feature set to append to the channel's features
Return values
0on success
-1on failure

Definition at line 11131 of file channel.c.

11132{
11133 return channel_feature_hooks_set_full(chan, features, 0);
11134}
channel_feature_hooks_set_full
static int channel_feature_hooks_set_full(struct ast_channel *chan, struct ast_bridge_features *features, int replace)
Definition channel.c:11094

References channel_feature_hooks_set_full().

Referenced by AST_TEST_DEFINE(), and 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
chanWhich channel to get features for
Return values
non-NULLThe features currently set for this channel
NULLif the features have not been set

Definition at line 11083 of file channel.c.

11084{
11085 struct ast_datastore *datastore;
11086
11087 datastore = ast_channel_datastore_find(chan, &bridge_features_info, NULL);
11088 if (!datastore) {
11089 return NULL;
11090 }
11091 return datastore->data;
11092}
bridge_features_info
static const struct ast_datastore_info bridge_features_info
Definition channel.c:11078
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.
Definition channel.c:2390

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
chanWhich channel to set features for
featuresThe feature set with which to replace the channel's features
Return values
0on success
-1on failure

Definition at line 11136 of file channel.c.

11137{
11138 return channel_feature_hooks_set_full(chan, features, 1);
11139}

References channel_feature_hooks_set_full().

◆ ast_channel_fin()

unsigned int ast_channel_fin ( const struct ast_channel *  chan)

Definition at line 389 of file channel_internal_api.c.

390{
391 return chan->fin;
392}
ast_channel::fin
unsigned int fin
Definition channel_private.h:157

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 393 of file channel_internal_api.c.

394{
395 chan->fin = value;
396}

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 1156 of file channel_internal_api.c.

1157{
1158 return &chan->flags;
1159}
ast_channel::flags
struct ast_flags flags
Definition channel_private.h:166

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_rtp_instance_set_stats_vars(), ast_sendtext_data(), ast_setstate(), ast_settimeout_full(), ast_softhangup_nolock(), ast_streamfile(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), ast_transfer_protocol(), ast_unreal_new_channels(), ast_var_channels_table(), ast_waitfor_nandfds(), ast_waitfordigit_full(), ast_write_stream(), audiosocket_request(), 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(), multicast_rtp_request(), 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(), stasis_app_control_snoop(), tonepair_alloc(), unicast_rtp_request(), waitstream_core(), and webchan_request().

◆ 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
chanThe channel to forward from
endpointThe endpoint to forward to
Return values
0Success
non-zeroFailure

Definition at line 1459 of file channel_internal_api.c.

1461{
1462 ast_assert(chan != NULL);
1463 ast_assert(endpoint != NULL);
1464
1465 chan->endpoint_forward =
1466 stasis_forward_all(ast_channel_topic(chan),
1467 ast_endpoint_topic(endpoint));
1468 if (!chan->endpoint_forward) {
1469 return -1;
1470 }
1471
1472 return 0;
1473}
ast_channel_topic
struct stasis_topic * ast_channel_topic(struct ast_channel *chan)
A topic which publishes the events for a particular channel.
Definition channel_internal_api.c:1450
ast_endpoint_topic
struct stasis_topic * ast_endpoint_topic(struct ast_endpoint *endpoint)
Returns the topic for a specific endpoint.
Definition main/endpoints.c:92
stasis_forward_all
struct stasis_forward * stasis_forward_all(struct stasis_topic *from_topic, struct stasis_topic *to_topic)
Create a subscription which forwards all messages from one topic to another.
Definition stasis.c:1645
ast_channel::endpoint_forward
struct stasis_forward * endpoint_forward
Definition channel_private.h:195
ast_assert
#define ast_assert(a)
Definition utils.h:779

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 397 of file channel_internal_api.c.

398{
399 return chan->fout;
400}
ast_channel::fout
unsigned int fout
Definition channel_private.h:159

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 401 of file channel_internal_api.c.

402{
403 chan->fout = value;
404}

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 572 of file channel_internal_api.c.

573{
574 return chan->framehooks;
575}
ast_channel::framehooks
struct ast_framehook_list * framehooks
Definition channel_private.h:68

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 576 of file channel_internal_api.c.

577{
578 chan->framehooks = value;
579}

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 580 of file channel_internal_api.c.

581{
582 return chan->generator;
583}
ast_channel::generator
struct ast_generator * generator
Definition channel_private.h:53

References ast_channel::generator.

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

◆ ast_channel_generator_set()

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

Definition at line 584 of file channel_internal_api.c.

585{
586 chan->generator = value;
587}

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 421 of file channel_internal_api.c.

422{
423 return chan->generatordata;
424}
ast_channel::generatordata
void * generatordata
Definition channel_private.h:52

References ast_channel::generatordata.

Referenced by 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 425 of file channel_internal_api.c.

426{
427 chan->generatordata = value;
428}

References ast_channel::generatordata, and value.

Referenced by 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
chanChannel to get variables for.
Returns
List of channel variables.
Return values
NULLon error

Definition at line 8037 of file channel.c.

8038{
8039 RAII_VAR(struct varshead *, ret, NULL, ao2_cleanup);
8040 RAII_VAR(struct ast_str *, tmp, NULL, ast_free);
8041 char *var_str;
8042 size_t i;
8043
8044 SCOPED_CHANNELLOCK(lock, chan);
8045
8046 ret = channel_get_external_vars(&ari_vars, chan);
8047
8048 if (ast_channel_internal_ari_reportable_vars_count(chan) == 0) {
8049 if (!ret) {
8050 return NULL;
8051 }
8052
8053 ao2_ref(ret, +1);
8054 return ret;
8055 }
8056
8057 if (!ret) {
8058 ret = ao2_alloc(sizeof(*ret), varshead_dtor);
8059 if (!ret) {
8060 return NULL;
8061 }
8062 }
8063
8064 tmp = ast_str_create(16);
8065 if (!tmp) {
8066 return NULL;
8067 }
8068
8069 for (i = 0; i < ast_channel_internal_ari_reportable_vars_count(chan); ++i) {
8070 const char *val = NULL;
8071 struct ast_var_t *var;
8072 int already_present = 0;
8073 struct ast_var_t *existing;
8074
8075 var_str = ast_channel_internal_ari_reportable_vars_get(chan, i);
8076
8077 AST_LIST_TRAVERSE(ret, existing, entries) {
8078 if (!strcmp(ast_var_name(existing), var_str)) {
8079 already_present = 1;
8080 break;
8081 }
8082 }
8083 if (already_present) {
8084 continue;
8085 }
8086
8087 if (strchr(var_str, '(')) {
8088 if (ast_func_read2(chan, var_str, &tmp, 0) == 0) {
8089 val = ast_str_buffer(tmp);
8090 } else {
8091 ast_log(LOG_ERROR,
8092 "Error invoking function %s\n", var_str);
8093 }
8094 } else {
8095 val = pbx_builtin_getvar_helper(chan, var_str);
8096 }
8097
8098 var = ast_var_assign(var_str, val ? val : "");
8099 if (!var) {
8100 return NULL;
8101 }
8102
8103 AST_RWLIST_INSERT_TAIL(ret, var, entries);
8104 }
8105
8106 ao2_ref(ret, +1);
8107 return ret;
8108}
lock
ast_mutex_t lock
Definition app_sla.c:337
var
#define var
Definition ast_expr2f.c:605
ao2_cleanup
#define ao2_cleanup(obj)
Definition astobj2.h:1934
channel_get_external_vars
static struct varshead * channel_get_external_vars(struct external_vars *channelvars, struct ast_channel *chan)
Definition channel.c:7985
ari_vars
static struct external_vars ari_vars
Definition channel.c:7841
varshead_dtor
static void varshead_dtor(void *obj)
Destructor for lists of variables.
Definition channel.c:7950
ast_var_name
const char * ast_var_name(const struct ast_var_t *var)
Definition chanvars.c:60
ast_var_assign
#define ast_var_assign(name, value)
Definition chanvars.h:40
AST_RWLIST_INSERT_TAIL
#define AST_RWLIST_INSERT_TAIL
Definition linkedlists.h:741
SCOPED_CHANNELLOCK
#define SCOPED_CHANNELLOCK(varname, chan)
scoped lock specialization for channels.
Definition lock.h:626
ast_func_read2
int ast_func_read2(struct ast_channel *chan, const char *function, struct ast_str **str, ssize_t maxlen)
executes a read operation on a function
Definition pbx_functions.c:665
ast_str_buffer
char *attribute_pure ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition strings.h:761
ast_var_t
Definition chanvars.h:28
ast_var_t::entries
struct ast_var_t::@221 entries
RAII_VAR
#define RAII_VAR(vartype, varname, initval, dtor)
Declare a variable that will call a destructor function when it goes out of scope.
Definition utils.h:981

References ao2_alloc, ao2_cleanup, ao2_ref, ari_vars, ast_channel_internal_ari_reportable_vars_count(), ast_channel_internal_ari_reportable_vars_get(), ast_free, ast_func_read2(), AST_LIST_TRAVERSE, ast_log, AST_RWLIST_INSERT_TAIL, ast_str_buffer(), ast_str_create, ast_var_assign, ast_var_name(), channel_get_external_vars(), ast_var_t::entries, lock, LOG_ERROR, NULL, pbx_builtin_getvar_helper(), RAII_VAR, SCOPED_CHANNELLOCK, var, and varshead_dtor().

Referenced by ast_channel_publish_varset(), and 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
chanThe 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
NULLNo bridge present on the channel
non-NULLThe bridge the channel is in

Definition at line 10714 of file channel.c.

10715{
10716 struct ast_bridge *bridge;
10717
10718 bridge = ast_channel_internal_bridge(chan);
10719 if (bridge) {
10720 ao2_ref(bridge, +1);
10721 }
10722 return bridge;
10723}

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
chanThe 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
NULLThe channel has no bridge_channel
non-NULLA reference to the bridge_channel

Definition at line 10762 of file channel.c.

10763{
10764 struct ast_bridge_channel *bridge_channel;
10765
10766 bridge_channel = ast_channel_internal_bridge_channel(chan);
10767 if (bridge_channel) {
10768 ao2_ref(bridge_channel, +1);
10769 }
10770 return bridge_channel;
10771}

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
extenthe extension to search for
contextthe context to search for

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

Return values
achannel that is at the specified extension and context
NULLif no channel was found
Since
1.8

Definition at line 1430 of file channel.c.

1431{
1432 if (!current_channel_storage_instance) {
1433 return NULL;
1434 }
1435 if (ast_strlen_zero(exten) || ast_strlen_zero(context)) {
1436 ast_log(LOG_ERROR, "exten and context must be provided\n");
1437 return NULL;
1438 }
1439 return CHANNELSTORAGE_API(current_channel_storage_instance, get_by_exten, exten, context, 1);
1440}
get_by_exten
static struct ast_channel * get_by_exten(struct ast_channelstorage_instance *driver, const char *exten, const char *context, int rdlock)
Definition channelstorage_ao2_legacy.c:246

References ast_log, ast_strlen_zero(), CHANNELSTORAGE_API, ast_channel::context, current_channel_storage_instance, ast_channel::exten, get_by_exten(), LOG_ERROR, and NULL.

◆ ast_channel_get_by_name()

struct ast_channel * ast_channel_get_by_name ( const char *  search)

Find a channel by name or uniqueid.

Parameters
searchthe name or uniqueid of the channel to search for

First searches for a channel with a matching name. If not found a search for a channel with a matching uniqueid is done.

Return values
achannel with a matching name or uniqueid
NULLif no channel was found
Note
The fallback search by uniqueid is a historical thing. If you know the search term is a uniqueid, use ast_channel_get_by_uniqueid instead.
Since
1.8

Definition at line 1417 of file channel.c.

1418{
1419 if (!current_channel_storage_instance) {
1420 return NULL;
1421 }
1422 if (ast_strlen_zero(name)) {
1423 ast_log(LOG_ERROR, "name must be provided\n");
1424 return NULL;
1425 }
1426
1427 return CHANNELSTORAGE_API(current_channel_storage_instance, get_by_name_prefix_or_uniqueid, name, 0, 1);
1428}

References ast_log, ast_strlen_zero(), CHANNELSTORAGE_API, current_channel_storage_instance, LOG_ERROR, name, and NULL.

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_get_channel_vars(), ast_ari_channels_hangup(), ast_ari_channels_rtpstatistics(), ast_ari_channels_set_channel_vars(), ast_ari_channels_transfer_progress(), ast_async_goto_by_name(), ast_manager_hangup_helper(), asyncgoto_exec(), bridge_channel_attended_transfer(), call_forwarded_handler(), channel_find(), channel_hangup_matches(), 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_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
searchThe channel name or uniqueid prefix to search for
lenOnly search for up to this many characters from the search term

Search for a channel that has the same name prefix as specified by the search term. If not found, search for an exact match on the uniqueid. Searching by partial uniqueid doesn't make any sense as it's usually a system-name plus a timestamp and is not supported.

Return values
achannel with a matching name or uniqueid
NULLif no channel was found
Note
The fallback search by uniqueid is a historical thing. If you know the search term is a uniqueid, use ast_channel_get_by_uniqueid instead.
Since
1.8

Definition at line 1400 of file channel.c.

1401{
1402 if (!current_channel_storage_instance) {
1403 return NULL;
1404 }
1405 if (ast_strlen_zero(name)) {
1406 ast_log(LOG_ERROR, "name must be provided\n");
1407 return NULL;
1408 }
1409
1410 return CHANNELSTORAGE_API(current_channel_storage_instance, get_by_name_prefix_or_uniqueid, name, name_len, 1);
1411}

References ast_log, ast_strlen_zero(), CHANNELSTORAGE_API, current_channel_storage_instance, LOG_ERROR, name, and NULL.

Referenced by action_aocmessage(), action_bridge(), 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_by_uniqueid()

struct ast_channel * ast_channel_get_by_uniqueid ( const char *  uniqueid)

Find a channel by a uniqueid.

Parameters
uniqueidThe uniqueid to search for
Return values
achannel with the uniqueid specified by the arguments
NULLif no channel was found

Definition at line 1442 of file channel.c.

1443{
1444 if (!current_channel_storage_instance) {
1445 return NULL;
1446 }
1447 if (ast_strlen_zero(uniqueid)) {
1448 ast_log(LOG_ERROR, "uniqueid must be provided\n");
1449 return NULL;
1450 }
1451 return CHANNELSTORAGE_API(current_channel_storage_instance, get_by_uniqueid, uniqueid, 1);
1452}
get_by_uniqueid
static struct ast_channel * get_by_uniqueid(struct ast_channelstorage_instance *driver, const char *uniqueid, int lock)
Definition channelstorage_ao2_legacy.c:214

References ast_log, ast_strlen_zero(), CHANNELSTORAGE_API, current_channel_storage_instance, get_by_uniqueid(), LOG_ERROR, NULL, and ast_channel::uniqueid.

◆ 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
chanThe channel for which we wish to retrieve the agent type
[out]agent_typeThe type of agent the channel driver wants us to use
sizeThe size of the buffer to write to

Definition at line 10693 of file channel.c.

10694{
10695 int len = size;
10696 char *slash;
10697
10698 if (!ast_channel_queryoption(chan, AST_OPTION_CC_AGENT_TYPE, agent_type, &len, 0)) {
10699 return 0;
10700 }
10701
10702 ast_copy_string(agent_type, ast_channel_name(chan), size);
10703 if ((slash = strchr(agent_type, '/'))) {
10704 *slash = '\0';
10705 }
10706 return 0;
10707}
ast_channel_queryoption
int ast_channel_queryoption(struct ast_channel *chan, int option, void *data, int *datalen, int block)
Checks the value of an option.
Definition channel.c:7478
AST_OPTION_CC_AGENT_TYPE
#define AST_OPTION_CC_AGENT_TYPE
Definition include/asterisk/frame.h:519

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.

Warning
You should call this function only if ast_cc_is_enabled() returns true.
Parameters
chanChannel to retrieve parameters from
Return values
NULLFailure or CCSS is globally disabled.
non-NULLThe parameters desired

Definition at line 10650 of file channel.c.

10651{
10652 struct ast_datastore *cc_datastore;
10653
10654 if (!ast_cc_is_enabled()) {
10655 return NULL;
10656 }
10657
10658 if (!(cc_datastore = ast_channel_datastore_find(chan, &cc_channel_datastore_info, NULL))) {
10659 /* If we can't find the datastore, it almost definitely means that the channel type being
10660 * used has not had its driver modified to parse CC config parameters. The best action
10661 * to take here is to create the parameters on the spot with the defaults set.
10662 */
10663 if (ast_channel_cc_params_init(chan, NULL)) {
10664 return NULL;
10665 }
10666 if (!(cc_datastore = ast_channel_datastore_find(chan, &cc_channel_datastore_info, NULL))) {
10667 /* Should be impossible */
10668 return NULL;
10669 }
10670 }
10671
10672 ast_assert(cc_datastore->data != NULL);
10673 return cc_datastore->data;
10674}
ast_cc_is_enabled
int ast_cc_is_enabled(void)
Determine if CCSS is enabled.
Definition ccss.c:4540
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.
Definition channel.c:10627

References ast_assert, ast_cc_is_enabled(), 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_current_storage_driver_name()

const char * ast_channel_get_current_storage_driver_name ( void  )

Get the name of the current channel storage driver.

Returns
The name of the current channel storage driver

Definition at line 8149 of file channel.c.

8150{
8151 return current_channel_storage_driver ?
8152 current_channel_storage_driver->driver_name : "NOT SET";
8153}
current_channel_storage_driver
const struct ast_channelstorage_driver * current_channel_storage_driver
The current channel storage driver.
Definition channel_internal_api.c:55
ast_channelstorage_driver::driver_name
const char * driver_name
Definition channelstorage.h:33

References current_channel_storage_driver, and ast_channelstorage_driver::driver_name.

Referenced by handle_show_settings().

◆ 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
chanThe channel to get the stream from
typeThe media type of the default stream
Precondition
chan is locked
Return values
non-NULLsuccess
NULLfailure

Definition at line 1567 of file channel_internal_api.c.

1569{
1570 ast_assert(chan != NULL);
1571 ast_assert(type < AST_MEDIA_TYPE_END);
1572
1573 return chan->default_streams[type];
1574}
AST_MEDIA_TYPE_END
@ AST_MEDIA_TYPE_END
Definition codec.h:36
ast_channel::default_streams
struct ast_stream * default_streams[AST_MEDIA_TYPE_END]
Definition channel_private.h:198

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
chanThe channel to retrieve the information from
[out]device_nameThe buffer to place the device's name into
name_buffer_lengthThe allocated space for the device_name
Returns
0 always

Definition at line 10676 of file channel.c.

10677{
10678 int len = name_buffer_length;
10679 char *dash;
10680 if (!ast_channel_queryoption(chan, AST_OPTION_DEVICE_NAME, device_name, &len, 0)) {
10681 return 0;
10682 }
10683
10684 /* Dang. Do it the old-fashioned way */
10685 ast_copy_string(device_name, ast_channel_name(chan), name_buffer_length);
10686 if ((dash = strrchr(device_name, '-'))) {
10687 *dash = '\0';
10688 }
10689
10690 return 0;
10691}
AST_OPTION_DEVICE_NAME
#define AST_OPTION_DEVICE_NAME
Definition include/asterisk/frame.h:515

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
chanThe channel object
Return values
0if the time value cannot be computed (or you called this really fast)
Thenumber of seconds the channel has been up

Definition at line 2830 of file channel.c.

2831{
2832 return (ast_channel_get_duration_ms(chan) / 1000);
2833}
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.
Definition channel.c:2820

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
chanThe channel object
Return values
0if the time value cannot be computed (or you called this really fast)
Thenumber of milliseconds since channel creation

Definition at line 2820 of file channel.c.

2821{
2822 ast_assert(NULL != chan);
2823
2824 if (ast_tvzero(ast_channel_creationtime(chan))) {
2825 return 0;
2826 }
2827 return ast_tvdiff_ms(ast_tvnow(), ast_channel_creationtime(chan));
2828}

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

Referenced by ast_channel_get_duration(), end_bridge_callback(), end_bridge_callback(), and queue_exec().

◆ 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
0Not in an intercept routine.
1In an intercept routine.

Definition at line 10509 of file channel.c.

10510{
10511 return ast_threadstorage_get_ptr(&in_intercept_routine) ? 1 : 0;
10512}
ast_threadstorage_get_ptr
void * ast_threadstorage_get_ptr(struct ast_threadstorage *ts)
Retrieve a raw pointer from threadstorage.
Definition threadstorage.h:243

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
chanChannel to get variables for.
Returns
List of channel variables.
Return values
NULLon error

Definition at line 8032 of file channel.c.

8033{
8034 return channel_get_external_vars(&ami_vars, chan);
8035}
ami_vars
static struct external_vars ami_vars
Definition channel.c:7840

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
chanThe channel to get the stream topology of
Precondition
chan is locked
Return values
non-NULLsuccess
NULLfailure

Definition at line 1531 of file channel_internal_api.c.

1533{
1534 ast_assert(chan != NULL);
1535
1536 return chan->stream_topology;
1537}
ast_channel::stream_topology
struct ast_stream_topology * stream_topology
Definition channel_private.h:196

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_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
chanThe channel
Return values
Thechannel's stream topology change source

Definition at line 539 of file channel_internal_api.c.

540{
541 return chan->stream_topology_change_source;
542}
ast_channel::stream_topology_change_source
void * stream_topology_change_source
Definition channel_private.h:197

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

2912{
2913 enum ast_t38_state state = T38_STATE_UNAVAILABLE;
2914 int datalen = sizeof(state);
2915
2916 ast_channel_queryoption(chan, AST_OPTION_T38_STATE, &state, &datalen, 0);
2917
2918 return state;
2919}

References ast_channel_queryoption(), AST_OPTION_T38_STATE, ast_channel::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
chanThe channel object
Return values
0if the channel isn't answered (or you called this really fast)
Thenumber of seconds the channel has been up

Definition at line 2845 of file channel.c.

2846{
2847 return (ast_channel_get_up_time_ms(chan) / 1000);
2848}
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.
Definition channel.c:2835

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
chanThe channel object
Return values
0if the channel isn't answered (or you called this really fast)
Thenumber of milliseconds the channel has been up

Definition at line 2835 of file channel.c.

2836{
2837 ast_assert(NULL != chan);
2838
2839 if (ast_tvzero(ast_channel_answertime(chan))) {
2840 return 0;
2841 }
2842 return ast_tvdiff_ms(ast_tvnow(), ast_channel_answertime(chan));
2843}

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
chanChannel to get variables for
Returns
List of channel variables.
Return values
NULLon error

Definition at line 7960 of file channel.c.

7961{
7962 RAII_VAR(struct varshead *, ret, NULL, ao2_cleanup);
7963 struct ast_var_t *cv;
7964
7965 ret = ao2_alloc(sizeof(*ret), varshead_dtor);
7966
7967 if (!ret) {
7968 return NULL;
7969 }
7970
7971 AST_LIST_TRAVERSE(ast_channel_varshead(chan), cv, entries) {
7972 struct ast_var_t *var = ast_var_assign(ast_var_name(cv), ast_var_value(cv));
7973
7974 if (!var) {
7975 return NULL;
7976 }
7977
7978 AST_LIST_INSERT_TAIL(ret, var, entries);
7979 }
7980
7981 ao2_ref(ret, +1);
7982 return ret;
7983}
ast_var_value
const char * ast_var_value(const struct ast_var_t *var)
Definition chanvars.c:80

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 731 of file channel_internal_api.c.

732{
733 return &chan->hangup_handlers;
734}
ast_channel::hangup_handlers
struct ast_hangup_handler_list hangup_handlers
Definition channel_private.h:135

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 298 of file channel_internal_api.c.

299{
300 return chan->hangupcause;
301}
ast_channel::hangupcause
int hangupcause
Definition channel_private.h:161

References ast_channel::hangupcause.

Referenced by ast_cc_call_failed(), ast_channel_softhangup_withcause_locked(), ast_queue_hangup(), 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
chanchannel on which to set the cause information
cause_codeast_control_pvt_cause_code structure containing cause information
datalentotal length of the structure since it may vary

Definition at line 4368 of file channel.c.

4369{
4370 char causevar[256];
4371
4372 if (ast_channel_dialed_causes_add(chan, cause_code, datalen)) {
4373 ast_log(LOG_WARNING, "Unable to store hangup cause for %s on %s\n", cause_code->chan_name, ast_channel_name(chan));
4374 }
4375
4376 if (cause_code->emulate_sip_cause) {
4377 snprintf(causevar, sizeof(causevar), "HASH(SIP_CAUSE,%s)", cause_code->chan_name);
4378 ast_func_write(chan, causevar, cause_code->code);
4379 }
4380}
ast_func_write
int ast_func_write(struct ast_channel *chan, const char *function, const char *value)
executes a write operation on a function
Definition pbx_functions.c:724
ast_control_pvt_cause_code::emulate_sip_cause
unsigned int emulate_sip_cause
Definition include/asterisk/frame.h:419
ast_control_pvt_cause_code::code
char code[1]
Definition include/asterisk/frame.h:421

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 302 of file channel_internal_api.c.

303{
304 chan->hangupcause = value;
305 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_HANGUP);
306}
AST_CHANNEL_SNAPSHOT_INVALIDATE_HANGUP
@ AST_CHANNEL_SNAPSHOT_INVALIDATE_HANGUP
Definition stasis_channels.h:46

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_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), ast_unreal_call_setup(), ast_unreal_hangup(), call_pickup_incoming_request(), chan_pjsip_session_end(), channel_set_cause(), console_new(), dahdi_indicate(), dial_exec_full(), disa_exec(), eivr_comm(), handle_call_outgoing(), handle_timeout_trip(), hangup_channel(), 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(), wait_for_answer(), wait_for_winner(), webchan_call(), and websocket_handoff_to_channel().

◆ 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
0if no ARI variables are expected
1if ARI variables are expected

Definition at line 7869 of file channel.c.

7870{
7871 return channel_has_external_vars(&ari_vars);
7872}
channel_has_external_vars
static int channel_has_external_vars(struct external_vars *channelvars)
Definition channel.c:7853

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
chanThe channel to check.
Return values
non-zeroif channel has active audiohooks, framehooks, or monitor.

Definition at line 2517 of file channel.c.

2518{
2519 return !ast_audiohook_write_list_empty(ast_channel_audiohooks(chan))
2520 || !ast_framehook_list_contains_no_active(ast_channel_framehooks(chan));
2521}
ast_audiohook_write_list_empty
int ast_audiohook_write_list_empty(struct ast_audiohook_list *audiohook_list)
Determine if a audiohook_list is empty or not.
Definition audiohook.c:1108
ast_framehook_list_contains_no_active
int ast_framehook_list_contains_no_active(struct ast_framehook_list *framehooks)
Determine if a framehook list is free of active framehooks or not.
Definition framehook.c:282

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
chanThe channel to check.
Return values
non-zeroif channel has active audiohooks, audio framehooks, or monitor.

Definition at line 2523 of file channel.c.

2524{
2525 return !ast_audiohook_write_list_empty(ast_channel_audiohooks(chan))
2526 || !ast_framehook_list_contains_no_active_of_type(ast_channel_framehooks(chan), AST_FRAME_VOICE);
2527}
ast_framehook_list_contains_no_active_of_type
int ast_framehook_list_contains_no_active_of_type(struct ast_framehook_list *framehooks, enum ast_frame_type type)
Determine if a framehook list is free of active framehooks consuming a specific type of frame.
Definition framehook.c:287

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
0if no manager variables are expected
1if manager variables are expected

Definition at line 7864 of file channel.c.

7865{
7866 return channel_has_external_vars(&ami_vars);
7867}

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 357 of file channel_internal_api.c.

358{
359 return chan->hold_state;
360}
ast_channel::hold_state
int hold_state
Definition channel_private.h:175

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 361 of file channel_internal_api.c.

362{
363 chan->hold_state = value;
364}

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
parentParent channel
childChild 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 6795 of file channel.c.

6796{
6797 struct ast_var_t *current;
6798 struct ast_var_t *newvar;
6799 const char *varname;
6800 int vartype;
6801
6802 AST_LIST_TRAVERSE(ast_channel_varshead((struct ast_channel *) parent), current, entries) {
6803 varname = ast_var_full_name(current);
6804 if (!varname) {
6805 continue;
6806 }
6807
6808 vartype = 0;
6809 if (varname[0] == '_') {
6810 vartype = 1;
6811 if (varname[1] == '_') {
6812 vartype = 2;
6813 }
6814 }
6815
6816 switch (vartype) {
6817 case 1:
6818 newvar = ast_var_assign(&varname[1], ast_var_value(current));
6819 break;
6820 case 2:
6821 newvar = ast_var_assign(varname, ast_var_value(current));
6822 break;
6823 default:
6824 continue;
6825 }
6826 if (newvar) {
6827 ast_debug(1, "Inheriting variable %s from %s to %s.\n",
6828 ast_var_full_name(newvar), ast_channel_name(parent),
6829 ast_channel_name(child));
6830 AST_LIST_INSERT_TAIL(ast_channel_varshead(child), newvar, entries);
6831 ast_channel_publish_varset(child, ast_var_full_name(newvar),
6832 ast_var_value(newvar));
6833 }
6834 }
6835}
current
size_t current
Definition channelstorage.c:23
ast_var_full_name
const char * ast_var_full_name(const struct ast_var_t *var)
Definition chanvars.c:75
ast_channel_publish_varset
void ast_channel_publish_varset(struct ast_channel *chan, const char *variable, const char *value)
Publish a ast_channel_publish_varset for a channel.
Definition stasis_channels.c:1176

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 405 of file channel_internal_api.c.

406{
407 return chan->insmpl;
408}
ast_channel::insmpl
unsigned long insmpl
Definition channel_private.h:138

References ast_channel::insmpl.

◆ ast_channel_insmpl_set()

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

Definition at line 409 of file channel_internal_api.c.

410{
411 chan->insmpl = value;
412}

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 982 of file channel_internal_api.c.

983{
984 return ast_alertpipe_flush(chan->alertpipe);
985}
ast_alertpipe_flush
ast_alert_status_t ast_alertpipe_flush(int alert_pipe[2])
Consume all alerts written to the alert pipe.
Definition alertpipe.c:134

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 987 of file channel_internal_api.c.

988{
989 return ast_alertpipe_read(chan->alertpipe);
990}
ast_alertpipe_read
ast_alert_status_t ast_alertpipe_read(int alert_pipe[2])
Read an event from an alert pipe.
Definition alertpipe.c:102

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 997 of file channel_internal_api.c.

998{
999 return ast_alertpipe_readable(chan->alertpipe);
1000}
ast_alertpipe_readable
int attribute_pure ast_alertpipe_readable(int alert_pipe[2])
Determine if the alert pipe is readable.
Definition alertpipe.h:114

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 1017 of file channel_internal_api.c.

1018{
1019 return ast_alertpipe_readfd(chan->alertpipe);
1020}
ast_alertpipe_readfd
int attribute_pure ast_alertpipe_readfd(int alert_pipe[2])
Get the alert pipe's read file descriptor.
Definition alertpipe.h:146

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 1002 of file channel_internal_api.c.

1003{
1004 ast_alertpipe_clear(chan->alertpipe);
1005}
ast_alertpipe_clear
void ast_alertpipe_clear(int alert_pipe[2])
Sets the alert pipe file descriptors to default values.
Definition alertpipe.h:98

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 1007 of file channel_internal_api.c.

1008{
1009 ast_alertpipe_close(chan->alertpipe);
1010}
ast_alertpipe_close
void ast_alertpipe_close(int alert_pipe[2])
Close an alert pipe.
Definition alertpipe.c:79

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 1012 of file channel_internal_api.c.

1013{
1014 return ast_alertpipe_init(chan->alertpipe);
1015}
ast_alertpipe_init
int ast_alertpipe_init(int alert_pipe[2])
Initialize an alert pipe.
Definition alertpipe.c:38

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 1022 of file channel_internal_api.c.

1023{
1024 ast_alertpipe_swap(chan1->alertpipe, chan2->alertpipe);
1025}
ast_alertpipe_swap
void ast_alertpipe_swap(int alert_pipe_1[2], int alert_pipe_2[2])
Swap the file descriptors from two alert pipes.
Definition alertpipe.h:161

References ast_channel::alertpipe, and ast_alertpipe_swap().

Referenced by channel_do_masquerade().

◆ ast_channel_internal_ari_reportable_vars_append()

int ast_channel_internal_ari_reportable_vars_append ( struct ast_channel *  chan,
char *  key 
)

Definition at line 1080 of file channel_internal_api.c.

1082{
1083 return AST_VECTOR_APPEND(&chan->ari_report_vars, key);
1084}
AST_VECTOR_APPEND
#define AST_VECTOR_APPEND(vec, elem)
Append an element to a vector, growing the vector if needed.
Definition vector.h:267

References AST_VECTOR_APPEND.

Referenced by ast_channel_set_ari_var_reportable().

◆ ast_channel_internal_ari_reportable_vars_count()

size_t ast_channel_internal_ari_reportable_vars_count ( const struct ast_channel *  chan)

Definition at line 1067 of file channel_internal_api.c.

1068{
1069 return AST_VECTOR_SIZE(&chan->ari_report_vars);
1070}

References AST_VECTOR_SIZE.

Referenced by ast_channel_get_ari_vars(), and ast_channel_set_ari_var_reportable().

◆ ast_channel_internal_ari_reportable_vars_get()

char * ast_channel_internal_ari_reportable_vars_get ( const struct ast_channel *  chan,
size_t  index 
)

Definition at line 1072 of file channel_internal_api.c.

1074{
1075 return index < AST_VECTOR_SIZE(&chan->ari_report_vars)
1076 ? AST_VECTOR_GET(&chan->ari_report_vars, index)
1077 : NULL;
1078}

References AST_VECTOR_GET, AST_VECTOR_SIZE, and NULL.

Referenced by ast_channel_get_ari_vars(), and ast_channel_set_ari_var_reportable().

◆ ast_channel_internal_ari_reportable_vars_remove()

char * ast_channel_internal_ari_reportable_vars_remove ( struct ast_channel *  chan,
size_t  index 
)

Definition at line 1086 of file channel_internal_api.c.

1088{
1089 if (index >= AST_VECTOR_SIZE(&chan->ari_report_vars)) {
1090 return NULL;
1091 }
1092
1093 return AST_VECTOR_REMOVE(&chan->ari_report_vars, index, 0);
1094}
AST_VECTOR_REMOVE
#define AST_VECTOR_REMOVE(vec, idx, preserve_ordered)
Remove an element from a vector by index.
Definition vector.h:423

References AST_VECTOR_REMOVE, AST_VECTOR_SIZE, and NULL.

Referenced by ast_channel_set_ari_var_reportable().

◆ ast_channel_internal_bridge()

struct ast_bridge * ast_channel_internal_bridge ( const struct ast_channel *  chan)

Definition at line 1136 of file channel_internal_api.c.

1137{
1138 return chan->bridge;
1139}
ast_channel::bridge
struct ast_bridge * bridge
Definition channel_private.h:179

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 1147 of file channel_internal_api.c.

1148{
1149 return chan->bridge_channel;
1150}
ast_channel::bridge_channel
struct ast_bridge_channel * bridge_channel
Definition channel_private.h:180

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

1152{
1153 chan->bridge_channel = value;
1154}

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 1140 of file channel_internal_api.c.

1141{
1142 chan->bridge = value;
1143 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_BRIDGE);
1144 ast_channel_publish_snapshot(chan);
1145}
AST_CHANNEL_SNAPSHOT_INVALIDATE_BRIDGE
@ AST_CHANNEL_SNAPSHOT_INVALIDATE_BRIDGE
Definition stasis_channels.h:38

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
destDestination to copy linkedid to
sourceSource channel to copy linkedid from

Definition at line 1334 of file channel_internal_api.c.

1335{
1336 if (dest->linkedid.creation_time == source->linkedid.creation_time
1337 && dest->linkedid.creation_unique == source->linkedid.creation_unique
1338 && !strcmp(dest->linkedid.unique_id, source->linkedid.unique_id)) {
1339 return;
1340 }
1341 dest->linkedid = source->linkedid;
1342 ast_channel_snapshot_invalidate_segment(dest, AST_CHANNEL_SNAPSHOT_INVALIDATE_PEER);
1343 ast_channel_publish_snapshot(dest);
1344}
AST_CHANNEL_SNAPSHOT_INVALIDATE_PEER
@ AST_CHANNEL_SNAPSHOT_INVALIDATE_PEER
Definition stasis_channels.h:48
ast_channel_id::creation_unique
int creation_unique
Definition channel_private.h:32
ast_channel_id::unique_id
char unique_id[AST_MAX_UNIQUEID]
Definition channel_private.h:33
ast_channel_id::creation_time
time_t creation_time
Definition channel_private.h:31

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 1041 of file channel_internal_api.c.

1042{
1043 if (which >= AST_VECTOR_SIZE(&chan->fds)) {
1044 return;
1045 }
1046
1047 AST_VECTOR_REPLACE(&chan->fds, which, -1);
1048}

References AST_VECTOR_REPLACE, and AST_VECTOR_SIZE.

Referenced by handle_command(), and handle_negotiated_sdp().

◆ ast_channel_internal_fd_clear_all()

void ast_channel_internal_fd_clear_all ( struct ast_channel *  chan)

Definition at line 1049 of file channel_internal_api.c.

1050{
1051 AST_VECTOR_RESET(&chan->fds, AST_VECTOR_ELEM_CLEANUP_NOOP);
1052}
AST_VECTOR_RESET
#define AST_VECTOR_RESET(vec, cleanup)
Reset vector.
Definition vector.h:636
AST_VECTOR_ELEM_CLEANUP_NOOP
#define AST_VECTOR_ELEM_CLEANUP_NOOP(elem)
Vector element cleanup that does nothing.
Definition vector.h:582

References AST_VECTOR_ELEM_CLEANUP_NOOP, and AST_VECTOR_RESET.

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 1028 of file channel_internal_api.c.

1029{
1030 int pos;
1031
1032 /* This ensures that if the vector has to grow with unused positions they will be
1033 * initialized to -1.
1034 */
1035 for (pos = AST_VECTOR_SIZE(&chan->fds); pos < which; pos++) {
1036 AST_VECTOR_REPLACE(&chan->fds, pos, -1);
1037 }
1038
1039 AST_VECTOR_REPLACE(&chan->fds, which, value);
1040}

References AST_VECTOR_REPLACE, AST_VECTOR_SIZE, 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
aFirst channel
bSecond channel
Returns
Returns an ast_channel structure that has oldest linkedid

Definition at line 1317 of file channel_internal_api.c.

1318{
1319 ast_assert(a->linkedid.creation_time != 0);
1320 ast_assert(b->linkedid.creation_time != 0);
1321
1322 if (a->linkedid.creation_time < b->linkedid.creation_time) {
1323 return a;
1324 }
1325 if (b->linkedid.creation_time < a->linkedid.creation_time) {
1326 return b;
1327 }
1328 if (a->linkedid.creation_unique < b->linkedid.creation_unique) {
1329 return a;
1330 }
1331 return b;
1332}

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
chanThe channel to set the uniqueid to
uniqueidThe uniqueid to set
linkedidThe 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 1411 of file channel_internal_api.c.

1412{
1413 ast_copy_string(chan->uniqueid.unique_id, uniqueid, sizeof(chan->uniqueid.unique_id));
1414 ast_copy_string(chan->linkedid.unique_id, linkedid, sizeof(chan->linkedid.unique_id));
1415}

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
aFirst channel
bSecond 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 1384 of file channel_internal_api.c.

1385{
1386 struct stasis_forward *temp;
1387
1388 temp = a->endpoint_forward;
1389 a->endpoint_forward = b->endpoint_forward;
1390 b->endpoint_forward = temp;
1391}
stasis_forward
Forwarding information.
Definition stasis.c:1598

References a, and b.

Referenced by channel_do_masquerade().

◆ ast_channel_internal_swap_endpoints()

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

Swap endpoints between two channels.

Parameters
aFirst channel
bSecond channel
Note
This is used in masquerade to exchange endpoints

Definition at line 1402 of file channel_internal_api.c.

1403{
1404 struct ast_endpoint *endpoint;
1405
1406 endpoint = a->endpoint;
1407 a->endpoint = b->endpoint;
1408 b->endpoint = endpoint;
1409}

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
aFirst channel
bSecond channel
Note
This is used in masquerade to exchange snapshots

Definition at line 1393 of file channel_internal_api.c.

1394{
1395 struct ast_channel_snapshot *snapshot;
1396
1397 snapshot = a->snapshot;
1398 a->snapshot = b->snapshot;
1399 b->snapshot = snapshot;
1400}

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
aFirst channel
bSecond channel
Note
This is used in masquerade to exchange topics for message routing

Definition at line 1370 of file channel_internal_api.c.

1371{
1372 struct stasis_topic *topic;
1373 struct stasis_forward *forward;
1374
1375 topic = a->topic;
1376 a->topic = b->topic;
1377 b->topic = topic;
1378
1379 forward = a->channel_forward;
1380 a->channel_forward = b->channel_forward;
1381 b->channel_forward = forward;
1382}

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
aFirst channel
bSecond channel
Note
This is used in masquerade to exchange identities

Definition at line 1346 of file channel_internal_api.c.

1347{
1348 struct ast_channel_id temp;
1349
1350 /* This operation is used as part of masquerading and so does not invalidate the peer
1351 * segment. This is due to the masquerade process invalidating all segments.
1352 */
1353
1354 /*
1355 * Since unique ids can be a key in the channel storage backend,
1356 * ensure that neither channel is linked in or the keys will be
1357 * invalid.
1358 */
1359 ast_assert(!a->linked_in_container && !b->linked_in_container);
1360
1361 temp = a->uniqueid;
1362 a->uniqueid = b->uniqueid;
1363 b->uniqueid = temp;
1364
1365 temp = a->linkedid;
1366 a->linkedid = b->linkedid;
1367 b->linkedid = temp;
1368}
ast_channel_id
Channel UniqueId structure.
Definition channel_private.h:30

References a, ast_assert, 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
chanThe 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
0The channel is not bridged
non-zeroThe channel is bridged

Definition at line 10725 of file channel.c.

10726{
10727 return ast_channel_internal_bridge(chan) != NULL;
10728}

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(), wait_for_bridged(), wait_for_unbridged(), 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
chanThe 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
0The channel is not leaving the bridge or is hung up
non-zeroThe channel is leaving the bridge

Definition at line 10730 of file channel.c.

10731{
10732 int hangup_flags = ast_channel_softhangup_internal_flag(chan);
10733 int hangup_test = hangup_flags & AST_SOFTHANGUP_ASYNCGOTO;
10734 int unbridge = ast_channel_unbridged(chan);
10735
10736 /* This function should only return true if either the unbridged flag or
10737 * the ASYNCGOTO soft hangup flag is set and when no other soft hangup
10738 * flags are set. Any other soft hangup flags being set should make it
10739 * return false.
10740 */
10741 return ((hangup_test || unbridge) && (hangup_test == hangup_flags));
10742}

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
chanThe channel to test
Precondition
chan is locked
Return values
trueif the channel is multi-stream capable.

Definition at line 1591 of file channel_internal_api.c.

1592{
1593 return (chan && chan->tech && chan->tech->read_stream && chan->tech->write_stream);
1594}
ast_channel_tech::write_stream
int(*const write_stream)(struct ast_channel *chan, int stream_num, struct ast_frame *frame)
Write a frame on a specific stream, in standard format (see frame.h)
Definition channel.h:773
ast_channel_tech::read_stream
struct ast_frame *(*const read_stream)(struct ast_channel *chan)
Read a frame (or chain of frames from the same stream), in standard format (see frame....
Definition channel.h:767

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
chanChannel 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 913 of file channel_internal_api.c.

914{
915 int res;
916
917 ast_channel_lock(chan);
918 res = ast_channel_is_t38_active_nolock(chan);
919 ast_channel_unlock(chan);
920 return res;
921}
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.
Definition channel_internal_api.c:908

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
chanChannel 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 908 of file channel_internal_api.c.

909{
910 return chan->is_t38_active;
911}
ast_channel::is_t38_active
char is_t38_active
Definition channel_private.h:189

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
NULLon failure
anew channel iterator
Since
1.8

Definition at line 1380 of file channel.c.

1381{
1382 if (!current_channel_storage_instance) {
1383 return NULL;
1384 }
1385 return CHANNELSTORAGE_API(current_channel_storage_instance, iterator_all_new);
1386}
iterator_all_new
static struct ast_channel_iterator * iterator_all_new(struct ast_channelstorage_instance *driver)
Definition channelstorage_ao2_legacy.c:194

References CHANNELSTORAGE_API, current_channel_storage_instance, iterator_all_new(), 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(), and handle_show_hangup_all().

◆ 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
extenThe extension that channels must be in
contextThe 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
NULLon failure
anew channel iterator based on the specified parameters
Since
1.8

Definition at line 1357 of file channel.c.

1358{
1359 if (!current_channel_storage_instance) {
1360 return NULL;
1361 }
1362 if (ast_strlen_zero(exten) || ast_strlen_zero(context)) {
1363 ast_log(LOG_ERROR, "exten and context must be provided\n");
1364 return NULL;
1365 }
1366 return CHANNELSTORAGE_API(current_channel_storage_instance, iterator_by_exten_new, exten, context);
1367}
iterator_by_exten_new
static struct ast_channel_iterator * iterator_by_exten_new(struct ast_channelstorage_instance *driver, const char *exten, const char *context)
Definition channelstorage_ao2_legacy.c:152

References ast_log, ast_strlen_zero(), CHANNELSTORAGE_API, current_channel_storage_instance, iterator_by_exten_new(), LOG_ERROR, and NULL.

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
namechannel name or channel uniqueid to match
name_lennumber 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
NULLon failure
anew channel iterator based on the specified parameters
Since
1.8

Definition at line 1368 of file channel.c.

1369{
1370 if (!current_channel_storage_instance) {
1371 return NULL;
1372 }
1373 if (ast_strlen_zero(name)) {
1374 ast_log(LOG_ERROR, "name must be provided\n");
1375 return NULL;
1376 }
1377 return CHANNELSTORAGE_API(current_channel_storage_instance, iterator_by_name_new, name, name_len);
1378}
iterator_by_name_new
static struct ast_channel_iterator * iterator_by_name_new(struct ast_channelstorage_instance *driver, const char *name, size_t name_len)
Definition channelstorage_ao2_legacy.c:173

References ast_log, ast_strlen_zero(), CHANNELSTORAGE_API, current_channel_storage_instance, iterator_by_name_new(), LOG_ERROR, name, and NULL.

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
ithe 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
NULLfor convenience to clear out the pointer to the iterator that was just destroyed.
Since
1.8

Definition at line 1349 of file channel.c.

1350{
1351 if (!current_channel_storage_instance || !i) {
1352 return NULL;
1353 }
1354 return CHANNELSTORAGE_API(current_channel_storage_instance, iterator_destroy, i);
1355}
iterator_destroy
static struct ast_channel_iterator * iterator_destroy(struct ast_channelstorage_instance *driver, struct ast_channel_iterator *i)
Definition channelstorage_ao2_legacy.c:143

References CHANNELSTORAGE_API, current_channel_storage_instance, iterator_destroy(), 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(), 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
ithe 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
thenext channel that matches the parameters used when the iterator was created.
NULLif no more channels match the iterator parameters.
Since
1.8

Definition at line 1388 of file channel.c.

1389{
1390 if (!current_channel_storage_instance || !i) {
1391 return NULL;
1392 }
1393 return CHANNELSTORAGE_API(current_channel_storage_instance, iterator_next, i);
1394}
iterator_next
static struct ast_channel * iterator_next(struct ast_channelstorage_instance *driver, struct ast_channel_iterator *i)
Definition channelstorage_ao2_legacy.c:208

References CHANNELSTORAGE_API, current_channel_storage_instance, iterator_next(), and NULL.

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(), next_channel(), pickup_by_exten(), and softhangup_exec().

◆ ast_channel_jb()

struct ast_jb * ast_channel_jb ( struct ast_channel *  chan)

Definition at line 751 of file channel_internal_api.c.

752{
753 return &chan->jb;
754}
ast_channel::jb
struct ast_jb jb
Definition channel_private.h:133

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 807 of file channel_internal_api.c.

808{
809 chan->jb = *value;
810}

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(), app_exec(), ast_app_getdata_full(), ast_app_getdata_terminator(), ast_ari_channels_dial(), 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(), invent_message(), isAnsweringMachine(), leave_voicemail(), leave_voicemail(), limits_interval_playback(), meetme_menu_admin(), meetme_menu_admin_extended(), meetme_menu_normal(), minivm_greet_exec(), moh_files_next(), 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(), wait_for_answer(), and wait_for_winner().

◆ ast_channel_lastcontext()

const char * ast_channel_lastcontext ( const struct ast_channel *  chan)

Definition at line 219 of file channel_internal_api.c.

220{
221 return chan->lastcontext;
222}

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 236 of file channel_internal_api.c.

237{
238 return chan->lastexten;
239}

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 167 of file channel_internal_api.c.

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

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

Referenced by ast_channel_log(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), 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
chanFirst channel to make compatible. Should be the calling party.
peerOther 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
0on success.
-1on error.

Definition at line 6739 of file channel.c.

6740{
6741 /*
6742 * Set up translation from the peer to the chan first in case we
6743 * need to hear any in-band tones and the other direction fails.
6744 */
6745 if (ast_channel_make_compatible_helper(peer, chan)) {
6746 return -1;
6747 }
6748
6749 /* Set up translation from the chan to the peer */
6750 if (ast_channel_make_compatible_helper(chan, peer)) {
6751 return -1;
6752 }
6753
6754 return 0;
6755}
ast_channel_make_compatible_helper
static int ast_channel_make_compatible_helper(struct ast_channel *from, struct ast_channel *to)
Set up translation from one channel to another.
Definition channel.c:6660

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 472 of file channel_internal_api.c.

473{
474 return chan->masq;
475}
ast_channel::masq
struct ast_channel * masq
Definition channel_private.h:54

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 476 of file channel_internal_api.c.

477{
478 chan->masq = value;
479}

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 480 of file channel_internal_api.c.

481{
482 return chan->masqr;
483}
ast_channel::masqr
struct ast_channel * masqr
Definition channel_private.h:55

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 484 of file channel_internal_api.c.

485{
486 chan->masqr = value;
487}

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
destThe place to move the source channel
sourceThe channel to move
Return values
0Success
non-zeroFailure

Definition at line 10846 of file channel.c.

10847{
10848 RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
10849 SCOPED_MUTEX(lock, &channel_move_lock);
10850
10851 if (dest == source) {
10852 ast_log(LOG_WARNING, "Can't move channel '%s' into itself!\n",
10853 ast_channel_name(dest));
10854 return -1;
10855 }
10856
10857 ast_channel_lock_both(dest, source);
10858
10859 if (ast_test_flag(ast_channel_flags(dest), AST_FLAG_ZOMBIE)
10860 || ast_test_flag(ast_channel_flags(source), AST_FLAG_ZOMBIE)) {
10861 /* Zombies! Run! */
10862 ast_log(LOG_WARNING,
10863 "Can't move channel. One or both is dead (%s <-- %s)\n",
10864 ast_channel_name(dest), ast_channel_name(source));
10865 ast_channel_unlock(source);
10866 ast_channel_unlock(dest);
10867 return -1;
10868 }
10869
10870 ast_channel_masq_set(dest, source);
10871 ast_channel_masqr_set(source, dest);
10872
10873 blob = ast_json_pack("{s: s}",
10874 "newchanneluniqueid", ast_channel_uniqueid(dest));
10875 ast_channel_publish_blob(source, ast_channel_masquerade_type(), blob);
10876
10877 ast_channel_unlock(dest);
10878 ast_channel_unlock(source);
10879
10880 channel_do_masquerade(dest, source);
10881 return 0;
10882}
channel_do_masquerade
static void channel_do_masquerade(struct ast_channel *original, struct ast_channel *clonechan)
Masquerade a channel.
Definition channel.c:6881
channel_move_lock
static ast_mutex_t channel_move_lock
Definition channel.c:10844
ast_channel_masquerade_type
struct stasis_message_type * ast_channel_masquerade_type(void)
Message type for when a channel is being masqueraded.
ast_channel_publish_blob
void ast_channel_publish_blob(struct ast_channel *chan, struct stasis_message_type *type, struct ast_json *blob)
Publish a channel blob message.
Definition stasis_channels.c:1161
ast_json_unref
void ast_json_unref(struct ast_json *value)
Decrease refcount on value. If refcount reaches zero, value is freed.
Definition json.c:73
ast_json_pack
struct ast_json * ast_json_pack(char const *format,...)
Helper for creating complex JSON values.
Definition json.c:612
SCOPED_MUTEX
#define SCOPED_MUTEX(varname, lock)
scoped lock specialization for mutexes
Definition lock.h:596
ast_json
Abstract JSON element (object, array, string, int, ...).

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 429 of file channel_internal_api.c.

430{
431 return chan->music_state;
432}
ast_channel::music_state
void * music_state
Definition channel_private.h:51

References ast_channel::music_state.

Referenced by __ast_read(), ast_channel_destructor(), local_ast_moh_cleanup(), local_ast_moh_start(), local_ast_moh_stop(), moh_alloc(), moh_files_alloc(), moh_files_generator(), moh_files_next(), 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 433 of file channel_internal_api.c.

434{
435 chan->music_state = value;
436}

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(), _create_event_MEDIA_START(), _dahdi_get_index(), _websocket_request_hangup(), 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(), add_inheritable_header(), 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_callwaiting_deluxe(), 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_exec(), app_notify(), append_channel_vars(), aqm_exec(), ari_bridges_play_new(), ari_originate_dial(), assign_uuid(), ast_agi_send(), ast_answer(), ast_ari_create_per_call_websocket(), 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_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_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_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_TEST_DEFINE(), AST_TEST_DEFINE(), 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_read(), audiosocket_run(), audiosocket_send_dtmf(), audiosocket_write(), 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_dissolve(), 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(), by_name_cb(), 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_cmp_cb(), 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(), channelstorage_name_cb(), comeback_goto(), common_exec(), complete_bridge_participant(), complete_confbridge_participant(), conf_exec(), conf_play(), conf_queue_dtmf(), conf_run(), 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(), dahdichan_helper(), deactivate_silence_generator(), defer_action(), defer_incoming_sdp_stream(), dequeue_frame(), 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_ids_conflict(), do_monitor(), do_waiting(), 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_read_verification(), func_response_read_header(), func_response_read_headers(), func_write_attestation(), func_write_header(), func_write_param(), 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_command(), handle_dump_frames(), handle_frame(), handle_gosub(), handle_incoming_request(), handle_participant_join(), handle_recordfile(), handle_showchan(), handle_softhangup(), handle_streamfile(), hangup(), hash_cb(), 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(), incoming_ws_http_callback(), 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(), 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_next(), 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(), outgoing_request(), 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(), pjsip_transfer_handling_write(), play_message(), play_moh_exec(), play_on_channel(), play_record_review(), playback_exec(), playtones_alloc(), polarity_read(), polarity_write(), pre_bridge_setup(), print_escaped_uri(), print_queue(), print_subchannel(), prnt_channel_key(), process_binary_message(), process_text_message(), publish_app_cdr_message(), publish_transfer_fail(), publish_transfer_success(), publish_transfer_threeway(), queue_exec(), queue_frame_from_buffer(), queue_function_queuegetchannel(), queue_option_frame(), read_from_ws_and_queue(), read_mf_digits(), read_pjsip(), read_sf_digits(), readexten_exec(), realtime_exec(), receive_dtmf_digits(), receivefax_exec(), receivefax_t38_init(), record_exec(), recording_info_read(), refer_ari_progress_framehook(), refer_attended_task(), refer_blind_callback(), refer_incoming_ari_request(), 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_header(), remove_hold_intercept(), remove_inheritable_header(), 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_broadcast_event(), send_direct_media_request(), send_dtmf_end_event(), 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_channel_timer(), 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_spying(), start_whispering(), start_whispering(), stasis_app_exec(), stasis_broadcast_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_header(), update_inheritable_header(), update_qe_rule(), user_chan_cb(), vm_exec(), vm_execmain(), vm_options(), wait_exec(), wait_for_answer(), wait_for_answer(), wait_for_signal_or_hangup(), wait_for_winner(), waitsignal_exec(), waitstream_control(), waitstream_core(), webchan_call(), webchan_hangup(), webchan_read(), webchan_request(), webchan_write(), websocket_handoff_to_channel(), 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_namestring that you wish to turn into a dial string. This string will be edited in place.

Definition at line 6863 of file channel.c.

6864{
6865 char *dash;
6866
6867 /* Truncate after the dash */
6868 dash = strrchr(channel_name, '-');
6869 if (dash) {
6870 *dash = '\0';
6871 }
6872}

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 957 of file channel_internal_api.c.

958{
959 return chan->named_callgroups;
960}
ast_channel::named_callgroups
struct ast_namedgroups * named_callgroups
Definition channel_private.h:128

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 961 of file channel_internal_api.c.

962{
963 ast_unref_namedgroups(chan->named_callgroups);
964 chan->named_callgroups = ast_ref_namedgroups(value);
965}

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 966 of file channel_internal_api.c.

967{
968 return chan->named_pickupgroups;
969}
ast_channel::named_pickupgroups
struct ast_namedgroups * named_pickupgroups
Definition channel_private.h:129

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 970 of file channel_internal_api.c.

971{
972 ast_unref_namedgroups(chan->named_pickupgroups);
973 chan->named_pickupgroups = ast_ref_namedgroups(value);
974}

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 504 of file channel_internal_api.c.

505{
506 return chan->nativeformats;
507}
ast_channel::nativeformats
struct ast_format_cap * nativeformats
Definition channel_private.h:168

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 544 of file channel_internal_api.c.

546{
547 SCOPE_ENTER(2, "%s: %sFormats: %s\n", S_OR(ast_channel_name(chan), "<initializing>"),
548 S_COR(ast_channel_is_multistream(chan), "Multistream", ""),
549 ast_str_tmp(128, ast_format_cap_get_names(value, &STR_TMP)));
550
551 ast_assert(chan != NULL);
552
553 ao2_replace(chan->nativeformats, value);
554
555 /* If chan->stream_topology is NULL, the channel is being destroyed
556 * and topology is destroyed.
557 */
558 if (!chan->stream_topology) {
559 SCOPE_EXIT_RTN("Channel is being initialized or destroyed\n");
560 }
561
562 if (!ast_channel_is_multistream(chan) || !value) {
563 struct ast_stream_topology *new_topology;
564
565 new_topology = ast_stream_topology_create_from_format_cap(value);
566 ast_channel_internal_set_stream_topology(chan, new_topology);
567 SCOPE_EXIT_RTN("New %stopology set\n", value ? "" : "empty ");
568 }
569 SCOPE_EXIT_RTN("Set native formats but not topology\n");
570}
ao2_replace
#define ao2_replace(dst, src)
Replace one object reference with another cleaning up the original.
Definition astobj2.h:501
ast_channel_internal_set_stream_topology
void ast_channel_internal_set_stream_topology(struct ast_channel *chan, struct ast_stream_topology *topology)
Definition channel_internal_api.c:525
ast_channel_is_multistream
int ast_channel_is_multistream(struct ast_channel *chan)
Determine if a channel is multi-stream capable.
Definition channel_internal_api.c:1591
ast_format_cap_get_names
const char * ast_format_cap_get_names(const struct ast_format_cap *cap, struct ast_str **buf)
Get the names of codecs of a set of formats.
Definition format_cap.c:734
SCOPE_EXIT_RTN
#define SCOPE_EXIT_RTN(...)
Definition include/asterisk/logger.h:1032
SCOPE_ENTER
#define SCOPE_ENTER(level,...)
Definition include/asterisk/logger.h:1008
ast_stream_topology_create_from_format_cap
struct ast_stream_topology * ast_stream_topology_create_from_format_cap(struct ast_format_cap *cap)
A helper function that, given a format capabilities structure, creates a topology and separates the m...
Definition stream.c:851
S_COR
#define S_COR(a, b, c)
returns the equivalent of logic or for strings, with an additional boolean check: second one if not e...
Definition strings.h:87
ast_str_tmp
#define ast_str_tmp(init_len, __expr)
Provides a temporary ast_str and returns a copy of its buffer.
Definition strings.h:1189

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_TEST_DEFINE(), 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_eval_function(), 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(), unistim_rtp_read(), and webchan_request().

◆ 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
aThe linkedid value of the first channel to compare
bThe linkedid value of the second channel to compare
Return values
NULLon failure
Theoldest linkedid value
Since
12.0.0

◆ ast_channel_oldwriteformat()

struct ast_format * ast_channel_oldwriteformat ( struct ast_channel *  chan)

Definition at line 711 of file channel_internal_api.c.

712{
713 return chan->oldwriteformat;
714}
ast_channel::oldwriteformat
struct ast_format * oldwriteformat
Definition channel_private.h:150

References ast_channel::oldwriteformat.

Referenced by ast_stopstream().

◆ ast_channel_outsmpl()

unsigned long ast_channel_outsmpl ( const struct ast_channel *  chan)

Definition at line 413 of file channel_internal_api.c.

414{
415 return chan->outsmpl;
416}
ast_channel::outsmpl
unsigned long outsmpl
Definition channel_private.h:139

References ast_channel::outsmpl.

◆ ast_channel_outsmpl_set()

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

Definition at line 417 of file channel_internal_api.c.

418{
419 chan->outsmpl = value;
420}

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 588 of file channel_internal_api.c.

589{
590 return chan->pbx;
591}
ast_channel::pbx
struct ast_pbx * pbx
Definition channel_private.h:64

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 592 of file channel_internal_api.c.

593{
594 chan->pbx = value;
595}

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 949 of file channel_internal_api.c.

950{
951 return chan->pickupgroup;
952}
ast_channel::pickupgroup
ast_group_t pickupgroup
Definition channel_private.h:127

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 953 of file channel_internal_api.c.

954{
955 chan->pickupgroup = value;
956}

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 316 of file channel_internal_api.c.

317{
318 return chan->priority;
319}
ast_channel::priority
int priority
Definition channel_private.h:154

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(), 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(), setup_peer_after_bridge_goto(), and setup_peer_after_bridge_goto().

◆ ast_channel_priority_set()

void ast_channel_priority_set ( struct ast_channel *  chan,
int  value 
)

Definition at line 320 of file channel_internal_api.c.

321{
322 chan->priority = value;
323 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_DIALPLAN);
324}

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(), 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 7478 of file channel.c.

7479{
7480 int res;
7481
7482 ast_channel_lock(chan);
7483 if (!ast_channel_tech(chan)->queryoption) {
7484 errno = ENOSYS;
7485 ast_channel_unlock(chan);
7486 return -1;
7487 }
7488
7489 if (block)
7490 ast_log(LOG_ERROR, "XXX Blocking not implemented yet XXX\n");
7491
7492 res = ast_channel_tech(chan)->queryoption(chan, option, data, datalen);
7493 ast_channel_unlock(chan);
7494
7495 return res;
7496}
ast_channel_tech::queryoption
int(*const queryoption)(struct ast_channel *chan, int option, void *data, int *datalen)
Query a given option. Called with chan locked.
Definition channel.h:800

References ast_channel_lock, 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
chanAsterisk channel to indicate connected line information
connectedConnected line information
updateWhat connected line information to update. NULL if all.

Definition at line 9282 of file channel.c.

9283{
9284 unsigned char data[1024]; /* This should be large enough */
9285 size_t datalen;
9286
9287 datalen = ast_connected_line_build_data(data, sizeof(data), connected, update);
9288 if (datalen == (size_t) -1) {
9289 return;
9290 }
9291
9292 ast_queue_control_data(chan, AST_CONTROL_CONNECTED_LINE, data, datalen);
9293}
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.
Definition channel.c:1296
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.
Definition channel.c:8873

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
chanAsterisk channel to indicate redirecting id information
redirectingRedirecting id information
updateWhat redirecting information to update. NULL if all.

Definition at line 10473 of file channel.c.

10474{
10475 unsigned char data[1024]; /* This should be large enough */
10476 size_t datalen;
10477
10478 datalen = ast_redirecting_build_data(data, sizeof(data), redirecting, update);
10479 if (datalen == (size_t) -1) {
10480 return;
10481 }
10482
10483 ast_queue_control_data(chan, AST_CONTROL_REDIRECTING, data, datalen);
10484}
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.
Definition channel.c:9444

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 715 of file channel_internal_api.c.

716{
717 return chan->rawreadformat;
718}
ast_channel::rawreadformat
struct ast_format * rawreadformat
Definition channel_private.h:171

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 719 of file channel_internal_api.c.

720{
721 return chan->rawwriteformat;
722}
ast_channel::rawwriteformat
struct ast_format * rawwriteformat
Definition channel_private.h:172

References ast_channel::rawwriteformat.

Referenced by ari_bridges_play_new(), 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 723 of file channel_internal_api.c.

724{
725 return chan->readformat;
726}
ast_channel::readformat
struct ast_format * readformat
Definition channel_private.h:169

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 743 of file channel_internal_api.c.

744{
745 return &chan->readq;
746}
ast_channel::readq
struct ast_readq_list readq
Definition channel_private.h:132

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 620 of file channel_internal_api.c.

621{
622 return chan->readtrans;
623}
ast_channel::readtrans
struct ast_trans_pvt * readtrans
Definition channel_private.h:66

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 624 of file channel_internal_api.c.

625{
626 chan->readtrans = value;
627}

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
reasonThe integer argument, usually taken from AST_CONTROL_ macros
Returns
char pointer explaining the code

Definition at line 5849 of file channel.c.

5850{
5851 switch (reason) /* the following appear to be the only ones actually returned by request_and_dial */
5852 {
5853 case 0:
5854 return "Call Failure (not BUSY, and not NO_ANSWER, maybe Circuit busy or down?)";
5855 case AST_CONTROL_HANGUP:
5856 return "Hangup";
5857 case AST_CONTROL_RING:
5858 return "Local Ring";
5859 case AST_CONTROL_RINGING:
5860 return "Remote end Ringing";
5861 case AST_CONTROL_ANSWER:
5862 return "Remote end has Answered";
5863 case AST_CONTROL_BUSY:
5864 return "Remote end is Busy";
5865 case AST_CONTROL_CONGESTION:
5866 return "Congestion (circuits busy)";
5867 default:
5868 return "Unknown Reason!!";
5869 }
5870}

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 775 of file channel_internal_api.c.

776{
777 return &chan->redirecting;
778}
ast_channel::redirecting
struct ast_party_redirecting redirecting
Redirecting/Diversion information.
Definition channel_private.h:122

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 783 of file channel_internal_api.c.

784{
785 return ast_party_id_merge(&chan->redirecting.from, &chan->redirecting.priv_from);
786}
ast_party_redirecting::priv_from
struct ast_party_id priv_from
Who is redirecting the call (Sent to the party the call is redirected toward) - private representatio...
Definition channel.h:538
ast_party_redirecting::from
struct ast_party_id from
Who is redirecting the call (Sent to the party the call is redirected toward)
Definition channel.h:529

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 779 of file channel_internal_api.c.

780{
781 return ast_party_id_merge(&chan->redirecting.orig, &chan->redirecting.priv_orig);
782}
ast_party_redirecting::orig
struct ast_party_id orig
Who originally redirected the call (Sent to the party the call is redirected toward)
Definition channel.h:526
ast_party_redirecting::priv_orig
struct ast_party_id priv_orig
Who originally redirected the call (Sent to the party the call is redirected toward) - private repres...
Definition channel.h:535

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 787 of file channel_internal_api.c.

788{
789 return ast_party_id_merge(&chan->redirecting.to, &chan->redirecting.priv_to);
790}
ast_party_redirecting::priv_to
struct ast_party_id priv_to
Call is redirecting to a new party (Sent to the caller) - private representation.
Definition channel.h:541
ast_party_redirecting::to
struct ast_party_id to
Call is redirecting to a new party (Sent to the caller)
Definition channel.h:532

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 826 of file channel_internal_api.c.

827{
828 chan->redirecting = *value;
829 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER);
830}

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_chanChannel to place into autoservice while the subroutine is running. It is perfectly safe for this to be NULL
sub_chanThe channel to run the subroutine on. Also the channel from which we determine which subroutine we need to run.
redirecting_infoEither an ast_party_redirecting or ast_frame pointer of type AST_CONTROL_REDIRECTING
is_frameIf true, then redirecting_info is an ast_frame pointer, otherwise it is an ast_party_redirecting pointer.
Return values
0Success
-1Either the subroutine does not exist, or there was an error while attempting to run the subroutine

Definition at line 10559 of file channel.c.

10560{
10561 const char *sub;
10562 const char *sub_args;
10563 int retval;
10564
10565 ast_channel_lock(sub_chan);
10566 sub = pbx_builtin_getvar_helper(sub_chan, "REDIRECTING_SEND_SUB");
10567 sub = ast_strdupa(S_OR(sub, ""));
10568 sub_args = pbx_builtin_getvar_helper(sub_chan, "REDIRECTING_SEND_SUB_ARGS");
10569 sub_args = ast_strdupa(S_OR(sub_args, ""));
10570
10571 if (ast_strlen_zero(sub)) {
10572 ast_channel_unlock(sub_chan);
10573 return -1;
10574 }
10575
10576 if (is_frame) {
10577 const struct ast_frame *frame = redirecting_info;
10578
10579 ast_redirecting_parse_data(frame->data.ptr, frame->datalen, ast_channel_redirecting(sub_chan));
10580 } else {
10581 const struct ast_party_redirecting *redirecting = redirecting_info;
10582
10583 ast_party_redirecting_copy(ast_channel_redirecting(sub_chan), redirecting);
10584 }
10585 ast_channel_unlock(sub_chan);
10586
10587 channel_set_intercept_mode(1);
10588 retval = ast_app_run_sub(autoservice_chan, sub_chan, sub, sub_args, 0);
10589 channel_set_intercept_mode(0);
10590 if (!retval) {
10591 struct ast_party_redirecting saved_redirecting;
10592
10593 ast_party_redirecting_init(&saved_redirecting);
10594 ast_channel_lock(sub_chan);
10595 ast_party_redirecting_copy(&saved_redirecting, ast_channel_redirecting(sub_chan));
10596 ast_channel_unlock(sub_chan);
10597 ast_channel_update_redirecting(sub_chan, &saved_redirecting, NULL);
10598 ast_party_redirecting_free(&saved_redirecting);
10599 }
10600
10601 return retval;
10602}
ast_party_redirecting_init
void ast_party_redirecting_init(struct ast_party_redirecting *init)
Initialize the given redirecting structure.
Definition channel.c:2109
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.
Definition channel.c:10460
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.
Definition channel.c:9655
ast_party_redirecting_free
void ast_party_redirecting_free(struct ast_party_redirecting *doomed)
Destroy the redirecting information contents.
Definition channel.c:2166

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, S_OR, and sub.

Referenced by bridge_channel_handle_control(), call_forward_inherit(), do_forward(), handle_frame(), wait_for_answer(), 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
techStructure 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 540 of file channel.c.

541{
542 struct chanlist *chan;
543
544 AST_RWLIST_WRLOCK(&backends);
545
546 AST_RWLIST_TRAVERSE(&backends, chan, list) {
547 if (!strcasecmp(tech->type, chan->tech->type)) {
548 ast_log(LOG_WARNING, "Already have a handler for type '%s'\n", tech->type);
549 AST_RWLIST_UNLOCK(&backends);
550 return -1;
551 }
552 }
553
554 if (!(chan = ast_calloc(1, sizeof(*chan)))) {
555 AST_RWLIST_UNLOCK(&backends);
556 return -1;
557 }
558 chan->tech = tech;
559 AST_RWLIST_INSERT_HEAD(&backends, chan, list);
560
561 ast_debug(5, "Registered handler for '%s' (%s)\n", chan->tech->type, chan->tech->description);
562
563 ast_verb(5, "Registered channel type '%s' (%s)\n", chan->tech->type, chan->tech->description);
564
565 AST_RWLIST_UNLOCK(&backends);
566
567 return 0;
568}
ast_verb
#define ast_verb(level,...)
Definition include/asterisk/logger.h:467
AST_RWLIST_WRLOCK
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition linkedlists.h:52
AST_RWLIST_UNLOCK
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition linkedlists.h:151
AST_RWLIST_TRAVERSE
#define AST_RWLIST_TRAVERSE
Definition linkedlists.h:494
AST_RWLIST_INSERT_HEAD
#define AST_RWLIST_INSERT_HEAD
Definition linkedlists.h:718
ast_channel_tech::type
const char *const type
Definition channel.h:649
ast_channel_tech::description
const char *const description
Definition channel.h:650
backends
the list of registered channel types
Definition channel.c:125
chanlist::chan
struct ast_channel * chan
Definition app_dial.c:806
chanlist::list
struct chanlist::@349 list
chanlist::tech
const char * tech
Definition app_dial.c:810

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(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), load_module(), 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
NULLconvenient for clearing invalid pointers
Note
Absolutely NO channel locks should be held before calling this function.
Since
1.8

Definition at line 1571 of file channel.c.

1572{
1573 /* Safe, even if already unlinked. */
1574 ast_channel_unlink(chan);
1575 return ast_channel_unref(chan);
1576}
ast_channel_unlink
void ast_channel_unlink(struct ast_channel *chan)
Remove a channel from the global channels container.
Definition channel.c:10709
ast_channel_unref
#define ast_channel_unref(c)
Decrease channel reference count.
Definition channel.h:3019

References ast_channel_unlink(), and ast_channel_unref.

Referenced by ast_iax2_new(), ast_unreal_new_channels(), destroy_msg_q_chan(), do_notify(), rec_request(), safe_channel_release(), safe_channel_release(), safe_channel_release(), safe_channel_release(), 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
chanNew channel to get accountcodes setup.
requestorRequesting channel to get accountcodes from.
relationshipWhat 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.

6454{
6455 channel_req_accountcodes(chan, requestor, relationship, 0);
6456}
channel_req_accountcodes
static void channel_req_accountcodes(struct ast_channel *chan, const struct ast_channel *requestor, enum ast_channel_requestor_relationship relationship, int precious)
Definition channel.c:6395

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
chanNew channel to get accountcodes setup.
requestorRequesting channel to get accountcodes from.
relationshipWhat 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.

6459{
6460 channel_req_accountcodes(chan, requestor, relationship, 1);
6461}

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
chanThe channel to change
topologyThe new stream topology
change_sourceThe source that initiated the change
Note
Absolutely NO channel locks should be held before calling this function.
Return values
0request has been accepted to be attempted
-1request 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 11146 of file channel.c.

11148{
11149 int res;
11150
11151 ast_assert(chan != NULL);
11152 ast_assert(topology != NULL);
11153
11154 ast_channel_lock(chan);
11155 if (!ast_channel_is_multistream(chan) || !ast_channel_tech(chan)->indicate) {
11156 ast_channel_unlock(chan);
11157 return -1;
11158 }
11159
11160 if (ast_stream_topology_equal(ast_channel_get_stream_topology(chan), topology)) {
11161 ast_debug(2, "%s: Topologies already match. Current: %s Requested: %s\n",
11162 ast_channel_name(chan),
11163 ast_str_tmp(256, ast_stream_topology_to_str(ast_channel_get_stream_topology(chan), &STR_TMP)),
11164 ast_str_tmp(256, ast_stream_topology_to_str(topology, &STR_TMP)));
11165 ast_channel_unlock(chan);
11166 return 0;
11167 }
11168
11169 ast_channel_internal_set_stream_topology_change_source(chan, change_source);
11170
11171 res = ast_channel_tech(chan)->indicate(chan, AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE, topology, sizeof(topology));
11172 ast_channel_unlock(chan);
11173 return res;
11174}
indicate
static int indicate(void *data)
Definition chan_pjsip.c:1335
ast_channel_internal_set_stream_topology_change_source
void ast_channel_internal_set_stream_topology_change_source(struct ast_channel *chan, void *change_source)
Definition channel_internal_api.c:533
AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE
@ AST_CONTROL_STREAM_TOPOLOGY_REQUEST_CHANGE
Definition include/asterisk/frame.h:312
ast_stream_topology_to_str
const char * ast_stream_topology_to_str(const struct ast_stream_topology *topology, struct ast_str **buf)
Get a string representing the topology for debugging/display purposes.
Definition stream.c:939
ast_stream_topology_equal
int ast_stream_topology_equal(const struct ast_stream_topology *left, const struct ast_stream_topology *right)
Compare two stream topologies to see if they are equal.
Definition stream.c:699
ast_channel_tech::indicate
int(*const indicate)(struct ast_channel *c, int condition, const void *data, size_t datalen)
Indicate a particular condition (e.g. AST_CONTROL_BUSY or AST_CONTROL_RINGING or AST_CONTROL_CONGESTI...
Definition channel.h:791

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_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(), 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 325 of file channel_internal_api.c.

326{
327 return chan->rings;
328}
ast_channel::rings
int rings
Definition channel_private.h:153

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 329 of file channel_internal_api.c.

330{
331 chan->rings = value;
332}

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 596 of file channel_internal_api.c.

597{
598 return chan->sched;
599}
ast_channel::sched
struct ast_sched_context * sched
Definition channel_private.h:59

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 600 of file channel_internal_api.c.

601{
602 chan->sched = value;
603}

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.

6648{
6649 if (ast_channel_tech(chan)->send_html)
6650 return ast_channel_tech(chan)->send_html(chan, subclass, data, datalen);
6651 return -1;
6652}
ast_channel_tech::send_html
int(*const send_html)(struct ast_channel *chan, int subclass, const char *data, int len)
Send HTML data.
Definition channel.h:782

References 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 259 of file channel_internal_api.c.

260{
261 return chan->sending_dtmf_digit;
262}
ast_channel::sending_dtmf_digit
char sending_dtmf_digit
Definition channel_private.h:191

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 263 of file channel_internal_api.c.

264{
265 chan->sending_dtmf_digit = value;
266}

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 268 of file channel_internal_api.c.

269{
270 return chan->sending_dtmf_tv;
271}
ast_channel::sending_dtmf_tv
struct timeval sending_dtmf_tv
Definition channel_private.h:192

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 272 of file channel_internal_api.c.

273{
274 chan->sending_dtmf_tv = value;
275}

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.

6655{
6656 return ast_channel_sendhtml(chan, AST_HTML_URL, url, strlen(url) + 1);
6657}
ast_channel_sendhtml
int ast_channel_sendhtml(struct ast_channel *chan, int subclass, const char *data, int datalen)
Sends HTML on given channel Send HTML or URL on link.
Definition channel.c:6647
AST_HTML_URL
#define AST_HTML_URL
Definition include/asterisk/frame.h:247

References ast_channel_sendhtml(), AST_HTML_URL, and url.

Referenced by dial_exec_full(), and try_calling().

◆ ast_channel_set_ari_var_reportable()

int ast_channel_set_ari_var_reportable ( struct ast_channel *  chan,
const char *  variable,
int  report_events 
)

Set whether a channel variable should be included in REST events on the channel.

Since
20.20.0
22.10.0
23.4.0
Parameters
chanChannel to update.
variableVariable name or dialplan function expression.
report_eventsNon-zero to include in REST events, zero to omit.
Return values
0on success
-1on failure

Definition at line 7906 of file channel.c.

7907{
7908 char *var_str;
7909 size_t i, count;
7910
7911 SCOPED_CHANNELLOCK(lock, chan);
7912
7913 if (ast_strlen_zero(variable)) {
7914 return -1;
7915 }
7916
7917 count = ast_channel_internal_ari_reportable_vars_count(chan);
7918 for (i = 0; i < count; ++i) {
7919 var_str = ast_channel_internal_ari_reportable_vars_get(chan, i);
7920 if (!strcmp(var_str, variable)) {
7921 if (!report_events) {
7922 var_str = ast_channel_internal_ari_reportable_vars_remove(chan, i);
7923 ast_free(var_str);
7924 }
7925 return 0;
7926 }
7927 }
7928
7929 if (!report_events) {
7930 return 0;
7931 }
7932
7933 var_str = ast_strdup(variable);
7934 if (!var_str) {
7935 return -1;
7936 }
7937
7938 if (ast_channel_internal_ari_reportable_vars_append(chan, var_str)) {
7939 ast_free(var_str);
7940 return -1;
7941 }
7942
7943 return 0;
7944}
ast_strdup
#define ast_strdup(str)
A wrapper for strdup()
Definition astmm.h:241

References ast_channel_internal_ari_reportable_vars_append(), ast_channel_internal_ari_reportable_vars_count(), ast_channel_internal_ari_reportable_vars_get(), ast_channel_internal_ari_reportable_vars_remove(), ast_free, ast_strdup, ast_strlen_zero(), lock, and SCOPED_CHANNELLOCK.

Referenced by app_control_set_channel_var(), ari_channels_handle_originate_with_id(), and ast_ari_channels_create().

◆ 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
varcNumber of variable names.
varsArray of variable names.

Definition at line 7901 of file channel.c.

7902{
7903 channel_set_external_vars(&ari_vars, varc, vars);
7904}
channel_set_external_vars
static void channel_set_external_vars(struct external_vars *channelvars, size_t varc, char **vars)
Definition channel.c:7874

References ari_vars, and channel_set_external_vars().

Referenced by general_apply().

◆ 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
chanAsterisk channel to set caller id information
callerCaller id information
updateWhat caller information to update. NULL if all.
Note
The channel does not need to be locked before calling this function.

Definition at line 7395 of file channel.c.

7396{
7397 if (ast_channel_caller(chan) == caller) {
7398 /* Don't set to self */
7399 return;
7400 }
7401
7402 ast_channel_lock(chan);
7403 ast_party_caller_set(ast_channel_caller(chan), caller, update);
7404 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER);
7405 ast_channel_unlock(chan);
7406}
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.
Definition channel.c:1994

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
chanAsterisk channel to set caller id information
callerCaller id information
updateWhat caller information to update. NULL if all.
Note
The channel does not need to be locked before calling this function.

Definition at line 7408 of file channel.c.

7409{
7410 if (ast_channel_caller(chan) == caller) {
7411 /* Don't set to self */
7412 return;
7413 }
7414
7415 ast_channel_lock(chan);
7416 ast_party_caller_set(ast_channel_caller(chan), caller, update);
7417 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER);
7418 ast_channel_publish_snapshot(chan);
7419 ast_channel_unlock(chan);
7420}

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
chanAsterisk channel to set connected line information
connectedConnected line information
updateWhat connected line information to update. NULL if all.
Note
The channel does not need to be locked before calling this function.

Definition at line 8484 of file channel.c.

8485{
8486 if (ast_channel_connected(chan) == connected) {
8487 /* Don't set to self */
8488 return;
8489 }
8490
8491 ast_channel_lock(chan);
8492 ast_party_connected_line_set(ast_channel_connected(chan), connected, update);
8493 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CONNECTED);
8494 ast_channel_publish_snapshot(chan);
8495 ast_channel_unlock(chan);
8496}
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.
Definition channel.c:2041

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

2418{
2419 ast_channel_internal_fd_set(chan, which, fd);
2420 return;
2421}

References ast_channel_internal_fd_set().

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

◆ 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
chanThe channel to set the flag on
flagThe 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 11207 of file channel.c.

11208{
11209 ast_channel_lock(chan);
11210 ast_set_flag(ast_channel_flags(chan), flag);
11211 ast_channel_unlock(chan);
11212}

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
chanWhich channel is having its is_t38_active value set
is_t38_activeNon-zero if T.38 is active

Definition at line 928 of file channel_internal_api.c.

929{
930 ast_channel_lock(chan);
931 ast_channel_set_is_t38_active_nolock(chan, is_t38_active);
932 ast_channel_unlock(chan);
933}
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.
Definition channel_internal_api.c:923

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
chanWhich channel is having its is_t38_active value set
is_t38_activeNon-zero if T.38 is active

Definition at line 923 of file channel_internal_api.c.

924{
925 chan->is_t38_active = !!is_t38_active;
926}

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
varcNumber of variable names.
varsArray of variable names.

Definition at line 7896 of file channel.c.

7897{
7898 channel_set_external_vars(&ami_vars, varc, vars);
7899}

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 691 of file channel_internal_api.c.

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

References ao2_replace, and ast_channel::oldwriteformat.

Referenced by ast_channel_destructor(), and openstream_internal().

◆ ast_channel_set_rawreadformat()

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

Definition at line 695 of file channel_internal_api.c.

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

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_eval_function(), 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(), unistim_new(), and webchan_request().

◆ ast_channel_set_rawwriteformat()

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

Definition at line 699 of file channel_internal_api.c.

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

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_eval_function(), 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(), unistim_new(), and webchan_request().

◆ ast_channel_set_readformat()

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

Definition at line 703 of file channel_internal_api.c.

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

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_eval_function(), 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(), unistim_new(), and webchan_request().

◆ 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
chanAsterisk channel to set redirecting id information
redirectingRedirecting id information
updateWhat redirecting information to update. NULL if all.
Note
The channel does not need to be locked before calling this function.

Definition at line 9295 of file channel.c.

9296{
9297 if (ast_channel_redirecting(chan) == redirecting) {
9298 /* Don't set to self */
9299 return;
9300 }
9301
9302 ast_channel_lock(chan);
9303 ast_party_redirecting_set(ast_channel_redirecting(chan), redirecting, update);
9304 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_CALLER);
9305 ast_channel_publish_snapshot(chan);
9306 ast_channel_unlock(chan);
9307}
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.
Definition channel.c:2153

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
chanThe channel to set the stream topology on
topologyThe 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-NULLSuccess
NULLfailure

Definition at line 1539 of file channel_internal_api.c.

1541{
1542 struct ast_stream_topology *new_topology;
1543 SCOPE_ENTER(1, "%s: %s\n", ast_channel_name(chan),
1544 ast_str_tmp(256, ast_stream_topology_to_str(topology, &STR_TMP)));
1545
1546 ast_assert(chan != NULL);
1547
1548 /* A non-MULTISTREAM channel can't manipulate topology directly */
1549 ast_assert(ast_channel_is_multistream(chan));
1550
1551 /* Unless the channel is being destroyed, we always want a topology on
1552 * it even if its empty.
1553 */
1554 if (!topology) {
1555 new_topology = ast_stream_topology_alloc();
1556 } else {
1557 new_topology = topology;
1558 }
1559
1560 if (new_topology) {
1561 ast_channel_internal_set_stream_topology(chan, new_topology);
1562 }
1563
1564 SCOPE_EXIT_RTN_VALUE(new_topology, "Used %s topology\n", topology ? "provided" : "empty");
1565}
SCOPE_EXIT_RTN_VALUE
#define SCOPE_EXIT_RTN_VALUE(__return_value,...)
Definition include/asterisk/logger.h:1036
ast_stream_topology_alloc
struct ast_stream_topology * ast_stream_topology_alloc(void)
Create a stream topology.
Definition stream.c:652

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_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
chanWhich channel is having its unbridged value set
valueWhat the unbridge value is being set to

Definition at line 901 of file channel_internal_api.c.

902{
903 ast_channel_lock(chan);
904 ast_channel_set_unbridged_nolock(chan, value);
905 ast_channel_unlock(chan);
906}
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.
Definition channel_internal_api.c:895

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
chanWhich channel is having its unbridged value set
valueWhat the unbridge value is being set to

Definition at line 895 of file channel_internal_api.c.

896{
897 chan->unbridged = !!value;
898 ast_queue_frame(chan, &ast_null_frame);
899}
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.
Definition channel.c:1171
ast_null_frame
struct ast_frame ast_null_frame
Definition main/frame.c:79
ast_channel::unbridged
char unbridged
Definition channel_private.h:187

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 707 of file channel_internal_api.c.

708{
709 ao2_replace(chan->writeformat, format);
710}
ast_channel::writeformat
struct ast_format * writeformat
Definition channel_private.h:170

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_eval_function(), 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(), unistim_new(), and webchan_request().

◆ 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
channelchannel to set options on
optionoption to change
datadata specific to option
datalenlength of the data
blockblocking 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 7458 of file channel.c.

7459{
7460 int res;
7461
7462 ast_channel_lock(chan);
7463 if (!ast_channel_tech(chan)->setoption) {
7464 errno = ENOSYS;
7465 ast_channel_unlock(chan);
7466 return -1;
7467 }
7468
7469 if (block)
7470 ast_log(LOG_ERROR, "XXX Blocking not implemented yet XXX\n");
7471
7472 res = ast_channel_tech(chan)->setoption(chan, option, data, datalen);
7473 ast_channel_unlock(chan);
7474
7475 return res;
7476}
ast_channel_tech::setoption
int(*const setoption)(struct ast_channel *chan, int option, void *data, int datalen)
Set a given option. Called with chan locked.
Definition channel.h:797

References ast_channel_lock, 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(), 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
chanchannel on which to check for hang up
offsetoffset 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 511 of file channel.c.

512{
513 if (ast_tvzero(offset)) {
514 ast_channel_whentohangup_set(chan, &offset);
515 } else {
516 struct timeval tv = ast_tvadd(offset, ast_tvnow());
517 ast_channel_whentohangup_set(chan, &tv);
518 }
519 ast_queue_frame(chan, &ast_null_frame);
520 return;
521}
ast_queue_frame
int ast_queue_frame(struct ast_channel *chan, struct ast_frame *fin)
Queue one or more frames to a channel's frame queue.
Definition channel.c:1171

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 1596 of file channel_internal_api.c.

1597{
1598 return chan->snapshot;
1599}
ast_channel::snapshot
struct ast_channel_snapshot * snapshot
Definition channel_private.h:199

References ast_channel::snapshot.

◆ ast_channel_snapshot_segment_flags()

struct ast_flags * ast_channel_snapshot_segment_flags ( struct ast_channel *  chan)

Definition at line 1607 of file channel_internal_api.c.

1608{
1609 return &chan->snapshot_segment_flags;
1610}
ast_channel::snapshot_segment_flags
struct ast_flags snapshot_segment_flags
Definition channel_private.h:200

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 1601 of file channel_internal_api.c.

1602{
1603 ao2_cleanup(chan->snapshot);
1604 chan->snapshot = ao2_bump(snapshot);
1605}

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 864 of file channel_internal_api.c.

865{
866 return chan->softhangup;
867}
ast_channel::softhangup
int softhangup
Definition channel_private.h:145

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(), ast_explicit_goto(), collect_digits(), gosub_run(), park_and_announce_app_exec(), park_app_exec(), pbx_extension_helper(), 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 872 of file channel_internal_api.c.

873{
874 chan->softhangup |= value;
875}

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 876 of file channel_internal_api.c.

877{
878 chan ->softhangup &= ~value;
879}

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 868 of file channel_internal_api.c.

869{
870 chan->softhangup = value;
871}

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
chanchannel on which to hang up
causecodecause code to use (Zero if don't use cause code)

Definition at line 469 of file channel.c.

470{
471 ast_channel_lock(chan);
472
473 if (causecode > 0) {
474 ast_debug(1, "Setting hangupcause of channel %s to %d (is %d now)\n",
475 ast_channel_name(chan), causecode, ast_channel_hangupcause(chan));
476
477 ast_channel_hangupcause_set(chan, causecode);
478 }
479
480 ast_softhangup_nolock(chan, AST_SOFTHANGUP_EXPLICIT);
481
482 ast_channel_unlock(chan);
483}
ast_softhangup_nolock
int ast_softhangup_nolock(struct ast_channel *chan, int cause)
Softly hangup a channel, don't lock.
Definition channel.c:2449

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

8341{
8342 struct ast_silence_generator *state;
8343
8344 if (!(state = ast_calloc(1, sizeof(*state)))) {
8345 return NULL;
8346 }
8347
8348 state->old_write_format = ao2_bump(ast_channel_writeformat(chan));
8349
8350 if (ast_set_write_format(chan, ast_format_slin) < 0) {
8351 ast_log(LOG_ERROR, "Could not set write format to SLINEAR\n");
8352 ast_free(state);
8353 return NULL;
8354 }
8355
8356 ast_activate_generator(chan, &silence_generator, state);
8357
8358 ast_debug(1, "Started silence generator on '%s'\n", ast_channel_name(chan));
8359
8360 return state;
8361}
ast_activate_generator
int ast_activate_generator(struct ast_channel *chan, struct ast_generator *gen, void *params)
Definition channel.c:2955
ast_set_write_format
int ast_set_write_format(struct ast_channel *chan, struct ast_format *format)
Sets write format on channel chan.
Definition channel.c:5826
silence_generator
static struct ast_generator silence_generator
Definition channel.c:8330
ast_format_slin
struct ast_format * ast_format_slin
Built-in cached signed linear 8kHz format.
Definition format_cache.c:41

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, and silence_generator.

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 656 of file channel_internal_api.c.

657{
658 return chan->state;
659}

References ast_channel::state.

◆ ast_channel_state_set()

void ast_channel_state_set ( struct ast_channel *  chan,
enum  ast_channel_state 
)

Definition at line 687 of file channel_internal_api.c.

688{
689 chan->state = value;
690}

References ast_channel::state, and value.

Referenced by __ast_channel_alloc_ap(), ast_setstate(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), 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
chanThe channel to operate on
stateThe 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 8386 of file channel.c.

8387{
8388 if (!state) {
8389 return;
8390 }
8391
8392 if (deactivate_silence_generator(chan)) {
8393 ast_debug(1, "Stopped silence generator on '%s'\n", ast_channel_name(chan));
8394 if (ast_set_write_format(chan, state->old_write_format) < 0) {
8395 ast_log(LOG_ERROR, "Could not return write format to its original state\n");
8396 }
8397 }
8398 ao2_cleanup(state->old_write_format);
8399 ast_free(state);
8400}
deactivate_silence_generator
static int deactivate_silence_generator(struct ast_channel *chan)
Definition channel.c:8363

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 488 of file channel_internal_api.c.

489{
490 return chan->stream;
491}
ast_channel::stream
struct ast_filestream * stream
Definition channel_private.h:60

References ast_channel::stream.

Referenced by ast_hangup(), 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_next(), moh_files_readframe(), moh_files_release(), openstream_internal(), 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 492 of file channel_internal_api.c.

493{
494 chan->stream = value;
495}

References ast_channel::stream, and value.

Referenced by ast_hangup(), ast_stopstream(), dictate_exec(), filehelper(), filestream_close(), gen_closestream(), handle_recordfile(), local_ast_moh_stop(), moh_files_next(), 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
chanThe channel to provide notice to
topologyThe new stream topology
Precondition
chan is locked Absolutely NO other channels can be locked.
Return values
0success
-1failure
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 11176 of file channel.c.

11177{
11178 ast_assert(chan != NULL);
11179 ast_assert(topology != NULL);
11180
11181 if (!ast_channel_is_multistream(chan) || !ast_channel_tech(chan)->indicate) {
11182 return -1;
11183 }
11184
11185 return ast_channel_tech(chan)->indicate(chan, AST_CONTROL_STREAM_TOPOLOGY_CHANGED, topology, sizeof(topology));
11186}
AST_CONTROL_STREAM_TOPOLOGY_CHANGED
@ AST_CONTROL_STREAM_TOPOLOGY_CHANGED
Definition include/asterisk/frame.h:313

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

Referenced by __ast_read(), AST_TEST_DEFINE(), 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
chanThe channel to provide notice from
Return values
0success
-1failure
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 11188 of file channel.c.

11189{
11190 int res;
11191 struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_STREAM_TOPOLOGY_CHANGED };
11192
11193 ast_assert(chan != NULL);
11194
11195 if (!ast_channel_is_multistream(chan)) {
11196 return -1;
11197 }
11198
11199 ast_channel_lock(chan);
11200 ast_channel_internal_set_stream_topology_change_source(chan, (void *)&ast_stream_topology_changed_external);
11201 res = ast_queue_frame(chan, &f);
11202 ast_channel_unlock(chan);
11203
11204 return res;
11205}
ast_stream_topology_changed_external
static const char ast_stream_topology_changed_external[]
Set as the change source reason when a channel stream topology has been changed externally as a resul...
Definition channel.h:223

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, ast_frame_subclass::integer, NULL, and ast_frame::subclass.

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 333 of file channel_internal_api.c.

334{
335 return chan->streamid;
336}
ast_channel::streamid
int streamid
Definition channel_private.h:148

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 337 of file channel_internal_api.c.

338{
339 chan->streamid = value;
340}

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
flagstring form of flag
Return values
theenum (integer) form of the flag

Definition at line 4382 of file channel.c.

4383{
4384 if (!strcasecmp(flag, "default"))
4385 return DEFAULT_AMA_FLAGS;
4386 if (!strcasecmp(flag, "omit"))
4387 return AST_AMA_OMIT;
4388 if (!strcasecmp(flag, "billing"))
4389 return AST_AMA_BILLING;
4390 if (!strcasecmp(flag, "documentation"))
4391 return AST_AMA_DOCUMENTATION;
4392 return AST_AMA_NONE;
4393}
DEFAULT_AMA_FLAGS
#define DEFAULT_AMA_FLAGS
Definition channel.c:112

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

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

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
chanThe channel to suppress
directionThe direction in which to suppress
frametypeThe type of frame (AST_FRAME_VOICE, etc) to suppress
Return values
0Success
-1Failure

Definition at line 10957 of file channel.c.

10958{
10959 struct suppress_data *suppress;
10960 const struct ast_datastore_info *datastore_info = NULL;
10961 struct ast_datastore *datastore = NULL;
10962 struct ast_framehook_interface interface = {
10963 .version = AST_FRAMEHOOK_INTERFACE_VERSION,
10964 .event_cb = suppress_framehook_event_cb,
10965 .destroy_cb = suppress_framehook_destroy_cb,
10966 .chan_fixup_cb = suppress_framehook_fixup_cb,
10967 };
10968 int framehook_id;
10969
10970 if (!(datastore_info = suppress_get_datastore_information(frametype))) {
10971 ast_log(LOG_WARNING, "Attempted to suppress an unsupported frame type (%u).\n", frametype);
10972 return -1;
10973 }
10974
10975 if ((datastore = ast_channel_datastore_find(chan, datastore_info, NULL))) {
10976 suppress = datastore->data;
10977 suppress->direction |= direction;
10978 return 0;
10979 }
10980
10981 if (!(suppress = ao2_alloc(sizeof(*suppress), NULL))) {
10982 ast_log(LOG_WARNING, "Failed to allocate data while attempting to suppress a stream.\n");
10983 return -1;
10984 }
10985
10986 suppress->frametype = frametype;
10987 suppress->direction |= direction;
10988
10989 interface.data = suppress;
10990
10991 framehook_id = ast_framehook_attach(chan, &interface);
10992 if (framehook_id < 0) {
10993 /* Hook attach failed. Get rid of the evidence. */
10994 ast_log(LOG_WARNING, "Failed to attach framehook while attempting to suppress a stream.\n");
10995 ao2_ref(suppress, -1);
10996 return -1;
10997 }
10998
10999 /* One ref for the framehook */
11000 ao2_ref(suppress, +1);
11001
11002 suppress->framehook_id = framehook_id;
11003
11004 if (!(datastore = ast_datastore_alloc(datastore_info, NULL))) {
11005 ast_log(LOG_WARNING, "Failed to allocate datastore while attempting to suppress a stream.\n");
11006 ast_framehook_detach(chan, framehook_id);
11007 ao2_ref(suppress, -1);
11008 return -1;
11009 }
11010
11011 /* the ref provided by the allocation is taken by the datastore */
11012 datastore->data = suppress;
11013
11014 ast_channel_datastore_add(chan, datastore);
11015
11016 return 0;
11017}
suppress_framehook_fixup_cb
static void suppress_framehook_fixup_cb(void *data, int framehook_id, struct ast_channel *old_chan, struct ast_channel *new_chan)
Definition channel.c:10905
suppress_get_datastore_information
static const struct ast_datastore_info * suppress_get_datastore_information(enum ast_frame_type frametype)
Definition channel.c:10947
suppress_framehook_destroy_cb
static void suppress_framehook_destroy_cb(void *data)
Definition channel.c:10894
suppress_framehook_event_cb
static struct ast_frame * suppress_framehook_event_cb(struct ast_channel *chan, struct ast_frame *frame, enum ast_framehook_event event, void *data)
Definition channel.c:10912
ast_framehook_attach
int ast_framehook_attach(struct ast_channel *chan, struct ast_framehook_interface *i)
Attach an framehook onto a channel for frame interception.
Definition framehook.c:132
ast_framehook_detach
int ast_framehook_detach(struct ast_channel *chan, int framehook_id)
Detach an framehook from a channel.
Definition framehook.c:177
AST_FRAMEHOOK_INTERFACE_VERSION
#define AST_FRAMEHOOK_INTERFACE_VERSION
Definition framehook.h:227
ast_datastore_info
Structure for a data store type.
Definition datastore.h:31
ast_framehook_interface
Definition framehook.h:229
ast_framehook_interface::data
void * data
Definition framehook.h:255
ast_framehook_interface::version
uint16_t version
Definition framehook.h:231
suppress_data
Definition channel.c:10899
suppress_data::framehook_id
int framehook_id
Definition channel.c:10902
suppress_data::frametype
enum ast_frame_type frametype
Definition channel.c:10900
suppress_data::direction
unsigned int direction
Definition channel.c:10901

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 636 of file channel_internal_api.c.

637{
638 return chan->tech;
639}

References ast_channel::tech.

◆ ast_channel_tech_hangupcause()

int ast_channel_tech_hangupcause ( const struct ast_channel *  chan)

Definition at line 307 of file channel_internal_api.c.

308{
309 return chan->tech_hangupcause;
310}
ast_channel::tech_hangupcause
int tech_hangupcause
Definition channel_private.h:162

References ast_channel::tech_hangupcause.

Referenced by ast_queue_hangup(), ast_queue_hangup_with_cause(), ast_softhangup(), chan_pjsip_hangup(), chan_pjsip_session_end(), channel_snapshot_hangup_create(), and webchan_hangup().

◆ ast_channel_tech_hangupcause_set()

void ast_channel_tech_hangupcause_set ( struct ast_channel *  chan,
int  value 
)

Definition at line 311 of file channel_internal_api.c.

312{
313 chan->tech_hangupcause = value;
314 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_HANGUP);
315}

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

Referenced by _websocket_request_hangup(), chan_pjsip_hangup(), chan_pjsip_session_end(), and websocket_handoff_to_channel().

◆ ast_channel_tech_pvt()

void * ast_channel_tech_pvt ( const struct ast_channel *  chan)

Definition at line 437 of file channel_internal_api.c.

438{
439 return chan->tech_pvt;
440}
ast_channel::tech_pvt
void * tech_pvt
Definition channel_private.h:50

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_TEST_DEFINE(), AST_TEST_DEFINE(), 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_send_dtmf(), 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(), dahdichan_helper(), 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(), 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(), pjsip_transfer_handling_write(), polarity_read(), polarity_write(), 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(), unistim_write(), webchan_call(), webchan_hangup(), webchan_read(), webchan_send_dtmf_text(), and webchan_write().

◆ ast_channel_tech_pvt_set()

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

Definition at line 441 of file channel_internal_api.c.

442{
443 chan->tech_pvt = value;
444 if (value != NULL) {
445 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_BASE);
446 }
447}

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_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(), unistim_new(), webchan_hangup(), and webchan_request().

◆ ast_channel_tech_set()

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

Definition at line 640 of file channel_internal_api.c.

641{
642 if (value->read_stream || value->write_stream) {
643 ast_assert(value->read_stream && value->write_stream);
644 }
645
646 chan->tech = value;
647}

References ast_assert, ast_channel::tech, and value.

Referenced by __ast_channel_alloc_ap(), ast_iax2_new(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), 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_eval_function(), 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(), unistim_new(), and webchan_request().

◆ ast_channel_tenantid()

const char * ast_channel_tenantid ( const struct ast_channel *  chan)

Definition at line 173 of file channel_internal_api.c.

174{
175 /* It's ok for tenantid to be empty, so no need to assert */
176 return chan->linkedid.tenant_id;
177}
ast_channel_id::tenant_id
char tenant_id[AST_MAX_TENANT_ID]
Definition channel_private.h:34

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 179 of file channel_internal_api.c.

180{
181 if (ast_strlen_zero(value)) {
182 return;
183 }
184 ast_copy_string(chan->linkedid.tenant_id, value, sizeof(chan->linkedid.tenant_id));
185 ast_channel_snapshot_invalidate_segment(chan, AST_CHANNEL_SNAPSHOT_INVALIDATE_BASE);
186}

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 ast_cel_fabricate_channel_from_event(), and func_channel_write_real().

◆ ast_channel_timer()

struct ast_timer * ast_channel_timer ( const struct ast_channel *  chan)

Definition at line 604 of file channel_internal_api.c.

605{
606 return chan->timer;
607}
ast_channel::timer
struct ast_timer * timer
Definition channel_private.h:181

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 608 of file channel_internal_api.c.

609{
610 chan->timer = value;
611}

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 448 of file channel_internal_api.c.

449{
450 return chan->timingdata;
451}
ast_channel::timingdata
void * timingdata
Definition channel_private.h:63

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 452 of file channel_internal_api.c.

453{
454 chan->timingdata = value;
455}

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 341 of file channel_internal_api.c.

342{
343 return chan->timingfd;
344}
ast_channel::timingfd
int timingfd
Definition channel_private.h:151

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 345 of file channel_internal_api.c.

346{
347 chan->timingfd = value;
348}

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 1127 of file channel_internal_api.c.

1128{
1129 return chan->timingfunc;
1130}
ast_channel::timingfunc
ast_timing_func_t timingfunc
Definition channel_private.h:62

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 1131 of file channel_internal_api.c.

1132{
1133 chan->timingfunc = value;
1134}

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
chanChannel, or NULL.
Return values
Topicfor channel's events.
ast_channel_topic_all()if chan is NULL.

Definition at line 1450 of file channel_internal_api.c.

1451{
1452 if (!chan) {
1453 return ast_channel_topic_all();
1454 }
1455
1456 return chan->topic;
1457}
ast_channel_topic_all
struct stasis_topic * ast_channel_topic_all(void)
A topic which publishes the events for all channels.
Definition stasis_channels.c:149
ast_channel::topic
struct stasis_topic * topic
Definition channel_private.h:193

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_refer_notify_transfer_request(), 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_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 373 of file channel_internal_api.c.

374{
375 return chan->transfercapability;
376}
ast_channel::transfercapability
unsigned short transfercapability
Definition channel_private.h:177

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 377 of file channel_internal_api.c.

378{
379 chan->transfercapability = value;
380}

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
chanChannel 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 886 of file channel_internal_api.c.

887{
888 int res;
889 ast_channel_lock(chan);
890 res = ast_channel_unbridged_nolock(chan);
891 ast_channel_unlock(chan);
892 return res;
893}
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.
Definition channel_internal_api.c:881

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
chanChannel 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 881 of file channel_internal_api.c.

882{
883 return chan->unbridged;
884}

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

1330{
1331 if (chan) {
1332 ast_channel_clear_flag(chan, AST_FLAG_DEFER_DTMF);
1333 }
1334}
ast_channel_clear_flag
void ast_channel_clear_flag(struct ast_channel *chan, unsigned int flag)
Clear a flag on a channel.
Definition channel.c:11214

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 161 of file channel_internal_api.c.

162{
163 ast_assert(chan->uniqueid.unique_id[0] != '\0');
164 return chan->uniqueid.unique_id;
165}

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

Referenced by __ast_change_name_nolink(), _create_event_DTMF_END(), _create_event_ERROR(), _create_event_MEDIA_BUFFERING_COMPLETED(), _create_event_MEDIA_MARK_PROCESSED(), _create_event_MEDIA_START(), _create_event_nodata(), _create_event_STATUS(), 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_ari_create_per_call_websocket(), 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_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_endpoint_remove_channel(), ast_str_retrieve_variable(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), 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(), by_uniqueid_cb(), call(), chan_pjsip_fixup(), chan_pjsip_indicate(), chan_pjsip_new(), chan_pjsip_session_end(), channel_replaced_cb(), channel_snapshot_base_create(), channelstorage_uniqueid_cb(), 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(), 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(), send_broadcast_event(), 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_broadcast_channel(), stasis_app_broadcast_wait(), stasis_app_control_find_by_channel(), stasis_app_control_get_channel_id(), stasis_app_control_snoop(), stasis_app_exec(), stasis_app_subscribe_channel(), stasis_broadcast_exec(), 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
chanchannel 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 10709 of file channel.c.

10710{
10711 CHANNELSTORAGE_API(current_channel_storage_instance, remove, chan, 1);
10712}

References CHANNELSTORAGE_API, current_channel_storage_instance, and remove.

Referenced by ast_channel_release(), ast_hangup(), and create_msg_q_chan().

◆ ast_channel_unregister()

void ast_channel_unregister ( const struct ast_channel_tech *  tech)

Unregister a channel technology.

Parameters
techStructure defining channel technology or "type" that was previously registered

Unregister a channel technology.

Definition at line 571 of file channel.c.

572{
573 struct chanlist *chan;
574
575 ast_debug(5, "Unregistering channel type '%s'\n", tech->type);
576
577 AST_RWLIST_WRLOCK(&backends);
578
579 AST_RWLIST_TRAVERSE_SAFE_BEGIN(&backends, chan, list) {
580 if (chan->tech == tech) {
581 AST_LIST_REMOVE_CURRENT(list);
582 ast_free(chan);
583 ast_verb(5, "Unregistered channel type '%s'\n", tech->type);
584 break;
585 }
586 }
587 AST_LIST_TRAVERSE_SAFE_END;
588
589 AST_RWLIST_UNLOCK(&backends);
590}
AST_RWLIST_TRAVERSE_SAFE_BEGIN
#define AST_RWLIST_TRAVERSE_SAFE_BEGIN
Definition linkedlists.h:545

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(), __unload_module(), channels_shutdown(), load_module(), load_module(), local_shutdown(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), unload_module(), 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
chanThe channel to stop suppressing
directionThe direction in which to stop suppressing
frametypeThe type of frame (AST_FRAME_VOICE, etc) to stop suppressing
Return values
0Success
-1Failure

Definition at line 11019 of file channel.c.

11020{
11021 const struct ast_datastore_info *datastore_info = NULL;
11022 struct ast_datastore *datastore = NULL;
11023 struct suppress_data *suppress;
11024
11025 if (!(datastore_info = suppress_get_datastore_information(frametype))) {
11026 ast_log(LOG_WARNING, "Attempted to unsuppress an unsupported frame type (%u).\n", frametype);
11027 return -1;
11028 }
11029
11030 if (!(datastore = ast_channel_datastore_find(chan, datastore_info, NULL))) {
11031 /* Nothing to do! */
11032 return 0;
11033 }
11034
11035 suppress = datastore->data;
11036
11037 suppress->direction &= ~(direction);
11038
11039 if (suppress->direction == 0) {
11040 /* Nothing left to suppress. Bye! */
11041 ast_framehook_detach(chan, suppress->framehook_id);
11042 ast_channel_datastore_remove(chan, datastore);
11043 ast_datastore_free(datastore);
11044 }
11045
11046 return 0;
11047}
ast_channel_datastore_remove
int ast_channel_datastore_remove(struct ast_channel *chan, struct ast_datastore *datastore)
Remove a datastore from a channel.
Definition channel.c:2385
ast_datastore_free
int ast_datastore_free(struct ast_datastore *datastore)
Free a data store object.
Definition datastore.c:68

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
chanAsterisk channel to indicate connected line information
connectedConnected line information
updateWhat connected line information to update. NULL if all.

Definition at line 9269 of file channel.c.

9270{
9271 unsigned char data[1024]; /* This should be large enough */
9272 size_t datalen;
9273
9274 datalen = ast_connected_line_build_data(data, sizeof(data), connected, update);
9275 if (datalen == (size_t) -1) {
9276 return;
9277 }
9278
9279 ast_indicate_data(chan, AST_CONTROL_CONNECTED_LINE, data, datalen);
9280}
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.
Definition channel.c:4676

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(), update_connected_line_from_peer(), wait_for_answer(), 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
chanAsterisk channel to indicate redirecting id information
redirectingRedirecting id information
updateWhat redirecting information to update. NULL if all.

Definition at line 10460 of file channel.c.

10461{
10462 unsigned char data[1024]; /* This should be large enough */
10463 size_t datalen;
10464
10465 datalen = ast_redirecting_build_data(data, sizeof(data), redirecting, update);
10466 if (datalen == (size_t) -1) {
10467 return;
10468 }
10469
10470 ast_indicate_data(chan, AST_CONTROL_REDIRECTING, data, datalen);
10471}

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 799 of file channel_internal_api.c.

800{
801 return &chan->varshead;
802}
ast_channel::varshead
struct varshead varshead
Definition channel_private.h:125

References ast_channel::varshead.

Referenced by __ast_channel_alloc_ap(), __ast_dummy_channel_alloc(), _create_event_MEDIA_START(), ast_cel_fabricate_channel_from_event(), ast_channel_destructor(), ast_channel_get_vars(), ast_channel_inherit_variables(), ast_dummy_channel_destructor(), ast_rtp_instance_set_stats_vars(), 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(), external_media_websocket(), 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 839 of file channel_internal_api.c.

840{
841 chan->varshead = *value;
842}

References value, and ast_channel::varshead.

◆ ast_channel_visible_indication()

int ast_channel_visible_indication ( const struct ast_channel *  chan)

Definition at line 349 of file channel_internal_api.c.

350{
351 return chan->visible_indication;
352}
ast_channel::visible_indication
int visible_indication
Definition channel_private.h:174

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 353 of file channel_internal_api.c.

354{
355 chan->visible_indication = value;
356}

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 496 of file channel_internal_api.c.

497{
498 return chan->vstream;
499}
ast_channel::vstream
struct ast_filestream * vstream
Definition channel_private.h:61

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 500 of file channel_internal_api.c.

501{
502 chan->vstream = value;
503}

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 365 of file channel_internal_api.c.

366{
367 return chan->vstreamid;
368}
ast_channel::vstreamid
int vstreamid
Definition channel_private.h:149

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 369 of file channel_internal_api.c.

370{
371 chan->vstreamid = value;
372}

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 795 of file channel_internal_api.c.

796{
797 return &chan->whentohangup;
798}
ast_channel::whentohangup
struct timeval whentohangup
Definition channel_private.h:92

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 835 of file channel_internal_api.c.

836{
837 chan->whentohangup = *value;
838}

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 727 of file channel_internal_api.c.

728{
729 return chan->writeformat;
730}

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_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(), openstream_internal(), 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 628 of file channel_internal_api.c.

629{
630 return chan->writetrans;
631}
ast_channel::writetrans
struct ast_trans_pvt * writetrans
Definition channel_private.h:65

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 632 of file channel_internal_api.c.

633{
634 chan->writetrans = value;
635}

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
yankeeThe channel to gain control of
Return values
NULLCould not gain control of the channel
non-NULLThe channel

Definition at line 10773 of file channel.c.

10774{
10775 struct ast_channel *yanked_chan;
10776 struct {
10777 char *accountcode;
10778 char *exten;
10779 char *context;
10780 char *name;
10781 int amaflags;
10782 int priority;
10783 struct ast_format *readformat;
10784 struct ast_format *writeformat;
10785 } my_vars = { 0, };
10786
10787 ast_channel_lock(yankee);
10788 my_vars.accountcode = ast_strdupa(ast_channel_accountcode(yankee));
10789 my_vars.exten = ast_strdupa(ast_channel_exten(yankee));
10790 my_vars.context = ast_strdupa(ast_channel_context(yankee));
10791 my_vars.name = ast_strdupa(ast_channel_name(yankee));
10792 my_vars.amaflags = ast_channel_amaflags(yankee);
10793 my_vars.priority = ast_channel_priority(yankee);
10794 /* The priority as returned by ast_channel_yank is where the channel
10795 * should go if the dialplan is executed on it. If the channel is
10796 * already executing dialplan then the priority currently set is
10797 * where it is currently. We increment it so it becomes where it should
10798 * execute.
10799 */
10800 if (ast_test_flag(ast_channel_flags(yankee), AST_FLAG_IN_AUTOLOOP)) {
10801 my_vars.priority++;
10802 }
10803 my_vars.writeformat = ao2_bump(ast_channel_writeformat(yankee));
10804 my_vars.readformat = ao2_bump(ast_channel_readformat(yankee));
10805 ast_channel_unlock(yankee);
10806
10807 /* Do not hold any channel locks while calling channel_alloc() since the function
10808 * locks the channel container when linking the new channel in. */
10809 if (!(yanked_chan = ast_channel_alloc(0, AST_STATE_DOWN, 0, 0, my_vars.accountcode,
10810 my_vars.exten, my_vars.context, NULL, yankee, my_vars.amaflags,
10811 "Surrogate/%s", my_vars.name))) {
10812 ao2_cleanup(my_vars.writeformat);
10813 ao2_cleanup(my_vars.readformat);
10814 return NULL;
10815 }
10816
10817 /* Make formats okay */
10818 ast_channel_set_readformat(yanked_chan, my_vars.readformat);
10819 ast_channel_set_writeformat(yanked_chan, my_vars.writeformat);
10820 ao2_cleanup(my_vars.readformat);
10821 ao2_cleanup(my_vars.writeformat);
10822 ast_channel_priority_set(yanked_chan, my_vars.priority);
10823
10824 ast_channel_unlock(yanked_chan);
10825
10826 if (ast_channel_move(yanked_chan, yankee)) {
10827 ast_hangup(yanked_chan);
10828 return NULL;
10829 }
10830
10831 return yanked_chan;
10832}
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.
Definition channel.c:10846
ast_channel_alloc
#define ast_channel_alloc(needqueue, state, cid_num, cid_name, acctcode, exten, context, assignedids, requestor, amaflag,...)
Create a channel structure.
Definition channel.h:1299
AST_STATE_DOWN
@ AST_STATE_DOWN
Definition channelstate.h:36

References 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, 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 612 of file channel_internal_api.c.

613{
614 return chan->zone;
615}
ast_channel::zone
struct ast_tone_zone * zone
Definition channel_private.h:70

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 616 of file channel_internal_api.c.

617{
618 chan->zone = value;
619}

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

190{
191 struct chanlist *cl;
192 struct ast_variable *var = NULL, *prev = NULL;
193
194 AST_RWLIST_RDLOCK(&backends);
195 AST_RWLIST_TRAVERSE(&backends, cl, list) {
196 if (prev) {
197 if ((prev->next = ast_variable_new(cl->tech->type, cl->tech->description, "")))
198 prev = prev->next;
199 } else {
200 var = ast_variable_new(cl->tech->type, cl->tech->description, "");
201 prev = var;
202 }
203 }
204 AST_RWLIST_UNLOCK(&backends);
205
206 return var;
207}
ast_variable_new
#define ast_variable_new(name, value, filename)
Definition include/asterisk/config.h:921
AST_RWLIST_RDLOCK
#define AST_RWLIST_RDLOCK(head)
Read locks a list.
Definition linkedlists.h:78

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

447{
448 if (ast_channel_softhangup_internal_flag(chan)) /* yes if soft hangup flag set */
449 return 1;
450 if (ast_tvzero(*ast_channel_whentohangup(chan))) /* no if no hangup scheduled */
451 return 0;
452 if (ast_tvdiff_ms(*ast_channel_whentohangup(chan), ast_tvnow()) > 0) /* no if hangup time has not come yet. */
453 return 0;
454 ast_debug(4, "Hangup time has come: %" PRIi64 "\n", ast_tvdiff_ms(*ast_channel_whentohangup(chan), ast_tvnow()));
455 ast_test_suite_event_notify("HANGUP_TIME", "Channel: %s", ast_channel_name(chan));
456 ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_TIMEOUT); /* record event */
457 return 1;
458}

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_broadcast_wait(), stasis_app_exec(), stasis_broadcast_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 460 of file channel.c.

461{
462 int res;
463 ast_channel_lock(chan);
464 res = ast_check_hangup(chan);
465 ast_channel_unlock(chan);
466 return res;
467}

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
dataBuffer to fill with the frame data
datalenSize of the buffer to fill
connectedConnected line information
updateWhat connected line information to build. NULL if all.
Return values
-1if error
Amountof data buffer used

Definition at line 8873 of file channel.c.

8874{
8875 int32_t value;
8876 size_t pos = 0;
8877 int res;
8878
8879 static const struct ast_party_id_ies ies = {
8880 .name.str = AST_CONNECTED_LINE_NAME,
8881 .name.char_set = AST_CONNECTED_LINE_NAME_CHAR_SET,
8882 .name.presentation = AST_CONNECTED_LINE_NAME_PRESENTATION,
8883 .name.valid = AST_CONNECTED_LINE_NAME_VALID,
8884
8885 .number.str = AST_CONNECTED_LINE_NUMBER,
8886 .number.plan = AST_CONNECTED_LINE_NUMBER_PLAN,
8887 .number.presentation = AST_CONNECTED_LINE_NUMBER_PRESENTATION,
8888 .number.valid = AST_CONNECTED_LINE_NUMBER_VALID,
8889
8890 .subaddress.str = AST_CONNECTED_LINE_SUBADDRESS,
8891 .subaddress.type = AST_CONNECTED_LINE_SUBADDRESS_TYPE,
8892 .subaddress.odd_even_indicator = AST_CONNECTED_LINE_SUBADDRESS_ODD_EVEN,
8893 .subaddress.valid = AST_CONNECTED_LINE_SUBADDRESS_VALID,
8894
8895 .tag = AST_CONNECTED_LINE_TAG,
8896 .combined_presentation = AST_CONNECTED_LINE_ID_PRESENTATION,
8897 };
8898
8899 static const struct ast_party_id_ies priv_ies = {
8900 .name.str = AST_CONNECTED_LINE_PRIV_NAME,
8901 .name.char_set = AST_CONNECTED_LINE_PRIV_NAME_CHAR_SET,
8902 .name.presentation = AST_CONNECTED_LINE_PRIV_NAME_PRESENTATION,
8903 .name.valid = AST_CONNECTED_LINE_PRIV_NAME_VALID,
8904
8905 .number.str = AST_CONNECTED_LINE_PRIV_NUMBER,
8906 .number.plan = AST_CONNECTED_LINE_PRIV_NUMBER_PLAN,
8907 .number.presentation = AST_CONNECTED_LINE_PRIV_NUMBER_PRESENTATION,
8908 .number.valid = AST_CONNECTED_LINE_PRIV_NUMBER_VALID,
8909
8910 .subaddress.str = AST_CONNECTED_LINE_PRIV_SUBADDRESS,
8911 .subaddress.type = AST_CONNECTED_LINE_PRIV_SUBADDRESS_TYPE,
8912 .subaddress.odd_even_indicator = AST_CONNECTED_LINE_PRIV_SUBADDRESS_ODD_EVEN,
8913 .subaddress.valid = AST_CONNECTED_LINE_PRIV_SUBADDRESS_VALID,
8914
8915 .tag = AST_CONNECTED_LINE_PRIV_TAG,
8916 .combined_presentation = 0,/* Not sent. */
8917 };
8918
8919 /*
8920 * The size of integer values must be fixed in case the frame is
8921 * shipped to another machine.
8922 */
8923
8924 /* Connected line frame version */
8925 if (datalen < pos + (sizeof(data[0]) * 2) + 1) {
8926 ast_log(LOG_WARNING, "No space left for connected line frame version\n");
8927 return -1;
8928 }
8929 data[pos++] = AST_CONNECTED_LINE_VERSION;
8930 data[pos++] = 1;
8931 data[pos++] = 2;/* Version 1 did not have a version ie */
8932
8933 res = party_id_build_data(data + pos, datalen - pos, &connected->id,
8934 "connected line", &ies, update ? &update->id : NULL);
8935 if (res < 0) {
8936 return -1;
8937 }
8938 pos += res;
8939
8940 res = party_id_build_data(data + pos, datalen - pos, &connected->priv,
8941 "connected line priv", &priv_ies, update ? &update->priv : NULL);
8942 if (res < 0) {
8943 return -1;
8944 }
8945 pos += res;
8946
8947 /* Connected line source */
8948 if (datalen < pos + (sizeof(data[0]) * 2) + sizeof(value)) {
8949 ast_log(LOG_WARNING, "No space left for connected line source\n");
8950 return -1;
8951 }
8952 data[pos++] = AST_CONNECTED_LINE_SOURCE;
8953 data[pos++] = sizeof(value);
8954 value = htonl(connected->source);
8955 memcpy(data + pos, &value, sizeof(value));
8956 pos += sizeof(value);
8957
8958 return pos;
8959}
AST_CONNECTED_LINE_NUMBER_VALID
@ AST_CONNECTED_LINE_NUMBER_VALID
Definition channel.c:8856
AST_CONNECTED_LINE_SOURCE
@ AST_CONNECTED_LINE_SOURCE
Definition channel.c:8842
AST_CONNECTED_LINE_PRIV_SUBADDRESS_VALID
@ AST_CONNECTED_LINE_PRIV_SUBADDRESS_VALID
Definition channel.c:8869
AST_CONNECTED_LINE_PRIV_SUBADDRESS_ODD_EVEN
@ AST_CONNECTED_LINE_PRIV_SUBADDRESS_ODD_EVEN
Definition channel.c:8868
AST_CONNECTED_LINE_PRIV_NAME_VALID
@ AST_CONNECTED_LINE_PRIV_NAME_VALID
Definition channel.c:8863
AST_CONNECTED_LINE_PRIV_SUBADDRESS_TYPE
@ AST_CONNECTED_LINE_PRIV_SUBADDRESS_TYPE
Definition channel.c:8867
AST_CONNECTED_LINE_PRIV_NUMBER_PRESENTATION
@ AST_CONNECTED_LINE_PRIV_NUMBER_PRESENTATION
Definition channel.c:8861
AST_CONNECTED_LINE_NAME_CHAR_SET
@ AST_CONNECTED_LINE_NAME_CHAR_SET
Definition channel.c:8854
AST_CONNECTED_LINE_SUBADDRESS_VALID
@ AST_CONNECTED_LINE_SUBADDRESS_VALID
Definition channel.c:8846
AST_CONNECTED_LINE_SUBADDRESS_ODD_EVEN
@ AST_CONNECTED_LINE_SUBADDRESS_ODD_EVEN
Definition channel.c:8845
AST_CONNECTED_LINE_SUBADDRESS
@ AST_CONNECTED_LINE_SUBADDRESS
Definition channel.c:8843
AST_CONNECTED_LINE_PRIV_NUMBER_PLAN
@ AST_CONNECTED_LINE_PRIV_NUMBER_PLAN
Definition channel.c:8859
AST_CONNECTED_LINE_NUMBER
@ AST_CONNECTED_LINE_NUMBER
Definition channel.c:8838
AST_CONNECTED_LINE_ID_PRESENTATION
@ AST_CONNECTED_LINE_ID_PRESENTATION
Definition channel.c:8841
AST_CONNECTED_LINE_PRIV_NAME_PRESENTATION
@ AST_CONNECTED_LINE_PRIV_NAME_PRESENTATION
Definition channel.c:8865
AST_CONNECTED_LINE_PRIV_NAME
@ AST_CONNECTED_LINE_PRIV_NAME
Definition channel.c:8862
AST_CONNECTED_LINE_TAG
@ AST_CONNECTED_LINE_TAG
Definition channel.c:8847
AST_CONNECTED_LINE_PRIV_NUMBER_VALID
@ AST_CONNECTED_LINE_PRIV_NUMBER_VALID
Definition channel.c:8860
AST_CONNECTED_LINE_NUMBER_PRESENTATION
@ AST_CONNECTED_LINE_NUMBER_PRESENTATION
Definition channel.c:8857
AST_CONNECTED_LINE_PRIV_NAME_CHAR_SET
@ AST_CONNECTED_LINE_PRIV_NAME_CHAR_SET
Definition channel.c:8864
AST_CONNECTED_LINE_NAME
@ AST_CONNECTED_LINE_NAME
Definition channel.c:8839
AST_CONNECTED_LINE_NAME_PRESENTATION
@ AST_CONNECTED_LINE_NAME_PRESENTATION
Definition channel.c:8855
AST_CONNECTED_LINE_SUBADDRESS_TYPE
@ AST_CONNECTED_LINE_SUBADDRESS_TYPE
Definition channel.c:8844
AST_CONNECTED_LINE_PRIV_SUBADDRESS
@ AST_CONNECTED_LINE_PRIV_SUBADDRESS
Definition channel.c:8866
AST_CONNECTED_LINE_PRIV_TAG
@ AST_CONNECTED_LINE_PRIV_TAG
Definition channel.c:8870
AST_CONNECTED_LINE_NAME_VALID
@ AST_CONNECTED_LINE_NAME_VALID
Definition channel.c:8853
AST_CONNECTED_LINE_PRIV_NUMBER
@ AST_CONNECTED_LINE_PRIV_NUMBER
Definition channel.c:8858
AST_CONNECTED_LINE_NUMBER_PLAN
@ AST_CONNECTED_LINE_NUMBER_PLAN
Definition channel.c:8840
AST_CONNECTED_LINE_VERSION
@ AST_CONNECTED_LINE_VERSION
Definition channel.c:8848
party_id_build_data
static int party_id_build_data(unsigned char *data, size_t datalen, const struct ast_party_id *id, const char *label, const struct ast_party_id_ies *ies, const struct ast_set_party_id *update)
Definition channel.c:8753
ast_party_id_ies
Definition channel.c:8722
ast_party_id_ies::name
struct ast_party_name_ies name
Subscriber name ies.
Definition channel.c:8724
ast_party_name_ies::str
int str
Subscriber name ie.
Definition channel.c:8501

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
destDestination connected line information
srcSource caller information
Note
Assumes locks are already acquired

Definition at line 8469 of file channel.c.

8470{
8471 ast_party_id_copy(&dest->id, &src->id);
8472 ast_party_id_copy(&dest->ani, &src->ani);
8473 dest->ani2 = src->ani2;
8474}
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.
Definition channel.c:1752
ast_party_caller::id
struct ast_party_id id
Caller party ID.
Definition channel.h:422
ast_party_caller::ani2
int ani2
Automatic Number Identification 2 (Info Digits)
Definition channel.h:435
ast_party_caller::ani
struct ast_party_id ani
Automatic Number Identification (ANI)
Definition channel.h:429
ast_party_connected_line::ani2
int ani2
Automatic Number Identification 2 (Info Digits)
Definition channel.h:477
ast_party_connected_line::ani
struct ast_party_id ani
Automatic Number Identification (ANI)
Definition channel.h:467

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(), 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
destDestination caller information
srcSource connected line information
Note
Assumes locks are already acquired

Definition at line 8476 of file channel.c.

8477{
8478 ast_party_id_copy(&dest->id, &src->id);
8479 ast_party_id_copy(&dest->ani, &src->ani);
8480
8481 dest->ani2 = src->ani2;
8482}

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
dataBuffer with the frame data to parse
datalenSize of the buffer
connectedExtracted connected line information
Return values
0on success.
-1on 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 8961 of file channel.c.

8962{
8963 size_t pos;
8964 unsigned char ie_len;
8965 unsigned char ie_id;
8966 int32_t value;
8967 int frame_version = 1;
8968 int combined_presentation = 0;
8969 int got_combined_presentation = 0;/* TRUE if got a combined name and number presentation value. */
8970
8971 for (pos = 0; pos < datalen; pos += ie_len) {
8972 if (datalen < pos + sizeof(ie_id) + sizeof(ie_len)) {
8973 ast_log(LOG_WARNING, "Invalid connected line update\n");
8974 return -1;
8975 }
8976 ie_id = data[pos++];
8977 ie_len = data[pos++];
8978 if (datalen < pos + ie_len) {
8979 ast_log(LOG_WARNING, "Invalid connected line update\n");
8980 return -1;
8981 }
8982
8983 switch (ie_id) {
8984/* Connected line party frame version */
8985 case AST_CONNECTED_LINE_VERSION:
8986 if (ie_len != 1) {
8987 ast_log(LOG_WARNING, "Invalid connected line frame version (%u)\n",
8988 (unsigned) ie_len);
8989 break;
8990 }
8991 frame_version = data[pos];
8992 break;
8993/* Connected line party id name */
8994 case AST_CONNECTED_LINE_NAME:
8995 ast_free(connected->id.name.str);
8996 connected->id.name.str = ast_malloc(ie_len + 1);
8997 if (connected->id.name.str) {
8998 memcpy(connected->id.name.str, data + pos, ie_len);
8999 connected->id.name.str[ie_len] = 0;
9000 }
9001 break;
9002 case AST_CONNECTED_LINE_NAME_CHAR_SET:
9003 if (ie_len != 1) {
9004 ast_log(LOG_WARNING, "Invalid connected line name char set (%u)\n",
9005 (unsigned) ie_len);
9006 break;
9007 }
9008 connected->id.name.char_set = data[pos];
9009 break;
9010 case AST_CONNECTED_LINE_NAME_PRESENTATION:
9011 if (ie_len != 1) {
9012 ast_log(LOG_WARNING, "Invalid connected line name presentation (%u)\n",
9013 (unsigned) ie_len);
9014 break;
9015 }
9016 connected->id.name.presentation = data[pos];
9017 break;
9018 case AST_CONNECTED_LINE_NAME_VALID:
9019 if (ie_len != 1) {
9020 ast_log(LOG_WARNING, "Invalid connected line name valid (%u)\n",
9021 (unsigned) ie_len);
9022 break;
9023 }
9024 connected->id.name.valid = data[pos];
9025 break;
9026/* Connected line party id number */
9027 case AST_CONNECTED_LINE_NUMBER:
9028 ast_free(connected->id.number.str);
9029 connected->id.number.str = ast_malloc(ie_len + 1);
9030 if (connected->id.number.str) {
9031 memcpy(connected->id.number.str, data + pos, ie_len);
9032 connected->id.number.str[ie_len] = 0;
9033 }
9034 break;
9035 case AST_CONNECTED_LINE_NUMBER_PLAN:
9036 if (ie_len != 1) {
9037 ast_log(LOG_WARNING, "Invalid connected line numbering plan (%u)\n",
9038 (unsigned) ie_len);
9039 break;
9040 }
9041 connected->id.number.plan = data[pos];
9042 break;
9043 case AST_CONNECTED_LINE_NUMBER_PRESENTATION:
9044 if (ie_len != 1) {
9045 ast_log(LOG_WARNING, "Invalid connected line number presentation (%u)\n",
9046 (unsigned) ie_len);
9047 break;
9048 }
9049 connected->id.number.presentation = data[pos];
9050 break;
9051 case AST_CONNECTED_LINE_NUMBER_VALID:
9052 if (ie_len != 1) {
9053 ast_log(LOG_WARNING, "Invalid connected line number valid (%u)\n",
9054 (unsigned) ie_len);
9055 break;
9056 }
9057 connected->id.number.valid = data[pos];
9058 break;
9059/* Connected line party id subaddress */
9060 case AST_CONNECTED_LINE_SUBADDRESS:
9061 ast_free(connected->id.subaddress.str);
9062 connected->id.subaddress.str = ast_malloc(ie_len + 1);
9063 if (connected->id.subaddress.str) {
9064 memcpy(connected->id.subaddress.str, data + pos, ie_len);
9065 connected->id.subaddress.str[ie_len] = 0;
9066 }
9067 break;
9068 case AST_CONNECTED_LINE_SUBADDRESS_TYPE:
9069 if (ie_len != 1) {
9070 ast_log(LOG_WARNING, "Invalid connected line type of subaddress (%u)\n",
9071 (unsigned) ie_len);
9072 break;
9073 }
9074 connected->id.subaddress.type = data[pos];
9075 break;
9076 case AST_CONNECTED_LINE_SUBADDRESS_ODD_EVEN:
9077 if (ie_len != 1) {
9078 ast_log(LOG_WARNING,
9079 "Invalid connected line subaddress odd-even indicator (%u)\n",
9080 (unsigned) ie_len);
9081 break;
9082 }
9083 connected->id.subaddress.odd_even_indicator = data[pos];
9084 break;
9085 case AST_CONNECTED_LINE_SUBADDRESS_VALID:
9086 if (ie_len != 1) {
9087 ast_log(LOG_WARNING, "Invalid connected line subaddress valid (%u)\n",
9088 (unsigned) ie_len);
9089 break;
9090 }
9091 connected->id.subaddress.valid = data[pos];
9092 break;
9093/* Connected line party tag */
9094 case AST_CONNECTED_LINE_TAG:
9095 ast_free(connected->id.tag);
9096 connected->id.tag = ast_malloc(ie_len + 1);
9097 if (connected->id.tag) {
9098 memcpy(connected->id.tag, data + pos, ie_len);
9099 connected->id.tag[ie_len] = 0;
9100 }
9101 break;
9102/* Connected line party id combined presentation */
9103 case AST_CONNECTED_LINE_ID_PRESENTATION:
9104 if (ie_len != 1) {
9105 ast_log(LOG_WARNING, "Invalid connected line combined presentation (%u)\n",
9106 (unsigned) ie_len);
9107 break;
9108 }
9109 combined_presentation = data[pos];
9110 got_combined_presentation = 1;
9111 break;
9112/* Private connected line party id name */
9113 case AST_CONNECTED_LINE_PRIV_NAME:
9114 ast_free(connected->priv.name.str);
9115 connected->priv.name.str = ast_malloc(ie_len + 1);
9116 if (connected->priv.name.str) {
9117 memcpy(connected->priv.name.str, data + pos, ie_len);
9118 connected->priv.name.str[ie_len] = 0;
9119 }
9120 break;
9121 case AST_CONNECTED_LINE_PRIV_NAME_CHAR_SET:
9122 if (ie_len != 1) {
9123 ast_log(LOG_WARNING, "Invalid connected line private name char set (%u)\n",
9124 (unsigned) ie_len);
9125 break;
9126 }
9127 connected->priv.name.char_set = data[pos];
9128 break;
9129 case AST_CONNECTED_LINE_PRIV_NAME_PRESENTATION:
9130 if (ie_len != 1) {
9131 ast_log(LOG_WARNING, "Invalid connected line private name presentation (%u)\n",
9132 (unsigned) ie_len);
9133 break;
9134 }
9135 connected->priv.name.presentation = data[pos];
9136 break;
9137 case AST_CONNECTED_LINE_PRIV_NAME_VALID:
9138 if (ie_len != 1) {
9139 ast_log(LOG_WARNING, "Invalid connected line private name valid (%u)\n",
9140 (unsigned) ie_len);
9141 break;
9142 }
9143 connected->priv.name.valid = data[pos];
9144 break;
9145/* Private connected line party id number */
9146 case AST_CONNECTED_LINE_PRIV_NUMBER:
9147 ast_free(connected->priv.number.str);
9148 connected->priv.number.str = ast_malloc(ie_len + 1);
9149 if (connected->priv.number.str) {
9150 memcpy(connected->priv.number.str, data + pos, ie_len);
9151 connected->priv.number.str[ie_len] = 0;
9152 }
9153 break;
9154 case AST_CONNECTED_LINE_PRIV_NUMBER_PLAN:
9155 if (ie_len != 1) {
9156 ast_log(LOG_WARNING, "Invalid connected line private numbering plan (%u)\n",
9157 (unsigned) ie_len);
9158 break;
9159 }
9160 connected->priv.number.plan = data[pos];
9161 break;
9162 case AST_CONNECTED_LINE_PRIV_NUMBER_PRESENTATION:
9163 if (ie_len != 1) {
9164 ast_log(LOG_WARNING, "Invalid connected line private number presentation (%u)\n",
9165 (unsigned) ie_len);
9166 break;
9167 }
9168 connected->priv.number.presentation = data[pos];
9169 break;
9170 case AST_CONNECTED_LINE_PRIV_NUMBER_VALID:
9171 if (ie_len != 1) {
9172 ast_log(LOG_WARNING, "Invalid connected line private number valid (%u)\n",
9173 (unsigned) ie_len);
9174 break;
9175 }
9176 connected->priv.number.valid = data[pos];
9177 break;
9178/* Private connected line party id subaddress */
9179 case AST_CONNECTED_LINE_PRIV_SUBADDRESS:
9180 ast_free(connected->priv.subaddress.str);
9181 connected->priv.subaddress.str = ast_malloc(ie_len + 1);
9182 if (connected->priv.subaddress.str) {
9183 memcpy(connected->priv.subaddress.str, data + pos, ie_len);
9184 connected->priv.subaddress.str[ie_len] = 0;
9185 }
9186 break;
9187 case AST_CONNECTED_LINE_PRIV_SUBADDRESS_TYPE:
9188 if (ie_len != 1) {
9189 ast_log(LOG_WARNING, "Invalid connected line private type of subaddress (%u)\n",
9190 (unsigned) ie_len);
9191 break;
9192 }
9193 connected->priv.subaddress.type = data[pos];
9194 break;
9195 case AST_CONNECTED_LINE_PRIV_SUBADDRESS_ODD_EVEN:
9196 if (ie_len != 1) {
9197 ast_log(LOG_WARNING,
9198 "Invalid connected line private subaddress odd-even indicator (%u)\n",
9199 (unsigned) ie_len);
9200 break;
9201 }
9202 connected->priv.subaddress.odd_even_indicator = data[pos];
9203 break;
9204 case AST_CONNECTED_LINE_PRIV_SUBADDRESS_VALID:
9205 if (ie_len != 1) {
9206 ast_log(LOG_WARNING, "Invalid connected line private subaddress valid (%u)\n",
9207 (unsigned) ie_len);
9208 break;
9209 }
9210 connected->priv.subaddress.valid = data[pos];
9211 break;
9212/* Private connected line party tag */
9213 case AST_CONNECTED_LINE_PRIV_TAG:
9214 ast_free(connected->priv.tag);
9215 connected->priv.tag = ast_malloc(ie_len + 1);
9216 if (connected->priv.tag) {
9217 memcpy(connected->priv.tag, data + pos, ie_len);
9218 connected->priv.tag[ie_len] = 0;
9219 }
9220 break;
9221/* Connected line party source */
9222 case AST_CONNECTED_LINE_SOURCE:
9223 if (ie_len != sizeof(value)) {
9224 ast_log(LOG_WARNING, "Invalid connected line source (%u)\n",
9225 (unsigned) ie_len);
9226 break;
9227 }
9228 memcpy(&value, data + pos, sizeof(value));
9229 connected->source = ntohl(value);
9230 break;
9231/* Connected line party unknown element */
9232 default:
9233 ast_debug(1, "Unknown connected line element: %u (%u)\n",
9234 (unsigned) ie_id, (unsigned) ie_len);
9235 break;
9236 }
9237 }
9238
9239 switch (frame_version) {
9240 case 1:
9241 /*
9242 * The other end is an earlier version that we need to adjust
9243 * for compatibility.
9244 */
9245 connected->id.name.valid = 1;
9246 connected->id.name.char_set = AST_PARTY_CHAR_SET_ISO8859_1;
9247 connected->id.number.valid = 1;
9248 if (got_combined_presentation) {
9249 connected->id.name.presentation = combined_presentation;
9250 connected->id.number.presentation = combined_presentation;
9251 }
9252 break;
9253 case 2:
9254 /* The other end is at the same level as we are. */
9255 break;
9256 default:
9257 /*
9258 * The other end is newer than we are.
9259 * We need to assume that they are compatible with us.
9260 */
9261 ast_debug(1, "Connected line frame has newer version: %u\n",
9262 (unsigned) frame_version);
9263 break;
9264 }
9265
9266 return 0;
9267}
ast_malloc
#define ast_malloc(len)
A wrapper for malloc()
Definition astmm.h:191

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(), 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 2892 of file channel.c.

2893{
2894 ast_channel_lock(chan);
2895 deactivate_generator_nolock(chan);
2896 if (should_trigger_dtmf_emulating(chan)) {
2897 /* if in the middle of dtmf emulation keep 50 tick per sec timer on rolling */
2898 struct ast_timer *timer = ast_channel_timer(chan);
2899 if (timer) {
2900 ast_timer_set_rate(timer, 50);
2901 } else {
2902 ast_log(LOG_WARNING, "No timing module loaded, DTMF length may be inaccurate\n");
2903 }
2904 }
2905 ast_channel_unlock(chan);
2906}
timer
static struct ast_timer * timer
Definition chan_iax2.c:401
deactivate_generator_nolock
static void deactivate_generator_nolock(struct ast_channel *chan)
Definition channel.c:2877
should_trigger_dtmf_emulating
static int should_trigger_dtmf_emulating(struct ast_channel *chan)
Determine whether or not we have to trigger dtmf emulating using 50 fps timer events especially when ...
Definition channel.c:2855
ast_timer_set_rate
int ast_timer_set_rate(const struct ast_timer *handle, unsigned int rate)
Set the timing tick rate.
Definition timing.c:166

References ast_channel_lock, ast_channel_timer(), ast_channel_unlock, ast_log, ast_timer_set_rate(), deactivate_generator_nolock(), LOG_WARNING, should_trigger_dtmf_emulating(), and timer.

Referenced by __ast_read(), app_exec(), app_exec(), 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(), openstream_internal(), 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 2888 of file channel.h.

2889{
2890 int x;
2891 int dummy = 0;
2892
2893 if (fd < 0)
2894 return 0;
2895 if (!start)
2896 start = &dummy;
2897 for (x = *start; x < maximum; x++)
2898 if (pfds[x].fd == fd) {
2899 if (x == *start)
2900 (*start)++;
2901 return pfds[x].revents;
2902 }
2903 return 0;
2904}

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

594{
595 struct chanlist *chanls;
596 const struct ast_channel_tech *ret = NULL;
597
598 AST_RWLIST_RDLOCK(&backends);
599
600 AST_RWLIST_TRAVERSE(&backends, chanls, list) {
601 if (!strcasecmp(name, chanls->tech->type)) {
602 ret = chanls->tech;
603 break;
604 }
605 }
606
607 AST_RWLIST_UNLOCK(&backends);
608
609 return ret;
610}

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

7655{
7656 char *piece;
7657 char *c;
7658 int start=0, finish=0, x;
7659 ast_group_t group = 0;
7660
7661 if (ast_strlen_zero(s))
7662 return 0;
7663
7664 c = ast_strdupa(s);
7665
7666 while ((piece = strsep(&c, ","))) {
7667 if (sscanf(piece, "%30d-%30d", &start, &finish) == 2) {
7668 /* Range */
7669 } else if (sscanf(piece, "%30d", &start)) {
7670 /* Just one */
7671 finish = start;
7672 } else {
7673 ast_log(LOG_ERROR, "Syntax error parsing group configuration '%s' at '%s'. Ignoring.\n", s, piece);
7674 continue;
7675 }
7676 for (x = start; x <= finish; x++) {
7677 if ((x > 63) || (x < 0)) {
7678 ast_log(LOG_WARNING, "Ignoring invalid group %d (maximum group is 63)\n", x);
7679 } else
7680 group |= ((ast_group_t) 1 << x);
7681 }
7682 }
7683 return group;
7684}
strsep
char * strsep(char **str, const char *delims)

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

7712{
7713 struct ao2_container *namedgroups;
7714 char *piece;
7715 char *c;
7716
7717 if (!s) {
7718 return NULL;
7719 }
7720
7721 /*! \brief Remove leading and trailing whitespace */
7722 c = ast_trim_blanks(ast_strdupa(ast_skip_blanks(s)));
7723 if (ast_strlen_zero(c)) {
7724 return NULL;
7725 }
7726
7727 namedgroups = ao2_container_alloc_hash(AO2_ALLOC_OPT_LOCK_NOLOCK, 0, 19,
7728 namedgroup_hash_cb, NULL, namedgroup_cmp_cb);
7729 if (!namedgroups) {
7730 return NULL;
7731 }
7732
7733 while ((piece = strsep(&c, ","))) {
7734 struct namedgroup_member *member;
7735 size_t len;
7736
7737 /* remove leading/trailing whitespace */
7738 piece = ast_strip(piece);
7739
7740 len = strlen(piece);
7741 if (!len) {
7742 continue;
7743 }
7744
7745 member = ao2_alloc_options(sizeof(*member) + len, NULL, AO2_ALLOC_OPT_LOCK_NOLOCK);
7746 if (!member) {
7747 ao2_ref(namedgroups, -1);
7748 return NULL;
7749 }
7750 strcpy(member->name, piece);/* Safe */
7751 member->hash = ast_str_hash(member->name);
7752
7753 /* every group name may exist only once, delete duplicates */
7754 ao2_find(namedgroups, member, OBJ_POINTER | OBJ_UNLINK | OBJ_NODATA);
7755 ao2_link(namedgroups, member);
7756 ao2_ref(member, -1);
7757 }
7758
7759 if (!ao2_container_count(namedgroups)) {
7760 /* There were no group names specified. */
7761 ao2_ref(namedgroups, -1);
7762 namedgroups = NULL;
7763 }
7764
7765 return (struct ast_namedgroups *) namedgroups;
7766}
OBJ_POINTER
#define OBJ_POINTER
Definition astobj2.h:1150
AO2_ALLOC_OPT_LOCK_NOLOCK
@ AO2_ALLOC_OPT_LOCK_NOLOCK
Definition astobj2.h:367
ao2_container_count
int ao2_container_count(struct ao2_container *c)
Returns the number of elements in a container.
Definition astobj2_container.c:34
ao2_alloc_options
#define ao2_alloc_options(data_size, destructor_fn, options)
Definition astobj2.h:404
ao2_container_alloc_hash
#define ao2_container_alloc_hash(ao2_options, container_options, n_buckets, hash_fn, sort_fn, cmp_fn)
Allocate and initialize a hash container with the desired number of buckets.
Definition astobj2.h:1303
namedgroup_cmp_cb
static int namedgroup_cmp_cb(void *obj, void *arg, int flags)
Comparison function used for named group container.
Definition channel.c:7695
namedgroup_hash_cb
static int namedgroup_hash_cb(const void *obj, const int flags)
Hashing function used for named group container.
Definition channel.c:7704
ast_str_hash
static force_inline int attribute_pure ast_str_hash(const char *str)
Compute a hash value on a string.
Definition strings.h:1259
ast_trim_blanks
char * ast_trim_blanks(char *str)
Trims trailing whitespace characters from a string.
Definition strings.h:186
ast_strip
char * ast_strip(char *s)
Strip leading/trailing whitespace from a string.
Definition strings.h:223
ast_skip_blanks
char *attribute_pure ast_skip_blanks(const char *str)
Gets a pointer to the first non-whitespace character in a string.
Definition strings.h:161
ao2_container
Generic container type.
Definition astobj2_container_private.h:270
namedgroup_member
Named group member structure.
Definition channel.c:7687

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
chanchannel to hang up (NULL tolerant)

Hang up a channel.

Definition at line 2540 of file channel.c.

2541{
2542 /* Be NULL safe for RAII_VAR() usage. */
2543 if (!chan) {
2544 return;
2545 }
2546
2547 ast_debug(1, "Channel %p '%s' hanging up. Refs: %d\n", chan, ast_channel_name(chan),
2548 ao2_ref(chan, 0));
2549
2550 ast_autoservice_stop(chan);
2551
2552 ast_channel_lock(chan);
2553
2554 while (ast_channel_masq(chan) || ast_channel_masqr(chan)) {
2555 CHANNEL_DEADLOCK_AVOIDANCE(chan);
2556 }
2557
2558 /* Mark as a zombie so a masquerade cannot be setup on this channel. */
2559 ast_set_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE);
2560
2561 ast_channel_unlock(chan);
2562
2563 /*
2564 * XXX if running the hangup handlers here causes problems
2565 * because the handlers take too long to execute, we could move
2566 * the meat of this function into another thread. A thread
2567 * where channels go to die.
2568 *
2569 * If this is done, ast_autoservice_chan_hangup_peer() will no
2570 * longer be needed.
2571 */
2572 ast_pbx_hangup_handler_run(chan);
2573 ast_channel_unlink(chan);
2574 ast_channel_lock(chan);
2575
2576 destroy_hooks(chan);
2577
2578 free_translation(chan);
2579 /* Close audio stream */
2580 if (ast_channel_stream(chan)) {
2581 ast_closestream(ast_channel_stream(chan));
2582 ast_channel_stream_set(chan, NULL);
2583 }
2584 /* Close video stream */
2585 if (ast_channel_vstream(chan)) {
2586 ast_closestream(ast_channel_vstream(chan));
2587 ast_channel_vstream_set(chan, NULL);
2588 }
2589 if (ast_channel_sched(chan)) {
2590 ast_sched_context_destroy(ast_channel_sched(chan));
2591 ast_channel_sched_set(chan, NULL);
2592 }
2593
2594 if (ast_channel_generatordata(chan)) { /* Clear any tone stuff remaining */
2595 if (ast_channel_generator(chan) && ast_channel_generator(chan)->release) {
2596 ast_channel_generator(chan)->release(chan, ast_channel_generatordata(chan));
2597 }
2598 }
2599 ast_channel_generatordata_set(chan, NULL);
2600 ast_channel_generator_set(chan, NULL);
2601
2602 if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING)) {
2603 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",
2604 ast_get_tid(), ast_channel_name(chan), ast_channel_blocker_tid(chan),
2605 ast_channel_blockproc(chan));
2606 ast_assert(0);
2607 }
2608
2609 if (ast_channel_tech(chan)->hangup) {
2610 ast_channel_tech(chan)->hangup(chan);
2611 }
2612
2613 ast_channel_unlock(chan);
2614
2615 ast_cc_offer(chan);
2616
2617 ast_channel_unref(chan);
2618}
ast_cc_offer
int ast_cc_offer(struct ast_channel *caller_chan)
Offer CC to a caller.
Definition ccss.c:3780
hangup
static int hangup(void *data)
Definition chan_pjsip.c:2536
destroy_hooks
static void destroy_hooks(struct ast_channel *chan)
Definition channel.c:2529
free_translation
static void free_translation(struct ast_channel *clonechan)
Definition channel.c:2486
ast_closestream
int ast_closestream(struct ast_filestream *f)
Closes a stream.
Definition file.c:1130
CHANNEL_DEADLOCK_AVOIDANCE
#define CHANNEL_DEADLOCK_AVOIDANCE(chan)
Definition lock.h:481
ast_pbx_hangup_handler_run
int ast_pbx_hangup_handler_run(struct ast_channel *chan)
Run all hangup handlers on the channel.
Definition pbx_hangup_handler.c:58
ast_sched_context_destroy
void ast_sched_context_destroy(struct ast_sched_context *c)
destroys a schedule context
Definition sched.c:271
ast_channel_tech::hangup
int(*const hangup)(struct ast_channel *chan)
Hangup (and possibly destroy) the channel.
Definition channel.h:724

References ao2_ref, 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_unlink(), 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, 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_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), 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_eval_function(), 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(), wait_for_answer(), 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
chanchannel to change the indication
conditionwhich condition to indicate on the channel
Returns
Returns 0 on success, -1 on failure

Definition at line 4298 of file channel.c.

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

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_progress(), 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(), wait_for_answer(), 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
chanchannel to change the indication
conditionwhich condition to indicate on the channel
datapointer to payload data
datalensize of payload data
Returns
Returns 0 on success, -1 on failure

Definition at line 4676 of file channel.c.

4677{
4678 int res;
4679 /* this frame is used by framehooks. if it is set, we must free it at the end of this function */
4680 struct ast_frame *awesome_frame = NULL;
4681
4682 ast_channel_lock(chan);
4683
4684 /* Don't bother if the channel is about to go away, anyway. */
4685 if ((ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE)
4686 || (ast_check_hangup(chan) && !ast_channel_is_leaving_bridge(chan)))
4687 && _condition != AST_CONTROL_MASQUERADE_NOTIFY) {
4688 res = -1;
4689 goto indicate_cleanup;
4690 }
4691
4692 if (!ast_framehook_list_is_empty(ast_channel_framehooks(chan))) {
4693 /* Do framehooks now, do it, go, go now */
4694 struct ast_frame frame = {
4695 .frametype = AST_FRAME_CONTROL,
4696 .subclass.integer = _condition,
4697 .data.ptr = (void *) data, /* this cast from const is only okay because we do the ast_frdup below */
4698 .datalen = datalen
4699 };
4700
4701 /* we have now committed to freeing this frame */
4702 awesome_frame = ast_frdup(&frame);
4703
4704 /* who knows what we will get back! the anticipation is killing me. */
4705 awesome_frame = ast_framehook_list_write_event(ast_channel_framehooks(chan),
4706 awesome_frame);
4707 if (!awesome_frame
4708 || awesome_frame->frametype != AST_FRAME_CONTROL) {
4709 res = 0;
4710 goto indicate_cleanup;
4711 }
4712
4713 _condition = awesome_frame->subclass.integer;
4714 data = awesome_frame->data.ptr;
4715 datalen = awesome_frame->datalen;
4716 }
4717
4718 res = indicate_data_internal(chan, _condition, data, datalen);
4719
4720indicate_cleanup:
4721 ast_channel_unlock(chan);
4722 if (awesome_frame) {
4723 ast_frfree(awesome_frame);
4724 }
4725
4726 return res;
4727}
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.
Definition channel.c:10730
indicate_data_internal
static int indicate_data_internal(struct ast_channel *chan, int _condition, const void *data, size_t datalen)
Definition channel.c:4492
ast_framehook_list_is_empty
int ast_framehook_list_is_empty(struct ast_framehook_list *framehooks)
Determine if an framehook list is empty or not.
Definition framehook.c:274
ast_framehook_list_write_event
struct ast_frame * ast_framehook_list_write_event(struct ast_framehook_list *framehooks, struct ast_frame *frame)
This is used by the channel API push a frame write event to a channel's framehook list.
Definition framehook.c:313
ast_frdup
#define ast_frdup(fr)
Copies a frame.
Definition include/asterisk/frame.h:594
AST_CONTROL_MASQUERADE_NOTIFY
@ AST_CONTROL_MASQUERADE_NOTIFY
Definition include/asterisk/frame.h:311

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_ari_channels_transfer_progress(), 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(), 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
frameThe frame we just read
Return values
1frame should be kept
0frame should be dropped

Definition at line 1454 of file channel.c.

1455{
1456 /* Do not add a default entry in this switch statement. Each new
1457 * frame type should be addressed directly as to whether it should
1458 * be queued up or not.
1459 */
1460 switch (frame->frametype) {
1461 case AST_FRAME_BRIDGE_ACTION:
1462 case AST_FRAME_BRIDGE_ACTION_SYNC:
1463 case AST_FRAME_CONTROL:
1464 case AST_FRAME_TEXT:
1465 case AST_FRAME_TEXT_DATA:
1466 case AST_FRAME_IMAGE:
1467 case AST_FRAME_HTML:
1468 return 1;
1469
1470 case AST_FRAME_DTMF_END:
1471 case AST_FRAME_DTMF_BEGIN:
1472 case AST_FRAME_VOICE:
1473 case AST_FRAME_VIDEO:
1474 case AST_FRAME_NULL:
1475 case AST_FRAME_IAX:
1476 case AST_FRAME_CNG:
1477 case AST_FRAME_MODEM:
1478 case AST_FRAME_RTCP:
1479 return 0;
1480 }
1481 return 0;
1482}

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

8267{
8268 void *match;
8269 struct ao2_container *group_a = (struct ao2_container *) a;
8270 struct ao2_container *group_b = (struct ao2_container *) b;
8271
8272 if (!a || !b) {
8273 return 0;
8274 }
8275
8276 /*
8277 * Do groups a and b intersect? Since a and b are hash tables,
8278 * the average time complexity is:
8279 * O(a.count <= b.count ? a.count : b.count)
8280 */
8281 if (ao2_container_count(group_b) < ao2_container_count(group_a)) {
8282 /* Traverse over the smaller group. */
8283 SWAP(group_a, group_b);
8284 }
8285 match = ao2_callback(group_a, 0, namedgroup_match, group_b);
8286 ao2_cleanup(match);
8287
8288 return match != NULL;
8289}
match
static int match(struct ast_sockaddr *addr, unsigned short callno, unsigned short dcallno, const struct chan_iax2_pvt *cur, int check_dcallno)
Definition chan_iax2.c:2401
namedgroup_match
static int namedgroup_match(void *obj, void *arg, int flags)
Definition channel.c:8256
SWAP
#define SWAP(a, b)
Definition utils.h:256

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
destDestination caller
srcSource caller

Definition at line 1973 of file channel.c.

1974{
1975 if (dest == src) {
1976 /* Don't copy to self */
1977 return;
1978 }
1979
1980 ast_party_id_copy(&dest->id, &src->id);
1981 ast_party_id_copy(&dest->ani, &src->ani);
1982 ast_party_id_copy(&dest->priv, &src->priv);
1983 dest->ani2 = src->ani2;
1984}
ast_party_caller::priv
struct ast_party_id priv
Private caller party ID.
Definition channel.h:432

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
doomedThe caller party to destroy.

Definition at line 2002 of file channel.c.

2003{
2004 ast_party_id_free(&doomed->id);
2005 ast_party_id_free(&doomed->ani);
2006 ast_party_id_free(&doomed->priv);
2007}
ast_party_id_free
void ast_party_id_free(struct ast_party_id *doomed)
Destroy the party id contents.
Definition channel.c:1798

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
initCaller structure to initialize.

Definition at line 1965 of file channel.c.

1966{
1967 ast_party_id_init(&init->id);
1968 ast_party_id_init(&init->ani);
1969 ast_party_id_init(&init->priv);
1970 init->ani2 = 0;
1971}
ast_party_id_init
void ast_party_id_init(struct ast_party_id *init)
Initialize the given party id structure.
Definition channel.c:1744

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
destThe caller one wishes to update
srcThe new caller values to update the dest
updateWhat caller information to update. NULL if all.

Definition at line 1994 of file channel.c.

1995{
1996 ast_party_id_set(&dest->id, &src->id, update ? &update->id : NULL);
1997 ast_party_id_set(&dest->ani, &src->ani, update ? &update->ani : NULL);
1998 ast_party_id_set(&dest->priv, &src->priv, update ? &update->priv : NULL);
1999 dest->ani2 = src->ani2;
2000}
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.
Definition channel.c:1775

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
initCaller structure to initialize.
guideSource caller to use as a guide in initializing.

Definition at line 1986 of file channel.c.

1987{
1988 ast_party_id_set_init(&init->id, &guide->id);
1989 ast_party_id_set_init(&init->ani, &guide->ani);
1990 ast_party_id_set_init(&init->priv, &guide->priv);
1991 init->ani2 = guide->ani2;
1992}
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.
Definition channel.c:1767

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
connectedCollected caller information for the connected line
callerCaller 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 2050 of file channel.c.

2051{
2052 connected->id = caller->id;
2053 connected->ani = caller->ani;
2054 connected->priv = caller->priv;
2055 connected->ani2 = caller->ani2;
2056 connected->source = AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN;
2057}
AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN
@ AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN
Definition callerid.h:552

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
destDestination connected line
srcSource connected line

Definition at line 2018 of file channel.c.

2019{
2020 if (dest == src) {
2021 /* Don't copy to self */
2022 return;
2023 }
2024
2025 ast_party_id_copy(&dest->id, &src->id);
2026 ast_party_id_copy(&dest->ani, &src->ani);
2027 ast_party_id_copy(&dest->priv, &src->priv);
2028 dest->ani2 = src->ani2;
2029 dest->source = src->source;
2030}
ast_party_connected_line::source
int source
Information about the source of an update.
Definition channel.h:484

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(), wait_for_answer(), 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
doomedThe connected line information to destroy.

Definition at line 2059 of file channel.c.

2060{
2061 ast_party_id_free(&doomed->id);
2062 ast_party_id_free(&doomed->ani);
2063 ast_party_id_free(&doomed->priv);
2064}

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(), update_connected_line_from_peer(), wait_for_answer(), 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
initConnected line structure to initialize.

Definition at line 2009 of file channel.c.

2010{
2011 ast_party_id_init(&init->id);
2012 ast_party_id_init(&init->ani);
2013 ast_party_id_init(&init->priv);
2014 init->ani2 = 0;
2015 init->source = AST_CONNECTED_LINE_UPDATE_SOURCE_UNKNOWN;
2016}

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(), 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
destThe connected line one wishes to update
srcThe new connected line values to update the dest
updateWhat connected line information to update. NULL if all.

Definition at line 2041 of file channel.c.

2042{
2043 ast_party_id_set(&dest->id, &src->id, update ? &update->id : NULL);
2044 ast_party_id_set(&dest->ani, &src->ani, update ? &update->ani : NULL);
2045 ast_party_id_set(&dest->priv, &src->priv, update ? &update->priv : NULL);
2046 dest->ani2 = src->ani2;
2047 dest->source = src->source;
2048}

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(), 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
initConnected line structure to initialize.
guideSource connected line to use as a guide in initializing.

Definition at line 2032 of file channel.c.

2033{
2034 ast_party_id_set_init(&init->id, &guide->id);
2035 ast_party_id_set_init(&init->ani, &guide->ani);
2036 ast_party_id_set_init(&init->priv, &guide->priv);
2037 init->ani2 = guide->ani2;
2038 init->source = guide->source;
2039}

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(), 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
destDestination dialed party
srcSource dialed party

Definition at line 1923 of file channel.c.

1924{
1925 if (dest == src) {
1926 /* Don't copy to self */
1927 return;
1928 }
1929
1930 ast_free(dest->number.str);
1931 dest->number.str = ast_strdup(src->number.str);
1932 dest->number.plan = src->number.plan;
1933 ast_party_subaddress_copy(&dest->subaddress, &src->subaddress);
1934 dest->transit_network_select = src->transit_network_select;
1935}
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.
Definition channel.c:1692
ast_party_dialed::subaddress
struct ast_party_subaddress subaddress
Dialed/Called subaddress.
Definition channel.h:393
ast_party_dialed::number
struct ast_party_dialed::@218 number
Dialed/Called number.
ast_party_dialed::str
char * str
Subscriber phone number (Malloced)
Definition channel.h:388
ast_party_dialed::plan
int plan
Q.931 Type-Of-Number and Numbering-Plan encoded fields.
Definition channel.h:390
ast_party_dialed::transit_network_select
int transit_network_select
Transit Network Select.
Definition channel.h:399

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
doomedThe dialed party to destroy.

Definition at line 1958 of file channel.c.

1959{
1960 ast_free(doomed->number.str);
1961 doomed->number.str = NULL;
1962 ast_party_subaddress_free(&doomed->subaddress);
1963}
ast_party_subaddress_free
void ast_party_subaddress_free(struct ast_party_subaddress *doomed)
Destroy the party subaddress contents.
Definition channel.c:1731

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
initDialed structure to initialize.

Definition at line 1915 of file channel.c.

1916{
1917 init->number.str = NULL;
1918 init->number.plan = 0;/* Unknown */
1919 ast_party_subaddress_init(&init->subaddress);
1920 init->transit_network_select = 0;
1921}
ast_party_subaddress_init
void ast_party_subaddress_init(struct ast_party_subaddress *init)
Initialize the given subaddress structure.
Definition channel.c:1684

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
destThe dialed one wishes to update
srcThe new dialed values to update the dest

Definition at line 1945 of file channel.c.

1946{
1947 if (src->number.str && src->number.str != dest->number.str) {
1948 ast_free(dest->number.str);
1949 dest->number.str = ast_strdup(src->number.str);
1950 }
1951 dest->number.plan = src->number.plan;
1952
1953 ast_party_subaddress_set(&dest->subaddress, &src->subaddress);
1954
1955 dest->transit_network_select = src->transit_network_select;
1956}
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.
Definition channel.c:1714

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
initCaller structure to initialize.
guideSource dialed to use as a guide in initializing.

Definition at line 1937 of file channel.c.

1938{
1939 init->number.str = NULL;
1940 init->number.plan = guide->number.plan;
1941 ast_party_subaddress_set_init(&init->subaddress, &guide->subaddress);
1942 init->transit_network_select = guide->transit_network_select;
1943}
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.
Definition channel.c:1706

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
destDestination party id
srcSource party id

Definition at line 1752 of file channel.c.

1753{
1754 if (dest == src) {
1755 /* Don't copy to self */
1756 return;
1757 }
1758
1759 ast_party_name_copy(&dest->name, &src->name);
1760 ast_party_number_copy(&dest->number, &src->number);
1761 ast_party_subaddress_copy(&dest->subaddress, &src->subaddress);
1762
1763 ast_free(dest->tag);
1764 dest->tag = ast_strdup(src->tag);
1765}
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.
Definition channel.c:1639
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.
Definition channel.c:1586
ast_party_id::subaddress
struct ast_party_subaddress subaddress
Subscriber subaddress.
Definition channel.h:346
ast_party_id::tag
char * tag
User-set "tag".
Definition channel.h:356
ast_party_id::name
struct ast_party_name name
Subscriber name.
Definition channel.h:342
ast_party_id::number
struct ast_party_number number
Subscriber phone number.
Definition channel.h:344

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
doomedThe party id to destroy.

Definition at line 1798 of file channel.c.

1799{
1800 ast_party_name_free(&doomed->name);
1801 ast_party_number_free(&doomed->number);
1802 ast_party_subaddress_free(&doomed->subaddress);
1803
1804 ast_free(doomed->tag);
1805 doomed->tag = NULL;
1806}
ast_party_name_free
void ast_party_name_free(struct ast_party_name *doomed)
Destroy the party name contents.
Definition channel.c:1625
ast_party_number_free
void ast_party_number_free(struct ast_party_number *doomed)
Destroy the party number contents.
Definition channel.c:1678

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
initParty id structure to initialize.

Definition at line 1744 of file channel.c.

1745{
1746 ast_party_name_init(&init->name);
1747 ast_party_number_init(&init->number);
1748 ast_party_subaddress_init(&init->subaddress);
1749 init->tag = NULL;
1750}
ast_party_name_init
void ast_party_name_init(struct ast_party_name *init)
Initialize the given name structure.
Definition channel.c:1578
ast_party_number_init
void ast_party_number_init(struct ast_party_number *init)
Initialize the given number structure.
Definition channel.c:1631

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
idThe party id to invalidate.

Definition at line 1876 of file channel.c.

1877{
1878 id->name.valid = 0;
1879 id->number.valid = 0;
1880 id->subaddress.valid = 0;
1881}

◆ 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
baseThe party id which is merged.
overlayThe 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 1889 of file channel.c.

1890{
1891 struct ast_party_id merged;
1892
1893 merged = *base;
1894 if (overlay->name.valid) {
1895 merged.name = overlay->name;
1896 }
1897 if (overlay->number.valid) {
1898 merged.number = overlay->number;
1899 }
1900 if (overlay->subaddress.valid) {
1901 merged.subaddress = overlay->subaddress;
1902 }
1903 /* Note the actual structure is returned and not a pointer to it! */
1904 return merged;
1905}
ast_party_name::valid
unsigned char valid
TRUE if the name information is valid/present.
Definition channel.h:281
ast_party_number::valid
unsigned char valid
TRUE if the number information is valid/present.
Definition channel.h:299
ast_party_subaddress::valid
unsigned char valid
TRUE if the subaddress information is valid/present.
Definition channel.h:330

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
destThe resulting merged party id.
baseThe party id which is merged.
overlayThe party id which is used to merge into.

Definition at line 1907 of file channel.c.

1908{
1909 struct ast_party_id merged;
1910
1911 merged = ast_party_id_merge(base, overlay);
1912 ast_party_id_copy(dest, &merged);
1913}
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.
Definition channel.c:1889

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
idParty to determine the overall presentation value.
Returns
Overall presentation value for the given party.

Definition at line 1808 of file channel.c.

1809{
1810 int number_priority;
1811 int number_value;
1812 int number_screening;
1813 int name_priority;
1814 int name_value;
1815
1816 /* Determine name presentation priority. */
1817 if (!id->name.valid) {
1818 name_value = AST_PRES_UNAVAILABLE;
1819 name_priority = 3;
1820 } else {
1821 name_value = id->name.presentation & AST_PRES_RESTRICTION;
1822 switch (name_value) {
1823 case AST_PRES_RESTRICTED:
1824 name_priority = 0;
1825 break;
1826 case AST_PRES_ALLOWED:
1827 name_priority = 1;
1828 break;
1829 case AST_PRES_UNAVAILABLE:
1830 name_priority = 2;
1831 break;
1832 default:
1833 name_value = AST_PRES_UNAVAILABLE;
1834 name_priority = 3;
1835 break;
1836 }
1837 }
1838
1839 /* Determine number presentation priority. */
1840 if (!id->number.valid) {
1841 number_screening = AST_PRES_USER_NUMBER_UNSCREENED;
1842 number_value = AST_PRES_UNAVAILABLE;
1843 number_priority = 3;
1844 } else {
1845 number_screening = id->number.presentation & AST_PRES_NUMBER_TYPE;
1846 number_value = id->number.presentation & AST_PRES_RESTRICTION;
1847 switch (number_value) {
1848 case AST_PRES_RESTRICTED:
1849 number_priority = 0;
1850 break;
1851 case AST_PRES_ALLOWED:
1852 number_priority = 1;
1853 break;
1854 case AST_PRES_UNAVAILABLE:
1855 number_priority = 2;
1856 break;
1857 default:
1858 number_screening = AST_PRES_USER_NUMBER_UNSCREENED;
1859 number_value = AST_PRES_UNAVAILABLE;
1860 number_priority = 3;
1861 break;
1862 }
1863 }
1864
1865 /* Select the wining presentation value. */
1866 if (name_priority < number_priority) {
1867 number_value = name_value;
1868 }
1869 if (number_value == AST_PRES_UNAVAILABLE) {
1870 return AST_PRES_NUMBER_NOT_AVAILABLE;
1871 }
1872
1873 return number_value | number_screening;
1874}
id
enum queue_result id
Definition app_queue.c:1790
AST_PRES_USER_NUMBER_UNSCREENED
#define AST_PRES_USER_NUMBER_UNSCREENED
Definition callerid.h:426
AST_PRES_UNAVAILABLE
#define AST_PRES_UNAVAILABLE
Definition callerid.h:434
AST_PRES_RESTRICTED
#define AST_PRES_RESTRICTED
Definition callerid.h:433
AST_PRES_ALLOWED
#define AST_PRES_ALLOWED
Definition callerid.h:432
AST_PRES_NUMBER_NOT_AVAILABLE
#define AST_PRES_NUMBER_NOT_AVAILABLE
Definition callerid.h:461
AST_PRES_NUMBER_TYPE
#define AST_PRES_NUMBER_TYPE
Definition callerid.h:425
AST_PRES_RESTRICTION
#define AST_PRES_RESTRICTION
Definition callerid.h:431

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
idThe party id to reset.

Definition at line 1883 of file channel.c.

1884{
1885 ast_party_id_free(id);
1886 ast_party_id_init(id);
1887}

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
destThe id one wishes to update
srcThe new id values to update the dest
updateWhat id information to update. NULL if all.

Definition at line 1775 of file channel.c.

1776{
1777 if (dest == src) {
1778 /* Don't set to self */
1779 return;
1780 }
1781
1782 if (!update || update->name) {
1783 ast_party_name_set(&dest->name, &src->name);
1784 }
1785 if (!update || update->number) {
1786 ast_party_number_set(&dest->number, &src->number);
1787 }
1788 if (!update || update->subaddress) {
1789 ast_party_subaddress_set(&dest->subaddress, &src->subaddress);
1790 }
1791
1792 if (src->tag && src->tag != dest->tag) {
1793 ast_free(dest->tag);
1794 dest->tag = ast_strdup(src->tag);
1795 }
1796}
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.
Definition channel.c:1661
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.
Definition channel.c:1608

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
initParty id structure to initialize.
guideSource party id to use as a guide in initializing.

Definition at line 1767 of file channel.c.

1768{
1769 ast_party_name_set_init(&init->name, &guide->name);
1770 ast_party_number_set_init(&init->number, &guide->number);
1771 ast_party_subaddress_set_init(&init->subaddress, &guide->subaddress);
1772 init->tag = NULL;
1773}
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.
Definition channel.c:1600
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.
Definition channel.c:1653

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
destDestination party name
srcSource party name

Definition at line 1586 of file channel.c.

1587{
1588 if (dest == src) {
1589 /* Don't copy to self */
1590 return;
1591 }
1592
1593 ast_free(dest->str);
1594 dest->str = ast_strdup(src->str);
1595 dest->char_set = src->char_set;
1596 dest->presentation = src->presentation;
1597 dest->valid = src->valid;
1598}
ast_party_name::char_set
int char_set
Character set the name is using.
Definition channel.h:274
ast_party_name::presentation
int presentation
Q.931 encoded presentation-indicator encoded field.
Definition channel.h:279
ast_party_name::str
char * str
Subscriber name (Malloced)
Definition channel.h:266

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
doomedThe party name to destroy.

Definition at line 1625 of file channel.c.

1626{
1627 ast_free(doomed->str);
1628 doomed->str = NULL;
1629}

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
initName structure to initialize.

Definition at line 1578 of file channel.c.

1579{
1580 init->str = NULL;
1581 init->char_set = AST_PARTY_CHAR_SET_ISO8859_1;
1582 init->presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
1583 init->valid = 0;
1584}

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
destThe name one wishes to update
srcThe new name values to update the dest

Definition at line 1608 of file channel.c.

1609{
1610 if (dest == src) {
1611 /* Don't set to self */
1612 return;
1613 }
1614
1615 if (src->str && src->str != dest->str) {
1616 ast_free(dest->str);
1617 dest->str = ast_strdup(src->str);
1618 }
1619
1620 dest->char_set = src->char_set;
1621 dest->presentation = src->presentation;
1622 dest->valid = src->valid;
1623}

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
initParty name structure to initialize.
guideSource party name to use as a guide in initializing.

Definition at line 1600 of file channel.c.

1601{
1602 init->str = NULL;
1603 init->char_set = guide->char_set;
1604 init->presentation = guide->presentation;
1605 init->valid = guide->valid;
1606}

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
destDestination party number
srcSource party number

Definition at line 1639 of file channel.c.

1640{
1641 if (dest == src) {
1642 /* Don't copy to self */
1643 return;
1644 }
1645
1646 ast_free(dest->str);
1647 dest->str = ast_strdup(src->str);
1648 dest->plan = src->plan;
1649 dest->presentation = src->presentation;
1650 dest->valid = src->valid;
1651}
ast_party_number::presentation
int presentation
Q.931 presentation-indicator and screening-indicator encoded fields.
Definition channel.h:297
ast_party_number::str
char * str
Subscriber phone number (Malloced)
Definition channel.h:293
ast_party_number::plan
int plan
Q.931 Type-Of-Number and Numbering-Plan encoded fields.
Definition channel.h:295

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
doomedThe party number to destroy.

Definition at line 1678 of file channel.c.

1679{
1680 ast_free(doomed->str);
1681 doomed->str = NULL;
1682}

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
initNumber structure to initialize.

Definition at line 1631 of file channel.c.

1632{
1633 init->str = NULL;
1634 init->plan = 0;/* Unknown */
1635 init->presentation = AST_PRES_ALLOWED_USER_NUMBER_NOT_SCREENED;
1636 init->valid = 0;
1637}

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
destThe number one wishes to update
srcThe new number values to update the dest

Definition at line 1661 of file channel.c.

1662{
1663 if (dest == src) {
1664 /* Don't set to self */
1665 return;
1666 }
1667
1668 if (src->str && src->str != dest->str) {
1669 ast_free(dest->str);
1670 dest->str = ast_strdup(src->str);
1671 }
1672
1673 dest->plan = src->plan;
1674 dest->presentation = src->presentation;
1675 dest->valid = src->valid;
1676}

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
initParty number structure to initialize.
guideSource party number to use as a guide in initializing.

Definition at line 1653 of file channel.c.

1654{
1655 init->str = NULL;
1656 init->plan = guide->plan;
1657 init->presentation = guide->presentation;
1658 init->valid = guide->valid;
1659}

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
destDestination redirecting
srcSource redirecting

Definition at line 2122 of file channel.c.

2123{
2124 if (dest == src) {
2125 /* Don't copy to self */
2126 return;
2127 }
2128
2129 ast_party_id_copy(&dest->orig, &src->orig);
2130 ast_party_id_copy(&dest->from, &src->from);
2131 ast_party_id_copy(&dest->to, &src->to);
2132 ast_party_id_copy(&dest->priv_orig, &src->priv_orig);
2133 ast_party_id_copy(&dest->priv_from, &src->priv_from);
2134 ast_party_id_copy(&dest->priv_to, &src->priv_to);
2135 ast_party_redirecting_reason_copy(&dest->reason, &src->reason);
2136 ast_party_redirecting_reason_copy(&dest->orig_reason, &src->orig_reason);
2137 dest->count = src->count;
2138}
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.
Definition channel.c:2072
ast_party_redirecting::orig_reason
struct ast_party_redirecting_reason orig_reason
Reason for the redirection by the original party.
Definition channel.h:547
ast_party_redirecting::reason
struct ast_party_redirecting_reason reason
Reason for the redirection.
Definition channel.h:544
ast_party_redirecting::count
int count
Number of times the call was redirected.
Definition channel.h:550

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
doomedThe redirecting information to destroy.

Definition at line 2166 of file channel.c.

2167{
2168 ast_party_id_free(&doomed->orig);
2169 ast_party_id_free(&doomed->from);
2170 ast_party_id_free(&doomed->to);
2171 ast_party_id_free(&doomed->priv_orig);
2172 ast_party_id_free(&doomed->priv_from);
2173 ast_party_id_free(&doomed->priv_to);
2174 ast_party_redirecting_reason_free(&doomed->reason);
2175 ast_party_redirecting_reason_free(&doomed->orig_reason);
2176}
ast_party_redirecting_reason_free
void ast_party_redirecting_reason_free(struct ast_party_redirecting_reason *doomed)
Destroy the redirecting reason contents.
Definition channel.c:2103

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
initRedirecting structure to initialize.

Definition at line 2109 of file channel.c.

2110{
2111 ast_party_id_init(&init->orig);
2112 ast_party_id_init(&init->from);
2113 ast_party_id_init(&init->to);
2114 ast_party_id_init(&init->priv_orig);
2115 ast_party_id_init(&init->priv_from);
2116 ast_party_id_init(&init->priv_to);
2117 ast_party_redirecting_reason_init(&init->reason);
2118 ast_party_redirecting_reason_init(&init->orig_reason);
2119 init->count = 0;
2120}
ast_party_redirecting_reason_init
void ast_party_redirecting_reason_init(struct ast_party_redirecting_reason *init)
Initialize the given redirecting reason structure.
Definition channel.c:2066

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
destDestination redirecting reason
srcSource redirecting reason

Definition at line 2072 of file channel.c.

2073{
2074 if (dest == src) {
2075 return;
2076 }
2077
2078 ast_free(dest->str);
2079 dest->str = ast_strdup(src->str);
2080 dest->code = src->code;
2081}
ast_party_redirecting_reason::code
int code
enum AST_REDIRECTING_REASON value for redirection
Definition channel.h:512
ast_party_redirecting_reason::str
char * str
a string value for the redirecting reason
Definition channel.h:509

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
doomedThe redirecting reason to destroy.

Definition at line 2103 of file channel.c.

2104{
2105 ast_free(doomed->str);
2106}

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
initRedirecting reason structure to initialize

Definition at line 2066 of file channel.c.

2067{
2068 init->str = NULL;
2069 init->code = AST_REDIRECTING_REASON_UNKNOWN;
2070}
AST_REDIRECTING_REASON_UNKNOWN
@ AST_REDIRECTING_REASON_UNKNOWN
Definition callerid.h:499

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
destThe redirecting reason one wishes to update
srcThe new redirecting reason values to update the dest

Definition at line 2089 of file channel.c.

2090{
2091 if (dest == src) {
2092 return;
2093 }
2094
2095 if (src->str && src->str != dest->str) {
2096 ast_free(dest->str);
2097 dest->str = ast_strdup(src->str);
2098 }
2099
2100 dest->code = src->code;
2101}

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
initRedirecting reason structure to initialize.
guideSource redirecting reason to use as a guide in initializing.

Definition at line 2083 of file channel.c.

2084{
2085 init->str = NULL;
2086 init->code = guide->code;
2087}

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
destThe redirecting one wishes to update
srcThe new redirecting values to update the dest
updateWhat redirecting information to update. NULL if all.

Definition at line 2153 of file channel.c.

2154{
2155 ast_party_id_set(&dest->orig, &src->orig, update ? &update->orig : NULL);
2156 ast_party_id_set(&dest->from, &src->from, update ? &update->from : NULL);
2157 ast_party_id_set(&dest->to, &src->to, update ? &update->to : NULL);
2158 ast_party_id_set(&dest->priv_orig, &src->priv_orig, update ? &update->priv_orig : NULL);
2159 ast_party_id_set(&dest->priv_from, &src->priv_from, update ? &update->priv_from : NULL);
2160 ast_party_id_set(&dest->priv_to, &src->priv_to, update ? &update->priv_to : NULL);
2161 ast_party_redirecting_reason_set(&dest->reason, &src->reason);
2162 ast_party_redirecting_reason_set(&dest->orig_reason, &src->orig_reason);
2163 dest->count = src->count;
2164}
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.
Definition channel.c:2089

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
initRedirecting id structure to initialize.
guideSource redirecting id to use as a guide in initializing.

Definition at line 2140 of file channel.c.

2141{
2142 ast_party_id_set_init(&init->orig, &guide->orig);
2143 ast_party_id_set_init(&init->from, &guide->from);
2144 ast_party_id_set_init(&init->to, &guide->to);
2145 ast_party_id_set_init(&init->priv_orig, &guide->priv_orig);
2146 ast_party_id_set_init(&init->priv_from, &guide->priv_from);
2147 ast_party_id_set_init(&init->priv_to, &guide->priv_to);
2148 ast_party_redirecting_reason_set_init(&init->reason, &guide->reason);
2149 ast_party_redirecting_reason_set_init(&init->orig_reason, &guide->orig_reason);
2150 init->count = guide->count;
2151}
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.
Definition channel.c:2083

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
destDestination party subaddress
srcSource party subaddress

Definition at line 1692 of file channel.c.

1693{
1694 if (dest == src) {
1695 /* Don't copy to self */
1696 return;
1697 }
1698
1699 ast_free(dest->str);
1700 dest->str = ast_strdup(src->str);
1701 dest->type = src->type;
1702 dest->odd_even_indicator = src->odd_even_indicator;
1703 dest->valid = src->valid;
1704}
ast_party_subaddress::odd_even_indicator
unsigned char odd_even_indicator
TRUE if odd number of address signals.
Definition channel.h:328
ast_party_subaddress::str
char * str
Malloced subaddress string.
Definition channel.h:315
ast_party_subaddress::type
int type
Q.931 subaddress type.
Definition channel.h:322

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
doomedThe party subaddress to destroy.

Definition at line 1731 of file channel.c.

1732{
1733 ast_free(doomed->str);
1734 doomed->str = NULL;
1735}

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
initSubaddress structure to initialize.

Definition at line 1684 of file channel.c.

1685{
1686 init->str = NULL;
1687 init->type = 0;
1688 init->odd_even_indicator = 0;
1689 init->valid = 0;
1690}

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
destThe subaddress one wishes to update
srcThe new subaddress values to update the dest

Definition at line 1714 of file channel.c.

1715{
1716 if (dest == src) {
1717 /* Don't set to self */
1718 return;
1719 }
1720
1721 if (src->str && src->str != dest->str) {
1722 ast_free(dest->str);
1723 dest->str = ast_strdup(src->str);
1724 }
1725
1726 dest->type = src->type;
1727 dest->odd_even_indicator = src->odd_even_indicator;
1728 dest->valid = src->valid;
1729}

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
initParty subaddress structure to initialize.
guideSource party subaddress to use as a guide in initializing.

Definition at line 1706 of file channel.c.

1707{
1708 init->str = NULL;
1709 init->type = guide->type;
1710 init->odd_even_indicator = guide->odd_even_indicator;
1711 init->valid = guide->valid;
1712}

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
chanChannel to execute Gosub.
sub_argsGosub application parameter string.
Note
Absolutely NO channel locks should be held before calling this function.
Return values
0on success.
-1on error.

Definition at line 6463 of file channel.c.

6464{
6465 int (*pre_call)(struct ast_channel *chan, const char *sub_args);
6466
6467 ast_channel_lock(chan);
6468 pre_call = ast_channel_tech(chan)->pre_call;
6469 if (pre_call) {
6470 int res;
6471
6472 res = pre_call(chan, sub_args);
6473 ast_channel_unlock(chan);
6474 return res;
6475 }
6476 ast_channel_unlock(chan);
6477 return ast_app_exec_sub(NULL, chan, sub_args, 0);
6478}
ast_app_exec_sub
int ast_app_exec_sub(struct ast_channel *autoservice_chan, struct ast_channel *sub_chan, const char *sub_args, int ignore_hangup)
Run a subroutine on a channel, placing an optional second channel into autoservice.
Definition main/app.c:297
ast_channel_tech::pre_call
int(* pre_call)(struct ast_channel *chan, const char *sub_args)
Execute a Gosub call on the channel in a technology specific way before a call is placed.
Definition channel.h:861

References ast_app_exec_sub(), ast_channel_lock, 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 8207 of file channel.c.

8208{
8209 unsigned int i;
8210 int first = 1;
8211 char num[3];
8212
8213 buf[0] = '\0';
8214
8215 if (!group) /* Return empty string if no group */
8216 return buf;
8217
8218 for (i = 0; i <= 63; i++) { /* Max group is 63 */
8219 if (group & ((ast_group_t) 1 << i)) {
8220 if (!first) {
8221 strncat(buf, ", ", buflen - strlen(buf) - 1);
8222 } else {
8223 first = 0;
8224 }
8225 snprintf(num, sizeof(num), "%u", i);
8226 strncat(buf, num, buflen - strlen(buf) - 1);
8227 }
8228 }
8229 return buf;
8230}
first
struct sla_ringing_trunk * first
Definition app_sla.c:338

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

8233{
8234 struct ao2_container *grp = (struct ao2_container *) group;
8235 struct namedgroup_member *ng;
8236 int first = 1;
8237 struct ao2_iterator it;
8238
8239 if (!grp) {
8240 return ast_str_buffer(*buf);
8241 }
8242
8243 for (it = ao2_iterator_init(grp, 0); (ng = ao2_iterator_next(&it)); ao2_ref(ng, -1)) {
8244 if (!first) {
8245 ast_str_append(buf, 0, ", ");
8246 } else {
8247 first = 0;
8248 }
8249 ast_str_append(buf, 0, "%s", ng->name);
8250 }
8251 ao2_iterator_destroy(&it);
8252
8253 return ast_str_buffer(*buf);
8254}
ao2_iterator_next
#define ao2_iterator_next(iter)
Definition astobj2.h:1911
ao2_iterator_destroy
void ao2_iterator_destroy(struct ao2_iterator *iter)
Destroy a container iterator.
Definition astobj2_container.c:534
ast_str_append
int ast_str_append(struct ast_str **buf, ssize_t max_len, const char *fmt,...)
Append to a thread local dynamic string.
Definition strings.h:1139
namedgroup_member::name
char name[1]
Definition channel.c:7691

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

5024{
5025 struct ast_frame a = { AST_FRAME_VOICE };
5026 char nothing[128];
5027
5028 /* Send an empty audio frame to get things moving */
5029 if (ast_channel_state(chan) != AST_STATE_UP) {
5030 ast_debug(3, "Prodding channel '%s'\n", ast_channel_name(chan));
5031 a.subclass.format = ast_channel_rawwriteformat(chan);
5032 a.data.ptr = nothing + AST_FRIENDLY_OFFSET;
5033 a.src = "ast_prod"; /* this better match check in ast_write */
5034 if (ast_write(chan, &a))
5035 ast_log(LOG_WARNING, "Prodding channel '%s' failed\n", ast_channel_name(chan));
5036 }
5037 return 0;
5038}
ast_write
int ast_write(struct ast_channel *chan, struct ast_frame *fr)
Write a frame to a channel This function writes the given frame to the indicated channel.
Definition channel.c:5167
AST_FRIENDLY_OFFSET
#define AST_FRIENDLY_OFFSET
Offset into a frame's data buffer.
Definition include/asterisk/frame.h:229

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
chanchannel to queue frame onto
topologytopology to be passed through the core to the peer channel
Return values
0success
non-zerofailure

Definition at line 1304 of file channel.c.

1305{
1306 struct ast_frame f = {
1307 AST_FRAME_CONTROL,
1308 .subclass.integer = AST_CONTROL_ANSWER,
1309 .subclass.topology = (struct ast_stream_topology *)topology,
1310 };
1311 return ast_queue_frame(chan, &f);
1312}

References AST_CONTROL_ANSWER, AST_FRAME_CONTROL, ast_queue_frame(), ast_frame_subclass::integer, and ast_frame::subclass.

◆ ast_queue_control()

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

Queue a control frame without payload.

Parameters
chanchannel to queue frame onto
controltype of control frame
Note
The channel does not need to be locked before calling this function.
Return values
zeroon success
non-zeroon failure

Queue a control frame without payload.

Definition at line 1289 of file channel.c.

1290{
1291 struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = control };
1292 return ast_queue_frame(chan, &f);
1293}

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

Referenced by __analog_handle_event(), __ast_read(), analog_call(), analog_callwaiting_deluxe(), 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(), handle_command(), 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(), video_info_incoming_request(), and websocket_handoff_to_channel().

◆ 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
chanchannel to queue frame onto
controltype of control frame
datapointer to payload data to be included in frame
datalennumber of bytes of payload data
Return values
0success
non-zerofailure

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

1298{
1299 struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = control, .data.ptr = (void *) data, .datalen = datalen };
1300 return ast_queue_frame(chan, &f);
1301}

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

Referenced by __analog_handle_event(), after_bridge_move_channel(), analog_callwaiting_deluxe(), 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
chanthe channel to queue the frame(s) on
fthe 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
0success
non-zerofailure

Definition at line 1171 of file channel.c.

1172{
1173 return __ast_queue_frame(chan, fin, 0, NULL);
1174}
__ast_queue_frame
static int __ast_queue_frame(struct ast_channel *chan, struct ast_frame *fin, int head, struct ast_frame *after)
Definition channel.c:1041

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(), AST_TEST_DEFINE(), AST_TEST_DEFINE(), 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_command(), 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(), 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
chanthe channel to queue the frame(s) on
fthe 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
0success
non-zerofailure

Definition at line 1176 of file channel.c.

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

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

1183{
1184 RAII_VAR(struct ast_json *, blob, ast_json_object_create(), ast_json_unref);
1185 struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_HANGUP };
1186 int res, cause, tech_cause;
1187
1188 if (!blob) {
1189 return -1;
1190 }
1191
1192 /* Yeah, let's not change a lock-critical value without locking */
1193 ast_channel_lock(chan);
1194 ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_DEV);
1195
1196 cause = ast_channel_hangupcause(chan);
1197 if (cause) {
1198 ast_json_object_set(blob, "cause", ast_json_integer_create(cause));
1199 }
1200 tech_cause = ast_channel_tech_hangupcause(chan);
1201 if (tech_cause) {
1202 ast_json_object_set(blob, "tech_cause", ast_json_integer_create(tech_cause));
1203 }
1204
1205 ast_channel_publish_blob(chan, ast_channel_hangup_request_type(), blob);
1206
1207 res = ast_queue_frame(chan, &f);
1208 ast_channel_unlock(chan);
1209 return res;
1210}
ast_channel_hangup_request_type
struct stasis_message_type * ast_channel_hangup_request_type(void)
Message type for when a hangup is requested on a channel.
ast_json_object_create
struct ast_json * ast_json_object_create(void)
Create a new JSON object.
Definition json.c:399
ast_json_integer_create
struct ast_json * ast_json_integer_create(intmax_t value)
Create a JSON integer.
Definition json.c:327
ast_json_object_set
int ast_json_object_set(struct ast_json *object, const char *key, struct ast_json *value)
Set a field in a JSON object.
Definition json.c:414

References ast_channel_hangup_request_type(), ast_channel_hangupcause(), ast_channel_lock, ast_channel_publish_blob(), ast_channel_softhangup_internal_flag_add(), ast_channel_tech_hangupcause(), ast_channel_unlock, AST_CONTROL_HANGUP, AST_FRAME_CONTROL, ast_json_integer_create(), ast_json_object_create(), ast_json_object_set(), ast_json_unref(), ast_queue_frame(), AST_SOFTHANGUP_DEV, ast_frame_subclass::integer, RAII_VAR, and ast_frame::subclass.

Referenced by analog_callwaiting_deluxe(), 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]chanchannel to queue frame onto
[in]causethe hangup cause
Return values
0on success
-1on error
Since
1.6.1

Queue a hangup frame with hangupcause set.

Definition at line 1213 of file channel.c.

1214{
1215 RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
1216 struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_HANGUP };
1217 int res;
1218 int tech_cause = 0;
1219
1220 if (cause >= 0) {
1221 f.data.uint32 = cause;
1222 }
1223
1224 /* Yeah, let's not change a lock-critical value without locking */
1225 ast_channel_lock(chan);
1226 ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_DEV);
1227 if (cause < 0) {
1228 f.data.uint32 = ast_channel_hangupcause(chan);
1229 }
1230 blob = ast_json_pack("{s: i}",
1231 "cause", cause);
1232 if (!blob) {
1233 ast_channel_unlock(chan);
1234 return -1;
1235 }
1236
1237 tech_cause = ast_channel_tech_hangupcause(chan);
1238 if (tech_cause) {
1239 ast_json_object_set(blob, "tech_cause", ast_json_integer_create(tech_cause));
1240 }
1241
1242 ast_channel_publish_blob(chan, ast_channel_hangup_request_type(), blob);
1243
1244 res = ast_queue_frame(chan, &f);
1245 ast_channel_unlock(chan);
1246 return res;
1247}
ast_frame::uint32
uint32_t uint32
Definition include/asterisk/frame.h:183

References ast_channel_hangup_request_type(), ast_channel_hangupcause(), ast_channel_lock, ast_channel_publish_blob(), ast_channel_softhangup_internal_flag_add(), ast_channel_tech_hangupcause(), ast_channel_unlock, AST_CONTROL_HANGUP, AST_FRAME_CONTROL, ast_json_integer_create(), ast_json_object_set(), ast_json_pack(), ast_json_unref(), ast_queue_frame(), AST_SOFTHANGUP_DEV, ast_frame::data, ast_frame_subclass::integer, NULL, RAII_VAR, ast_frame::subclass, and ast_frame::uint32.

Referenced by __analog_handle_event(), _websocket_request_hangup(), ast_unreal_hangup(), 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
chanchannel to queue frame onto
musicclassThe suggested musicclass for the other end to use
Note
The channel does not need to be locked before calling this function.
Return values
zeroon success
non-zeroon failure

Definition at line 1249 of file channel.c.

1250{
1251 struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_HOLD };
1252 struct ast_json *blob = NULL;
1253 int res;
1254
1255 if (!ast_strlen_zero(musicclass)) {
1256 f.data.ptr = (void *) musicclass;
1257 f.datalen = strlen(musicclass) + 1;
1258
1259 blob = ast_json_pack("{s: s}",
1260 "musicclass", musicclass);
1261 }
1262
1263 ast_channel_lock(chan);
1264 ast_channel_publish_blob(chan, ast_channel_hold_type(), blob);
1265 ast_channel_unlock(chan);
1266
1267 res = ast_queue_frame(chan, &f);
1268
1269 ast_json_unref(blob);
1270
1271 return res;
1272}
ast_channel_hold_type
struct stasis_message_type * ast_channel_hold_type(void)
Message type for when a channel is placed on hold.

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, ast_frame_subclass::integer, NULL, ast_frame::ptr, and ast_frame::subclass.

Referenced by __analog_handle_event(), analog_callwaiting_deluxe(), 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
chanchannel to queue frame onto
Note
The channel does not need to be locked before calling this function.
Return values
zeroon success
non-zeroon failure

Definition at line 1274 of file channel.c.

1275{
1276 struct ast_frame f = { AST_FRAME_CONTROL, .subclass.integer = AST_CONTROL_UNHOLD };
1277 int res;
1278
1279 ast_channel_lock(chan);
1280 ast_channel_publish_blob(chan, ast_channel_unhold_type(), NULL);
1281 ast_channel_unlock(chan);
1282
1283 res = ast_queue_frame(chan, &f);
1284
1285 return res;
1286}
ast_channel_unhold_type
struct stasis_message_type * ast_channel_unhold_type(void)
Message type for when a channel is removed from hold.

References ast_channel_lock, ast_channel_publish_blob(), ast_channel_unhold_type(), ast_channel_unlock, AST_CONTROL_UNHOLD, AST_FRAME_CONTROL, ast_queue_frame(), ast_frame_subclass::integer, NULL, and ast_frame::subclass.

Referenced by __analog_handle_event(), __analog_ss_thread(), __dahdi_exception(), analog_callwaiting_deluxe(), 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
chanchannel 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
0on success
non-zeroon failure

Definition at line 2690 of file channel.c.

2691{
2692 return ast_raw_answer_with_stream_topology(chan, NULL);
2693}
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.
Definition channel.c:2638

References ast_raw_answer_with_stream_topology(), and NULL.

Referenced by __ast_answer(), answer_trunk_chan(), app_control_answer(), pbx_builtin_answer(), refer_incoming_invite_request(), and wait_for_answer().

◆ 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
chanchannel to answer
topologythe 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
0on success
non-zeroon failure

Definition at line 2638 of file channel.c.

2639{
2640 int res = 0;
2641 SCOPE_TRACE(1, "%s\n", ast_channel_name(chan));
2642
2643 ast_channel_lock(chan);
2644
2645 /* You can't answer an outbound call */
2646 if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_OUTGOING)) {
2647 ast_channel_unlock(chan);
2648 return 0;
2649 }
2650
2651 /* Stop if we're a zombie or need a soft hangup */
2652 if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
2653 ast_channel_unlock(chan);
2654 return -1;
2655 }
2656
2657 /*
2658 * Mark when incoming channel answered so we can know how
2659 * long the channel has been up.
2660 */
2661 set_channel_answer_time(chan);
2662
2663 ast_channel_unlock(chan);
2664
2665 switch (ast_channel_state(chan)) {
2666 case AST_STATE_RINGING:
2667 case AST_STATE_RING:
2668 ast_channel_lock(chan);
2669 if (ast_channel_tech(chan)->answer_with_stream_topology) {
2670 res = ast_channel_tech(chan)->answer_with_stream_topology(chan, topology);
2671
2672 } else if (ast_channel_tech(chan)->answer) {
2673 res = ast_channel_tech(chan)->answer(chan);
2674 }
2675 ast_setstate(chan, AST_STATE_UP);
2676 ast_channel_unlock(chan);
2677 break;
2678 case AST_STATE_UP:
2679 /* Fall through */
2680 default:
2681 ast_debug(2, "Skipping answer, since channel state on %s is %s\n", ast_channel_name(chan), ast_state2str(ast_channel_state(chan)));
2682 break;
2683 }
2684
2685 ast_indicate(chan, -1);
2686
2687 return res;
2688}
answer
static int answer(void *data)
Definition chan_pjsip.c:687
ast_setstate
int ast_setstate(struct ast_channel *chan, enum ast_channel_state state)
Change the state of a channel.
Definition channel.c:7422
ast_state2str
const char * ast_state2str(enum ast_channel_state state)
Gives the string form of a given channel state.
Definition channel.c:637
set_channel_answer_time
static void set_channel_answer_time(struct ast_channel *chan)
Definition channel.c:2627
ast_indicate
int ast_indicate(struct ast_channel *chan, int condition)
Indicates condition of channel.
Definition channel.c:4298
ast_channel_tech::answer
int(*const answer)(struct ast_channel *chan)
Answer the channel.
Definition channel.h:727
ast_channel_tech::answer_with_stream_topology
int(*const answer_with_stream_topology)(struct ast_channel *chan, struct ast_stream_topology *topology)
Answer the channel with topology.
Definition channel.h:740

References answer(), ast_channel_tech::answer, ast_channel_tech::answer_with_stream_topology, ast_channel_flags(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, ast_check_hangup(), ast_debug, AST_FLAG_OUTGOING, AST_FLAG_ZOMBIE, ast_indicate(), ast_setstate(), ast_state2str(), 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
chanchannel 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 4278 of file channel.c.

4279{
4280 return __ast_read(chan, 0, 1);
4281}
__ast_read
static struct ast_frame * __ast_read(struct ast_channel *chan, int dropaudio, int dropnondefault)
Definition channel.c:3541

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_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
chanchannel 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 4288 of file channel.c.

4289{
4290 return __ast_read(chan, 1, 1);
4291}

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

4284{
4285 return __ast_read(chan, 0, 0);
4286}

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

4294{
4295 return __ast_read(chan, 1, 0);
4296}

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
cchannel to read from
sstring to read in to. Must be at least the size of your length
lenhow many digits to read (maximum)
timeouthow long to timeout between digits
rtimeouttimeout to wait on the first digit
endersdigits 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.

6578{
6579 return ast_readstring_full(c, s, len, timeout, ftimeout, enders, -1, -1);
6580}
ast_readstring_full
int ast_readstring_full(struct ast_channel *c, char *s, int len, int timeout, int ftimeout, char *enders, int audiofd, int ctrlfd)
Definition channel.c:6582

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.

6583{
6584 int pos = 0; /* index in the buffer where we accumulate digits */
6585 int to = ftimeout;
6586
6587 struct ast_silence_generator *silgen = NULL;
6588
6589 /* Stop if we're a zombie or need a soft hangup */
6590 if (ast_test_flag(ast_channel_flags(c), AST_FLAG_ZOMBIE) || ast_check_hangup(c))
6591 return -1;
6592 if (!len)
6593 return -1;
6594 for (;;) {
6595 int d;
6596 if (ast_channel_stream(c)) {
6597 d = ast_waitstream_full(c, AST_DIGIT_ANY, audiofd, ctrlfd);
6598 ast_stopstream(c);
6599 if (!silgen && ast_opt_transmit_silence)
6600 silgen = ast_channel_start_silence_generator(c);
6601 usleep(1000);
6602 if (!d)
6603 d = ast_waitfordigit_full(c, to, NULL, audiofd, ctrlfd);
6604 } else {
6605 if (!silgen && ast_opt_transmit_silence)
6606 silgen = ast_channel_start_silence_generator(c);
6607 d = ast_waitfordigit_full(c, to, NULL, audiofd, ctrlfd);
6608 }
6609 if (d < 0) {
6610 ast_channel_stop_silence_generator(c, silgen);
6611 return AST_GETDATA_FAILED;
6612 }
6613 if (d == 0) {
6614 s[pos] = '\0';
6615 ast_channel_stop_silence_generator(c, silgen);
6616 return AST_GETDATA_TIMEOUT;
6617 }
6618 if (d == 1) {
6619 s[pos] = '\0';
6620 ast_channel_stop_silence_generator(c, silgen);
6621 return AST_GETDATA_INTERRUPTED;
6622 }
6623 if (strchr(enders, d) && (pos == 0)) {
6624 s[pos] = '\0';
6625 ast_channel_stop_silence_generator(c, silgen);
6626 return AST_GETDATA_EMPTY_END_TERMINATED;
6627 }
6628 if (!strchr(enders, d)) {
6629 s[pos++] = d;
6630 }
6631 if (strchr(enders, d) || (pos >= len)) {
6632 s[pos] = '\0';
6633 ast_channel_stop_silence_generator(c, silgen);
6634 return AST_GETDATA_COMPLETE;
6635 }
6636 to = timeout;
6637 }
6638 /* Never reached */
6639 return 0;
6640}
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.
Definition channel.c:8340
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.
Definition channel.c:8386
ast_waitfordigit_full
int ast_waitfordigit_full(struct ast_channel *c, int timeout_ms, const char *breakon, int audiofd, int cmdfd)
Wait for a digit Same as ast_waitfordigit() with audio fd for outputting read audio and ctrlfd to mon...
Definition channel.c:3244
ast_waitstream_full
int ast_waitstream_full(struct ast_channel *c, const char *breakon, int audiofd, int monfd)
Definition file.c:1883
ast_stopstream
int ast_stopstream(struct ast_channel *c)
Stops a stream.
Definition file.c:223
AST_DIGIT_ANY
#define AST_DIGIT_ANY
Definition file.h:48
AST_GETDATA_FAILED
@ AST_GETDATA_FAILED
Definition include/asterisk/app.h:127
AST_GETDATA_INTERRUPTED
@ AST_GETDATA_INTERRUPTED
Definition include/asterisk/app.h:130
AST_GETDATA_COMPLETE
@ AST_GETDATA_COMPLETE
Definition include/asterisk/app.h:128
AST_GETDATA_TIMEOUT
@ AST_GETDATA_TIMEOUT
Definition include/asterisk/app.h:129
AST_GETDATA_EMPTY_END_TERMINATED
@ AST_GETDATA_EMPTY_END_TERMINATED
Definition include/asterisk/app.h:133
ast_opt_transmit_silence
#define ast_opt_transmit_silence
Definition options.h:134
d
static struct test_val d
Definition test_linkedlists.c:49

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
chanchannel to act upon
timeouttimeout in milliseconds (0 for infinite wait)

Read a char of text from a channel

Returns
0 on success, -1 on failure

Definition at line 4729 of file channel.c.

4730{
4731 int c;
4732 char *buf = ast_recvtext(chan, timeout);
4733 if (buf == NULL)
4734 return -1; /* error or timeout */
4735 c = *(unsigned char *)buf;
4736 ast_free(buf);
4737 return c;
4738}
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.
Definition channel.c:4740

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
chanchannel to act upon
timeouttimeout in milliseconds (0 for infinite wait)
Returns
the received text, or NULL to signify failure.

Definition at line 4740 of file channel.c.

4741{
4742 int res;
4743 char *buf = NULL;
4744 struct timeval start = ast_tvnow();
4745 int ms;
4746
4747 while ((ms = ast_remaining_ms(start, timeout))) {
4748 struct ast_frame *f;
4749
4750 if (ast_check_hangup(chan)) {
4751 break;
4752 }
4753 res = ast_waitfor(chan, ms);
4754 if (res <= 0) {/* timeout or error */
4755 break;
4756 }
4757 f = ast_read(chan);
4758 if (f == NULL) {
4759 break; /* no frame */
4760 }
4761 if (f->frametype == AST_FRAME_CONTROL && f->subclass.integer == AST_CONTROL_HANGUP) {
4762 ast_frfree(f);
4763 break;
4764 } else if (f->frametype == AST_FRAME_TEXT) { /* what we want */
4765 buf = ast_strndup((char *) f->data.ptr, f->datalen); /* dup and break */
4766 ast_frfree(f);
4767 break;
4768 }
4769 ast_frfree(f);
4770 }
4771 return buf;
4772}
ast_strndup
#define ast_strndup(str, len)
A wrapper for strndup()
Definition astmm.h:256

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
dataBuffer to fill with the frame data
datalenSize of the buffer to fill
redirectingRedirecting id information
updateWhat redirecting information to build. NULL if all.
Return values
-1if error
Amountof data buffer used

Definition at line 9444 of file channel.c.

9445{
9446 int32_t value;
9447 size_t pos = 0;
9448 int res;
9449
9450 static const struct ast_party_id_ies orig_ies = {
9451 .name.str = AST_REDIRECTING_ORIG_NAME,
9452 .name.char_set = AST_REDIRECTING_ORIG_NAME_CHAR_SET,
9453 .name.presentation = AST_REDIRECTING_ORIG_NAME_PRESENTATION,
9454 .name.valid = AST_REDIRECTING_ORIG_NAME_VALID,
9455
9456 .number.str = AST_REDIRECTING_ORIG_NUMBER,
9457 .number.plan = AST_REDIRECTING_ORIG_NUMBER_PLAN,
9458 .number.presentation = AST_REDIRECTING_ORIG_NUMBER_PRESENTATION,
9459 .number.valid = AST_REDIRECTING_ORIG_NUMBER_VALID,
9460
9461 .subaddress.str = AST_REDIRECTING_ORIG_SUBADDRESS,
9462 .subaddress.type = AST_REDIRECTING_ORIG_SUBADDRESS_TYPE,
9463 .subaddress.odd_even_indicator = AST_REDIRECTING_ORIG_SUBADDRESS_ODD_EVEN,
9464 .subaddress.valid = AST_REDIRECTING_ORIG_SUBADDRESS_VALID,
9465
9466 .tag = AST_REDIRECTING_ORIG_TAG,
9467 .combined_presentation = 0,/* Not sent. */
9468 };
9469 static const struct ast_party_id_ies from_ies = {
9470 .name.str = AST_REDIRECTING_FROM_NAME,
9471 .name.char_set = AST_REDIRECTING_FROM_NAME_CHAR_SET,
9472 .name.presentation = AST_REDIRECTING_FROM_NAME_PRESENTATION,
9473 .name.valid = AST_REDIRECTING_FROM_NAME_VALID,
9474
9475 .number.str = AST_REDIRECTING_FROM_NUMBER,
9476 .number.plan = AST_REDIRECTING_FROM_NUMBER_PLAN,
9477 .number.presentation = AST_REDIRECTING_FROM_NUMBER_PRESENTATION,
9478 .number.valid = AST_REDIRECTING_FROM_NUMBER_VALID,
9479
9480 .subaddress.str = AST_REDIRECTING_FROM_SUBADDRESS,
9481 .subaddress.type = AST_REDIRECTING_FROM_SUBADDRESS_TYPE,
9482 .subaddress.odd_even_indicator = AST_REDIRECTING_FROM_SUBADDRESS_ODD_EVEN,
9483 .subaddress.valid = AST_REDIRECTING_FROM_SUBADDRESS_VALID,
9484
9485 .tag = AST_REDIRECTING_FROM_TAG,
9486 .combined_presentation = AST_REDIRECTING_FROM_ID_PRESENTATION,
9487 };
9488 static const struct ast_party_id_ies to_ies = {
9489 .name.str = AST_REDIRECTING_TO_NAME,
9490 .name.char_set = AST_REDIRECTING_TO_NAME_CHAR_SET,
9491 .name.presentation = AST_REDIRECTING_TO_NAME_PRESENTATION,
9492 .name.valid = AST_REDIRECTING_TO_NAME_VALID,
9493
9494 .number.str = AST_REDIRECTING_TO_NUMBER,
9495 .number.plan = AST_REDIRECTING_TO_NUMBER_PLAN,
9496 .number.presentation = AST_REDIRECTING_TO_NUMBER_PRESENTATION,
9497 .number.valid = AST_REDIRECTING_TO_NUMBER_VALID,
9498
9499 .subaddress.str = AST_REDIRECTING_TO_SUBADDRESS,
9500 .subaddress.type = AST_REDIRECTING_TO_SUBADDRESS_TYPE,
9501 .subaddress.odd_even_indicator = AST_REDIRECTING_TO_SUBADDRESS_ODD_EVEN,
9502 .subaddress.valid = AST_REDIRECTING_TO_SUBADDRESS_VALID,
9503
9504 .tag = AST_REDIRECTING_TO_TAG,
9505 .combined_presentation = AST_REDIRECTING_TO_ID_PRESENTATION,
9506 };
9507 static const struct ast_party_id_ies priv_orig_ies = {
9508 .name.str = AST_REDIRECTING_PRIV_ORIG_NAME,
9509 .name.char_set = AST_REDIRECTING_PRIV_ORIG_NAME_CHAR_SET,
9510 .name.presentation = AST_REDIRECTING_PRIV_ORIG_NAME_PRESENTATION,
9511 .name.valid = AST_REDIRECTING_PRIV_ORIG_NAME_VALID,
9512
9513 .number.str = AST_REDIRECTING_PRIV_ORIG_NUMBER,
9514 .number.plan = AST_REDIRECTING_PRIV_ORIG_NUMBER_PLAN,
9515 .number.presentation = AST_REDIRECTING_PRIV_ORIG_NUMBER_PRESENTATION,
9516 .number.valid = AST_REDIRECTING_PRIV_ORIG_NUMBER_VALID,
9517
9518 .subaddress.str = AST_REDIRECTING_PRIV_ORIG_SUBADDRESS,
9519 .subaddress.type = AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_TYPE,
9520 .subaddress.odd_even_indicator = AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_ODD_EVEN,
9521 .subaddress.valid = AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_VALID,
9522
9523 .tag = AST_REDIRECTING_PRIV_ORIG_TAG,
9524 .combined_presentation = 0,/* Not sent. */
9525 };
9526 static const struct ast_party_id_ies priv_from_ies = {
9527 .name.str = AST_REDIRECTING_PRIV_FROM_NAME,
9528 .name.char_set = AST_REDIRECTING_PRIV_FROM_NAME_CHAR_SET,
9529 .name.presentation = AST_REDIRECTING_PRIV_FROM_NAME_PRESENTATION,
9530 .name.valid = AST_REDIRECTING_PRIV_FROM_NAME_VALID,
9531
9532 .number.str = AST_REDIRECTING_PRIV_FROM_NUMBER,
9533 .number.plan = AST_REDIRECTING_PRIV_FROM_NUMBER_PLAN,
9534 .number.presentation = AST_REDIRECTING_PRIV_FROM_NUMBER_PRESENTATION,
9535 .number.valid = AST_REDIRECTING_PRIV_FROM_NUMBER_VALID,
9536
9537 .subaddress.str = AST_REDIRECTING_PRIV_FROM_SUBADDRESS,
9538 .subaddress.type = AST_REDIRECTING_PRIV_FROM_SUBADDRESS_TYPE,
9539 .subaddress.odd_even_indicator = AST_REDIRECTING_PRIV_FROM_SUBADDRESS_ODD_EVEN,
9540 .subaddress.valid = AST_REDIRECTING_PRIV_FROM_SUBADDRESS_VALID,
9541
9542 .tag = AST_REDIRECTING_PRIV_FROM_TAG,
9543 .combined_presentation = 0,/* Not sent. */
9544 };
9545 static const struct ast_party_id_ies priv_to_ies = {
9546 .name.str = AST_REDIRECTING_PRIV_TO_NAME,
9547 .name.char_set = AST_REDIRECTING_PRIV_TO_NAME_CHAR_SET,
9548 .name.presentation = AST_REDIRECTING_PRIV_TO_NAME_PRESENTATION,
9549 .name.valid = AST_REDIRECTING_PRIV_TO_NAME_VALID,
9550
9551 .number.str = AST_REDIRECTING_PRIV_TO_NUMBER,
9552 .number.plan = AST_REDIRECTING_PRIV_TO_NUMBER_PLAN,
9553 .number.presentation = AST_REDIRECTING_PRIV_TO_NUMBER_PRESENTATION,
9554 .number.valid = AST_REDIRECTING_PRIV_TO_NUMBER_VALID,
9555
9556 .subaddress.str = AST_REDIRECTING_PRIV_TO_SUBADDRESS,
9557 .subaddress.type = AST_REDIRECTING_PRIV_TO_SUBADDRESS_TYPE,
9558 .subaddress.odd_even_indicator = AST_REDIRECTING_PRIV_TO_SUBADDRESS_ODD_EVEN,
9559 .subaddress.valid = AST_REDIRECTING_PRIV_TO_SUBADDRESS_VALID,
9560
9561 .tag = AST_REDIRECTING_PRIV_TO_TAG,
9562 .combined_presentation = 0,/* Not sent. */
9563 };
9564 static const struct ast_party_redirecting_reason_ies reason_ies = {
9565 .code = AST_REDIRECTING_REASON_CODE,
9566 .str = AST_REDIRECTING_REASON_STR,
9567 };
9568
9569 static const struct ast_party_redirecting_reason_ies orig_reason_ies = {
9570 .code = AST_REDIRECTING_ORIG_REASON_CODE,
9571 .str = AST_REDIRECTING_ORIG_REASON_STR,
9572 };
9573
9574 /* Redirecting frame version */
9575 if (datalen < pos + (sizeof(data[0]) * 2) + 1) {
9576 ast_log(LOG_WARNING, "No space left for redirecting frame version\n");
9577 return -1;
9578 }
9579 data[pos++] = AST_REDIRECTING_VERSION;
9580 data[pos++] = 1;
9581 data[pos++] = 2;/* Version 1 did not have a version ie */
9582
9583 res = party_id_build_data(data + pos, datalen - pos, &redirecting->orig,
9584 "redirecting-orig", &orig_ies, update ? &update->orig : NULL);
9585 if (res < 0) {
9586 return -1;
9587 }
9588 pos += res;
9589
9590 res = party_id_build_data(data + pos, datalen - pos, &redirecting->from,
9591 "redirecting-from", &from_ies, update ? &update->from : NULL);
9592 if (res < 0) {
9593 return -1;
9594 }
9595 pos += res;
9596
9597 res = party_id_build_data(data + pos, datalen - pos, &redirecting->to,
9598 "redirecting-to", &to_ies, update ? &update->to : NULL);
9599 if (res < 0) {
9600 return -1;
9601 }
9602 pos += res;
9603
9604 res = party_id_build_data(data + pos, datalen - pos, &redirecting->priv_orig,
9605 "redirecting-priv-orig", &priv_orig_ies, update ? &update->priv_orig : NULL);
9606 if (res < 0) {
9607 return -1;
9608 }
9609 pos += res;
9610
9611 res = party_id_build_data(data + pos, datalen - pos, &redirecting->priv_from,
9612 "redirecting-priv-from", &priv_from_ies, update ? &update->priv_from : NULL);
9613 if (res < 0) {
9614 return -1;
9615 }
9616 pos += res;
9617
9618 res = party_id_build_data(data + pos, datalen - pos, &redirecting->priv_to,
9619 "redirecting-priv-to", &priv_to_ies, update ? &update->priv_to : NULL);
9620 if (res < 0) {
9621 return -1;
9622 }
9623 pos += res;
9624
9625 /* Redirecting reason */
9626 res = redirecting_reason_build_data(data + pos, datalen - pos, &redirecting->reason,
9627 "redirecting-reason", &reason_ies);
9628 if (res < 0) {
9629 return -1;
9630 }
9631 pos += res;
9632
9633 /* Redirecting original reason */
9634 res = redirecting_reason_build_data(data + pos, datalen - pos, &redirecting->orig_reason,
9635 "redirecting-orig-reason", &orig_reason_ies);
9636 if (res < 0) {
9637 return -1;
9638 }
9639 pos += res;
9640
9641 /* Redirecting count */
9642 if (datalen < pos + (sizeof(data[0]) * 2) + sizeof(value)) {
9643 ast_log(LOG_WARNING, "No space left for redirecting count\n");
9644 return -1;
9645 }
9646 data[pos++] = AST_REDIRECTING_COUNT;
9647 data[pos++] = sizeof(value);
9648 value = htonl(redirecting->count);
9649 memcpy(data + pos, &value, sizeof(value));
9650 pos += sizeof(value);
9651
9652 return pos;
9653}
AST_REDIRECTING_FROM_NAME_PRESENTATION
@ AST_REDIRECTING_FROM_NAME_PRESENTATION
Definition channel.c:9341
AST_REDIRECTING_TO_NAME
@ AST_REDIRECTING_TO_NAME
Definition channel.c:9319
AST_REDIRECTING_VERSION
@ AST_REDIRECTING_VERSION
Definition channel.c:9334
AST_REDIRECTING_PRIV_FROM_NAME_VALID
@ AST_REDIRECTING_PRIV_FROM_NAME_VALID
Definition channel.c:9381
AST_REDIRECTING_PRIV_FROM_SUBADDRESS_ODD_EVEN
@ AST_REDIRECTING_PRIV_FROM_SUBADDRESS_ODD_EVEN
Definition channel.c:9386
AST_REDIRECTING_TO_TAG
@ AST_REDIRECTING_TO_TAG
Definition channel.c:9333
AST_REDIRECTING_FROM_NUMBER_PLAN
@ AST_REDIRECTING_FROM_NUMBER_PLAN
Definition channel.c:9316
AST_REDIRECTING_PRIV_TO_NAME_VALID
@ AST_REDIRECTING_PRIV_TO_NAME_VALID
Definition channel.c:9368
AST_REDIRECTING_ORIG_TAG
@ AST_REDIRECTING_ORIG_TAG
Definition channel.c:9361
AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_ODD_EVEN
@ AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_ODD_EVEN
Definition channel.c:9399
AST_REDIRECTING_REASON_CODE
@ AST_REDIRECTING_REASON_CODE
Definition channel.c:9322
AST_REDIRECTING_PRIV_TO_NUMBER_VALID
@ AST_REDIRECTING_PRIV_TO_NUMBER_VALID
Definition channel.c:9365
AST_REDIRECTING_PRIV_TO_NUMBER_PRESENTATION
@ AST_REDIRECTING_PRIV_TO_NUMBER_PRESENTATION
Definition channel.c:9366
AST_REDIRECTING_ORIG_REASON_CODE
@ AST_REDIRECTING_ORIG_REASON_CODE
Definition channel.c:9362
AST_REDIRECTING_TO_NAME_PRESENTATION
@ AST_REDIRECTING_TO_NAME_PRESENTATION
Definition channel.c:9346
AST_REDIRECTING_PRIV_TO_NAME
@ AST_REDIRECTING_PRIV_TO_NAME
Definition channel.c:9367
AST_REDIRECTING_PRIV_ORIG_NAME_VALID
@ AST_REDIRECTING_PRIV_ORIG_NAME_VALID
Definition channel.c:9394
AST_REDIRECTING_ORIG_NUMBER_VALID
@ AST_REDIRECTING_ORIG_NUMBER_VALID
Definition channel.c:9350
AST_REDIRECTING_FROM_NUMBER_PRESENTATION
@ AST_REDIRECTING_FROM_NUMBER_PRESENTATION
Definition channel.c:9343
AST_REDIRECTING_ORIG_SUBADDRESS_VALID
@ AST_REDIRECTING_ORIG_SUBADDRESS_VALID
Definition channel.c:9360
AST_REDIRECTING_FROM_NUMBER_VALID
@ AST_REDIRECTING_FROM_NUMBER_VALID
Definition channel.c:9342
AST_REDIRECTING_TO_NAME_VALID
@ AST_REDIRECTING_TO_NAME_VALID
Definition channel.c:9344
AST_REDIRECTING_PRIV_FROM_NAME
@ AST_REDIRECTING_PRIV_FROM_NAME
Definition channel.c:9380
AST_REDIRECTING_TO_SUBADDRESS_ODD_EVEN
@ AST_REDIRECTING_TO_SUBADDRESS_ODD_EVEN
Definition channel.c:9330
AST_REDIRECTING_ORIG_SUBADDRESS_ODD_EVEN
@ AST_REDIRECTING_ORIG_SUBADDRESS_ODD_EVEN
Definition channel.c:9359
AST_REDIRECTING_PRIV_FROM_SUBADDRESS_TYPE
@ AST_REDIRECTING_PRIV_FROM_SUBADDRESS_TYPE
Definition channel.c:9385
AST_REDIRECTING_PRIV_TO_SUBADDRESS_VALID
@ AST_REDIRECTING_PRIV_TO_SUBADDRESS_VALID
Definition channel.c:9374
AST_REDIRECTING_PRIV_TO_SUBADDRESS_ODD_EVEN
@ AST_REDIRECTING_PRIV_TO_SUBADDRESS_ODD_EVEN
Definition channel.c:9373
AST_REDIRECTING_ORIG_NAME_CHAR_SET
@ AST_REDIRECTING_ORIG_NAME_CHAR_SET
Definition channel.c:9355
AST_REDIRECTING_PRIV_FROM_SUBADDRESS
@ AST_REDIRECTING_PRIV_FROM_SUBADDRESS
Definition channel.c:9384
AST_REDIRECTING_TO_NUMBER_PLAN
@ AST_REDIRECTING_TO_NUMBER_PLAN
Definition channel.c:9320
AST_REDIRECTING_PRIV_TO_NUMBER
@ AST_REDIRECTING_PRIV_TO_NUMBER
Definition channel.c:9363
AST_REDIRECTING_PRIV_FROM_NUMBER_VALID
@ AST_REDIRECTING_PRIV_FROM_NUMBER_VALID
Definition channel.c:9378
AST_REDIRECTING_ORIG_NAME
@ AST_REDIRECTING_ORIG_NAME
Definition channel.c:9353
AST_REDIRECTING_ORIG_SUBADDRESS
@ AST_REDIRECTING_ORIG_SUBADDRESS
Definition channel.c:9357
AST_REDIRECTING_FROM_TAG
@ AST_REDIRECTING_FROM_TAG
Definition channel.c:9332
AST_REDIRECTING_PRIV_ORIG_NUMBER_PLAN
@ AST_REDIRECTING_PRIV_ORIG_NUMBER_PLAN
Definition channel.c:9391
AST_REDIRECTING_TO_NUMBER
@ AST_REDIRECTING_TO_NUMBER
Definition channel.c:9318
AST_REDIRECTING_ORIG_SUBADDRESS_TYPE
@ AST_REDIRECTING_ORIG_SUBADDRESS_TYPE
Definition channel.c:9358
AST_REDIRECTING_FROM_NAME_CHAR_SET
@ AST_REDIRECTING_FROM_NAME_CHAR_SET
Definition channel.c:9340
AST_REDIRECTING_PRIV_FROM_TAG
@ AST_REDIRECTING_PRIV_FROM_TAG
Definition channel.c:9388
AST_REDIRECTING_FROM_ID_PRESENTATION
@ AST_REDIRECTING_FROM_ID_PRESENTATION
Definition channel.c:9317
AST_REDIRECTING_PRIV_FROM_NUMBER
@ AST_REDIRECTING_PRIV_FROM_NUMBER
Definition channel.c:9376
AST_REDIRECTING_PRIV_TO_NUMBER_PLAN
@ AST_REDIRECTING_PRIV_TO_NUMBER_PLAN
Definition channel.c:9364
AST_REDIRECTING_TO_NUMBER_VALID
@ AST_REDIRECTING_TO_NUMBER_VALID
Definition channel.c:9347
AST_REDIRECTING_FROM_SUBADDRESS_VALID
@ AST_REDIRECTING_FROM_SUBADDRESS_VALID
Definition channel.c:9327
AST_REDIRECTING_FROM_NAME_VALID
@ AST_REDIRECTING_FROM_NAME_VALID
Definition channel.c:9339
AST_REDIRECTING_PRIV_TO_NAME_CHAR_SET
@ AST_REDIRECTING_PRIV_TO_NAME_CHAR_SET
Definition channel.c:9369
AST_REDIRECTING_PRIV_ORIG_TAG
@ AST_REDIRECTING_PRIV_ORIG_TAG
Definition channel.c:9401
AST_REDIRECTING_FROM_SUBADDRESS_TYPE
@ AST_REDIRECTING_FROM_SUBADDRESS_TYPE
Definition channel.c:9325
AST_REDIRECTING_PRIV_TO_TAG
@ AST_REDIRECTING_PRIV_TO_TAG
Definition channel.c:9375
AST_REDIRECTING_COUNT
@ AST_REDIRECTING_COUNT
Definition channel.c:9323
AST_REDIRECTING_FROM_SUBADDRESS
@ AST_REDIRECTING_FROM_SUBADDRESS
Definition channel.c:9324
AST_REDIRECTING_PRIV_ORIG_NAME_CHAR_SET
@ AST_REDIRECTING_PRIV_ORIG_NAME_CHAR_SET
Definition channel.c:9395
AST_REDIRECTING_ORIG_NAME_VALID
@ AST_REDIRECTING_ORIG_NAME_VALID
Definition channel.c:9354
AST_REDIRECTING_TO_ID_PRESENTATION
@ AST_REDIRECTING_TO_ID_PRESENTATION
Definition channel.c:9321
AST_REDIRECTING_PRIV_FROM_NUMBER_PLAN
@ AST_REDIRECTING_PRIV_FROM_NUMBER_PLAN
Definition channel.c:9377
AST_REDIRECTING_PRIV_TO_NAME_PRESENTATION
@ AST_REDIRECTING_PRIV_TO_NAME_PRESENTATION
Definition channel.c:9370
AST_REDIRECTING_PRIV_FROM_NUMBER_PRESENTATION
@ AST_REDIRECTING_PRIV_FROM_NUMBER_PRESENTATION
Definition channel.c:9379
AST_REDIRECTING_PRIV_FROM_NAME_PRESENTATION
@ AST_REDIRECTING_PRIV_FROM_NAME_PRESENTATION
Definition channel.c:9383
AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_TYPE
@ AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_TYPE
Definition channel.c:9398
AST_REDIRECTING_ORIG_REASON_STR
@ AST_REDIRECTING_ORIG_REASON_STR
Definition channel.c:9403
AST_REDIRECTING_ORIG_NAME_PRESENTATION
@ AST_REDIRECTING_ORIG_NAME_PRESENTATION
Definition channel.c:9356
AST_REDIRECTING_PRIV_FROM_NAME_CHAR_SET
@ AST_REDIRECTING_PRIV_FROM_NAME_CHAR_SET
Definition channel.c:9382
AST_REDIRECTING_ORIG_NUMBER
@ AST_REDIRECTING_ORIG_NUMBER
Definition channel.c:9349
AST_REDIRECTING_PRIV_ORIG_NAME
@ AST_REDIRECTING_PRIV_ORIG_NAME
Definition channel.c:9393
AST_REDIRECTING_PRIV_TO_SUBADDRESS_TYPE
@ AST_REDIRECTING_PRIV_TO_SUBADDRESS_TYPE
Definition channel.c:9372
AST_REDIRECTING_PRIV_ORIG_NUMBER_VALID
@ AST_REDIRECTING_PRIV_ORIG_NUMBER_VALID
Definition channel.c:9390
AST_REDIRECTING_PRIV_ORIG_NUMBER_PRESENTATION
@ AST_REDIRECTING_PRIV_ORIG_NUMBER_PRESENTATION
Definition channel.c:9392
AST_REDIRECTING_TO_SUBADDRESS_VALID
@ AST_REDIRECTING_TO_SUBADDRESS_VALID
Definition channel.c:9331
AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_VALID
@ AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_VALID
Definition channel.c:9400
AST_REDIRECTING_TO_SUBADDRESS_TYPE
@ AST_REDIRECTING_TO_SUBADDRESS_TYPE
Definition channel.c:9329
AST_REDIRECTING_REASON_STR
@ AST_REDIRECTING_REASON_STR
Definition channel.c:9402
AST_REDIRECTING_FROM_NAME
@ AST_REDIRECTING_FROM_NAME
Definition channel.c:9315
AST_REDIRECTING_PRIV_ORIG_NUMBER
@ AST_REDIRECTING_PRIV_ORIG_NUMBER
Definition channel.c:9389
AST_REDIRECTING_PRIV_FROM_SUBADDRESS_VALID
@ AST_REDIRECTING_PRIV_FROM_SUBADDRESS_VALID
Definition channel.c:9387
AST_REDIRECTING_ORIG_NUMBER_PRESENTATION
@ AST_REDIRECTING_ORIG_NUMBER_PRESENTATION
Definition channel.c:9352
AST_REDIRECTING_PRIV_TO_SUBADDRESS
@ AST_REDIRECTING_PRIV_TO_SUBADDRESS
Definition channel.c:9371
AST_REDIRECTING_PRIV_ORIG_NAME_PRESENTATION
@ AST_REDIRECTING_PRIV_ORIG_NAME_PRESENTATION
Definition channel.c:9396
AST_REDIRECTING_TO_NUMBER_PRESENTATION
@ AST_REDIRECTING_TO_NUMBER_PRESENTATION
Definition channel.c:9348
AST_REDIRECTING_FROM_NUMBER
@ AST_REDIRECTING_FROM_NUMBER
Definition channel.c:9314
AST_REDIRECTING_ORIG_NUMBER_PLAN
@ AST_REDIRECTING_ORIG_NUMBER_PLAN
Definition channel.c:9351
AST_REDIRECTING_FROM_SUBADDRESS_ODD_EVEN
@ AST_REDIRECTING_FROM_SUBADDRESS_ODD_EVEN
Definition channel.c:9326
AST_REDIRECTING_PRIV_ORIG_SUBADDRESS
@ AST_REDIRECTING_PRIV_ORIG_SUBADDRESS
Definition channel.c:9397
AST_REDIRECTING_TO_SUBADDRESS
@ AST_REDIRECTING_TO_SUBADDRESS
Definition channel.c:9328
AST_REDIRECTING_TO_NAME_CHAR_SET
@ AST_REDIRECTING_TO_NAME_CHAR_SET
Definition channel.c:9345
redirecting_reason_build_data
static int redirecting_reason_build_data(unsigned char *data, size_t datalen, const struct ast_party_redirecting_reason *reason, const char *label, const struct ast_party_redirecting_reason_ies *ies)
Definition channel.c:9411
ast_party_redirecting_reason_ies
Definition channel.c:9406
ast_party_redirecting_reason_ies::code
int code
Definition channel.c:9407

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
dataBuffer with the frame data to parse
datalenSize of the buffer
redirectingExtracted redirecting id information
Return values
0on success.
-1on 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 9655 of file channel.c.

9656{
9657 size_t pos;
9658 unsigned char ie_len;
9659 unsigned char ie_id;
9660 int32_t value;
9661 int frame_version = 1;
9662 int from_combined_presentation = 0;
9663 int got_from_combined_presentation = 0;/* TRUE if got a combined name and number presentation value. */
9664 int to_combined_presentation = 0;
9665 int got_to_combined_presentation = 0;/* TRUE if got a combined name and number presentation value. */
9666
9667 for (pos = 0; pos < datalen; pos += ie_len) {
9668 if (datalen < pos + sizeof(ie_id) + sizeof(ie_len)) {
9669 ast_log(LOG_WARNING, "Invalid redirecting update\n");
9670 return -1;
9671 }
9672 ie_id = data[pos++];
9673 ie_len = data[pos++];
9674 if (datalen < pos + ie_len) {
9675 ast_log(LOG_WARNING, "Invalid redirecting update\n");
9676 return -1;
9677 }
9678
9679 switch (ie_id) {
9680/* Redirecting frame version */
9681 case AST_REDIRECTING_VERSION:
9682 if (ie_len != 1) {
9683 ast_log(LOG_WARNING, "Invalid redirecting frame version (%u)\n",
9684 (unsigned) ie_len);
9685 break;
9686 }
9687 frame_version = data[pos];
9688 break;
9689/* Redirecting-orig party id name */
9690 case AST_REDIRECTING_ORIG_NAME:
9691 ast_free(redirecting->orig.name.str);
9692 redirecting->orig.name.str = ast_malloc(ie_len + 1);
9693 if (redirecting->orig.name.str) {
9694 memcpy(redirecting->orig.name.str, data + pos, ie_len);
9695 redirecting->orig.name.str[ie_len] = 0;
9696 }
9697 break;
9698 case AST_REDIRECTING_ORIG_NAME_CHAR_SET:
9699 if (ie_len != 1) {
9700 ast_log(LOG_WARNING, "Invalid redirecting-orig name char set (%u)\n",
9701 (unsigned) ie_len);
9702 break;
9703 }
9704 redirecting->orig.name.char_set = data[pos];
9705 break;
9706 case AST_REDIRECTING_ORIG_NAME_PRESENTATION:
9707 if (ie_len != 1) {
9708 ast_log(LOG_WARNING, "Invalid redirecting-orig name presentation (%u)\n",
9709 (unsigned) ie_len);
9710 break;
9711 }
9712 redirecting->orig.name.presentation = data[pos];
9713 break;
9714 case AST_REDIRECTING_ORIG_NAME_VALID:
9715 if (ie_len != 1) {
9716 ast_log(LOG_WARNING, "Invalid redirecting-orig name valid (%u)\n",
9717 (unsigned) ie_len);
9718 break;
9719 }
9720 redirecting->orig.name.valid = data[pos];
9721 break;
9722/* Redirecting-orig party id number */
9723 case AST_REDIRECTING_ORIG_NUMBER:
9724 ast_free(redirecting->orig.number.str);
9725 redirecting->orig.number.str = ast_malloc(ie_len + 1);
9726 if (redirecting->orig.number.str) {
9727 memcpy(redirecting->orig.number.str, data + pos, ie_len);
9728 redirecting->orig.number.str[ie_len] = 0;
9729 }
9730 break;
9731 case AST_REDIRECTING_ORIG_NUMBER_PLAN:
9732 if (ie_len != 1) {
9733 ast_log(LOG_WARNING, "Invalid redirecting-orig numbering plan (%u)\n",
9734 (unsigned) ie_len);
9735 break;
9736 }
9737 redirecting->orig.number.plan = data[pos];
9738 break;
9739 case AST_REDIRECTING_ORIG_NUMBER_PRESENTATION:
9740 if (ie_len != 1) {
9741 ast_log(LOG_WARNING, "Invalid redirecting-orig number presentation (%u)\n",
9742 (unsigned) ie_len);
9743 break;
9744 }
9745 redirecting->orig.number.presentation = data[pos];
9746 break;
9747 case AST_REDIRECTING_ORIG_NUMBER_VALID:
9748 if (ie_len != 1) {
9749 ast_log(LOG_WARNING, "Invalid redirecting-orig number valid (%u)\n",
9750 (unsigned) ie_len);
9751 break;
9752 }
9753 redirecting->orig.number.valid = data[pos];
9754 break;
9755/* Redirecting-orig party id subaddress */
9756 case AST_REDIRECTING_ORIG_SUBADDRESS:
9757 ast_free(redirecting->orig.subaddress.str);
9758 redirecting->orig.subaddress.str = ast_malloc(ie_len + 1);
9759 if (redirecting->orig.subaddress.str) {
9760 memcpy(redirecting->orig.subaddress.str, data + pos, ie_len);
9761 redirecting->orig.subaddress.str[ie_len] = 0;
9762 }
9763 break;
9764 case AST_REDIRECTING_ORIG_SUBADDRESS_TYPE:
9765 if (ie_len != 1) {
9766 ast_log(LOG_WARNING, "Invalid redirecting-orig type of subaddress (%u)\n",
9767 (unsigned) ie_len);
9768 break;
9769 }
9770 redirecting->orig.subaddress.type = data[pos];
9771 break;
9772 case AST_REDIRECTING_ORIG_SUBADDRESS_ODD_EVEN:
9773 if (ie_len != 1) {
9774 ast_log(LOG_WARNING,
9775 "Invalid redirecting-orig subaddress odd-even indicator (%u)\n",
9776 (unsigned) ie_len);
9777 break;
9778 }
9779 redirecting->orig.subaddress.odd_even_indicator = data[pos];
9780 break;
9781 case AST_REDIRECTING_ORIG_SUBADDRESS_VALID:
9782 if (ie_len != 1) {
9783 ast_log(LOG_WARNING, "Invalid redirecting-orig subaddress valid (%u)\n",
9784 (unsigned) ie_len);
9785 break;
9786 }
9787 redirecting->orig.subaddress.valid = data[pos];
9788 break;
9789/* Redirecting-orig party id tag */
9790 case AST_REDIRECTING_ORIG_TAG:
9791 ast_free(redirecting->orig.tag);
9792 redirecting->orig.tag = ast_malloc(ie_len + 1);
9793 if (redirecting->orig.tag) {
9794 memcpy(redirecting->orig.tag, data + pos, ie_len);
9795 redirecting->orig.tag[ie_len] = 0;
9796 }
9797 break;
9798/* Redirecting-from party id name */
9799 case AST_REDIRECTING_FROM_NAME:
9800 ast_free(redirecting->from.name.str);
9801 redirecting->from.name.str = ast_malloc(ie_len + 1);
9802 if (redirecting->from.name.str) {
9803 memcpy(redirecting->from.name.str, data + pos, ie_len);
9804 redirecting->from.name.str[ie_len] = 0;
9805 }
9806 break;
9807 case AST_REDIRECTING_FROM_NAME_CHAR_SET:
9808 if (ie_len != 1) {
9809 ast_log(LOG_WARNING, "Invalid redirecting-from name char set (%u)\n",
9810 (unsigned) ie_len);
9811 break;
9812 }
9813 redirecting->from.name.char_set = data[pos];
9814 break;
9815 case AST_REDIRECTING_FROM_NAME_PRESENTATION:
9816 if (ie_len != 1) {
9817 ast_log(LOG_WARNING, "Invalid redirecting-from name presentation (%u)\n",
9818 (unsigned) ie_len);
9819 break;
9820 }
9821 redirecting->from.name.presentation = data[pos];
9822 break;
9823 case AST_REDIRECTING_FROM_NAME_VALID:
9824 if (ie_len != 1) {
9825 ast_log(LOG_WARNING, "Invalid redirecting-from name valid (%u)\n",
9826 (unsigned) ie_len);
9827 break;
9828 }
9829 redirecting->from.name.valid = data[pos];
9830 break;
9831/* Redirecting-from party id number */
9832 case AST_REDIRECTING_FROM_NUMBER:
9833 ast_free(redirecting->from.number.str);
9834 redirecting->from.number.str = ast_malloc(ie_len + 1);
9835 if (redirecting->from.number.str) {
9836 memcpy(redirecting->from.number.str, data + pos, ie_len);
9837 redirecting->from.number.str[ie_len] = 0;
9838 }
9839 break;
9840 case AST_REDIRECTING_FROM_NUMBER_PLAN:
9841 if (ie_len != 1) {
9842 ast_log(LOG_WARNING, "Invalid redirecting-from numbering plan (%u)\n",
9843 (unsigned) ie_len);
9844 break;
9845 }
9846 redirecting->from.number.plan = data[pos];
9847 break;
9848 case AST_REDIRECTING_FROM_NUMBER_PRESENTATION:
9849 if (ie_len != 1) {
9850 ast_log(LOG_WARNING, "Invalid redirecting-from number presentation (%u)\n",
9851 (unsigned) ie_len);
9852 break;
9853 }
9854 redirecting->from.number.presentation = data[pos];
9855 break;
9856 case AST_REDIRECTING_FROM_NUMBER_VALID:
9857 if (ie_len != 1) {
9858 ast_log(LOG_WARNING, "Invalid redirecting-from number valid (%u)\n",
9859 (unsigned) ie_len);
9860 break;
9861 }
9862 redirecting->from.number.valid = data[pos];
9863 break;
9864/* Redirecting-from party id combined presentation */
9865 case AST_REDIRECTING_FROM_ID_PRESENTATION:
9866 if (ie_len != 1) {
9867 ast_log(LOG_WARNING, "Invalid redirecting-from combined presentation (%u)\n",
9868 (unsigned) ie_len);
9869 break;
9870 }
9871 from_combined_presentation = data[pos];
9872 got_from_combined_presentation = 1;
9873 break;
9874/* Redirecting-from party id subaddress */
9875 case AST_REDIRECTING_FROM_SUBADDRESS:
9876 ast_free(redirecting->from.subaddress.str);
9877 redirecting->from.subaddress.str = ast_malloc(ie_len + 1);
9878 if (redirecting->from.subaddress.str) {
9879 memcpy(redirecting->from.subaddress.str, data + pos, ie_len);
9880 redirecting->from.subaddress.str[ie_len] = 0;
9881 }
9882 break;
9883 case AST_REDIRECTING_FROM_SUBADDRESS_TYPE:
9884 if (ie_len != 1) {
9885 ast_log(LOG_WARNING, "Invalid redirecting-from type of subaddress (%u)\n",
9886 (unsigned) ie_len);
9887 break;
9888 }
9889 redirecting->from.subaddress.type = data[pos];
9890 break;
9891 case AST_REDIRECTING_FROM_SUBADDRESS_ODD_EVEN:
9892 if (ie_len != 1) {
9893 ast_log(LOG_WARNING,
9894 "Invalid redirecting-from subaddress odd-even indicator (%u)\n",
9895 (unsigned) ie_len);
9896 break;
9897 }
9898 redirecting->from.subaddress.odd_even_indicator = data[pos];
9899 break;
9900 case AST_REDIRECTING_FROM_SUBADDRESS_VALID:
9901 if (ie_len != 1) {
9902 ast_log(LOG_WARNING, "Invalid redirecting-from subaddress valid (%u)\n",
9903 (unsigned) ie_len);
9904 break;
9905 }
9906 redirecting->from.subaddress.valid = data[pos];
9907 break;
9908/* Redirecting-from party id tag */
9909 case AST_REDIRECTING_FROM_TAG:
9910 ast_free(redirecting->from.tag);
9911 redirecting->from.tag = ast_malloc(ie_len + 1);
9912 if (redirecting->from.tag) {
9913 memcpy(redirecting->from.tag, data + pos, ie_len);
9914 redirecting->from.tag[ie_len] = 0;
9915 }
9916 break;
9917/* Redirecting-to party id name */
9918 case AST_REDIRECTING_TO_NAME:
9919 ast_free(redirecting->to.name.str);
9920 redirecting->to.name.str = ast_malloc(ie_len + 1);
9921 if (redirecting->to.name.str) {
9922 memcpy(redirecting->to.name.str, data + pos, ie_len);
9923 redirecting->to.name.str[ie_len] = 0;
9924 }
9925 break;
9926 case AST_REDIRECTING_TO_NAME_CHAR_SET:
9927 if (ie_len != 1) {
9928 ast_log(LOG_WARNING, "Invalid redirecting-to name char set (%u)\n",
9929 (unsigned) ie_len);
9930 break;
9931 }
9932 redirecting->to.name.char_set = data[pos];
9933 break;
9934 case AST_REDIRECTING_TO_NAME_PRESENTATION:
9935 if (ie_len != 1) {
9936 ast_log(LOG_WARNING, "Invalid redirecting-to name presentation (%u)\n",
9937 (unsigned) ie_len);
9938 break;
9939 }
9940 redirecting->to.name.presentation = data[pos];
9941 break;
9942 case AST_REDIRECTING_TO_NAME_VALID:
9943 if (ie_len != 1) {
9944 ast_log(LOG_WARNING, "Invalid redirecting-to name valid (%u)\n",
9945 (unsigned) ie_len);
9946 break;
9947 }
9948 redirecting->to.name.valid = data[pos];
9949 break;
9950/* Redirecting-to party id number */
9951 case AST_REDIRECTING_TO_NUMBER:
9952 ast_free(redirecting->to.number.str);
9953 redirecting->to.number.str = ast_malloc(ie_len + 1);
9954 if (redirecting->to.number.str) {
9955 memcpy(redirecting->to.number.str, data + pos, ie_len);
9956 redirecting->to.number.str[ie_len] = 0;
9957 }
9958 break;
9959 case AST_REDIRECTING_TO_NUMBER_PLAN:
9960 if (ie_len != 1) {
9961 ast_log(LOG_WARNING, "Invalid redirecting-to numbering plan (%u)\n",
9962 (unsigned) ie_len);
9963 break;
9964 }
9965 redirecting->to.number.plan = data[pos];
9966 break;
9967 case AST_REDIRECTING_TO_NUMBER_PRESENTATION:
9968 if (ie_len != 1) {
9969 ast_log(LOG_WARNING, "Invalid redirecting-to number presentation (%u)\n",
9970 (unsigned) ie_len);
9971 break;
9972 }
9973 redirecting->to.number.presentation = data[pos];
9974 break;
9975 case AST_REDIRECTING_TO_NUMBER_VALID:
9976 if (ie_len != 1) {
9977 ast_log(LOG_WARNING, "Invalid redirecting-to number valid (%u)\n",
9978 (unsigned) ie_len);
9979 break;
9980 }
9981 redirecting->to.number.valid = data[pos];
9982 break;
9983/* Redirecting-to party id combined presentation */
9984 case AST_REDIRECTING_TO_ID_PRESENTATION:
9985 if (ie_len != 1) {
9986 ast_log(LOG_WARNING, "Invalid redirecting-to combined presentation (%u)\n",
9987 (unsigned) ie_len);
9988 break;
9989 }
9990 to_combined_presentation = data[pos];
9991 got_to_combined_presentation = 1;
9992 break;
9993/* Redirecting-to party id subaddress */
9994 case AST_REDIRECTING_TO_SUBADDRESS:
9995 ast_free(redirecting->to.subaddress.str);
9996 redirecting->to.subaddress.str = ast_malloc(ie_len + 1);
9997 if (redirecting->to.subaddress.str) {
9998 memcpy(redirecting->to.subaddress.str, data + pos, ie_len);
9999 redirecting->to.subaddress.str[ie_len] = 0;
10000 }
10001 break;
10002 case AST_REDIRECTING_TO_SUBADDRESS_TYPE:
10003 if (ie_len != 1) {
10004 ast_log(LOG_WARNING, "Invalid redirecting-to type of subaddress (%u)\n",
10005 (unsigned) ie_len);
10006 break;
10007 }
10008 redirecting->to.subaddress.type = data[pos];
10009 break;
10010 case AST_REDIRECTING_TO_SUBADDRESS_ODD_EVEN:
10011 if (ie_len != 1) {
10012 ast_log(LOG_WARNING,
10013 "Invalid redirecting-to subaddress odd-even indicator (%u)\n",
10014 (unsigned) ie_len);
10015 break;
10016 }
10017 redirecting->to.subaddress.odd_even_indicator = data[pos];
10018 break;
10019 case AST_REDIRECTING_TO_SUBADDRESS_VALID:
10020 if (ie_len != 1) {
10021 ast_log(LOG_WARNING, "Invalid redirecting-to subaddress valid (%u)\n",
10022 (unsigned) ie_len);
10023 break;
10024 }
10025 redirecting->to.subaddress.valid = data[pos];
10026 break;
10027/* Redirecting-to party id tag */
10028 case AST_REDIRECTING_TO_TAG:
10029 ast_free(redirecting->to.tag);
10030 redirecting->to.tag = ast_malloc(ie_len + 1);
10031 if (redirecting->to.tag) {
10032 memcpy(redirecting->to.tag, data + pos, ie_len);
10033 redirecting->to.tag[ie_len] = 0;
10034 }
10035 break;
10036/* Private redirecting-orig party id name */
10037 case AST_REDIRECTING_PRIV_ORIG_NAME:
10038 ast_free(redirecting->priv_orig.name.str);
10039 redirecting->priv_orig.name.str = ast_malloc(ie_len + 1);
10040 if (redirecting->priv_orig.name.str) {
10041 memcpy(redirecting->priv_orig.name.str, data + pos, ie_len);
10042 redirecting->priv_orig.name.str[ie_len] = 0;
10043 }
10044 break;
10045 case AST_REDIRECTING_PRIV_ORIG_NAME_CHAR_SET:
10046 if (ie_len != 1) {
10047 ast_log(LOG_WARNING, "Invalid private redirecting-orig name char set (%u)\n",
10048 (unsigned) ie_len);
10049 break;
10050 }
10051 redirecting->priv_orig.name.char_set = data[pos];
10052 break;
10053 case AST_REDIRECTING_PRIV_ORIG_NAME_PRESENTATION:
10054 if (ie_len != 1) {
10055 ast_log(LOG_WARNING, "Invalid private redirecting-orig name presentation (%u)\n",
10056 (unsigned) ie_len);
10057 break;
10058 }
10059 redirecting->priv_orig.name.presentation = data[pos];
10060 break;
10061 case AST_REDIRECTING_PRIV_ORIG_NAME_VALID:
10062 if (ie_len != 1) {
10063 ast_log(LOG_WARNING, "Invalid private redirecting-orig name valid (%u)\n",
10064 (unsigned) ie_len);
10065 break;
10066 }
10067 redirecting->priv_orig.name.valid = data[pos];
10068 break;
10069/* Private redirecting-orig party id number */
10070 case AST_REDIRECTING_PRIV_ORIG_NUMBER:
10071 ast_free(redirecting->priv_orig.number.str);
10072 redirecting->priv_orig.number.str = ast_malloc(ie_len + 1);
10073 if (redirecting->priv_orig.number.str) {
10074 memcpy(redirecting->priv_orig.number.str, data + pos, ie_len);
10075 redirecting->priv_orig.number.str[ie_len] = 0;
10076 }
10077 break;
10078 case AST_REDIRECTING_PRIV_ORIG_NUMBER_PLAN:
10079 if (ie_len != 1) {
10080 ast_log(LOG_WARNING, "Invalid private redirecting-orig numbering plan (%u)\n",
10081 (unsigned) ie_len);
10082 break;
10083 }
10084 redirecting->priv_orig.number.plan = data[pos];
10085 break;
10086 case AST_REDIRECTING_PRIV_ORIG_NUMBER_PRESENTATION:
10087 if (ie_len != 1) {
10088 ast_log(LOG_WARNING, "Invalid private redirecting-orig number presentation (%u)\n",
10089 (unsigned) ie_len);
10090 break;
10091 }
10092 redirecting->priv_orig.number.presentation = data[pos];
10093 break;
10094 case AST_REDIRECTING_PRIV_ORIG_NUMBER_VALID:
10095 if (ie_len != 1) {
10096 ast_log(LOG_WARNING, "Invalid private redirecting-orig number valid (%u)\n",
10097 (unsigned) ie_len);
10098 break;
10099 }
10100 redirecting->priv_orig.number.valid = data[pos];
10101 break;
10102/* Private redirecting-orig party id subaddress */
10103 case AST_REDIRECTING_PRIV_ORIG_SUBADDRESS:
10104 ast_free(redirecting->priv_orig.subaddress.str);
10105 redirecting->priv_orig.subaddress.str = ast_malloc(ie_len + 1);
10106 if (redirecting->priv_orig.subaddress.str) {
10107 memcpy(redirecting->priv_orig.subaddress.str, data + pos, ie_len);
10108 redirecting->priv_orig.subaddress.str[ie_len] = 0;
10109 }
10110 break;
10111 case AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_TYPE:
10112 if (ie_len != 1) {
10113 ast_log(LOG_WARNING, "Invalid private redirecting-orig type of subaddress (%u)\n",
10114 (unsigned) ie_len);
10115 break;
10116 }
10117 redirecting->priv_orig.subaddress.type = data[pos];
10118 break;
10119 case AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_ODD_EVEN:
10120 if (ie_len != 1) {
10121 ast_log(LOG_WARNING,
10122 "Invalid private redirecting-orig subaddress odd-even indicator (%u)\n",
10123 (unsigned) ie_len);
10124 break;
10125 }
10126 redirecting->priv_orig.subaddress.odd_even_indicator = data[pos];
10127 break;
10128 case AST_REDIRECTING_PRIV_ORIG_SUBADDRESS_VALID:
10129 if (ie_len != 1) {
10130 ast_log(LOG_WARNING, "Invalid private redirecting-orig subaddress valid (%u)\n",
10131 (unsigned) ie_len);
10132 break;
10133 }
10134 redirecting->priv_orig.subaddress.valid = data[pos];
10135 break;
10136/* Private redirecting-orig party id tag */
10137 case AST_REDIRECTING_PRIV_ORIG_TAG:
10138 ast_free(redirecting->priv_orig.tag);
10139 redirecting->priv_orig.tag = ast_malloc(ie_len + 1);
10140 if (redirecting->priv_orig.tag) {
10141 memcpy(redirecting->priv_orig.tag, data + pos, ie_len);
10142 redirecting->priv_orig.tag[ie_len] = 0;
10143 }
10144 break;
10145/* Private redirecting-from party id name */
10146 case AST_REDIRECTING_PRIV_FROM_NAME:
10147 ast_free(redirecting->priv_from.name.str);
10148 redirecting->priv_from.name.str = ast_malloc(ie_len + 1);
10149 if (redirecting->priv_from.name.str) {
10150 memcpy(redirecting->priv_from.name.str, data + pos, ie_len);
10151 redirecting->priv_from.name.str[ie_len] = 0;
10152 }
10153 break;
10154 case AST_REDIRECTING_PRIV_FROM_NAME_CHAR_SET:
10155 if (ie_len != 1) {
10156 ast_log(LOG_WARNING, "Invalid private redirecting-from name char set (%u)\n",
10157 (unsigned) ie_len);
10158 break;
10159 }
10160 redirecting->priv_from.name.char_set = data[pos];
10161 break;
10162 case AST_REDIRECTING_PRIV_FROM_NAME_PRESENTATION:
10163 if (ie_len != 1) {
10164 ast_log(LOG_WARNING, "Invalid private redirecting-from name presentation (%u)\n",
10165 (unsigned) ie_len);
10166 break;
10167 }
10168 redirecting->priv_from.name.presentation = data[pos];
10169 break;
10170 case AST_REDIRECTING_PRIV_FROM_NAME_VALID:
10171 if (ie_len != 1) {
10172 ast_log(LOG_WARNING, "Invalid private redirecting-from name valid (%u)\n",
10173 (unsigned) ie_len);
10174 break;
10175 }
10176 redirecting->priv_from.name.valid = data[pos];
10177 break;
10178/* Private redirecting-from party id number */
10179 case AST_REDIRECTING_PRIV_FROM_NUMBER:
10180 ast_free(redirecting->priv_from.number.str);
10181 redirecting->priv_from.number.str = ast_malloc(ie_len + 1);
10182 if (redirecting->priv_from.number.str) {
10183 memcpy(redirecting->priv_from.number.str, data + pos, ie_len);
10184 redirecting->priv_from.number.str[ie_len] = 0;
10185 }
10186 break;
10187 case AST_REDIRECTING_PRIV_FROM_NUMBER_PLAN:
10188 if (ie_len != 1) {
10189 ast_log(LOG_WARNING, "Invalid private redirecting-from numbering plan (%u)\n",
10190 (unsigned) ie_len);
10191 break;
10192 }
10193 redirecting->priv_from.number.plan = data[pos];
10194 break;
10195 case AST_REDIRECTING_PRIV_FROM_NUMBER_PRESENTATION:
10196 if (ie_len != 1) {
10197 ast_log(LOG_WARNING, "Invalid private redirecting-from number presentation (%u)\n",
10198 (unsigned) ie_len);
10199 break;
10200 }
10201 redirecting->priv_from.number.presentation = data[pos];
10202 break;
10203 case AST_REDIRECTING_PRIV_FROM_NUMBER_VALID:
10204 if (ie_len != 1) {
10205 ast_log(LOG_WARNING, "Invalid private redirecting-from number valid (%u)\n",
10206 (unsigned) ie_len);
10207 break;
10208 }
10209 redirecting->priv_from.number.valid = data[pos];
10210 break;
10211/* Private redirecting-from party id subaddress */
10212 case AST_REDIRECTING_PRIV_FROM_SUBADDRESS:
10213 ast_free(redirecting->priv_from.subaddress.str);
10214 redirecting->priv_from.subaddress.str = ast_malloc(ie_len + 1);
10215 if (redirecting->priv_from.subaddress.str) {
10216 memcpy(redirecting->priv_from.subaddress.str, data + pos, ie_len);
10217 redirecting->priv_from.subaddress.str[ie_len] = 0;
10218 }
10219 break;
10220 case AST_REDIRECTING_PRIV_FROM_SUBADDRESS_TYPE:
10221 if (ie_len != 1) {
10222 ast_log(LOG_WARNING, "Invalid private redirecting-from type of subaddress (%u)\n",
10223 (unsigned) ie_len);
10224 break;
10225 }
10226 redirecting->priv_from.subaddress.type = data[pos];
10227 break;
10228 case AST_REDIRECTING_PRIV_FROM_SUBADDRESS_ODD_EVEN:
10229 if (ie_len != 1) {
10230 ast_log(LOG_WARNING,
10231 "Invalid private redirecting-from subaddress odd-even indicator (%u)\n",
10232 (unsigned) ie_len);
10233 break;
10234 }
10235 redirecting->priv_from.subaddress.odd_even_indicator = data[pos];
10236 break;
10237 case AST_REDIRECTING_PRIV_FROM_SUBADDRESS_VALID:
10238 if (ie_len != 1) {
10239 ast_log(LOG_WARNING, "Invalid private redirecting-from subaddress valid (%u)\n",
10240 (unsigned) ie_len);
10241 break;
10242 }
10243 redirecting->priv_from.subaddress.valid = data[pos];
10244 break;
10245/* Private redirecting-from party id tag */
10246 case AST_REDIRECTING_PRIV_FROM_TAG:
10247 ast_free(redirecting->priv_from.tag);
10248 redirecting->priv_from.tag = ast_malloc(ie_len + 1);
10249 if (redirecting->priv_from.tag) {
10250 memcpy(redirecting->priv_from.tag, data + pos, ie_len);
10251 redirecting->priv_from.tag[ie_len] = 0;
10252 }
10253 break;
10254/* Private redirecting-to party id name */
10255 case AST_REDIRECTING_PRIV_TO_NAME:
10256 ast_free(redirecting->priv_to.name.str);
10257 redirecting->priv_to.name.str = ast_malloc(ie_len + 1);
10258 if (redirecting->priv_to.name.str) {
10259 memcpy(redirecting->priv_to.name.str, data + pos, ie_len);
10260 redirecting->priv_to.name.str[ie_len] = 0;
10261 }
10262 break;
10263 case AST_REDIRECTING_PRIV_TO_NAME_CHAR_SET:
10264 if (ie_len != 1) {
10265 ast_log(LOG_WARNING, "Invalid private redirecting-to name char set (%u)\n",
10266 (unsigned) ie_len);
10267 break;
10268 }
10269 redirecting->priv_to.name.char_set = data[pos];
10270 break;
10271 case AST_REDIRECTING_PRIV_TO_NAME_PRESENTATION:
10272 if (ie_len != 1) {
10273 ast_log(LOG_WARNING, "Invalid private redirecting-to name presentation (%u)\n",
10274 (unsigned) ie_len);
10275 break;
10276 }
10277 redirecting->priv_to.name.presentation = data[pos];
10278 break;
10279 case AST_REDIRECTING_PRIV_TO_NAME_VALID:
10280 if (ie_len != 1) {
10281 ast_log(LOG_WARNING, "Invalid private redirecting-to name valid (%u)\n",
10282 (unsigned) ie_len);
10283 break;
10284 }
10285 redirecting->priv_to.name.valid = data[pos];
10286 break;
10287/* Private redirecting-to party id number */
10288 case AST_REDIRECTING_PRIV_TO_NUMBER:
10289 ast_free(redirecting->priv_to.number.str);
10290 redirecting->priv_to.number.str = ast_malloc(ie_len + 1);
10291 if (redirecting->priv_to.number.str) {
10292 memcpy(redirecting->priv_to.number.str, data + pos, ie_len);
10293 redirecting->priv_to.number.str[ie_len] = 0;
10294 }
10295 break;
10296 case AST_REDIRECTING_PRIV_TO_NUMBER_PLAN:
10297 if (ie_len != 1) {
10298 ast_log(LOG_WARNING, "Invalid private redirecting-to numbering plan (%u)\n",
10299 (unsigned) ie_len);
10300 break;
10301 }
10302 redirecting->priv_to.number.plan = data[pos];
10303 break;
10304 case AST_REDIRECTING_PRIV_TO_NUMBER_PRESENTATION:
10305 if (ie_len != 1) {
10306 ast_log(LOG_WARNING, "Invalid private redirecting-to number presentation (%u)\n",
10307 (unsigned) ie_len);
10308 break;
10309 }
10310 redirecting->priv_to.number.presentation = data[pos];
10311 break;
10312 case AST_REDIRECTING_PRIV_TO_NUMBER_VALID:
10313 if (ie_len != 1) {
10314 ast_log(LOG_WARNING, "Invalid private redirecting-to number valid (%u)\n",
10315 (unsigned) ie_len);
10316 break;
10317 }
10318 redirecting->priv_to.number.valid = data[pos];
10319 break;
10320/* Private redirecting-to party id subaddress */
10321 case AST_REDIRECTING_PRIV_TO_SUBADDRESS:
10322 ast_free(redirecting->priv_to.subaddress.str);
10323 redirecting->priv_to.subaddress.str = ast_malloc(ie_len + 1);
10324 if (redirecting->priv_to.subaddress.str) {
10325 memcpy(redirecting->priv_to.subaddress.str, data + pos, ie_len);
10326 redirecting->priv_to.subaddress.str[ie_len] = 0;
10327 }
10328 break;
10329 case AST_REDIRECTING_PRIV_TO_SUBADDRESS_TYPE:
10330 if (ie_len != 1) {
10331 ast_log(LOG_WARNING, "Invalid private redirecting-to type of subaddress (%u)\n",
10332 (unsigned) ie_len);
10333 break;
10334 }
10335 redirecting->priv_to.subaddress.type = data[pos];
10336 break;
10337 case AST_REDIRECTING_PRIV_TO_SUBADDRESS_ODD_EVEN:
10338 if (ie_len != 1) {
10339 ast_log(LOG_WARNING,
10340 "Invalid private redirecting-to subaddress odd-even indicator (%u)\n",
10341 (unsigned) ie_len);
10342 break;
10343 }
10344 redirecting->priv_to.subaddress.odd_even_indicator = data[pos];
10345 break;
10346 case AST_REDIRECTING_PRIV_TO_SUBADDRESS_VALID:
10347 if (ie_len != 1) {
10348 ast_log(LOG_WARNING, "Invalid private redirecting-to subaddress valid (%u)\n",
10349 (unsigned) ie_len);
10350 break;
10351 }
10352 redirecting->priv_to.subaddress.valid = data[pos];
10353 break;
10354/* Private redirecting-to party id tag */
10355 case AST_REDIRECTING_PRIV_TO_TAG:
10356 ast_free(redirecting->priv_to.tag);
10357 redirecting->priv_to.tag = ast_malloc(ie_len + 1);
10358 if (redirecting->priv_to.tag) {
10359 memcpy(redirecting->priv_to.tag, data + pos, ie_len);
10360 redirecting->priv_to.tag[ie_len] = 0;
10361 }
10362 break;
10363/* Redirecting reason code */
10364 case AST_REDIRECTING_REASON_CODE:
10365 if (ie_len != sizeof(value)) {
10366 ast_log(LOG_WARNING, "Invalid redirecting reason (%u)\n",
10367 (unsigned) ie_len);
10368 break;
10369 }
10370 memcpy(&value, data + pos, sizeof(value));
10371 redirecting->reason.code = ntohl(value);
10372 break;
10373/* Redirecting reason string */
10374 case AST_REDIRECTING_REASON_STR:
10375 ast_free(redirecting->reason.str);
10376 redirecting->reason.str = ast_malloc(ie_len + 1);
10377 if (redirecting->reason.str) {
10378 memcpy(redirecting->reason.str, data + pos, ie_len);
10379 redirecting->reason.str[ie_len] = 0;
10380 }
10381 break;
10382/* Redirecting orig-reason code */
10383 case AST_REDIRECTING_ORIG_REASON_CODE:
10384 if (ie_len != sizeof(value)) {
10385 ast_log(LOG_WARNING, "Invalid redirecting original reason (%u)\n",
10386 (unsigned) ie_len);
10387 break;
10388 }
10389 memcpy(&value, data + pos, sizeof(value));
10390 redirecting->orig_reason.code = ntohl(value);
10391 break;
10392/* Redirecting orig-reason string */
10393 case AST_REDIRECTING_ORIG_REASON_STR:
10394 ast_free(redirecting->orig_reason.str);
10395 redirecting->orig_reason.str = ast_malloc(ie_len + 1);
10396 if (redirecting->orig_reason.str) {
10397 memcpy(redirecting->orig_reason.str, data + pos, ie_len);
10398 redirecting->orig_reason.str[ie_len] = 0;
10399 }
10400 break;
10401/* Redirecting count */
10402 case AST_REDIRECTING_COUNT:
10403 if (ie_len != sizeof(value)) {
10404 ast_log(LOG_WARNING, "Invalid redirecting count (%u)\n",
10405 (unsigned) ie_len);
10406 break;
10407 }
10408 memcpy(&value, data + pos, sizeof(value));
10409 redirecting->count = ntohl(value);
10410 break;
10411/* Redirecting unknown element */
10412 default:
10413 ast_debug(1, "Unknown redirecting element: %u (%u)\n",
10414 (unsigned) ie_id, (unsigned) ie_len);
10415 break;
10416 }
10417 }
10418
10419 switch (frame_version) {
10420 case 1:
10421 /*
10422 * The other end is an earlier version that we need to adjust
10423 * for compatibility.
10424 *
10425 * The earlier version did not have the orig party id or
10426 * orig_reason value.
10427 */
10428 redirecting->from.name.valid = 1;
10429 redirecting->from.name.char_set = AST_PARTY_CHAR_SET_ISO8859_1;
10430 redirecting->from.number.valid = 1;
10431 if (got_from_combined_presentation) {
10432 redirecting->from.name.presentation = from_combined_presentation;
10433 redirecting->from.number.presentation = from_combined_presentation;
10434 }
10435
10436 redirecting->to.name.valid = 1;
10437 redirecting->to.name.char_set = AST_PARTY_CHAR_SET_ISO8859_1;
10438 redirecting->to.number.valid = 1;
10439 if (got_to_combined_presentation) {
10440 redirecting->to.name.presentation = to_combined_presentation;
10441 redirecting->to.number.presentation = to_combined_presentation;
10442 }
10443 break;
10444 case 2:
10445 /* The other end is at the same level as we are. */
10446 break;
10447 default:
10448 /*
10449 * The other end is newer than we are.
10450 * We need to assume that they are compatible with us.
10451 */
10452 ast_debug(1, "Redirecting frame has newer version: %u\n",
10453 (unsigned) frame_version);
10454 break;
10455 }
10456
10457 return 0;
10458}

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

7775{
7776 if (groups) {
7777 ao2_ref(groups, 1);
7778 }
7779 return groups;
7780}

References ao2_ref.

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
typetype of channel to request
request_capFormat capabilities for requested channel
assignedidsUnique ID to create channel with
requestorchannel asking for data
addrdestination of the call
causeCause of failure

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

Return values
NULLfailure
non-NULLchannel on success

Definition at line 6373 of file channel.c.

6374{
6375 return request_channel(type, request_cap, NULL, assignedids, requestor, addr, cause);
6376}
request_channel
static struct ast_channel * request_channel(const char *type, struct ast_format_cap *request_cap, struct ast_stream_topology *topology, const struct ast_assigned_ids *assignedids, const struct ast_channel *requestor, const char *addr, int *cause)
Definition channel.c:6238

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
typetype of channel to request
capformat capabilities for requested channel
assignedidsUnique Id to assign to channel
requestorchannel asking for data
addrdestination of the call
timeoutmaximum amount of time to wait for an answer
reasonwhy unsuccessful (if unsuccessful)
cid_numCaller-ID Number
cid_nameCaller-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.

6194{
6195 return __ast_request_and_dial(type, cap, assignedids, requestor, addr, timeout, outstate, cidnum, cidname, NULL);
6196}
__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 *outstate, const char *cid_num, const char *cid_name, struct outgoing_helper *oh)
Request a channel of a given type, with data as optional information used by the low level module and...
Definition channel.c:5997

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
typetype of channel to request
topologyStream topology for requested channel
assignedidsUnique ID to create channel with
requestorchannel asking for data
addrdestination of the call
causeCause of failure

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

Return values
NULLfailure
non-NULLchannel on success

Definition at line 6378 of file channel.c.

6379{
6380 return request_channel(type, NULL, topology, assignedids, requestor, addr, cause);
6381}

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
chanchannel to wait for
mslength 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 1561 of file channel.c.

1562{
1563 return safe_sleep_conditional(chan, ms, NULL, NULL, 1);
1564}
safe_sleep_conditional
static int safe_sleep_conditional(struct ast_channel *chan, int timeout_ms, int(*cond)(void *), void *data, unsigned int generate_silence)
Wait, look for hangups and condition arg.
Definition channel.c:1485

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
chanchannel to wait for
mslength of time in milliseconds to sleep.
conda function pointer for testing continue condition
dataargument 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 1555 of file channel.c.

1556{
1557 return safe_sleep_conditional(chan, timeout_ms, cond, data, 1);
1558}

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
chanchannel to wait for
mslength 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 1566 of file channel.c.

1567{
1568 return safe_sleep_conditional(chan, ms, NULL, NULL, 0);
1569}

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
chanchannel to act upon
digitthe DTMF digit to send, encoded in ASCII
durationthe 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 4997 of file channel.c.

4998{
4999 if (duration < AST_DEFAULT_EMULATE_DTMF_DURATION) {
5000 duration = AST_DEFAULT_EMULATE_DTMF_DURATION;
5001 }
5002 if (ast_channel_tech(chan)->send_digit_begin) {
5003 ast_senddigit_begin(chan, digit);
5004 ast_safe_sleep(chan, duration);
5005 }
5006
5007 return ast_senddigit_end(chan, digit, duration);
5008}
ast_senddigit_begin
int ast_senddigit_begin(struct ast_channel *chan, char digit)
Send a DTMF digit to a channel.
Definition channel.c:4897
AST_DEFAULT_EMULATE_DTMF_DURATION
#define AST_DEFAULT_EMULATE_DTMF_DURATION
Definition channel.c:106
ast_safe_sleep
int ast_safe_sleep(struct ast_channel *chan, int ms)
Wait, look for hangups.
Definition channel.c:1561

References 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
chanchannel to act upon
digitthe DTMF digit to send, encoded in ASCII
Returns
0 on success, -1 on failure

Definition at line 4897 of file channel.c.

4898{
4899 /* Device does not support DTMF tones, lets fake
4900 * it by doing our own generation. */
4901 static const char * const dtmf_tones[] = {
4902 "941+1336", /* 0 */
4903 "697+1209", /* 1 */
4904 "697+1336", /* 2 */
4905 "697+1477", /* 3 */
4906 "770+1209", /* 4 */
4907 "770+1336", /* 5 */
4908 "770+1477", /* 6 */
4909 "852+1209", /* 7 */
4910 "852+1336", /* 8 */
4911 "852+1477", /* 9 */
4912 "697+1633", /* A */
4913 "770+1633", /* B */
4914 "852+1633", /* C */
4915 "941+1633", /* D */
4916 "941+1209", /* * */
4917 "941+1477" /* # */
4918 };
4919
4920 if (!ast_channel_tech(chan)->send_digit_begin)
4921 return 0;
4922
4923 ast_channel_lock(chan);
4924 ast_channel_sending_dtmf_digit_set(chan, digit);
4925 ast_channel_sending_dtmf_tv_set(chan, ast_tvnow());
4926 ast_channel_unlock(chan);
4927
4928 if (!ast_channel_tech(chan)->send_digit_begin(chan, digit))
4929 return 0;
4930
4931 if (digit >= '0' && digit <='9')
4932 ast_playtones_start(chan, 0, dtmf_tones[digit-'0'], 0);
4933 else if (digit >= 'A' && digit <= 'D')
4934 ast_playtones_start(chan, 0, dtmf_tones[digit-'A'+10], 0);
4935 else if (digit == '*')
4936 ast_playtones_start(chan, 0, dtmf_tones[14], 0);
4937 else if (digit == '#')
4938 ast_playtones_start(chan, 0, dtmf_tones[15], 0);
4939 else {
4940 /* not handled */
4941 ast_debug(1, "Unable to generate DTMF tone '%c' for '%s'\n", digit, ast_channel_name(chan));
4942 }
4943
4944 return 0;
4945}
ast_playtones_start
int ast_playtones_start(struct ast_channel *chan, int vol, const char *tonelist, int interruptible)
Start playing a list of tones on a channel.
Definition indications.c:302

References ast_channel_lock, ast_channel_name(), ast_channel_sending_dtmf_digit_set(), ast_channel_sending_dtmf_tv_set(), 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
chanchannel to act upon
digitthe DTMF digit to send, encoded in ASCII
durationthe duration of the digit ending in ms
Returns
Returns 0 on success, -1 on failure

Definition at line 4947 of file channel.c.

4948{
4949 int res = -1;
4950
4951 if (ast_channel_tech(chan)->send_digit_end)
4952 res = ast_channel_tech(chan)->send_digit_end(chan, digit, duration);
4953
4954 ast_channel_lock(chan);
4955 if (ast_channel_sending_dtmf_digit(chan) == digit) {
4956 ast_channel_sending_dtmf_digit_set(chan, 0);
4957 }
4958 ast_channel_unlock(chan);
4959
4960 if (res && ast_channel_generator(chan))
4961 ast_playtones_stop(chan);
4962
4963 return 0;
4964}
ast_playtones_stop
void ast_playtones_stop(struct ast_channel *chan)
Stop playing tones on a channel.
Definition indications.c:393
ast_channel_tech::send_digit_end
int(*const send_digit_end)(struct ast_channel *chan, char digit, unsigned int duration)
Stop sending a literal DTMF digit.
Definition channel.h:710

References ast_channel_generator(), ast_channel_lock, ast_channel_sending_dtmf_digit(), ast_channel_sending_dtmf_digit_set(), 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
chanchannel to act upon
digitthe DTMF digit to send, encoded in ASCII
durationthe 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 5010 of file channel.c.

5011{
5012 if (duration < AST_DEFAULT_EMULATE_DTMF_DURATION) {
5013 duration = AST_DEFAULT_EMULATE_DTMF_DURATION;
5014 }
5015 if (ast_channel_tech(chan)->send_digit_begin) {
5016 ast_senddigit_begin(chan, digit);
5017 usleep(duration * 1000);
5018 }
5019
5020 return ast_senddigit_end(chan, digit, duration);
5021}

References 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
chanchannel to act upon
digitthe MF digit to send, encoded in ASCII
durationthe duration of a numeric digit ending in ms
durationkpthe duration of a KP digit ending in ms
durationstthe duration of a ST, STP, ST2P, or ST3P digit ending in ms
is_external1 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 4975 of file channel.c.

4977{
4978 if (duration < DEFAULT_EMULATE_MF_DURATION) {
4979 duration = DEFAULT_EMULATE_MF_DURATION;
4980 }
4981 if (ast_channel_tech(chan)->send_digit_begin) {
4982 if (digit == '*') {
4983 duration = durationkp;
4984 } else if (digit == '#' || digit == 'A' || digit == 'B' || digit == 'C') {
4985 duration = durationst;
4986 }
4987 ast_senddigit_mf_begin(chan, digit);
4988 if (is_external) {
4989 usleep(duration * 1000);
4990 } else {
4991 ast_safe_sleep(chan, duration);
4992 }
4993 }
4994 return ast_senddigit_mf_end(chan);
4995}
ast_senddigit_mf_begin
int ast_senddigit_mf_begin(struct ast_channel *chan, char digit)
Send an MF digit to a channel.
Definition channel.c:4858
ast_senddigit_mf_end
int ast_senddigit_mf_end(struct ast_channel *chan)
End sending an MF digit to a channel.
Definition channel.c:4966
DEFAULT_EMULATE_MF_DURATION
#define DEFAULT_EMULATE_MF_DURATION
Definition channel.c:110

References 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
chanchannel to act upon
digitthe MF digit to send, encoded in ASCII
Returns
0 on success, -1 on failure

Definition at line 4858 of file channel.c.

4859{
4860 static const char * const mf_tones[] = {
4861 "1300+1500", /* 0 */
4862 "700+900", /* 1 */
4863 "700+1100", /* 2 */
4864 "900+1100", /* 3 */
4865 "700+1300", /* 4 */
4866 "900+1300", /* 5 */
4867 "1100+1300", /* 6 */
4868 "700+1500", /* 7 */
4869 "900+1500", /* 8 */
4870 "1100+1500", /* 9 */
4871 "1100+1700", /* * (KP) */
4872 "1500+1700", /* # (ST) */
4873 "900+1700", /* A (STP) */
4874 "1300+1700", /* B (ST2P) */
4875 "700+1700" /* C (ST3P) */
4876 };
4877
4878 if (digit >= '0' && digit <='9') {
4879 ast_playtones_start(chan, 0, mf_tones[digit-'0'], 0);
4880 } else if (digit == '*') {
4881 ast_playtones_start(chan, 0, mf_tones[10], 0);
4882 } else if (digit == '#') {
4883 ast_playtones_start(chan, 0, mf_tones[11], 0);
4884 } else if (digit == 'A') {
4885 ast_playtones_start(chan, 0, mf_tones[12], 0);
4886 } else if (digit == 'B') {
4887 ast_playtones_start(chan, 0, mf_tones[13], 0);
4888 } else if (digit == 'C') {
4889 ast_playtones_start(chan, 0, mf_tones[14], 0);
4890 } else {
4891 /* not handled */
4892 ast_log(LOG_WARNING, "Unable to generate MF tone '%c' for '%s'\n", digit, ast_channel_name(chan));
4893 }
4894 return 0;
4895}
mf_tones
static const float mf_tones[]
Definition dsp.c:332

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
chanchannel to act upon
Returns
Returns 0 on success, -1 on failure

Definition at line 4966 of file channel.c.

4967{
4968 if (ast_channel_generator(chan)) {
4969 ast_playtones_stop(chan);
4970 return 0;
4971 }
4972 return -1;
4973}

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
chanchannel to act upon
textstring 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
0on success
-1on failure

Definition at line 4832 of file channel.c.

4833{
4834 struct ast_msg_data *msg;
4835 int rc;
4836 struct ast_msg_data_attribute attrs[] =
4837 {
4838 {
4839 .type = AST_MSG_DATA_ATTR_BODY,
4840 .value = (char *)text,
4841 }
4842 };
4843
4844 if (ast_strlen_zero(text)) {
4845 return 0;
4846 }
4847
4848 msg = ast_msg_data_alloc(AST_MSG_DATA_SOURCE_TYPE_UNKNOWN, attrs, ARRAY_LEN(attrs));
4849 if (!msg) {
4850 return -1;
4851 }
4852 rc = ast_sendtext_data(chan, msg);
4853 ast_free(msg);
4854
4855 return rc;
4856}
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.
Definition channel.c:4774
ast_msg_data_alloc
struct ast_msg_data * ast_msg_data_alloc(enum ast_msg_data_source_type source, struct ast_msg_data_attribute attributes[], size_t count)
Allocates an ast_msg_data structure.
Definition main/message.c:1458
AST_MSG_DATA_ATTR_BODY
@ AST_MSG_DATA_ATTR_BODY
Definition message.h:458
AST_MSG_DATA_SOURCE_TYPE_UNKNOWN
@ AST_MSG_DATA_SOURCE_TYPE_UNKNOWN
Definition message.h:447
ast_msg_data_attribute
Definition message.h:462
ast_msg_data_attribute::type
enum ast_msg_data_attribute_type type
Definition message.h:463

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
chanchannel to act upon
msgast_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
0on success
-1on failure

Definition at line 4774 of file channel.c.

4775{
4776 int res = 0;
4777 const char *body = ast_msg_data_get_attribute(msg, AST_MSG_DATA_ATTR_BODY);
4778 const char *content_type = ast_msg_data_get_attribute(msg, AST_MSG_DATA_ATTR_CONTENT_TYPE);
4779
4780 ast_channel_lock(chan);
4781 /* Stop if we're a zombie or need a soft hangup */
4782 if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
4783 ast_channel_unlock(chan);
4784 return -1;
4785 }
4786
4787 CHECK_BLOCKING(chan);
4788 if (ast_channel_tech(chan)->write_text
4789 && (ast_strlen_zero(content_type) || ast_begins_with(content_type, "text/"))
4790 && (ast_format_cap_has_type(ast_channel_nativeformats(chan), AST_MEDIA_TYPE_TEXT))) {
4791 struct ast_frame f;
4792 /* T.140 payload does not include the null byte terminator */
4793 size_t body_len = strlen(body);
4794
4795 /* Process as T.140 text (moved here from ast_sendtext() */
4796 memset(&f, 0, sizeof(f));
4797 f.src = "DIALPLAN";
4798 f.subclass.format = ast_format_t140;
4799 f.frametype = AST_FRAME_TEXT;
4800 f.datalen = body_len;
4801 f.mallocd = AST_MALLOCD_DATA;
4802 f.data.ptr = ast_strdup(body);
4803 if (f.data.ptr) {
4804 res = ast_channel_tech(chan)->write_text(chan, &f);
4805 } else {
4806 res = -1;
4807 }
4808 ast_frfree(&f);
4809 } else if ((ast_channel_tech(chan)->properties & AST_CHAN_TP_SEND_TEXT_DATA)
4810 && ast_channel_tech(chan)->send_text_data) {
4811 /* Send enhanced message to a channel driver that supports it */
4812 ast_debug(1, "Sending TEXT_DATA from '%s' to %s:%s %s\n",
4813 ast_msg_data_get_attribute(msg, AST_MSG_DATA_ATTR_FROM),
4814 ast_msg_data_get_attribute(msg, AST_MSG_DATA_ATTR_TO),
4815 ast_channel_name(chan), body);
4816 res = ast_channel_tech(chan)->send_text_data(chan, msg);
4817 } else if (ast_channel_tech(chan)->send_text
4818 && (ast_strlen_zero(content_type) || ast_begins_with(content_type, "text/"))) {
4819 /* Send the body of an enhanced message to a channel driver that supports only a char str */
4820 ast_debug(1, "Sending TEXT to %s: %s\n", ast_channel_name(chan), body);
4821 res = ast_channel_tech(chan)->send_text(chan, body);
4822 } else {
4823 ast_debug(1, "Channel technology does not support sending content type '%s' on channel '%s'\n",
4824 S_OR(content_type, "text/plain"), ast_channel_name(chan));
4825 res = -1;
4826 }
4827 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
4828 ast_channel_unlock(chan);
4829 return res;
4830}
send_text
static void send_text(unsigned char pos, unsigned char inverse, struct unistimsession *pte, const char *text)
Definition chan_unistim.c:1578
CHECK_BLOCKING
#define CHECK_BLOCKING(c)
Set the blocking indication on the channel.
Definition channel.h:2932
AST_MEDIA_TYPE_TEXT
@ AST_MEDIA_TYPE_TEXT
Definition codec.h:35
ast_format_t140
struct ast_format * ast_format_t140
Built-in cached t140 format.
Definition format_cache.c:231
ast_format_cap_has_type
int ast_format_cap_has_type(const struct ast_format_cap *cap, enum ast_media_type type)
Find out if the capabilities structure has any formats of a specific type.
Definition format_cap.c:613
ast_msg_data_get_attribute
const char * ast_msg_data_get_attribute(struct ast_msg_data *msg, enum ast_msg_data_attribute_type attribute_type)
Get attribute from ast_msg_data.
Definition main/message.c:1573
AST_MSG_DATA_ATTR_TO
@ AST_MSG_DATA_ATTR_TO
Definition message.h:455
AST_MSG_DATA_ATTR_FROM
@ AST_MSG_DATA_ATTR_FROM
Definition message.h:456
AST_MSG_DATA_ATTR_CONTENT_TYPE
@ AST_MSG_DATA_ATTR_CONTENT_TYPE
Definition message.h:457
AST_MALLOCD_DATA
#define AST_MALLOCD_DATA
Definition include/asterisk/frame.h:235
ast_begins_with
static int force_inline attribute_pure ast_begins_with(const char *str, const char *prefix)
Checks whether a string begins with another.
Definition strings.h:97
ast_channel_tech::send_text
int(*const send_text)(struct ast_channel *chan, const char *text)
Display or transmit text.
Definition channel.h:776
ast_channel_tech::write_text
int(*const write_text)(struct ast_channel *chan, struct ast_frame *frame)
Write a text frame, in standard format.
Definition channel.h:809
ast_channel_tech::send_text_data
int(*const send_text_data)(struct ast_channel *chan, struct ast_msg_data *data)
Display or transmit text with data.
Definition channel.h:864

References ast_begins_with(), AST_CHAN_TP_SEND_TEXT_DATA, ast_channel_flags(), ast_channel_lock, ast_channel_name(), ast_channel_nativeformats(), 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 7370 of file channel.c.

7371{
7372 ast_channel_lock(chan);
7373
7374 if (cid_num) {
7375 ast_channel_caller(chan)->id.number.valid = 1;
7376 ast_free(ast_channel_caller(chan)->id.number.str);
7377 ast_channel_caller(chan)->id.number.str = ast_strdup(cid_num);
7378 }
7379 if (cid_name) {
7380 ast_channel_caller(chan)->id.name.valid = 1;
7381 ast_free(ast_channel_caller(chan)->id.name.str);
7382 ast_channel_caller(chan)->id.name.str = ast_strdup(cid_name);
7383 }
7384 if (cid_ani) {
7385 ast_channel_caller(chan)->ani.number.valid = 1;
7386 ast_free(ast_channel_caller(chan)->ani.number.str);
7387 ast_channel_caller(chan)->ani.number.str = ast_strdup(cid_ani);
7388 }
7389
7390 ast_channel_publish_snapshot(chan);
7391
7392 ast_channel_unlock(chan);
7393}
number
Number structure.
Definition app_followme.c:157

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
chanchannel to set the field on
sourcea 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 2498 of file channel.c.

2499{
2500 RAII_VAR(struct ast_channel *, bridge, ast_channel_bridge_peer(chan), ast_channel_cleanup);
2501
2502 ast_channel_lock(chan);
2503 if (force || ast_strlen_zero(ast_channel_hangupsource(chan))) {
2504 ast_channel_hangupsource_set(chan, source);
2505 }
2506 ast_channel_unlock(chan);
2507
2508 if (bridge) {
2509 ast_channel_lock(bridge);
2510 if (force || ast_strlen_zero(ast_channel_hangupsource(bridge))) {
2511 ast_channel_hangupsource_set(bridge, source);
2512 }
2513 ast_channel_unlock(bridge);
2514 }
2515}
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.
Definition channel.c:10744
ast_channel_cleanup
#define ast_channel_cleanup(c)
Cleanup a channel reference.
Definition channel.h:3030

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_idThe update marker for a corresponding party id.

Definition at line 1737 of file channel.c.

1738{
1739 update_id->name = 1;
1740 update_id->number = 1;
1741 update_id->subaddress = 1;
1742}
ast_set_party_id::subaddress
unsigned char subaddress
Definition channel.h:369
ast_set_party_id::number
unsigned char number
Definition channel.h:367
ast_set_party_id::name
unsigned char name
Definition channel.h:365

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
chanchannel to change
formatformat to set for reading
Returns
Returns 0 on success, -1 on failure

Definition at line 5785 of file channel.c.

5786{
5787 struct ast_format_cap *cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
5788 int res;
5789
5790 ast_assert(format != NULL);
5791
5792 if (!cap) {
5793 return -1;
5794 }
5795 ast_format_cap_append(cap, format, 0);
5796
5797 res = set_format(chan, cap, 0, 0);
5798
5799 ao2_cleanup(cap);
5800 return res;
5801}
set_format
static int set_format(struct ast_channel *chan, struct ast_format_cap *cap_set, const int direction, int interleaved_stereo)
Definition channel.c:5616
AST_FORMAT_CAP_FLAG_DEFAULT
@ AST_FORMAT_CAP_FLAG_DEFAULT
Definition format_cap.h:38
ast_format_cap_append
#define ast_format_cap_append(cap, format, framing)
Add format capability to capabilities structure.
Definition format_cap.h:99
ast_format_cap_alloc
#define ast_format_cap_alloc(flags)
Allocate a new ast_format_cap structure.
Definition format_cap.h:49

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
chanchannel to change
formatsnew formats to pick from for reading
Returns
Returns 0 on success, -1 on failure

Definition at line 5803 of file channel.c.

5804{
5805 return set_format(chan, cap, 0, 0);
5806}

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
chanChannel to setup read path.
raw_formatFormat to expect from the channel driver.
core_formatWhat the core wants to read.
Precondition
chan is locked
Return values
0on success.
-1on error.

Definition at line 5511 of file channel.c.

5512{
5513 struct ast_trans_pvt *trans_old;
5514 struct ast_trans_pvt *trans_new;
5515
5516 if (ast_format_cmp(ast_channel_rawreadformat(chan), raw_format) == AST_FORMAT_CMP_EQUAL
5517 && ast_format_cmp(ast_channel_readformat(chan), core_format) == AST_FORMAT_CMP_EQUAL) {
5518 /* Nothing to setup */
5519 return 0;
5520 }
5521
5522 ast_debug(1, "Channel %s setting read format path: %s -> %s\n",
5523 ast_channel_name(chan),
5524 ast_format_get_name(raw_format),
5525 ast_format_get_name(core_format));
5526
5527 /* Setup new translation path. */
5528 if (ast_format_cmp(raw_format, core_format) != AST_FORMAT_CMP_EQUAL) {
5529 trans_new = ast_translator_build_path(core_format, raw_format);
5530 if (!trans_new) {
5531 return -1;
5532 }
5533 } else {
5534 /* No translation needed. */
5535 trans_new = NULL;
5536 }
5537 trans_old = ast_channel_readtrans(chan);
5538 if (trans_old) {
5539 ast_translator_free_path(trans_old);
5540 }
5541 ast_channel_readtrans_set(chan, trans_new);
5542 ast_channel_set_rawreadformat(chan, raw_format);
5543 ast_channel_set_readformat(chan, core_format);
5544 return 0;
5545}
ast_format_cmp
enum ast_format_cmp_res ast_format_cmp(const struct ast_format *format1, const struct ast_format *format2)
Compare two formats.
Definition format.c:201
AST_FORMAT_CMP_EQUAL
@ AST_FORMAT_CMP_EQUAL
Definition format.h:36
ast_format_get_name
const char * ast_format_get_name(const struct ast_format *format)
Get the name associated with a format.
Definition format.c:334
ast_translator_free_path
void ast_translator_free_path(struct ast_trans_pvt *tr)
Frees a translator path Frees the given translator path structure.
Definition translate.c:533
ast_translator_build_path
struct ast_trans_pvt * ast_translator_build_path(struct ast_format *dest, struct ast_format *source)
Builds a translator path Build a path (possibly NULL) from source to dest.
Definition translate.c:543

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
chanthe channel
varsa linked list of variables
Warning
The channel must not be locked if there's a possibility that a dialplan function would be invoked.

Variable names can be for a regular channel variable or a dialplan function that has the ability to be written to.

Definition at line 8291 of file channel.c.

8292{
8293 struct ast_variable *cur;
8294
8295 for (cur = vars; cur; cur = cur->next) {
8296 pbx_builtin_setvar_helper(chan, cur->name, cur->value);
8297 }
8298}
ast_variable::value
const char * value
Definition include/asterisk/config.h:87
ast_variable::name
const char * name
Definition include/asterisk/config.h:85
ast_variable::next
struct ast_variable * next
Definition include/asterisk/config.h:90

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
chanchannel to change
formatformat to set for writing
Returns
Returns 0 on success, -1 on failure

Definition at line 5826 of file channel.c.

5827{
5828 struct ast_format_cap *cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
5829 int res;
5830
5831 ast_assert(format != NULL);
5832
5833 if (!cap) {
5834 return -1;
5835 }
5836 ast_format_cap_append(cap, format, 0);
5837
5838 res = set_format(chan, cap, 1, 0);
5839
5840 ao2_cleanup(cap);
5841 return res;
5842}

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
chanchannel to change
formatsnew formats to pick from for writing
Returns
Returns 0 on success, -1 on failure

Definition at line 5844 of file channel.c.

5845{
5846 return set_format(chan, cap, 1, 0);
5847}

References set_format().

Referenced by openstream_internal().

◆ 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
chanchannel to change
formatformat to set for writing
Returns
Returns 0 on success, -1 on failure

Definition at line 5808 of file channel.c.

5809{
5810 struct ast_format_cap *cap = ast_format_cap_alloc(AST_FORMAT_CAP_FLAG_DEFAULT);
5811 int res;
5812
5813 ast_assert(format != NULL);
5814
5815 if (!cap) {
5816 return -1;
5817 }
5818 ast_format_cap_append(cap, format, 0);
5819
5820 res = set_format(chan, cap, 1, 1);
5821
5822 ao2_cleanup(cap);
5823 return res;
5824}

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
chanChannel to setup write path.
core_formatWhat the core wants to write.
raw_formatRaw write format.
Precondition
chan is locked
Return values
0on success.
-1on error.

Definition at line 5547 of file channel.c.

5548{
5549 struct ast_trans_pvt *trans_old;
5550 struct ast_trans_pvt *trans_new;
5551
5552 if (ast_format_cmp(ast_channel_rawwriteformat(chan), raw_format) == AST_FORMAT_CMP_EQUAL
5553 && ast_format_cmp(ast_channel_writeformat(chan), core_format) == AST_FORMAT_CMP_EQUAL) {
5554 /* Nothing to setup */
5555 return 0;
5556 }
5557
5558 ast_debug(1, "Channel %s setting write format path: %s -> %s\n",
5559 ast_channel_name(chan),
5560 ast_format_get_name(core_format),
5561 ast_format_get_name(raw_format));
5562
5563 /* Setup new translation path. */
5564 if (ast_format_cmp(raw_format, core_format) != AST_FORMAT_CMP_EQUAL) {
5565 trans_new = ast_translator_build_path(raw_format, core_format);
5566 if (!trans_new) {
5567 return -1;
5568 }
5569 } else {
5570 /* No translation needed. */
5571 trans_new = NULL;
5572 }
5573 trans_old = ast_channel_writetrans(chan);
5574 if (trans_old) {
5575 ast_translator_free_path(trans_old);
5576 }
5577 ast_channel_writetrans_set(chan, trans_new);
5578 ast_channel_set_rawwriteformat(chan, raw_format);
5579 ast_channel_set_writeformat(chan, core_format);
5580 return 0;
5581}

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
cchannel
ratenumber of timer ticks per second
funccallback 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 3184 of file channel.c.

3185{
3186 return ast_settimeout_full(c, rate, func, data, 0);
3187}
ast_settimeout_full
int ast_settimeout_full(struct ast_channel *c, unsigned int rate, int(*func)(const void *data), void *data, unsigned int is_ao2_obj)
Definition channel.c:3189

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

3190{
3191 int res;
3192 unsigned int real_rate = rate, max_rate;
3193 struct ast_timer *timer = ast_channel_timer(c);
3194
3195 ast_channel_lock(c);
3196
3197 if (ast_channel_timingfd(c) == -1) {
3198 ast_channel_unlock(c);
3199 return -1;
3200 }
3201
3202 if (!func) {
3203 rate = 0;
3204 data = NULL;
3205 }
3206
3207 if (rate && rate > (max_rate = ast_timer_get_max_rate(timer))) {
3208 real_rate = max_rate;
3209 }
3210
3211 ast_debug(3, "Scheduling timer at (%u requested / %u actual) timer ticks per second\n", rate, real_rate);
3212
3213 res = ast_timer_set_rate(timer, real_rate);
3214
3215 if (ast_channel_timingdata(c) && ast_test_flag(ast_channel_flags(c), AST_FLAG_TIMINGDATA_IS_AO2_OBJ)) {
3216 ao2_ref(ast_channel_timingdata(c), -1);
3217 }
3218
3219 ast_channel_timingfunc_set(c, func);
3220 ast_channel_timingdata_set(c, data);
3221
3222 if (data && is_ao2_obj) {
3223 ao2_ref(data, 1);
3224 ast_set_flag(ast_channel_flags(c), AST_FLAG_TIMINGDATA_IS_AO2_OBJ);
3225 } else {
3226 ast_clear_flag(ast_channel_flags(c), AST_FLAG_TIMINGDATA_IS_AO2_OBJ);
3227 }
3228
3229 if (func == NULL && rate == 0 && ast_channel_fdno(c) == AST_TIMING_FD) {
3230 /* Clearing the timing func and setting the rate to 0
3231 * means that we don't want to be reading from the timingfd
3232 * any more. Setting c->fdno to -1 means we won't have any
3233 * errant reads from the timingfd, meaning we won't potentially
3234 * miss any important frames.
3235 */
3236 ast_channel_fdno_set(c, -1);
3237 }
3238
3239 ast_channel_unlock(c);
3240
3241 return res;
3242}
AST_TIMING_FD
#define AST_TIMING_FD
Definition channel.h:203
ast_timer::data
void * data
Definition timing.c:55
ast_timer_get_max_rate
unsigned int ast_timer_get_max_rate(const struct ast_timer *handle)
Get maximum rate supported for a timer.
Definition timing.c:191

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_timer::data, NULL, and timer.

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
chanchannel to be soft-hung-up
causean 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 2462 of file channel.c.

2463{
2464 RAII_VAR(struct ast_json *, blob, NULL, ast_json_unref);
2465 int res;
2466 int tech_cause = 0;
2467
2468 ast_channel_lock(chan);
2469
2470 res = ast_softhangup_nolock(chan, cause);
2471 blob = ast_json_pack("{s: i, s: b}",
2472 "cause", cause,
2473 "soft", 1);
2474
2475 tech_cause = ast_channel_tech_hangupcause(chan);
2476 if (tech_cause) {
2477 ast_json_object_set(blob, "tech_cause", ast_json_integer_create(tech_cause));
2478 }
2479
2480 ast_channel_publish_blob(chan, ast_channel_hangup_request_type(), blob);
2481 ast_channel_unlock(chan);
2482
2483 return res;
2484}

References ast_channel_hangup_request_type(), ast_channel_lock, ast_channel_publish_blob(), ast_channel_tech_hangupcause(), ast_channel_unlock, ast_json_integer_create(), ast_json_object_set(), 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(), channel_hangup_matches(), 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 494 of file channel.c.

495{
496 ast_channel_callback(ast_channel_softhangup_cb, NULL, NULL, 0);
497}
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.
Definition channel.c:1336
ast_channel_softhangup_cb
static int ast_channel_softhangup_cb(void *obj, void *arg, void *data, int flags)
Definition channel.c:485

References ast_channel_callback(), ast_channel_softhangup_cb(), and NULL.

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
chanchannel to be soft-hung-up
causean AST_SOFTHANGUP_* reason code

Softly hangup up a channel (no channel lock)

Definition at line 2449 of file channel.c.

2450{
2451 ast_debug(1, "Soft-Hanging (%#04x) up channel '%s'\n", (unsigned)cause, ast_channel_name(chan));
2452 /* Inform channel driver that we need to be hung up, if it cares */
2453 ast_channel_softhangup_internal_flag_add(chan, cause);
2454 ast_queue_frame(chan, &ast_null_frame);
2455 /* Interrupt any poll call or such */
2456 if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING))
2457 pthread_kill(ast_channel_blocker(chan), SIGURG);
2458 return 0;
2459}

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
statestate to get the name of
Returns
the text form of the binary state given
Note
This function is not reentrant.

Definition at line 637 of file channel.c.

638{
639 char *buf;
640
641 switch (state) {
642 case AST_STATE_DOWN:
643 return "Down";
644 case AST_STATE_RESERVED:
645 return "Rsrvd";
646 case AST_STATE_OFFHOOK:
647 return "OffHook";
648 case AST_STATE_DIALING:
649 return "Dialing";
650 case AST_STATE_RING:
651 return "Ring";
652 case AST_STATE_RINGING:
653 return "Ringing";
654 case AST_STATE_UP:
655 return "Up";
656 case AST_STATE_BUSY:
657 return "Busy";
658 case AST_STATE_DIALING_OFFHOOK:
659 return "Dialing Offhook";
660 case AST_STATE_PRERING:
661 return "Pre-ring";
662 case AST_STATE_MUTE:
663 return "Mute";
664 default:
665 if (!(buf = ast_threadstorage_get(&state2str_threadbuf, STATE2STR_BUFSIZE)))
666 return "Unknown";
667 snprintf(buf, STATE2STR_BUFSIZE, "Unknown (%u)", state);
668 return buf;
669 }
670}
STATE2STR_BUFSIZE
#define STATE2STR_BUFSIZE
Definition channel.c:102
AST_STATE_MUTE
@ AST_STATE_MUTE
Definition channelstate.h:47
AST_STATE_DIALING_OFFHOOK
@ AST_STATE_DIALING_OFFHOOK
Definition channelstate.h:44
AST_STATE_PRERING
@ AST_STATE_PRERING
Definition channelstate.h:45
AST_STATE_OFFHOOK
@ AST_STATE_OFFHOOK
Definition channelstate.h:38
AST_STATE_BUSY
@ AST_STATE_BUSY
Definition channelstate.h:43
AST_STATE_DIALING
@ AST_STATE_DIALING
Definition channelstate.h:39
AST_STATE_RESERVED
@ AST_STATE_RESERVED
Definition channelstate.h:37
ast_threadstorage_get
void * ast_threadstorage_get(struct ast_threadstorage *ts, size_t init_size)
Retrieve thread storage.
Definition threadstorage.h:199

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, and STATE2STR_BUFSIZE.

Referenced by ast_channel_snapshot_to_json(), ast_manager_build_channel_state_string_prefix(), ast_raw_answer_with_stream_topology(), 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
namestring form of the cause
Returns
the cause code

Convert the string form of a cause code to a number.

Definition at line 626 of file channel.c.

627{
628 int x;
629
630 for (x = 0; x < ARRAY_LEN(causes); x++)
631 if (!strncasecmp(causes[x].name, name, strlen(causes[x].name)))
632 return causes[x].cause;
633
634 return -1;
635}

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

7637{
7638 int res;
7639
7640 if ((res = ast_tonepair_start(chan, freq1, freq2, duration, vol)))
7641 return res;
7642
7643 /* Give us some wiggle room */
7644 while (ast_channel_generatordata(chan) && ast_waitfor(chan, 100) >= 0) {
7645 struct ast_frame *f = ast_read(chan);
7646 if (f)
7647 ast_frfree(f);
7648 else
7649 return -1;
7650 }
7651 return 0;
7652}
ast_tonepair_start
int ast_tonepair_start(struct ast_channel *chan, int freq1, int freq2, int duration, int vol)
Definition channel.c:7618

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

7619{
7620 struct tonepair_def d = { 0, };
7621
7622 d.freq1 = freq1;
7623 d.freq2 = freq2;
7624 d.duration = duration;
7625 d.vol = (vol < 1) ? 8192 : vol; /* force invalid to 8192 */
7626 if (ast_activate_generator(chan, &tonepair, &d))
7627 return -1;
7628 return 0;
7629}
tonepair
static struct ast_generator tonepair
Definition channel.c:7612
tonepair_def
Definition channel.c:7498
tonepair_def::vol
int vol
Definition channel.c:7502
tonepair_def::duration
int duration
Definition channel.c:7501
tonepair_def::freq2
int freq2
Definition channel.c:7500
tonepair_def::freq1
int freq1
Definition channel.c:7499

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

7632{
7633 ast_deactivate_generator(chan);
7634}
ast_deactivate_generator
void ast_deactivate_generator(struct ast_channel *chan)
Definition channel.c:2892

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
-1on error
0if not supported
1if supported and requested
Parameters
chancurrent channel
destdestination extension for transfer

Transfer a channel (if supported).

Called by:

  • app_transfer
  • the manager interface

Definition at line 6504 of file channel.c.

6505{
6506 int protocol;
6507 return ast_transfer_protocol(chan, dest, &protocol);
6508}
ast_transfer_protocol
int ast_transfer_protocol(struct ast_channel *chan, char *dest, int *protocol)
Transfer a call to dest, if the channel supports transfer.
Definition channel.c:6517

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
-1on error
0if not supported
1if supported and requested
Parameters
chanchannel to transfer
destdestination extension to transfer to
protocolprotocol 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.

6518{
6519 int res = -1;
6520
6521 if (protocol) {
6522 *protocol = 0;
6523 }
6524
6525 /* Stop if we're a zombie or need a soft hangup */
6526 ast_channel_lock(chan);
6527 if (!ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE) && !ast_check_hangup(chan)) {
6528 if (ast_channel_tech(chan)->transfer) {
6529 res = ast_channel_tech(chan)->transfer(chan, dest);
6530 if (!res)
6531 res = 1;
6532 } else
6533 res = 0;
6534 }
6535 ast_channel_unlock(chan);
6536
6537 if (res <= 0) {
6538 return res;
6539 }
6540
6541 for (;;) {
6542 struct ast_frame *fr;
6543
6544 res = ast_waitfor(chan, -1);
6545
6546 if (res < 0 || !(fr = ast_read(chan))) {
6547 res = -1;
6548 break;
6549 }
6550
6551 if (fr->frametype == AST_FRAME_CONTROL && fr->subclass.integer == AST_CONTROL_TRANSFER) {
6552 enum ast_control_transfer *message = fr->data.ptr;
6553
6554 if (*message == AST_TRANSFER_SUCCESS) {
6555 res = 1;
6556 } else {
6557 res = -1;
6558 /* Message can contain a protocol specific code
6559 AST_TRANSFER_SUCCESS indicates success
6560 Else, failure. Protocol will be set to the failure reason.
6561 SIP example, 0 is success, else error code 3xx-6xx */
6562 if (protocol) {
6563 *protocol = *message;
6564 }
6565 }
6566
6567 ast_frfree(fr);
6568 break;
6569 }
6570
6571 ast_frfree(fr);
6572 }
6573
6574 return res;
6575}
transfer
static int transfer(void *data)
Definition chan_pjsip.c:2141
AST_TRANSFER_SUCCESS
@ AST_TRANSFER_SUCCESS
Definition include/asterisk/frame.h:410
AST_CONTROL_TRANSFER
@ AST_CONTROL_TRANSFER
Definition include/asterisk/frame.h:298
ast_channel_tech::transfer
int(*const transfer)(struct ast_channel *chan, const char *newdest)
Blind transfer other side (see app_transfer.c and ast_transfer()
Definition channel.h:803

References ast_channel_flags(), ast_channel_lock, 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
transfercapabilitytransfer capability to get the name of
Returns
the text form of the binary transfer capability

Definition at line 673 of file channel.c.

674{
675 switch (transfercapability) {
676 case AST_TRANS_CAP_SPEECH:
677 return "SPEECH";
678 case AST_TRANS_CAP_DIGITAL:
679 return "DIGITAL";
680 case AST_TRANS_CAP_RESTRICTED_DIGITAL:
681 return "RESTRICTED_DIGITAL";
682 case AST_TRANS_CAP_3_1K_AUDIO:
683 return "3K1AUDIO";
684 case AST_TRANS_CAP_DIGITAL_W_TONES:
685 return "DIGITAL_W_TONES";
686 case AST_TRANS_CAP_VIDEO:
687 return "VIDEO";
688 default:
689 return "UNKNOWN";
690 }
691}
AST_TRANS_CAP_RESTRICTED_DIGITAL
#define AST_TRANS_CAP_RESTRICTED_DIGITAL
Definition transcap.h:37
AST_TRANS_CAP_DIGITAL
#define AST_TRANS_CAP_DIGITAL
Definition transcap.h:36
AST_TRANS_CAP_DIGITAL_W_TONES
#define AST_TRANS_CAP_DIGITAL_W_TONES
Definition transcap.h:40
AST_TRANS_CAP_SPEECH
#define AST_TRANS_CAP_SPEECH
Definition transcap.h:35
AST_TRANS_CAP_3_1K_AUDIO
#define AST_TRANS_CAP_3_1K_AUDIO
Definition transcap.h:38
AST_TRANS_CAP_VIDEO
#define AST_TRANS_CAP_VIDEO
Definition transcap.h:41

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

506{
507 return ast_atomic_fetchadd_int(&chancount, 0);
508}
chancount
static int chancount
Definition channel.c:97
ast_atomic_fetchadd_int
int ast_atomic_fetchadd_int(volatile int *p, int v)
Atomically add v to *p and return the previous value of *p.
Definition lock.h:764

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

7769{
7770 ao2_cleanup(groups);
7771 return NULL;
7772}

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
chanchannel to wait on
mslength 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
0if nothing ever arrived
the# of ms remaining otherwise

Definition at line 3166 of file channel.c.

3167{
3168 if (ms < 0) {
3169 do {
3170 ms = 100000;
3171 ast_waitfor_nandfds(&c, 1, NULL, 0, NULL, NULL, &ms);
3172 } while (!ms);
3173 } else {
3174 ast_waitfor_nandfds(&c, 1, NULL, 0, NULL, NULL, &ms);
3175 }
3176 return ms;
3177}
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)
Wait for x amount of time on a file descriptor to have input.
Definition channel.c:2992

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
chanan array of pointers to channels
nnumber of channels that are to be waited upon
mstime "ms" is modified in-place, if applicable

Definition at line 3161 of file channel.c.

3162{
3163 return ast_waitfor_nandfds(c, n, NULL, 0, NULL, NULL, ms);
3164}

References ast_waitfor_nandfds(), c, and NULL.

Referenced by autoservice_run(), dial_exec_full(), monitor_dial(), wait_for_answer(), 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 2984 of file channel.c.

2985{
2986 int winner = -1;
2987 ast_waitfor_nandfds(NULL, 0, fds, n, exception, &winner, ms);
2988 return winner;
2989}

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
can array of pointers to channels
nnumber of channels that are to be waited upon
fdsan array of fds to wait upon
nfdsthe number of fds to wait upon
exceptionexception flag
outfdfd that had activity on it
msOn invocation, max wait time. Upon returning, how long the wait actually was (in/out parameter).

Big momma function here. Wait for activity on any of the n channels, or any of the nfds file descriptors. -1 can be passed as the ms timeout to wait forever, 0 to return instantly if theres no activity immediantely available.

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

2994{
2995 struct timeval start = { 0 , 0 };
2996 struct pollfd *pfds = NULL;
2997 int res;
2998 long rms;
2999 int x, y, max;
3000 int sz = nfds;
3001 struct timeval now = { 0, 0 };
3002 struct timeval whentohangup = { 0, 0 }, diff;
3003 struct ast_channel *winner = NULL;
3004 struct fdmap {
3005 int chan;
3006 int fdno;
3007 } *fdmap = NULL;
3008
3009 if (outfd) {
3010 *outfd = -99999;
3011 }
3012 if (exception) {
3013 *exception = 0;
3014 }
3015
3016 for (x = 0; x < n; x++) {
3017 ast_channel_lock(c[x]);
3018 if (!ast_tvzero(*ast_channel_whentohangup(c[x]))) {
3019 if (ast_tvzero(whentohangup))
3020 now = ast_tvnow();
3021 diff = ast_tvsub(*ast_channel_whentohangup(c[x]), now);
3022 if (diff.tv_sec < 0 || ast_tvzero(diff)) {
3023 ast_test_suite_event_notify("HANGUP_TIME", "Channel: %s", ast_channel_name(c[x]));
3024 /* Should already be hungup */
3025 ast_channel_softhangup_internal_flag_add(c[x], AST_SOFTHANGUP_TIMEOUT);
3026 ast_channel_unlock(c[x]);
3027 return c[x];
3028 }
3029 if (ast_tvzero(whentohangup) || ast_tvcmp(diff, whentohangup) < 0)
3030 whentohangup = diff;
3031 }
3032 sz += ast_channel_fd_count(c[x]);
3033 ast_channel_unlock(c[x]);
3034 }
3035
3036 if (!sz) {
3037 return NULL;
3038 }
3039
3040 pfds = ast_alloca(sizeof(*pfds) * sz);
3041 fdmap = ast_alloca(sizeof(*fdmap) * sz);
3042
3043 /* Wait full interval */
3044 rms = *ms;
3045 /* INT_MAX, not LONG_MAX, because it matters on 64-bit */
3046 if (!ast_tvzero(whentohangup) && whentohangup.tv_sec < INT_MAX / 1000) {
3047 rms = whentohangup.tv_sec * 1000 + whentohangup.tv_usec / 1000; /* timeout in milliseconds */
3048 if (*ms >= 0 && *ms < rms) { /* original *ms still smaller */
3049 rms = *ms;
3050 }
3051 } else if (!ast_tvzero(whentohangup) && rms < 0) {
3052 /* Tiny corner case... call would need to last >24 days */
3053 rms = INT_MAX;
3054 }
3055 /*
3056 * Build the pollfd array, putting the channels' fds first,
3057 * followed by individual fds. Order is important because
3058 * individual fd's must have priority over channel fds.
3059 */
3060 max = 0;
3061 for (x = 0; x < n; x++) {
3062 ast_channel_lock(c[x]);
3063 for (y = 0; y < ast_channel_fd_count(c[x]); y++) {
3064 fdmap[max].fdno = y; /* fd y is linked to this pfds */
3065 fdmap[max].chan = x; /* channel x is linked to this pfds */
3066 max += ast_add_fd(&pfds[max], ast_channel_fd(c[x], y));
3067 }
3068 CHECK_BLOCKING(c[x]);
3069 ast_channel_unlock(c[x]);
3070 }
3071 /* Add the individual fds */
3072 for (x = 0; x < nfds; x++) {
3073 fdmap[max].chan = -1;
3074 max += ast_add_fd(&pfds[max], fds[x]);
3075 }
3076
3077 if (*ms > 0) {
3078 start = ast_tvnow();
3079 }
3080
3081 if (sizeof(int) == 4) { /* XXX fix timeout > 600000 on linux x86-32 */
3082 do {
3083 int kbrms = rms;
3084 if (kbrms > 600000) {
3085 kbrms = 600000;
3086 }
3087 res = ast_poll(pfds, max, kbrms);
3088 if (!res) {
3089 rms -= kbrms;
3090 }
3091 } while (!res && (rms > 0));
3092 } else {
3093 res = ast_poll(pfds, max, rms);
3094 }
3095 for (x = 0; x < n; x++) {
3096 ast_channel_lock(c[x]);
3097 ast_clear_flag(ast_channel_flags(c[x]), AST_FLAG_BLOCKING);
3098 ast_channel_unlock(c[x]);
3099 }
3100 if (res < 0) { /* Simulate a timeout if we were interrupted */
3101 if (errno != EINTR) {
3102 *ms = -1;
3103 }
3104 return NULL;
3105 }
3106 if (!ast_tvzero(whentohangup)) { /* if we have a timeout, check who expired */
3107 now = ast_tvnow();
3108 for (x = 0; x < n; x++) {
3109 if (!ast_tvzero(*ast_channel_whentohangup(c[x])) && ast_tvcmp(*ast_channel_whentohangup(c[x]), now) <= 0) {
3110 ast_test_suite_event_notify("HANGUP_TIME", "Channel: %s", ast_channel_name(c[x]));
3111 ast_channel_softhangup_internal_flag_add(c[x], AST_SOFTHANGUP_TIMEOUT);
3112 if (winner == NULL) {
3113 winner = c[x];
3114 }
3115 }
3116 }
3117 }
3118 if (res == 0) { /* no fd ready, reset timeout and done */
3119 *ms = 0; /* XXX use 0 since we may not have an exact timeout. */
3120 return winner;
3121 }
3122 /*
3123 * Then check if any channel or fd has a pending event.
3124 * Remember to check channels first and fds last, as they
3125 * must have priority on setting 'winner'
3126 */
3127 for (x = 0; x < max; x++) {
3128 res = pfds[x].revents;
3129 if (res == 0) {
3130 continue;
3131 }
3132 if (fdmap[x].chan >= 0) { /* this is a channel */
3133 winner = c[fdmap[x].chan]; /* override previous winners */
3134 ast_channel_lock(winner);
3135 if (res & POLLPRI) {
3136 ast_set_flag(ast_channel_flags(winner), AST_FLAG_EXCEPTION);
3137 } else {
3138 ast_clear_flag(ast_channel_flags(winner), AST_FLAG_EXCEPTION);
3139 }
3140 ast_channel_fdno_set(winner, fdmap[x].fdno);
3141 ast_channel_unlock(winner);
3142 } else { /* this is an fd */
3143 if (outfd) {
3144 *outfd = pfds[x].fd;
3145 }
3146 if (exception) {
3147 *exception = (res & POLLPRI) ? -1 : 0;
3148 }
3149 winner = NULL;
3150 }
3151 }
3152 if (*ms > 0) {
3153 *ms -= ast_tvdiff_ms(ast_tvnow(), start);
3154 if (*ms < 0) {
3155 *ms = 0;
3156 }
3157 }
3158 return winner;
3159}
ast_alloca
#define ast_alloca(size)
call __builtin_alloca to ensure we get gcc builtin semantics
Definition astmm.h:288
max
#define max(a, b)
Definition f2c.h:198
ast_poll
#define ast_poll(a, b, c)
Definition poll-compat.h:88
ast_tvcmp
int ast_tvcmp(struct timeval _a, struct timeval _b)
Compress two struct timeval instances returning -1, 0, 1 if the first arg is smaller,...
Definition time.h:137
ast_tvsub
struct timeval ast_tvsub(struct timeval a, struct timeval b)
Returns the difference of two timevals a - b.
Definition extconf.c:2295

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
cchannel to wait for a digit on
mshow many milliseconds to wait (<0 for indefinite).
Returns
Returns <0 on error, 0 on no entry, and the digit on success.

Definition at line 3179 of file channel.c.

3180{
3181 return ast_waitfordigit_full(c, ms, NULL, -1, -1);
3182}

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(), 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
cchannel to wait for a digit on
mshow many milliseconds to wait (<0 for indefinite).
breakonstring of DTMF digits to break upon or NULL for any.
audiofdaudio file descriptor to write to if audio frames are received
ctrlfdcontrol file descriptor to monitor for reading
Returns
Returns 1 if ctrlfd becomes available

Definition at line 3244 of file channel.c.

3245{
3246 struct timeval start = ast_tvnow();
3247 int ms;
3248
3249 /* Stop if we're a zombie or need a soft hangup */
3250 if (ast_test_flag(ast_channel_flags(c), AST_FLAG_ZOMBIE) || ast_check_hangup(c))
3251 return -1;
3252
3253 /* Only look for the end of DTMF, don't bother with the beginning and don't emulate things */
3254 ast_channel_set_flag(c, AST_FLAG_END_DTMF_ONLY);
3255
3256 /* Wait for a digit, no more than timeout_ms milliseconds total.
3257 * Or, wait indefinitely if timeout_ms is <0.
3258 */
3259 while ((ms = ast_remaining_ms(start, timeout_ms))) {
3260 struct ast_channel *rchan;
3261 int outfd = -1;
3262
3263 errno = 0;
3264 /* While ast_waitfor_nandfds tries to help by reducing the timeout by how much was waited,
3265 * it is unhelpful if it waited less than a millisecond.
3266 */
3267 rchan = ast_waitfor_nandfds(&c, 1, &cmdfd, (cmdfd > -1) ? 1 : 0, NULL, &outfd, &ms);
3268
3269 if (!rchan && outfd < 0 && ms) {
3270 if (errno == 0 || errno == EINTR)
3271 continue;
3272 ast_log(LOG_WARNING, "Wait failed (%s)\n", strerror(errno));
3273 ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
3274 return -1;
3275 } else if (outfd > -1) {
3276 /* The FD we were watching has something waiting */
3277 ast_log(LOG_WARNING, "The FD we were waiting for has something waiting. Waitfordigit returning numeric 1\n");
3278 ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
3279 return 1;
3280 } else if (rchan) {
3281 int res;
3282 struct ast_frame *f = ast_read(c);
3283
3284 if (!f) {
3285 ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
3286
3287 return -1;
3288 }
3289
3290 switch (f->frametype) {
3291 case AST_FRAME_DTMF_BEGIN:
3292 break;
3293 case AST_FRAME_DTMF_END:
3294 res = f->subclass.integer;
3295 if (!breakon || strchr(breakon, res)) {
3296 ast_frfree(f);
3297 ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
3298 return res;
3299 }
3300 break;
3301 case AST_FRAME_CONTROL:
3302 switch (f->subclass.integer) {
3303 case AST_CONTROL_HANGUP:
3304 ast_frfree(f);
3305 ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
3306 return -1;
3307 case AST_CONTROL_STREAM_STOP:
3308 case AST_CONTROL_STREAM_SUSPEND:
3309 case AST_CONTROL_STREAM_RESTART:
3310 case AST_CONTROL_STREAM_REVERSE:
3311 case AST_CONTROL_STREAM_FORWARD:
3312 /* Fall-through and treat as if it were a DTMF signal. Items
3313 * that perform stream control will handle this. */
3314 res = f->subclass.integer;
3315 ast_frfree(f);
3316 ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
3317 return res;
3318 case AST_CONTROL_PVT_CAUSE_CODE:
3319 case AST_CONTROL_PROGRESS:
3320 case AST_CONTROL_RINGING:
3321 case AST_CONTROL_ANSWER:
3322 case AST_CONTROL_SRCUPDATE:
3323 case AST_CONTROL_SRCCHANGE:
3324 case AST_CONTROL_CONNECTED_LINE:
3325 case AST_CONTROL_REDIRECTING:
3326 case AST_CONTROL_UPDATE_RTP_PEER:
3327 case AST_CONTROL_HOLD:
3328 case AST_CONTROL_UNHOLD:
3329 case AST_CONTROL_FLASH:
3330 case -1:
3331 /* Unimportant */
3332 break;
3333 default:
3334 ast_log(LOG_WARNING, "Unexpected control subclass '%d'\n", f->subclass.integer);
3335 break;
3336 }
3337 break;
3338 case AST_FRAME_VOICE:
3339 /* Write audio if appropriate */
3340 if (audiofd > -1) {
3341 if (write(audiofd, f->data.ptr, f->datalen) < 0) {
3342 ast_log(LOG_WARNING, "write() failed: %s\n", strerror(errno));
3343 }
3344 }
3345 default:
3346 /* Ignore */
3347 break;
3348 }
3349 ast_frfree(f);
3350 }
3351 }
3352
3353 ast_channel_clear_flag(c, AST_FLAG_END_DTMF_ONLY);
3354
3355 return 0; /* Time is up */
3356}
AST_CONTROL_STREAM_RESTART
@ AST_CONTROL_STREAM_RESTART
Definition include/asterisk/frame.h:335
AST_CONTROL_STREAM_SUSPEND
@ AST_CONTROL_STREAM_SUSPEND
Definition include/asterisk/frame.h:334
AST_CONTROL_STREAM_REVERSE
@ AST_CONTROL_STREAM_REVERSE
Definition include/asterisk/frame.h:336
AST_CONTROL_STREAM_STOP
@ AST_CONTROL_STREAM_STOP
Definition include/asterisk/frame.h:333
AST_CONTROL_STREAM_FORWARD
@ AST_CONTROL_STREAM_FORWARD
Definition include/asterisk/frame.h:337
AST_CONTROL_FLASH
@ AST_CONTROL_FLASH
Definition include/asterisk/frame.h:286
AST_CONTROL_UPDATE_RTP_PEER
@ AST_CONTROL_UPDATE_RTP_PEER
Definition include/asterisk/frame.h:309

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
chandestination channel of the frame
frameframe that will be written
Returns
It returns 0 on success, -1 on failure.

Definition at line 5167 of file channel.c.

5168{
5169 return ast_write_stream(chan, -1, fr);
5170}
ast_write_stream
int ast_write_stream(struct ast_channel *chan, int stream_num, struct ast_frame *fr)
Write a frame to a stream This function writes the given frame to the indicated stream on the channel...
Definition channel.c:5172

References ast_write_stream().

Referenced by adsi_careful_send(), ast_prod(), ast_readaudio_callback(), ast_readvideo_callback(), AST_TEST_DEFINE(), 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(), 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
chandestination channel of the frame
stream_numdestination stream on the channel
frameframe 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 5172 of file channel.c.

5173{
5174 struct ast_stream *stream = NULL, *default_stream = NULL;
5175 int res = -1;
5176 struct ast_frame *f = NULL;
5177 int count = 0;
5178 int hooked = 0;
5179
5180 /*Deadlock avoidance*/
5181 while(ast_channel_trylock(chan)) {
5182 /*cannot goto done since the channel is not locked*/
5183 if(count++ > 10) {
5184 ast_debug(1, "Deadlock avoided for write to channel '%s'\n", ast_channel_name(chan));
5185 return 0;
5186 }
5187 usleep(1);
5188 }
5189
5190 /* Stop if we're a zombie or need a soft hangup */
5191 if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_ZOMBIE) || ast_check_hangup(chan)) {
5192 goto done;
5193 }
5194
5195 if (stream_num >= 0) {
5196 /* If we were told to write to an explicit stream then allow this frame through, no matter
5197 * if the type is expected or not (a framehook could change)
5198 */
5199 if (stream_num >= ast_stream_topology_get_count(ast_channel_get_stream_topology(chan))) {
5200 goto done;
5201 }
5202 stream = ast_stream_topology_get_stream(ast_channel_get_stream_topology(chan), stream_num);
5203 default_stream = ast_channel_get_default_stream(chan, ast_stream_get_type(stream));
5204 } else if (fr->frametype == AST_FRAME_VOICE || fr->frametype == AST_FRAME_VIDEO || fr->frametype == AST_FRAME_MODEM) {
5205 /* If we haven't been told of a stream then we need to figure out which once we need */
5206 enum ast_media_type type = AST_MEDIA_TYPE_UNKNOWN;
5207
5208 /* Some frame types have a fixed media type */
5209 if (fr->frametype == AST_FRAME_VOICE || fr->frametype == AST_FRAME_VIDEO) {
5210 type = ast_format_get_type(fr->subclass.format);
5211 } else if (fr->frametype == AST_FRAME_MODEM) {
5212 type = AST_MEDIA_TYPE_IMAGE;
5213 }
5214
5215 /* No stream was specified, so use the default one */
5216 stream = default_stream = ast_channel_get_default_stream(chan, type);
5217 }
5218
5219 /* Perform the framehook write event here. After the frame enters the framehook list
5220 * there is no telling what will happen, how awesome is that!!! */
5221 if ((stream == default_stream) && !(fr = ast_framehook_list_write_event(ast_channel_framehooks(chan), fr))) {
5222 res = 0;
5223 goto done;
5224 }
5225
5226 if (ast_channel_generatordata(chan) && (fr->frametype != AST_FRAME_RTCP) && (!fr->src || strcasecmp(fr->src, "ast_prod"))) {
5227 if (ast_test_flag(ast_channel_flags(chan), AST_FLAG_WRITE_INT)) {
5228 ast_deactivate_generator(chan);
5229 } else {
5230 if (fr->frametype == AST_FRAME_DTMF_END) {
5231 /* There is a generator running while we're in the middle of a digit.
5232 * It's probably inband DTMF, so go ahead and pass it so it can
5233 * stop the generator */
5234 ast_channel_unlock(chan);
5235 res = ast_senddigit_end(chan, fr->subclass.integer, fr->len);
5236 ast_channel_lock(chan);
5237 } else if (fr->frametype == AST_FRAME_CONTROL
5238 && fr->subclass.integer == AST_CONTROL_UNHOLD) {
5239 /*
5240 * This is a side case where Echo is basically being called
5241 * and the person put themselves on hold and took themselves
5242 * off hold.
5243 */
5244 indicate_data_internal(chan, fr->subclass.integer, fr->data.ptr,
5245 fr->datalen);
5246 }
5247 res = 0; /* XXX explain, why 0 ? */
5248 goto done;
5249 }
5250 }
5251 /* High bit prints debugging */
5252 if (ast_channel_fout(chan) & DEBUGCHAN_FLAG)
5253 ast_frame_dump(ast_channel_name(chan), fr, ">>");
5254 switch (fr->frametype) {
5255 case AST_FRAME_CONTROL:
5256 indicate_data_internal(chan, fr->subclass.integer, fr->data.ptr, fr->datalen);
5257 res = 0;
5258 break;
5259 case AST_FRAME_DTMF_BEGIN:
5260 if (ast_channel_audiohooks(chan)) {
5261 struct ast_frame *old_frame = fr;
5262 fr = ast_audiohook_write_list(chan, ast_channel_audiohooks(chan), AST_AUDIOHOOK_DIRECTION_WRITE, fr);
5263 if (old_frame != fr)
5264 f = fr;
5265 }
5266 send_dtmf_begin_event(chan, DTMF_SENT, fr->subclass.integer);
5267 ast_channel_unlock(chan);
5268 res = ast_senddigit_begin(chan, fr->subclass.integer);
5269 ast_channel_lock(chan);
5270 break;
5271 case AST_FRAME_DTMF_END:
5272 if (ast_channel_audiohooks(chan)) {
5273 struct ast_frame *new_frame = fr;
5274
5275 new_frame = ast_audiohook_write_list(chan, ast_channel_audiohooks(chan), AST_AUDIOHOOK_DIRECTION_WRITE, fr);
5276 if (new_frame != fr) {
5277 ast_frfree(new_frame);
5278 }
5279 }
5280 send_dtmf_end_event(chan, DTMF_SENT, fr->subclass.integer, fr->len);
5281 ast_channel_unlock(chan);
5282 res = ast_senddigit_end(chan, fr->subclass.integer, fr->len);
5283 ast_channel_lock(chan);
5284 break;
5285 case AST_FRAME_TEXT:
5286 CHECK_BLOCKING(chan);
5287 if (ast_format_cmp(fr->subclass.format, ast_format_t140) == AST_FORMAT_CMP_EQUAL) {
5288 res = (ast_channel_tech(chan)->write_text == NULL) ? 0 :
5289 ast_channel_tech(chan)->write_text(chan, fr);
5290 } else {
5291 res = (ast_channel_tech(chan)->send_text == NULL) ? 0 :
5292 ast_channel_tech(chan)->send_text(chan, (char *) fr->data.ptr);
5293 }
5294 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
5295 break;
5296 case AST_FRAME_HTML:
5297 CHECK_BLOCKING(chan);
5298 res = (ast_channel_tech(chan)->send_html == NULL) ? 0 :
5299 ast_channel_tech(chan)->send_html(chan, fr->subclass.integer, (char *) fr->data.ptr, fr->datalen);
5300 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
5301 break;
5302 case AST_FRAME_VIDEO:
5303 /* XXX Handle translation of video codecs one day XXX */
5304 CHECK_BLOCKING(chan);
5305 if (ast_channel_tech(chan)->write_stream) {
5306 if (stream) {
5307 res = ast_channel_tech(chan)->write_stream(chan, ast_stream_get_position(stream), fr);
5308 } else {
5309 res = 0;
5310 }
5311 } else if ((stream == default_stream) && ast_channel_tech(chan)->write_video) {
5312 res = ast_channel_tech(chan)->write_video(chan, fr);
5313 } else {
5314 res = 0;
5315 }
5316 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
5317 break;
5318 case AST_FRAME_MODEM:
5319 CHECK_BLOCKING(chan);
5320 res = tech_write(chan, stream, default_stream, fr);
5321 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
5322 break;
5323 case AST_FRAME_VOICE:
5324 if (ast_opt_generic_plc && ast_format_cmp(fr->subclass.format, ast_format_slin) == AST_FORMAT_CMP_EQUAL) {
5325 apply_plc(chan, fr);
5326 }
5327
5328 f = fr;
5329
5330 /*
5331 * Send frame to audiohooks if present, if frametype is linear (else, later as per
5332 * previous behavior)
5333 */
5334 if ((stream == default_stream) && ast_channel_audiohooks(chan)) {
5335 if (ast_format_cache_is_slinear(fr->subclass.format)) {
5336 hooked = 1;
5337 f = ast_audiohook_write_list(chan, ast_channel_audiohooks(chan), AST_AUDIOHOOK_DIRECTION_WRITE, fr);
5338 }
5339 }
5340
5341 /* If the frame is in the raw write format, then it's easy... just use the frame - otherwise we will have to translate */
5342 if ((stream == default_stream) && ast_format_cmp(fr->subclass.format, ast_channel_rawwriteformat(chan)) != AST_FORMAT_CMP_EQUAL) {
5343 if (ast_format_cmp(ast_channel_writeformat(chan), fr->subclass.format) != AST_FORMAT_CMP_EQUAL) {
5344 struct ast_str *codec_buf = ast_str_alloca(AST_FORMAT_CAP_NAMES_LEN);
5345
5346 /*
5347 * We are not setup to write this frame. Things may have changed
5348 * on the peer side of the world and we try to adjust the format to
5349 * make it compatible again. However, bad things can happen if we
5350 * cannot setup a new translation path. Problems range from no
5351 * audio, one-way audio, to garbled audio. The best we can do is
5352 * request the call to hangup since we could not make it compatible.
5353 *
5354 * Being continuously spammed by this message likely indicates a
5355 * problem with the peer because it cannot make up its mind about
5356 * which format to use.
5357 */
5358 ast_debug(1, "Channel %s changing write format from %s to %s, native formats %s\n",
5359 ast_channel_name(chan),
5360 ast_format_get_name(ast_channel_writeformat(chan)),
5361 ast_format_get_name(fr->subclass.format),
5362 ast_format_cap_get_names(ast_channel_nativeformats(chan), &codec_buf));
5363 if (ast_set_write_format(chan, fr->subclass.format)) {
5364 /* Could not handle the new write format. Induce a hangup. */
5365 break;
5366 }
5367 }
5368
5369 if (ast_channel_writetrans(chan)) {
5370 struct ast_frame *trans_frame = ast_translate(ast_channel_writetrans(chan), f, 0);
5371 if (trans_frame != f && f != fr) {
5372 /*
5373 * If translate gives us a new frame and so did the audio
5374 * hook then we need to free the one from the audio hook.
5375 */
5376 ast_frfree(f);
5377 }
5378 f = trans_frame;
5379 }
5380 }
5381
5382 if (!f) {
5383 res = 0;
5384 break;
5385 }
5386
5387 if ((stream == default_stream) && ast_channel_audiohooks(chan) && !hooked) {
5388 struct ast_frame *prev = NULL, *new_frame, *cur, *dup;
5389 int freeoldlist = 0;
5390
5391 if (f != fr) {
5392 freeoldlist = 1;
5393 }
5394
5395 /* Since ast_audiohook_write may return a new frame, and the cur frame is
5396 * an item in a list of frames, create a new list adding each cur frame back to it
5397 * regardless if the cur frame changes or not. */
5398 for (cur = f; cur; cur = AST_LIST_NEXT(cur, frame_list)) {
5399 new_frame = ast_audiohook_write_list(chan, ast_channel_audiohooks(chan), AST_AUDIOHOOK_DIRECTION_WRITE, cur);
5400
5401 /* if this frame is different than cur, preserve the end of the list,
5402 * free the old frames, and set cur to be the new frame */
5403 if (new_frame != cur) {
5404
5405 /* doing an ast_frisolate here seems silly, but we are not guaranteed the new_frame
5406 * isn't part of local storage, meaning if ast_audiohook_write is called multiple
5407 * times it may override the previous frame we got from it unless we dup it */
5408 if ((dup = ast_frisolate(new_frame))) {
5409 AST_LIST_NEXT(dup, frame_list) = AST_LIST_NEXT(cur, frame_list);
5410 if (freeoldlist) {
5411 AST_LIST_NEXT(cur, frame_list) = NULL;
5412 ast_frfree(cur);
5413 }
5414 if (new_frame != dup) {
5415 ast_frfree(new_frame);
5416 }
5417 cur = dup;
5418 }
5419 }
5420
5421 /* now, regardless if cur is new or not, add it to the new list,
5422 * if the new list has not started, cur will become the first item. */
5423 if (prev) {
5424 AST_LIST_NEXT(prev, frame_list) = cur;
5425 } else {
5426 f = cur; /* set f to be the beginning of our new list */
5427 }
5428 prev = cur;
5429 }
5430 }
5431
5432 /* the translator on chan->writetrans may have returned multiple frames
5433 from the single frame we passed in; if so, feed each one of them to the
5434 channel, freeing each one after it has been written */
5435 CHECK_BLOCKING(chan);
5436 if ((f != fr) && AST_LIST_NEXT(f, frame_list)) {
5437 struct ast_frame *cur, *next = NULL;
5438 unsigned int skip = 0;
5439
5440 cur = f;
5441 while (cur) {
5442 next = AST_LIST_NEXT(cur, frame_list);
5443 AST_LIST_NEXT(cur, frame_list) = NULL;
5444 if (!skip) {
5445 res = tech_write(chan, stream, default_stream, cur);
5446 if (res < 0) {
5447 ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_DEV);
5448 skip = 1;
5449 } else if (next) {
5450 /* don't do this for the last frame in the list,
5451 as the code outside the loop will do it once
5452 */
5453 ast_channel_fout_set(chan, FRAMECOUNT_INC(ast_channel_fout(chan)));
5454 }
5455 }
5456 ast_frfree(cur);
5457 cur = next;
5458 }
5459
5460 /* reset f so the code below doesn't attempt to free it */
5461 f = NULL;
5462 } else {
5463 res = tech_write(chan, stream, default_stream, f);
5464 }
5465 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
5466 break;
5467 case AST_FRAME_NULL:
5468 case AST_FRAME_IAX:
5469 /* Ignore these */
5470 res = 0;
5471 break;
5472 case AST_FRAME_RTCP:
5473 /* RTCP information is on a per-stream basis and only available on multistream capable channels */
5474 CHECK_BLOCKING(chan);
5475 if (ast_channel_tech(chan)->write_stream && stream) {
5476 res = ast_channel_tech(chan)->write_stream(chan, ast_stream_get_position(stream), fr);
5477 } else {
5478 res = 0;
5479 }
5480 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
5481 break;
5482 default:
5483 /* At this point, fr is the incoming frame and f is NULL. Channels do
5484 * not expect to get NULL as a frame pointer and will segfault. Hence,
5485 * we output the original frame passed in. */
5486 CHECK_BLOCKING(chan);
5487 res = ast_channel_tech(chan)->write(chan, fr);
5488 ast_clear_flag(ast_channel_flags(chan), AST_FLAG_BLOCKING);
5489 break;
5490 }
5491
5492 if (f && f != fr)
5493 ast_frfree(f);
5494
5495 /* Consider a write failure to force a soft hangup */
5496 if (res < 0) {
5497 ast_channel_softhangup_internal_flag_add(chan, AST_SOFTHANGUP_DEV);
5498 } else {
5499 ast_channel_fout_set(chan, FRAMECOUNT_INC(ast_channel_fout(chan)));
5500 }
5501done:
5502 if (ast_channel_audiohooks(chan) && ast_audiohook_write_list_empty(ast_channel_audiohooks(chan))) {
5503 /* The list gets recreated if audiohooks are added again later */
5504 ast_audiohook_detach_list(ast_channel_audiohooks(chan));
5505 ast_channel_audiohooks_set(chan, NULL);
5506 }
5507 ast_channel_unlock(chan);
5508 return res;
5509}
ast_audiohook_write_list
struct ast_frame * ast_audiohook_write_list(struct ast_channel *chan, struct ast_audiohook_list *audiohook_list, enum ast_audiohook_direction direction, struct ast_frame *frame)
Pass a frame off to be handled by the audiohook core.
Definition audiohook.c:1116
AST_AUDIOHOOK_DIRECTION_WRITE
@ AST_AUDIOHOOK_DIRECTION_WRITE
Definition audiohook.h:50
ast_audiohook_detach_list
void ast_audiohook_detach_list(struct ast_audiohook_list *audiohook_list)
Detach audiohooks from list and destroy said list.
Definition audiohook.c:602
send_dtmf_begin_event
static void send_dtmf_begin_event(struct ast_channel *chan, enum DtmfDirection direction, const char digit)
Definition channel.c:3375
DTMF_SENT
@ DTMF_SENT
Definition channel.c:3360
send_dtmf_end_event
static void send_dtmf_end_event(struct ast_channel *chan, enum DtmfDirection direction, const char digit, long duration_ms)
Definition channel.c:3390
tech_write
static int tech_write(struct ast_channel *chan, struct ast_stream *stream, struct ast_stream *default_stream, struct ast_frame *frame)
Definition channel.c:5155
apply_plc
static void apply_plc(struct ast_channel *chan, struct ast_frame *frame)
Definition channel.c:5129
DEBUGCHAN_FLAG
#define DEBUGCHAN_FLAG
Definition channel.h:877
FRAMECOUNT_INC
#define FRAMECOUNT_INC(x)
Definition channel.h:880
AST_MEDIA_TYPE_UNKNOWN
@ AST_MEDIA_TYPE_UNKNOWN
Definition codec.h:31
AST_MEDIA_TYPE_IMAGE
@ AST_MEDIA_TYPE_IMAGE
Definition codec.h:34
ast_format_get_type
enum ast_media_type ast_format_get_type(const struct ast_format *format)
Get the media type of a format.
Definition format.c:354
ast_format_cache_is_slinear
int ast_format_cache_is_slinear(struct ast_format *format)
Determines if a format is one of the cached slin formats.
Definition format_cache.c:534
AST_FORMAT_CAP_NAMES_LEN
#define AST_FORMAT_CAP_NAMES_LEN
Definition format_cap.h:324
write_stream
static void write_stream(struct ogg_vorbis_desc *s, FILE *f)
Write out any pending encoded data.
Definition format_ogg_vorbis.c:203
ast_frame_dump
void ast_frame_dump(const char *name, struct ast_frame *f, char *prefix)
Definition main/frame.c:731
AST_LIST_NEXT
#define AST_LIST_NEXT(elm, field)
Returns the next entry in the list after the given entry.
Definition linkedlists.h:439
integer
INT32 integer
Definition lpc10.h:80
ast_opt_generic_plc
#define ast_opt_generic_plc
Definition options.h:144
ast_stream_get_position
int ast_stream_get_position(const struct ast_stream *stream)
Get the position of the stream in the topology.
Definition stream.c:500
ast_stream_topology_get_stream
struct ast_stream * ast_stream_topology_get_stream(const struct ast_stream_topology *topology, unsigned int position)
Get a specific stream from the topology.
Definition stream.c:791
ast_stream_topology_get_count
int ast_stream_topology_get_count(const struct ast_stream_topology *topology)
Get the number of streams in a topology.
Definition stream.c:768
ast_stream_get_type
enum ast_media_type ast_stream_get_type(const struct ast_stream *stream)
Get the media type of a stream.
Definition stream.c:316
ast_str_alloca
#define ast_str_alloca(init_len)
Definition strings.h:848
ast_channel_tech::write
int(*const write)(struct ast_channel *chan, struct ast_frame *frame)
Write a frame, in standard format (see frame.h)
Definition channel.h:770
ast_channel_tech::write_video
int(*const write_video)(struct ast_channel *chan, struct ast_frame *frame)
Write a frame, in standard format.
Definition channel.h:806
ast_frame::next
struct ast_frame * next
Definition include/asterisk/frame.h:187
ast_translate
struct ast_frame * ast_translate(struct ast_trans_pvt *tr, struct ast_frame *f, int consume)
translates one or more frames Apply an input frame into the translator and receive zero or one output...
Definition translate.c:623

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_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_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
chandestination channel of the frame
frameframe 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
chandestination channel of the frame
frameframe that will be written
Returns
It returns 1 on success, 0 if not implemented, and -1 on failure.

Definition at line 5040 of file channel.c.

5041{
5042 int res;
5043 if (!ast_channel_tech(chan)->write_video)
5044 return 0;
5045 res = ast_write(chan, fr);
5046 if (!res)
5047 res = 1;
5048 return res;
5049}

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

◆ internal_channel_set_current_storage_driver()

int internal_channel_set_current_storage_driver ( const char *  driver_name)

Definition at line 8155 of file channel.c.

8156{
8157 if (ast_fully_booted) {
8158 ast_log(LOG_ERROR, "Cannot change channel storage driver after Asterisk has started\n");
8159 return -1;
8160 }
8161 current_channel_storage_driver = ast_channelstorage_get_driver(driver_name);
8162 if (current_channel_storage_driver) {
8163 return 0;
8164 }
8165 ast_log(LOG_WARNING,
8166 "Invalid channel storage backend '%s' specified. Attempting to use default '%s'.\n",
8167 driver_name, AST_CHANNELSTORAGE_DEFAULT_TYPE);
8168 current_channel_storage_driver = ast_channelstorage_get_driver(AST_CHANNELSTORAGE_DEFAULT_TYPE);
8169 if (current_channel_storage_driver) {
8170 return 0;
8171 }
8172 ast_log(LOG_ERROR, "Unable to find default channel storage backend '%s'.\n",
8173 AST_CHANNELSTORAGE_DEFAULT_TYPE);
8174 return -1;
8175}
ast_channelstorage_get_driver
const struct ast_channelstorage_driver * ast_channelstorage_get_driver(const char *driver_name)
Definition channelstorage.c:34
AST_CHANNELSTORAGE_DEFAULT_TYPE
#define AST_CHANNELSTORAGE_DEFAULT_TYPE
Definition channelstorage.h:30
ast_fully_booted
#define ast_fully_booted
Definition options.h:127

References AST_CHANNELSTORAGE_DEFAULT_TYPE, ast_channelstorage_get_driver(), ast_fully_booted, ast_log, current_channel_storage_driver, LOG_ERROR, and LOG_WARNING.

Referenced by ast_channel_open_storage(), and load_asterisk_conf().

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

435 {
436 .type = "Kill",
437 .description = "Kill channel (should not see this)",
438 .read = kill_read,
439 .exception = kill_exception,
440 .write = kill_write,
441 .fixup = kill_fixup,
442 .hangup = kill_hangup,
443};
kill_write
static int kill_write(struct ast_channel *chan, struct ast_frame *frame)
Definition channel.c:408
kill_exception
static struct ast_frame * kill_exception(struct ast_channel *chan)
Definition channel.c:402
kill_read
static struct ast_frame * kill_read(struct ast_channel *chan)
Definition channel.c:396
kill_hangup
static int kill_hangup(struct ast_channel *chan)
Definition channel.c:420
kill_fixup
static int kill_fixup(struct ast_channel *oldchan, struct ast_channel *newchan)
Definition channel.c:414

◆ 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 99 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().

Generated on Wed Jun 10 2026 20:04:22 for Asterisk - The Open Source Telephony Project by doxygen 1.9.8