ccss.c File Reference

Call Completion Supplementary Services implementation. More...

#include "asterisk.h"
#include "asterisk/astobj2.h"
#include "asterisk/strings.h"
#include "asterisk/ccss.h"
#include "asterisk/channel.h"
#include "asterisk/pbx.h"
#include "asterisk/utils.h"
#include "asterisk/taskprocessor.h"
#include "asterisk/devicestate.h"
#include "asterisk/module.h"
#include "asterisk/app.h"
#include "asterisk/cli.h"
#include "asterisk/manager.h"
#include "asterisk/causes.h"
#include "asterisk/stasis_system.h"
#include "asterisk/format_cache.h"

Include dependency graph for ccss.c:

Go to the source code of this file.

Data Structures
struct	ast_cc_config_params
struct	ast_cc_monitor_failure_data
struct	cc_agent_backend
struct	cc_agent_backends
struct	cc_callback_helper
struct	cc_control_payload
	The payload for an AST_CONTROL_CC frame. More...
struct	cc_core_instance
struct	cc_generic_agent_pvt
struct	cc_monitor_backend
struct	cc_monitor_backends
struct	cc_monitor_tree
	The "tree" of interfaces that is dialed. More...
struct	cc_recall_ds_data
struct	cc_state_change_args
struct	cc_status_response_args
struct	count_agents_cb_data
struct	count_monitors_cb_data
struct	dialed_cc_interfaces
struct	extension_child_dialstring
	Data regarding an extension monitor's child's dialstrings. More...
struct	extension_monitor_pvt
	Private data for an extension monitor. More...
struct	generic_monitor_instance
struct	generic_monitor_instance_list
struct	generic_monitor_pvt
	private data for generic device monitor More...

Macros
#define	CC_ACTIVE_DEVSTATE_DEFAULT   AST_DEVICE_INUSE
#define	CC_AVAILABLE_DEVSTATE_DEFAULT   AST_DEVICE_NOT_INUSE
#define	CC_CALLEE_READY_DEVSTATE_DEFAULT   AST_DEVICE_RINGING
#define	CC_CALLER_BUSY_DEVSTATE_DEFAULT   AST_DEVICE_ONHOLD
#define	CC_CALLER_OFFERED_DEVSTATE_DEFAULT   AST_DEVICE_NOT_INUSE
#define	CC_CALLER_REQUESTED_DEVSTATE_DEFAULT   AST_DEVICE_NOT_INUSE
#define	CC_COMPLETE_DEVSTATE_DEFAULT   AST_DEVICE_NOT_INUSE
#define	CC_FAILED_DEVSTATE_DEFAULT   AST_DEVICE_NOT_INUSE
#define	CC_MAX_AGENTS_DEFAULT   5
#define	CC_MAX_MONITORS_DEFAULT   5
#define	CC_OFFER_TIMER_DEFAULT   20 /* Seconds */
#define	CC_RECALL_TIMER_DEFAULT   20 /* Seconds */
#define	CC_RECALLING_DEVSTATE_DEFAULT   AST_DEVICE_RINGING
#define	CCBS_AVAILABLE_TIMER_DEFAULT   4800 /* Seconds */
#define	CCNR_AVAILABLE_TIMER_DEFAULT   7200 /* Seconds */
#define	GLOBAL_CC_MAX_REQUESTS_DEFAULT   20

Enumerations
enum	cc_state {   CC_AVAILABLE, CC_CALLER_OFFERED, CC_CALLER_REQUESTED, CC_ACTIVE,   CC_CALLEE_READY, CC_CALLER_BUSY, CC_RECALLING, CC_COMPLETE,   CC_FAILED }
	The states used in the CCSS core state machine. More...
enum	match_flags { MATCH_NO_REQUEST = (1 << 0), MATCH_REQUEST = (1 << 1) }

Functions
struct ast_cc_config_params *	__ast_cc_config_params_init (const char *file, int line, const char *function)
	Allocate and initialize an ast_cc_config_params structure. More...
static void	__reg_module (void)
static void	__unreg_module (void)
static void	agent_destroy (void *data)
static const char *	agent_policy_to_str (enum ast_cc_agent_policies policy)
int	ast_cc_agent_accept_request (int core_id, const char *const debug,...)
	Accept inbound CC request. More...
struct ast_cc_agent *	ast_cc_agent_callback (int flags, ao2_callback_fn *function, void *args, const char *const type)
	Call a callback on all agents of a specific type. More...
int	ast_cc_agent_caller_available (int core_id, const char *const debug,...)
	Indicate that a previously unavailable caller has become available. More...
int	ast_cc_agent_caller_busy (int core_id, const char *debug,...)
	Indicate that the caller is busy. More...
int	ast_cc_agent_recalling (int core_id, const char *const debug,...)
	Tell the CC core that a caller is currently recalling. More...
int	ast_cc_agent_register (const struct ast_cc_agent_callbacks *callbacks)
	Register a set of agent callbacks with the core. More...
int	ast_cc_agent_set_interfaces_chanvar (struct ast_channel *chan)
	Set the first level CC_INTERFACES channel variable for a channel. More...
int	ast_cc_agent_status_response (int core_id, enum ast_device_state devstate)
	Response with a caller's current status. More...
void	ast_cc_agent_unregister (const struct ast_cc_agent_callbacks *callbacks)
	Unregister a set of agent callbacks with the core. More...
int	ast_cc_available_timer_expire (const void *data)
	Scheduler callback for available timer expiration. More...
int	ast_cc_build_frame (struct ast_channel *chan, struct ast_cc_config_params *cc_params, const char *monitor_type, const char *const device_name, const char *const dialstring, enum ast_cc_service_type service, void *private_data, struct ast_frame *frame)
	Create a CC Control frame. More...
void	ast_cc_busy_interface (struct ast_channel *inbound, struct ast_cc_config_params *cc_params, const char *monitor_type, const char *const device_name, const char *const dialstring, void *private_data)
	Callback made from ast_cc_callback for certain channel types. More...
void	ast_cc_call_failed (struct ast_channel *incoming, struct ast_channel *outgoing, const char *const dialstring)
	Make CCBS available in the case that ast_call fails. More...
int	ast_cc_call_init (struct ast_channel *chan, int *ignore_cc)
	Start the CC process on a call. More...
int	ast_cc_callback (struct ast_channel *inbound, const char *const tech, const char *const dest, ast_cc_callback_fn callback)
	Run a callback for potential matching destinations. More...
int	ast_cc_completed (struct ast_channel *chan, const char *const debug,...)
	Indicate recall has been acknowledged. More...
void	ast_cc_config_params_destroy (struct ast_cc_config_params *params)
	Free memory from CCSS configuration params. More...
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 More...
void	ast_cc_default_config_params (struct ast_cc_config_params *params)
	Set the specified CC config params to default values. More...
void	ast_cc_extension_monitor_add_dialstring (struct ast_channel *incoming, const char *const dialstring, const char *const device_name)
	Add a child dialstring to an extension monitor. More...
int	ast_cc_failed (int core_id, const char *const debug,...)
	Indicate failure has occurred. More...
int	ast_cc_get_current_core_id (struct ast_channel *chan)
	Get the core id for the current call. More...
struct ast_cc_monitor *	ast_cc_get_monitor_by_recall_core_id (const int core_id, const char *const device_name)
	Get the associated monitor given the device name and core_id. More...
int	ast_cc_get_param (struct ast_cc_config_params *params, const char *const name, char *buf, size_t buf_len)
	get a CCSS configuration parameter, given its name More...
int	ast_cc_is_config_param (const char *const name)
	Is this a CCSS configuration parameter? More...
int	ast_cc_is_recall (struct ast_channel *chan, int *core_id, const char *const monitor_type)
	Decide if a call to a particular channel is a CC recall. More...
int	ast_cc_monitor_callee_available (const int core_id, const char *const debug,...)
	Alert the core that a device being monitored has become available. More...
int	ast_cc_monitor_count (const char *const name, const char *const type)
	Return the number of outstanding CC requests to a specific device. More...
int	ast_cc_monitor_failed (int core_id, const char *const monitor_name, const char *const debug,...)
	Indicate that a failure has occurred on a specific monitor. More...
int	ast_cc_monitor_party_b_free (int core_id)
	Alert a caller that though the callee has become free, the caller himself is not and may not call back. More...
int	ast_cc_monitor_register (const struct ast_cc_monitor_callbacks *callbacks)
	Register a set of monitor callbacks with the core. More...
int	ast_cc_monitor_request_acked (int core_id, const char *const debug,...)
	Indicate that an outbound entity has accepted our CC request. More...
int	ast_cc_monitor_status_request (int core_id)
	Request the status of a caller or callers. More...
int	ast_cc_monitor_stop_ringing (int core_id)
	Alert a caller to stop ringing. More...
void	ast_cc_monitor_unregister (const struct ast_cc_monitor_callbacks *callbacks)
	Unregister a set of monitor callbacks with the core. More...
int	ast_cc_offer (struct ast_channel *caller_chan)
	Offer CC to a caller. More...
int	ast_cc_request_is_within_limits (void)
	Check if the incoming CC request is within the bounds set by the cc_max_requests configuration option. More...
int	ast_cc_set_param (struct ast_cc_config_params *params, const char *const name, const char *const value)
	set a CCSS configuration parameter, given its name More...
const char *	ast_get_cc_agent_dialstring (struct ast_cc_config_params *config)
	Get the cc_agent_dialstring. More...
enum ast_cc_agent_policies	ast_get_cc_agent_policy (struct ast_cc_config_params *config)
	Get the cc_agent_policy. More...
const char *	ast_get_cc_callback_macro (struct ast_cc_config_params *config)
	Get the name of the callback_macro. More...
const char *	ast_get_cc_callback_sub (struct ast_cc_config_params *config)
	Get the name of the callback subroutine. More...
unsigned int	ast_get_cc_max_agents (struct ast_cc_config_params *config)
	Get the cc_max_agents. More...
unsigned int	ast_get_cc_max_monitors (struct ast_cc_config_params *config)
	Get the cc_max_monitors. More...
enum ast_cc_monitor_policies	ast_get_cc_monitor_policy (struct ast_cc_config_params *config)
	Get the cc_monitor_policy. More...
unsigned int	ast_get_cc_offer_timer (struct ast_cc_config_params *config)
	Get the cc_offer_timer. More...
unsigned int	ast_get_cc_recall_timer (struct ast_cc_config_params *config)
	Get the cc_recall_timer. More...
unsigned int	ast_get_ccbs_available_timer (struct ast_cc_config_params *config)
	Get the ccbs_available_timer. More...
unsigned int	ast_get_ccnr_available_timer (struct ast_cc_config_params *config)
	Get the ccnr_available_timer. More...
void	ast_handle_cc_control_frame (struct ast_channel *inbound, struct ast_channel *outbound, void *frame_data)
	Properly react to a CC control frame. More...
void	ast_ignore_cc (struct ast_channel *chan)
	Mark the channel to ignore further CC activity. More...
struct ast_module *	AST_MODULE_SELF_SYM (void)
int	ast_queue_cc_frame (struct ast_channel *chan, const char *monitor_type, const char *const dialstring, enum ast_cc_service_type service, void *private_data)
	Queue an AST_CONTROL_CC frame. More...
void	ast_set_cc_agent_dialstring (struct ast_cc_config_params *config, const char *const value)
	Set the cc_agent_dialstring. More...
int	ast_set_cc_agent_policy (struct ast_cc_config_params *config, enum ast_cc_agent_policies value)
	Set the cc_agent_policy. More...
void	ast_set_cc_callback_macro (struct ast_cc_config_params *config, const char *const value)
	Set the callback_macro name. More...
void	ast_set_cc_callback_sub (struct ast_cc_config_params *config, const char *const value)
	Set the callback subroutine name. More...
int	ast_set_cc_interfaces_chanvar (struct ast_channel *chan, const char *const extension)
	Set the CC_INTERFACES channel variable for a channel using an. More...
void	ast_set_cc_max_agents (struct ast_cc_config_params *config, unsigned int value)
	Set the cc_max_agents. More...
void	ast_set_cc_max_monitors (struct ast_cc_config_params *config, unsigned int value)
	Set the cc_max_monitors. More...
int	ast_set_cc_monitor_policy (struct ast_cc_config_params *config, enum ast_cc_monitor_policies value)
	Set the cc_monitor_policy. More...
void	ast_set_cc_offer_timer (struct ast_cc_config_params *config, unsigned int value)
	Set the cc_offer_timer. More...
void	ast_set_cc_recall_timer (struct ast_cc_config_params *config, unsigned int value)
	Set the cc_recall_timer. More...
void	ast_set_ccbs_available_timer (struct ast_cc_config_params *config, unsigned int value)
	Set the ccbs_available_timer. More...
void	ast_set_ccnr_available_timer (struct ast_cc_config_params *config, unsigned int value)
	Set the ccnr_available_timer. More...
int	ast_setup_cc_recall_datastore (struct ast_channel *chan, const int core_id)
	Set up a CC recall datastore on a channel. More...
static void	build_cc_interfaces_chanvar (struct ast_cc_monitor *starting_point, struct ast_str **str)
static void	call_destructor_with_no_monitor (const char *const monitor_type, void *private_data)
static void	cancel_available_timer (struct cc_core_instance *core_instance)
static int	cc_active (struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
static int	cc_agent_callback_helper (void *obj, void *args, int flags)
static struct ast_cc_agent *	cc_agent_init (struct ast_channel *caller_chan, const char *const caller_name, const int core_id, struct cc_monitor_tree *interface_tree)
static int	cc_available (struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
static int	cc_build_payload (struct ast_channel *chan, struct ast_cc_config_params *cc_params, const char *monitor_type, const char *const device_name, const char *dialstring, enum ast_cc_service_type service, void *private_data, struct cc_control_payload *payload)
static int	cc_callee_ready (struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
static int	cc_caller_busy (struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
static int	cc_caller_offered (struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
static int	cc_caller_requested (struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
static int	cc_cli_output_status (void *data)
static void	cc_cli_print_monitor_stats (struct ast_cc_monitor *monitor, int fd, int parent_id)
static int	cc_complete (struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
static struct cc_core_instance *	cc_core_init_instance (struct ast_channel *caller_chan, struct cc_monitor_tree *called_tree, const int core_id, struct cc_control_payload *cc_data)
static int	cc_core_instance_cmp_fn (void *obj, void *arg, int flags)
static void	cc_core_instance_destructor (void *data)
static int	cc_core_instance_hash_fn (const void *obj, const int flags)
static struct ast_cc_monitor *	cc_device_monitor_init (const char *const device_name, const char *const dialstring, const struct cc_control_payload *cc_data, int core_id)
static int	cc_do_state_change (void *datap)
static void	cc_extension_monitor_change_is_valid (struct cc_core_instance *core_instance, unsigned int parent_id, const char *const device_name, int is_valid)
static void	cc_extension_monitor_destructor (void *private_data)
static struct ast_cc_monitor *	cc_extension_monitor_init (const char *const exten, const char *const context, const unsigned int parent_id)
static int	cc_failed (struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
static void	cc_generic_agent_destructor (struct ast_cc_agent *agent)
static int	cc_generic_agent_init (struct ast_cc_agent *agent, struct ast_channel *chan)
static int	cc_generic_agent_recall (struct ast_cc_agent *agent)
static void	cc_generic_agent_respond (struct ast_cc_agent *agent, enum ast_cc_agent_response_reason reason)
static int	cc_generic_agent_start_monitoring (struct ast_cc_agent *agent)
static int	cc_generic_agent_start_offer_timer (struct ast_cc_agent *agent)
static int	cc_generic_agent_status_request (struct ast_cc_agent *agent)
static int	cc_generic_agent_stop_offer_timer (struct ast_cc_agent *agent)
static int	cc_generic_agent_stop_ringing (struct ast_cc_agent *agent)
static int	cc_generic_is_device_available (enum ast_device_state state)
static int	cc_generic_monitor_cancel_available_timer (struct ast_cc_monitor *monitor, int *sched_id)
static void	cc_generic_monitor_destructor (void *private_data)
static int	cc_generic_monitor_request_cc (struct ast_cc_monitor *monitor, int *available_timer_id)
static int	cc_generic_monitor_suspend (struct ast_cc_monitor *monitor)
static int	cc_generic_monitor_unsuspend (struct ast_cc_monitor *monitor)
static void	cc_interface_destroy (void *data)
static void	cc_interface_tree_destroy (void *data)
static int	cc_interfaces_datastore_init (struct ast_channel *chan)
static void	cc_monitor_destroy (void *data)
static int	cc_monitor_failed (void *data)
static int	cc_offer (const int core_id, const char *const debug,...)
static int	cc_party_b_free (void *data)
static int	cc_publish (struct stasis_message_type *message_type, int core_id, struct ast_json *extras)
static void	cc_publish_available (int core_id, const char *callee, const char *service)
static void	cc_publish_callerrecalling (int core_id, const char *caller)
static void	cc_publish_callerstartmonitoring (int core_id, const char *caller)
static void	cc_publish_callerstopmonitoring (int core_id, const char *caller)
static void	cc_publish_failure (int core_id, const char *caller, const char *reason)
static void	cc_publish_monitorfailed (int core_id, const char *callee)
static void	cc_publish_offertimerstart (int core_id, const char *caller, unsigned int expires)
static void	cc_publish_recallcomplete (int core_id, const char *caller)
static void	cc_publish_requestacknowledged (int core_id, const char *caller)
static void	cc_publish_requested (int core_id, const char *caller, const char *callee)
static void	cc_recall_ds_destroy (void *data)
static void *	cc_recall_ds_duplicate (void *data)
static int	cc_recalling (struct cc_core_instance *core_instance, struct cc_state_change_args *args, enum cc_state previous_state)
static void *	cc_ref (void *obj, const char *debug)
static int	cc_request_state_change (enum cc_state state, const int core_id, const char *debug, va_list ap)
static const char *	cc_service_to_string (enum ast_cc_service_type service)
static enum ast_device_state	cc_state_to_devstate (enum cc_state state)
static const char *	cc_state_to_string (enum cc_state state)
static int	cc_status_request (void *data)
static int	cc_status_response (void *data)
static int	cc_stop_ringing (void *data)
static void	cc_unique_append (struct ast_str **str, const char *dialstring)
static void *	cc_unref (void *obj, const char *debug)
static int	cccancel_exec (struct ast_channel *chan, const char *data)
static int	ccreq_exec (struct ast_channel *chan, const char *data)
static enum ast_device_state	ccss_device_state (const char *device_name)
static void	ccss_notify_device_state_change (const char *device, enum cc_state state)
static void	check_callback_sanity (const struct ast_cc_agent_callbacks *callbacks)
static char *	complete_core_id (const char *word)
static long	count_agents (const char *const caller, const int core_id_exception)
static int	count_agents_cb (void *obj, void *arg, void *data, int flags)
static int	count_monitors_cb (void *obj, void *arg, int flags)
static struct generic_monitor_instance_list *	create_new_generic_list (struct ast_cc_monitor *monitor)
static void	dialed_cc_interfaces_destroy (void *data)
static void *	dialed_cc_interfaces_duplicate (void *data)
static struct extension_monitor_pvt *	extension_monitor_pvt_init (void)
static const struct ast_cc_agent_callbacks *	find_agent_callbacks (struct ast_channel *chan)
static struct cc_core_instance *	find_cc_core_instance (const int core_id)
static struct generic_monitor_instance_list *	find_generic_monitor_instance_list (const char *const device_name)
static const struct ast_cc_monitor_callbacks *	find_monitor_callbacks (const char *const type)
static void	generic_agent_devstate_cb (void *userdata, struct stasis_subscription *sub, struct stasis_message *msg)
static void	generic_monitor_devstate_cb (void *userdata, struct stasis_subscription *sub, struct stasis_message *msg)
static int	generic_monitor_devstate_tp_cb (void *data)
static void	generic_monitor_instance_list_destructor (void *obj)
static void *	generic_recall (void *data)
static char *	handle_cc_kill (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static char *	handle_cc_status (struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)
static int	has_device_monitors (struct cc_core_instance *core_instance)
	check if the core instance has any device monitors More...
static void	initialize_cc_devstate_map (void)
static void	initialize_cc_devstate_map_helper (struct ast_config *cc_config, enum cc_state state, const char *cc_setting)
static void	initialize_cc_max_requests (void)
static int	is_state_change_valid (enum cc_state current_state, const enum cc_state new_state, struct ast_cc_agent *agent)
static int	kill_cores (void *obj, void *arg, int flags)
static void	kill_duplicate_offers (char *caller)
static int	load_module (void)
static int	match_agent (void *obj, void *arg, void *data, int flags)
static const char *	monitor_policy_to_str (enum ast_cc_monitor_policies policy)
static int	offer_timer_expire (const void *data)
static int	print_stats_cb (void *obj, void *arg, int flags)
static void	request_cc (struct cc_core_instance *core_instance)
static enum ast_cc_agent_policies	str_to_agent_policy (const char *const value)
static enum ast_cc_monitor_policies	str_to_monitor_policy (const char *const value)
static void	suspend (struct cc_core_instance *core_instance)
static int	unload_module (void)
static void	unsuspend (struct cc_core_instance *core_instance)

Variables
static struct ast_module_info	__mod_info = { .name = AST_MODULE, .flags = AST_MODFLAG_GLOBAL_SYMBOLS | AST_MODFLAG_LOAD_ORDER , .description = "Call Completion Supplementary Services" , .key = "This paragraph is copyright (c) 2006 by Digium, Inc. \In order for your module to load, it must return this \key via a function called \"key\". Any code which \includes this paragraph must be licensed under the GNU \General Public License version 2 or later (at your \option). In addition to Digium's general reservations \of rights, Digium expressly reserves the right to \allow other parties to license this paragraph under \different terms. Any use of Digium, Inc. trademarks or \logos (including \"Asterisk\" or \"Digium\") without \express written permission of Digium, Inc. is prohibited.\n" , .buildopt_sum = "30ef0c93b36035ec78c9cfd712d36d9b" , .support_level = AST_MODULE_SUPPORT_CORE, .load = load_module, .unload = unload_module, .load_pri = AST_MODPRI_CORE, }
static const struct ast_module_info *	ast_module_info = &__mod_info
struct cc_agent_backends	cc_agent_backends = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
static struct ast_cli_entry	cc_cli []
static struct ao2_container *	cc_core_instances
static const int	CC_CORE_INSTANCES_BUCKETS = 17
static struct ast_taskprocessor *	cc_core_taskprocessor
static const struct ast_cc_config_params	cc_default_params
static int	cc_logger_level
static const char *	CC_LOGGER_LEVEL_NAME = "CC"
struct cc_monitor_backends	cc_monitor_backends = { .first = NULL, .last = NULL, .lock = { PTHREAD_RWLOCK_INITIALIZER , NULL, {1, 0} } , }
static int	cc_request_count
static struct ast_sched_context *	cc_sched_context
struct {
enum ast_cc_service_type   service
const char *   service_string
}	cc_service_to_string_map []
static enum ast_device_state	cc_state_to_devstate_map []
struct {
enum cc_state   state
const char *   state_string
}	cc_state_to_string_map []
static const char *	cccancel_app = "CallCompletionCancel"
static const char *	ccreq_app = "CallCompletionRequest"
static int	core_id_counter
static int	dialed_cc_interface_counter
static const struct ast_datastore_info	dialed_cc_interfaces_info
static struct ast_cc_agent_callbacks	generic_agent_callbacks
static struct ast_cc_monitor_callbacks	generic_monitor_cbs
struct ao2_container *	generic_monitors
static unsigned int	global_cc_max_requests
static const struct ast_datastore_info	recall_ds_info
static int(*const	state_change_funcs [])(struct cc_core_instance *, struct cc_state_change_args *, enum cc_state previous_state)

Detailed Description

Call Completion Supplementary Services implementation.

Author

Mark Michelson mmich.nosp@m.elso.nosp@m.n@dig.nosp@m.ium..nosp@m.com

Definition in file ccss.c.

Macro Definition Documentation

CC_ACTIVE_DEVSTATE_DEFAULT

#define CC_ACTIVE_DEVSTATE_DEFAULT   AST_DEVICE_INUSE

Definition at line 552 of file ccss.c.

CC_AVAILABLE_DEVSTATE_DEFAULT

#define CC_AVAILABLE_DEVSTATE_DEFAULT   AST_DEVICE_NOT_INUSE

Definition at line 549 of file ccss.c.

CC_CALLEE_READY_DEVSTATE_DEFAULT

#define CC_CALLEE_READY_DEVSTATE_DEFAULT   AST_DEVICE_RINGING

Definition at line 553 of file ccss.c.

CC_CALLER_BUSY_DEVSTATE_DEFAULT

#define CC_CALLER_BUSY_DEVSTATE_DEFAULT   AST_DEVICE_ONHOLD

Definition at line 554 of file ccss.c.

CC_CALLER_OFFERED_DEVSTATE_DEFAULT

#define CC_CALLER_OFFERED_DEVSTATE_DEFAULT   AST_DEVICE_NOT_INUSE

Definition at line 550 of file ccss.c.

CC_CALLER_REQUESTED_DEVSTATE_DEFAULT

#define CC_CALLER_REQUESTED_DEVSTATE_DEFAULT   AST_DEVICE_NOT_INUSE

Definition at line 551 of file ccss.c.

CC_COMPLETE_DEVSTATE_DEFAULT

#define CC_COMPLETE_DEVSTATE_DEFAULT   AST_DEVICE_NOT_INUSE

Definition at line 556 of file ccss.c.

CC_FAILED_DEVSTATE_DEFAULT

#define CC_FAILED_DEVSTATE_DEFAULT   AST_DEVICE_NOT_INUSE

Definition at line 557 of file ccss.c.

CC_MAX_AGENTS_DEFAULT

#define CC_MAX_AGENTS_DEFAULT   5

Definition at line 658 of file ccss.c.

CC_MAX_MONITORS_DEFAULT

#define CC_MAX_MONITORS_DEFAULT   5

Definition at line 659 of file ccss.c.

CC_OFFER_TIMER_DEFAULT

#define CC_OFFER_TIMER_DEFAULT   20 /* Seconds */

Definition at line 654 of file ccss.c.

CC_RECALL_TIMER_DEFAULT

#define CC_RECALL_TIMER_DEFAULT   20 /* Seconds */

Definition at line 657 of file ccss.c.

CC_RECALLING_DEVSTATE_DEFAULT

#define CC_RECALLING_DEVSTATE_DEFAULT   AST_DEVICE_RINGING

Definition at line 555 of file ccss.c.

CCBS_AVAILABLE_TIMER_DEFAULT

#define CCBS_AVAILABLE_TIMER_DEFAULT   4800 /* Seconds */

Definition at line 656 of file ccss.c.

CCNR_AVAILABLE_TIMER_DEFAULT

#define CCNR_AVAILABLE_TIMER_DEFAULT   7200 /* Seconds */

Definition at line 655 of file ccss.c.

GLOBAL_CC_MAX_REQUESTS_DEFAULT

#define GLOBAL_CC_MAX_REQUESTS_DEFAULT   20

Definition at line 660 of file ccss.c.

Referenced by initialize_cc_max_requests().

Enumeration Type Documentation

cc_state

enum cc_state

The states used in the CCSS core state machine.

Since

1.8 For more information, see doc/CCSS_architecture.pdf

Enumerator
CC_AVAILABLE	Entered when it is determined that CCSS may be used for the call
CC_CALLER_OFFERED	Entered when a CCSS agent has offered CCSS to a caller
CC_CALLER_REQUESTED	Entered when a CCSS agent confirms that a caller has requested CCSS
CC_ACTIVE	Entered when a CCSS monitor confirms acknowledgment of an outbound CCSS request
CC_CALLEE_READY	Entered when a CCSS monitor alerts the core that the called party has become available
CC_CALLER_BUSY	Entered when a CCSS agent alerts the core that the calling party may not be recalled because he is unavailable
CC_RECALLING	Entered when a CCSS agent alerts the core that the calling party is attempting to recall the called party
CC_COMPLETE	Entered when an application alerts the core that the calling party's recall attempt has had a call progress response indicated
CC_FAILED	Entered any time that something goes wrong during the process, thus resulting in the failure of the attempted CCSS transaction. Note also that cancellations of CC are treated as failures.

Definition at line 181 of file ccss.c.

 {
 /*! Entered when it is determined that CCSS may be used for the call */
 CC_AVAILABLE,
 /*! Entered when a CCSS agent has offered CCSS to a caller */
 CC_CALLER_OFFERED,
 /*! Entered when a CCSS agent confirms that a caller has
 * requested CCSS */
 CC_CALLER_REQUESTED,
 /*! Entered when a CCSS monitor confirms acknowledgment of an
 * outbound CCSS request */
 CC_ACTIVE,
 /*! Entered when a CCSS monitor alerts the core that the called party
 * has become available */
 CC_CALLEE_READY,
 /*! Entered when a CCSS agent alerts the core that the calling party
 * may not be recalled because he is unavailable
 */
 CC_CALLER_BUSY,
 /*! Entered when a CCSS agent alerts the core that the calling party
 * is attempting to recall the called party
 */
 CC_RECALLING,
 /*! Entered when an application alerts the core that the calling party's
 * recall attempt has had a call progress response indicated
 */
 CC_COMPLETE,
 /*! Entered any time that something goes wrong during the process, thus
 * resulting in the failure of the attempted CCSS transaction. Note also
 * that cancellations of CC are treated as failures.
 */
 CC_FAILED,
};

match_flags

enum match_flags

Enumerator
MATCH_NO_REQUEST
MATCH_REQUEST

Definition at line 469 of file ccss.c.

 {
 /* Only match agents that have not yet
 * made a CC request
 */
 MATCH_NO_REQUEST = (1 << 0),
 /* Only match agents that have made
 * a CC request
 */
 MATCH_REQUEST = (1 << 1),
};

Function Documentation

__ast_cc_config_params_init()

struct ast_cc_config_params* __ast_cc_config_params_init	(	const char *	file,
		int	line,
		const char *	function
	)

Allocate and initialize an ast_cc_config_params structure.

Note

Reasonable default values are chosen for the parameters upon allocation.

Return values

NULL	Unable to allocate the structure
non-NULL	A pointer to the newly allocated and initialized structure

Definition at line 681 of file ccss.c.

References __ast_malloc(), ast_cc_default_config_params(), and NULL.

{
 struct ast_cc_config_params *params = __ast_malloc(sizeof(*params), file, line, function);

 if (!params) {
 return NULL;
 }

 ast_cc_default_config_params(params);
 return params;
}

__reg_module()

static void __reg_module ( void  )

static

Definition at line 4703 of file ccss.c.

__unreg_module()

static void __unreg_module ( void  )

static

Definition at line 4703 of file ccss.c.

agent_destroy()

static void agent_destroy ( void *  data )

static

Definition at line 2544 of file ccss.c.

References ast_cc_config_params_destroy(), ast_cc_agent::callbacks, ast_cc_agent::cc_params, and ast_cc_agent_callbacks::destructor.

Referenced by cc_agent_init().

{
 struct ast_cc_agent *agent = data;

 if (agent->callbacks) {
 agent->callbacks->destructor(agent);
 }
 ast_cc_config_params_destroy(agent->cc_params);
}

agent_policy_to_str()

static const char* agent_policy_to_str ( enum ast_cc_agent_policies  policy )

static

Definition at line 728 of file ccss.c.

References AST_CC_AGENT_GENERIC, AST_CC_AGENT_NATIVE, and AST_CC_AGENT_NEVER.

Referenced by ast_cc_get_param().

{
 switch (policy) {
 case AST_CC_AGENT_NEVER:
 return "never";
 case AST_CC_AGENT_NATIVE:
 return "native";
 case AST_CC_AGENT_GENERIC:
 return "generic";
 default:
 /* This should never happen... */
 return "";
 }
}

ast_cc_agent_accept_request()

int ast_cc_agent_accept_request	(	int	core_id,
		const char *const	debug,
			...
	)

Accept inbound CC request.

Since

1.8

When a caller requests CC, this function should be called to let the core know that the request has been accepted.

Parameters

core_id	core_id of the CC transaction
debug	optional string to print for debugging purposes

Return values

0	Success
-1	Failure

Definition at line 3776 of file ccss.c.

References CC_CALLER_REQUESTED, and cc_request_state_change().

Referenced by ccreq_exec(), and handle_cc_subscribe().

{
 va_list ap;
 int res;

 va_start(ap, debug);
 res = cc_request_state_change(CC_CALLER_REQUESTED, core_id, debug, ap);
 va_end(ap);
 return res;
}

ast_cc_agent_callback()

struct ast_cc_agent* ast_cc_agent_callback	(	int	flags,
		ao2_callback_fn *	function,
		void *	arg,
		const char *const	type
	)

Call a callback on all agents of a specific type.

Since the container of CC core instances is private, and so are the items which the container contains, we have to provide an ao2_callback-like method so that a specific agent may be found or so that an operation can be made on all agents of a particular type. The first three arguments should be familiar to anyone who has used ao2_callback. The final argument is the type of agent you wish to have the callback called on.

Note

Since agents are refcounted, and this function returns a reference to the agent, it is imperative that you decrement the refcount of the agent once you have finished using it.

Parameters

flags	astobj2 search flags
function	an ao2 callback function to call
arg	the argument to the callback function
type	The type of agents to call the callback on

Definition at line 456 of file ccss.c.

References cc_core_instance::agent, ao2_t_callback, args, cc_agent_callback_helper(), cc_ref(), cc_unref(), cc_callback_helper::function, and NULL.

Referenced by find_sip_cc_agent_by_notify_uri(), find_sip_cc_agent_by_original_callid(), and find_sip_cc_agent_by_subscribe_uri().

{
 struct cc_callback_helper helper = {.function = function, .args = args, .type = type};
 struct cc_core_instance *core_instance;
 if ((core_instance = ao2_t_callback(cc_core_instances, flags, cc_agent_callback_helper, &helper,
 "Calling provided agent callback function"))) {
 struct ast_cc_agent *agent = cc_ref(core_instance->agent, "An outside entity needs the agent");
 cc_unref(core_instance, "agent callback done with the core_instance");
 return agent;
 }
 return NULL;
}

ast_cc_agent_caller_available()

int ast_cc_agent_caller_available	(	int	core_id,
		const char *const	debug,
			...
	)

Indicate that a previously unavailable caller has become available.

Since

1.8

If a monitor is suspended due to a caller becoming unavailable, then this function should be called to indicate that the caller has become available.

Parameters

core_id	core_id of the CC transaction
debug	optional string to print for debugging purposes

Return values

0	Success
-1	Failure

Definition at line 3820 of file ccss.c.

References CC_ACTIVE, and cc_request_state_change().

Referenced by cc_esc_publish_handler(), and generic_agent_devstate_cb().

{
 va_list ap;
 int res;

 va_start(ap, debug);
 res = cc_request_state_change(CC_ACTIVE, core_id, debug, ap);
 va_end(ap);
 return res;
}

ast_cc_agent_caller_busy()

int ast_cc_agent_caller_busy	(	int	core_id,
		const char *const	debug,
			...
	)

Indicate that the caller is busy.

Since

1.8

When the callee makes it known that he is available, the core will let the caller's channel driver know that it may attempt to let the caller know to attempt a recall. If the channel driver can detect, though, that the caller is busy, then the channel driver should call this function to let the CC core know.

Parameters

core_id	core_id of the CC transaction
debug	optional string to print for debugging purposes

Return values

0	Success
-1	Failure

Definition at line 3809 of file ccss.c.

References CC_CALLER_BUSY, and cc_request_state_change().

Referenced by cc_esc_publish_handler(), cc_generic_agent_recall(), and sip_cc_agent_recall().

{
 va_list ap;
 int res;

 va_start(ap, debug);
 res = cc_request_state_change(CC_CALLER_BUSY, core_id, debug, ap);
 va_end(ap);
 return res;
}

ast_cc_agent_recalling()

int ast_cc_agent_recalling	(	int	core_id,
		const char *const	debug,
			...
	)

Tell the CC core that a caller is currently recalling.

Since

1.8

The main purpose of this is so that the core can alert the monitor to stop its available timer since the caller has begun its recall phase.

Parameters

core_id	core_id of the CC transaction
debug	optional string to print for debugging purposes

Return values

0	Success
-1	Failure

Definition at line 3831 of file ccss.c.

References CC_RECALLING, and cc_request_state_change().

Referenced by generic_recall(), and get_destination().

{
 va_list ap;
 int res;

 va_start(ap, debug);
 res = cc_request_state_change(CC_RECALLING, core_id, debug, ap);
 va_end(ap);
 return res;
}

ast_cc_agent_register()

int ast_cc_agent_register

(

const struct ast_cc_agent_callbacks *

callbacks

)

Register a set of agent callbacks with the core.

Since

1.8

This is made so that at agent creation time, the proper callbacks may be installed and the proper .init callback may be called for the monitor to establish private data.

Parameters

callbacks

The callbacks used by the agent implementation

Return values

0	Successfully registered
-1	Failure to register

Definition at line 1239 of file ccss.c.

References ast_calloc, AST_RWLIST_INSERT_TAIL, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, cc_agent_backend::callbacks, and cc_agent_backend::next.

Referenced by load_module().

{
 struct cc_agent_backend *backend = ast_calloc(1, sizeof(*backend));

 if (!backend) {
 return -1;
 }

 backend->callbacks = callbacks;
 AST_RWLIST_WRLOCK(&cc_agent_backends);
 AST_RWLIST_INSERT_TAIL(&cc_agent_backends, backend, next);
 AST_RWLIST_UNLOCK(&cc_agent_backends);
 return 0;
}

ast_cc_agent_set_interfaces_chanvar()

int ast_cc_agent_set_interfaces_chanvar

(

struct ast_channel *

chan

)

Set the first level CC_INTERFACES channel variable for a channel.

Since

1.8

Note

Implementers of protocol-specific CC agents should call this function after calling ast_setup_cc_recall_datastore.

This function will lock the channel as well as the list of monitors stored on the channel's CC recall datastore, though neither are held at the same time. Callers of this function should be aware of potential lock ordering problems that may arise.

The CC_INTERFACES channel variable will have the interfaces that should be called back for a specific PBX instance.

Parameters

chan	The channel to set the CC_INTERFACES variable on

Definition at line 3631 of file ccss.c.

References ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, ast_free, AST_LIST_FIRST, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_log_dynamic_level, ast_str_buffer(), ast_str_create, build_cc_interfaces_chanvar(), cc_logger_level, cc_recall_ds_data::core_id, ast_datastore::data, cc_recall_ds_data::interface_tree, monitor, NULL, pbx_builtin_setvar_helper(), and str.

Referenced by generic_recall(), and handle_request_invite().

{
 struct ast_datastore *recall_datastore;
 struct cc_monitor_tree *interface_tree;
 struct ast_cc_monitor *monitor;
 struct cc_recall_ds_data *recall_data;
 struct ast_str *str = ast_str_create(64);
 int core_id;

 if (!str) {
 return -1;
 }

 ast_channel_lock(chan);
 if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
 ast_channel_unlock(chan);
 ast_free(str);
 return -1;
 }
 recall_data = recall_datastore->data;
 interface_tree = recall_data->interface_tree;
 core_id = recall_data->core_id;
 ast_channel_unlock(chan);

 AST_LIST_LOCK(interface_tree);
 monitor = AST_LIST_FIRST(interface_tree);
 build_cc_interfaces_chanvar(monitor, &str);
 AST_LIST_UNLOCK(interface_tree);

 pbx_builtin_setvar_helper(chan, "CC_INTERFACES", ast_str_buffer(str));
 ast_log_dynamic_level(cc_logger_level, "Core %d: CC_INTERFACES set to %s\n",
 core_id, ast_str_buffer(str));

 ast_free(str);
 return 0;
}

ast_cc_agent_status_response()

int ast_cc_agent_status_response	(	int	core_id,
		enum ast_device_state	devstate
	)

Response with a caller's current status.

When an ISDN PTMP monitor requests the caller's status, the agent must respond to the request using this function. For simplicity it is recommended that the devstate parameter be one of AST_DEVICE_INUSE or AST_DEVICE_NOT_INUSE.

Parameters

core_id	The core ID of the CC transaction
devstate	The current state of the caller to which the agent pertains

Return values

0	Successfully responded with our status
-1	Failed to respond with our status

Definition at line 4093 of file ccss.c.

References args, ast_calloc, ast_free, ast_taskprocessor_push(), cc_status_response(), cc_unref(), cc_status_response_args::core_instance, cc_status_response_args::devstate, and find_cc_core_instance().

Referenced by cc_generic_agent_status_request(), and sip_cc_agent_status_request().

{
 struct cc_status_response_args *args;
 struct cc_core_instance *core_instance;
 int res;

 args = ast_calloc(1, sizeof(*args));
 if (!args) {
 return -1;
 }

 core_instance = find_cc_core_instance(core_id);
 if (!core_instance) {
 ast_free(args);
 return -1;
 }

 args->core_instance = core_instance;
 args->devstate = devstate;

 res = ast_taskprocessor_push(cc_core_taskprocessor, cc_status_response, args);
 if (res) {
 cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
 ast_free(args);
 }
 return res;
}

ast_cc_agent_unregister()

void ast_cc_agent_unregister

(

const struct ast_cc_agent_callbacks *

callbacks

)

Unregister a set of agent callbacks with the core.

Since

1.8

If a module which makes use of a CC agent is unloaded, then it may unregister its agent callbacks with the core.

Parameters

callbacks

The callbacks used by the agent implementation

Return values

0	Successfully unregistered
-1	Failure to unregister

Definition at line 1254 of file ccss.c.

References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, cc_agent_backend::callbacks, and cc_agent_backend::next.

Referenced by __unload_module(), and unload_module().

{
 struct cc_agent_backend *backend;
 AST_RWLIST_WRLOCK(&cc_agent_backends);
 AST_RWLIST_TRAVERSE_SAFE_BEGIN(&cc_agent_backends, backend, next) {
 if (backend->callbacks == callbacks) {
 AST_RWLIST_REMOVE_CURRENT(next);
 ast_free(backend);
 break;
 }
 }
 AST_RWLIST_TRAVERSE_SAFE_END;
 AST_RWLIST_UNLOCK(&cc_agent_backends);
}

ast_cc_available_timer_expire()

int ast_cc_available_timer_expire

(

const void *

data

)

Scheduler callback for available timer expiration.

Since

1.8

Note

When arming the available timer from within a device monitor, you MUST use this function as the callback for the scheduler.

Parameters

data	A reference to the CC monitor on which the timer was running.

Definition at line 1509 of file ccss.c.

References ast_cc_monitor_failed(), ast_cc_monitor::available_timer_id, cc_unref(), ast_cc_monitor::core_id, ast_cc_interface::device_name, and ast_cc_monitor::interface.

Referenced by cc_generic_monitor_request_cc(), and sip_cc_monitor_request_cc().

{
 struct ast_cc_monitor *monitor = (struct ast_cc_monitor *) data;
 int res;
 monitor->available_timer_id = -1;
 res = ast_cc_monitor_failed(monitor->core_id, monitor->interface->device_name, "Available timer expired for monitor");
 cc_unref(monitor, "Unref reference from scheduler\n");
 return res;
}

ast_cc_build_frame()

int ast_cc_build_frame	(	struct ast_channel *	chan,
		struct ast_cc_config_params *	cc_params,
		const char *	monitor_type,
		const char *const	device_name,
		const char *const	dialstring,
		enum ast_cc_service_type	service,
		void *	private_data,
		struct ast_frame *	frame
	)

Create a CC Control frame.

Since

1.8

chan_dahdi is weird. It doesn't seem to actually queue frames when it needs to tell an application something. Instead it wakes up, tells the application that it has data ready, and then based on set flags, creates the proper frame type. For chan_dahdi, we provide this function. It provides us the data we need, and we'll make its frame for it.

Parameters

	chan	A channel involved in the call. What we want is on a datastore on both incoming and outgoing so either may be provided
	cc_params	The CC configuration parameters for the outbound target
	monitor_type	The type of monitor to use when CC is requested
	device_name	The name of the outbound target device.
	dialstring	The dial string used when calling this specific interface
	service	What kind of CC service is being offered. (CCBS/CCNR/etc...)
	private_data	If a native monitor is being used, and some channel-driver-specific private data has been allocated, then this parameter should contain a pointer to that data. If using a generic monitor, this parameter should remain NULL. Note that if this function should fail at some point, it is the responsibility of the caller to free the private data upon return.
[out]	frame	The frame we will be returning to the caller. It is vital that ast_frame_free be called on this frame since the payload will be allocated on the heap.

Return values

-1	Failure. At some point there was a failure. Do not attempt to use the frame in this case.
0	Success

Definition at line 4176 of file ccss.c.

References ast_calloc, AST_CONTROL_CC, AST_FRAME_CONTROL, ast_free, AST_MALLOCD_DATA, cc_build_payload(), ast_frame::data, ast_frame::datalen, ast_frame::frametype, ast_frame_subclass::integer, ast_frame::mallocd, ast_frame::ptr, and ast_frame::subclass.

Referenced by ast_queue_cc_frame().

{
 struct cc_control_payload *payload = ast_calloc(1, sizeof(*payload));

 if (!payload) {
 return -1;
 }
 if (cc_build_payload(chan, cc_params, monitor_type, device_name, dialstring, service, private_data, payload)) {
 /* Something screwed up, we can't make a frame with this */
 ast_free(payload);
 return -1;
 }
 frame->frametype = AST_FRAME_CONTROL;
 frame->subclass.integer = AST_CONTROL_CC;
 frame->data.ptr = payload;
 frame->datalen = sizeof(*payload);
 frame->mallocd = AST_MALLOCD_DATA;
 return 0;
}

ast_cc_busy_interface()

void ast_cc_busy_interface	(	struct ast_channel *	inbound,
		struct ast_cc_config_params *	cc_params,
		const char *	monitor_type,
		const char *const	device_name,
		const char *const	dialstring,
		void *	private_data
	)

Callback made from ast_cc_callback for certain channel types.

Since

1.8

Parameters

inbound	Incoming asterisk channel.
cc_params	The CC configuration parameters for the outbound target
monitor_type	The type of monitor to use when CC is requested
device_name	The name of the outbound target device.
dialstring	The dial string used when calling this specific interface
private_data	If a native monitor is being used, and some channel-driver-specific private data has been allocated, then this parameter should contain a pointer to that data. If using a generic monitor, this parameter should remain NULL. Note that if this function should fail at some point, it is the responsibility of the caller to free the private data upon return.

For channel types that fail ast_request when the device is busy, we call into the channel driver with ast_cc_callback. This is the callback that is called in that case for each device found which could have been returned by ast_request.

This function creates a CC control frame payload, simulating the act of reading it from the nonexistent outgoing channel's frame queue. We then handle this simulated frame just as we would a normal CC frame which had actually been queued by the channel driver.

Definition at line 4232 of file ccss.c.

References AST_CC_CCBS, ast_handle_cc_control_frame(), call_destructor_with_no_monitor(), cc_build_payload(), and NULL.

Referenced by dial_exec_full().

{
 struct cc_control_payload payload;
 if (cc_build_payload(inbound, cc_params, monitor_type, device_name, dialstring, AST_CC_CCBS, private_data, &payload)) {
 /* Something screwed up. Don't try to handle this payload */
 call_destructor_with_no_monitor(monitor_type, private_data);
 return;
 }
 ast_handle_cc_control_frame(inbound, NULL, &payload);
}

ast_cc_call_failed()

void ast_cc_call_failed	(	struct ast_channel *	incoming,
		struct ast_channel *	outgoing,
		const char *const	dialstring
	)

Make CCBS available in the case that ast_call fails.

Since

1.8 In some situations, notably if a call-limit is reached in SIP, ast_call will fail due to Asterisk's knowing that the desired device is currently busy. In such a situation, CCBS should be made available to the caller.

One caveat is that this may only be used if generic monitoring is being used. The reason is that since Asterisk determined that the device was busy without actually placing a call to it, the far end will have no idea what call we are requesting call completion for if we were to send a call completion request.

Definition at line 4199 of file ccss.c.

References AST_CAUSE_BUSY, AST_CAUSE_CONGESTION, AST_CC_CCBS, AST_CC_GENERIC_MONITOR_TYPE, AST_CC_MONITOR_GENERIC, ast_channel_get_cc_config_params(), ast_channel_get_device_name(), ast_channel_hangupcause(), AST_CHANNEL_NAME, ast_get_cc_monitor_policy(), ast_handle_cc_control_frame(), cc_build_payload(), cc_control_payload::device_name, and NULL.

Referenced by dial_exec_full().

{
 char device_name[AST_CHANNEL_NAME];
 struct cc_control_payload payload;
 struct ast_cc_config_params *cc_params;

 if (ast_channel_hangupcause(outgoing) != AST_CAUSE_BUSY && ast_channel_hangupcause(outgoing) != AST_CAUSE_CONGESTION) {
 /* It doesn't make sense to try to offer CCBS to the caller if the reason for ast_call
 * failing is something other than busy or congestion
 */
 return;
 }

 cc_params = ast_channel_get_cc_config_params(outgoing);
 if (!cc_params) {
 return;
 }
 if (ast_get_cc_monitor_policy(cc_params) != AST_CC_MONITOR_GENERIC) {
 /* This sort of CCBS only works if using generic CC. For native, we would end up sending
 * a CC request for a non-existent call. The far end will reject this every time
 */
 return;
 }

 ast_channel_get_device_name(outgoing, device_name, sizeof(device_name));
 if (cc_build_payload(outgoing, cc_params, AST_CC_GENERIC_MONITOR_TYPE, device_name,
 dialstring, AST_CC_CCBS, NULL, &payload)) {
 /* Something screwed up, we can't make a frame with this */
 return;
 }
 ast_handle_cc_control_frame(incoming, outgoing, &payload);
}

ast_cc_call_init()

int ast_cc_call_init	(	struct ast_channel *	chan,
		int *	ignore_cc
	)

Start the CC process on a call.

Since

1.8

Whenever a CC-capable application, such as Dial, wishes to engage in CC activity, it initiates the process by calling this function. If the CC core should discover that a previous application has called ast_ignore_cc on this channel or a "parent" channel, then the value of the ignore_cc integer passed in will be set nonzero.

The ignore_cc parameter is a convenience parameter. It can save an application the trouble of trying to call CC APIs when it knows that it should just ignore further attempts at CC actions.

Parameters

	chan	The inbound channel calling the CC-capable application.
[out]	ignore_cc	Will be set non-zero if no further CC actions need to be taken

Return values

0	Success
-1	Failure

Definition at line 2409 of file ccss.c.

References AST_CC_AGENT_NEVER, ast_channel_context(), ast_channel_datastore_find(), ast_channel_exten(), ast_channel_get_cc_config_params(), ast_channel_lock, ast_channel_macrocontext(), ast_channel_macroexten(), ast_channel_name(), ast_channel_unlock, ast_get_cc_agent_policy(), AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_UNLOCK, ast_log_dynamic_level, cc_extension_monitor_init(), cc_interfaces_datastore_init(), cc_logger_level, cc_ref(), cc_unref(), ast_cc_monitor::core_id, dialed_cc_interfaces::core_id, ast_datastore::data, dialed_cc_interfaces::dial_parent_id, ast_cc_monitor::id, dialed_cc_interfaces::ignore, dialed_cc_interfaces::interface_tree, interfaces, monitor, NULL, and S_OR.

Referenced by dial_exec_full().

{
 /* There are three situations to deal with here:
 *
 * 1. The channel does not have a dialed_cc_interfaces datastore on
 * it. This means that this is the first time that Dial has
 * been called. We need to create/initialize the datastore.
 *
 * 2. The channel does have a cc_interface datastore on it and
 * the "ignore" indicator is 0. This means that a Local channel
 * was called by a "parent" dial. We can check the datastore's
 * parent field to see who the root of this particular dial tree
 * is.
 *
 * 3. The channel does have a cc_interface datastore on it and
 * the "ignore" indicator is 1. This means that a second Dial call
 * is being made from an extension. In this case, we do not
 * want to make any additions/modifications to the datastore. We
 * will instead set a flag to indicate that CCSS is completely
 * disabled for this Dial attempt.
 */

 struct ast_datastore *cc_interfaces_datastore;
 struct dialed_cc_interfaces *interfaces;
 struct ast_cc_monitor *monitor;
 struct ast_cc_config_params *cc_params;

 ast_channel_lock(chan);

 cc_params = ast_channel_get_cc_config_params(chan);
 if (!cc_params) {
 ast_channel_unlock(chan);
 return -1;
 }
 if (ast_get_cc_agent_policy(cc_params) == AST_CC_AGENT_NEVER) {
 /* We can't offer CC to this caller anyway, so don't bother with CC on this call
 */
 *ignore_cc = 1;
 ast_channel_unlock(chan);
 ast_log_dynamic_level(cc_logger_level, "Agent policy for %s is 'never'. CC not possible\n", ast_channel_name(chan));
 return 0;
 }

 if (!(cc_interfaces_datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
 /* Situation 1 has occurred */
 ast_channel_unlock(chan);
 return cc_interfaces_datastore_init(chan);
 }
 interfaces = cc_interfaces_datastore->data;
 ast_channel_unlock(chan);

 if (interfaces->ignore) {
 /* Situation 3 has occurred */
 *ignore_cc = 1;
 ast_log_dynamic_level(cc_logger_level, "Datastore is present with ignore flag set. Ignoring CC offers on this call\n");
 return 0;
 }

 /* Situation 2 has occurred */
 if (!(monitor = cc_extension_monitor_init(S_OR(ast_channel_macroexten(chan), ast_channel_exten(chan)),
 S_OR(ast_channel_macrocontext(chan), ast_channel_context(chan)), interfaces->dial_parent_id))) {
 return -1;
 }
 monitor->core_id = interfaces->core_id;
 AST_LIST_LOCK(interfaces->interface_tree);
 cc_ref(monitor, "monitor tree's reference to the monitor");
 AST_LIST_INSERT_TAIL(interfaces->interface_tree, monitor, next);
 AST_LIST_UNLOCK(interfaces->interface_tree);
 interfaces->dial_parent_id = monitor->id;
 cc_unref(monitor, "Unref monitor's allocation reference");
 return 0;
}

ast_cc_callback()

int ast_cc_callback	(	struct ast_channel *	inbound,
		const char *const	tech,
		const char *const	dest,
		ast_cc_callback_fn	callback
	)

Run a callback for potential matching destinations.

Since

1.8

Note

See the explanation in ast_channel_tech::cc_callback for more details.

Parameters

inbound
tech	Channel technology to use
dest	Channel/group/peer or whatever the specific technology uses
callback	Function to call when a target is reached

Return values

Always

0, I guess.

Definition at line 4244 of file ccss.c.

References ast_get_channel_tech(), and ast_channel_tech::cc_callback.

Referenced by dial_exec_full().

{
 const struct ast_channel_tech *chantech = ast_get_channel_tech(tech);

 if (chantech && chantech->cc_callback) {
 chantech->cc_callback(inbound, dest, callback);
 }

 return 0;
}

ast_cc_completed()

int ast_cc_completed	(	struct ast_channel *	chan,
		const char *const	debug,
			...
	)

Indicate recall has been acknowledged.

Since

1.8

When we receive confirmation that an endpoint has responded to our CC recall, we call this function.

Parameters

chan	The inbound channel making the CC recall
debug	optional string to print for debugging purposes

Return values

0	Success
-1	Failure

Definition at line 3842 of file ccss.c.

References ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, CC_COMPLETE, cc_request_state_change(), cc_recall_ds_data::core_id, ast_datastore::data, cc_recall_ds_data::ignore, cc_recall_ds_data::nested, and NULL.

Referenced by wait_for_answer().

{
 struct ast_datastore *recall_datastore;
 struct cc_recall_ds_data *recall_data;
 int core_id;
 va_list ap;
 int res;

 ast_channel_lock(chan);
 if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
 /* Silly! Why did you call this function if there's no recall DS? */
 ast_channel_unlock(chan);
 return -1;
 }
 recall_data = recall_datastore->data;
 if (recall_data->nested || recall_data->ignore) {
 /* If this is being called from a nested Dial, it is too
 * early to determine if the recall has actually completed.
 * The outermost dial is the only one with the authority to
 * declare the recall to be complete.
 *
 * Similarly, if this function has been called when the
 * recall has progressed beyond the first dial, this is not
 * a legitimate time to declare the recall to be done. In fact,
 * that should have been done already.
 */
 ast_channel_unlock(chan);
 return -1;
 }
 core_id = recall_data->core_id;
 ast_channel_unlock(chan);
 va_start(ap, debug);
 res = cc_request_state_change(CC_COMPLETE, core_id, debug, ap);
 va_end(ap);
 return res;
}

ast_cc_config_params_destroy()

void ast_cc_config_params_destroy

(

struct ast_cc_config_params *

params

)

Free memory from CCSS configuration params.

Note

Just a call to ast_free for now...

Parameters

params

Pointer to structure whose memory we need to free

Return values

void

Definition at line 693 of file ccss.c.

References ast_free.

Referenced by agent_destroy(), ast_channel_cc_params_init(), cc_interface_destroy(), channel_cc_params_destroy(), dahdi_create_channel_range(), destroy_dahdi_pvt(), process_dahdi(), setup_dahdi(), sip_destroy_peer(), and sip_pvt_dtor().

{
 ast_free(params);
}

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

Since

1.8

For now, this is a simple memcpy, but this function is necessary since the size of an ast_cc_config_params structure is unknown outside of main/ccss.c. Also, this allows for easier expansion of the function in case it becomes more complex than just a memcpy.

Parameters

src	The structure from which data is copied
dest	The structure to which data is copied

Returns

Nothing

Definition at line 861 of file ccss.c.

Referenced by ast_channel_cc_params_init(), cc_agent_init(), cc_build_payload(), cc_device_monitor_init(), channel_cc_params_copy(), check_peer_ok(), create_addr_from_peer(), dahdi_new(), deep_copy_dahdi_chan_conf(), duplicate_pseudo(), and mkintf().

{
 *dest = *src;
}

ast_cc_default_config_params()

void ast_cc_default_config_params

(

struct ast_cc_config_params *

params

)

Set the specified CC config params to default values.

Since

1.8

This is just like ast_cc_copy_config_params() and could be used in place of it if you need to set the config params to defaults instead. You are simply "copying" defaults into the destination.

Parameters

params

CC config params to set to default values.

Returns

Nothing

Definition at line 676 of file ccss.c.

References cc_default_params.

Referenced by __ast_cc_config_params_init().

{
 *params = cc_default_params;
}

ast_cc_extension_monitor_add_dialstring()

void ast_cc_extension_monitor_add_dialstring	(	struct ast_channel *	incoming,
		const char *const	dialstring,
		const char *const	device_name
	)

Add a child dialstring to an extension monitor.

Since

1.8

Whenever we request a channel, the parent extension monitor needs to store the dialstring of the device requested. The reason is so that we can call the device back during the recall even if we are not monitoring the device.

Parameters

incoming	The caller's channel
dialstring	The dialstring used when requesting the outbound channel
device_name	The device name associated with the requested outbound channel

Return values

void

Definition at line 2005 of file ccss.c.

References ast_calloc, ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, ast_copy_string(), AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, extension_monitor_pvt::child_dialstrings, ast_datastore::data, extension_child_dialstring::device_name, dialed_cc_interfaces::dial_parent_id, ast_cc_monitor::id, id, dialed_cc_interfaces::interface_tree, extension_child_dialstring::is_valid, monitor, NULL, extension_child_dialstring::original_dialstring, and ast_cc_monitor::private_data.

Referenced by dial_exec_full().

{
 struct ast_datastore *cc_datastore;
 struct dialed_cc_interfaces *cc_interfaces;
 struct ast_cc_monitor *monitor;
 struct extension_monitor_pvt *extension_pvt;
 struct extension_child_dialstring *child_dialstring;
 struct cc_monitor_tree *interface_tree;
 int id;

 ast_channel_lock(incoming);
 if (!(cc_datastore = ast_channel_datastore_find(incoming, &dialed_cc_interfaces_info, NULL))) {
 ast_channel_unlock(incoming);
 return;
 }

 cc_interfaces = cc_datastore->data;
 interface_tree = cc_interfaces->interface_tree;
 id = cc_interfaces->dial_parent_id;
 ast_channel_unlock(incoming);

 AST_LIST_LOCK(interface_tree);
 AST_LIST_TRAVERSE(interface_tree, monitor, next) {
 if (monitor->id == id) {
 break;
 }
 }

 if (!monitor) {
 AST_LIST_UNLOCK(interface_tree);
 return;
 }

 extension_pvt = monitor->private_data;
 if (!(child_dialstring = ast_calloc(1, sizeof(*child_dialstring)))) {
 AST_LIST_UNLOCK(interface_tree);
 return;
 }
 ast_copy_string(child_dialstring->original_dialstring, dialstring, sizeof(child_dialstring->original_dialstring));
 ast_copy_string(child_dialstring->device_name, device_name, sizeof(child_dialstring->device_name));
 child_dialstring->is_valid = 1;
 AST_LIST_INSERT_TAIL(&extension_pvt->child_dialstrings, child_dialstring, next);
 AST_LIST_UNLOCK(interface_tree);
}

ast_cc_failed()

int ast_cc_failed	(	int	core_id,
		const char *const	debug,
			...
	)

Indicate failure has occurred.

Since

1.8

If at any point a failure occurs, this is the function to call so that the core can initiate cleanup procedures.

Parameters

core_id	core_id of the CC transaction
debug	optional string to print for debugging purposes

Return values

0	Success
-1	Failure

Definition at line 3879 of file ccss.c.

References CC_FAILED, and cc_request_state_change().

Referenced by cancel_available_timer(), cc_caller_offered(), cc_caller_requested(), cc_monitor_failed(), cccancel_exec(), ccreq_exec(), generic_recall(), handle_cc_subscribe(), kill_cores(), offer_timer_expire(), request_cc(), sip_offer_timer_expire(), suspend(), unsuspend(), and wait_for_answer().

{
 va_list ap;
 int res;

 va_start(ap, debug);
 res = cc_request_state_change(CC_FAILED, core_id, debug, ap);
 va_end(ap);
 return res;
}

ast_cc_get_current_core_id()

int ast_cc_get_current_core_id

(

struct ast_channel *

chan

)

Get the core id for the current call.

Since

1.8

The main use of this function is for channel drivers who queue an AST_CONTROL_CC frame. A channel driver may call this function in order to get the core_id for what may become a CC request. This way, when monitor functions are called which use a core_id as a means of identification, the channel driver will have saved this information.

The channel given to this function may be an inbound or outbound channel. Both will have the necessary info on it.

Parameters

chan	The channel from which to get the core_id.

Return values

core_id	on success
-1	Failure

Definition at line 2487 of file ccss.c.

References ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, dialed_cc_interfaces::core_id, ast_datastore::data, dialed_cc_interfaces::ignore, and NULL.

Referenced by sip_handle_cc().

{
 struct ast_datastore *datastore;
 struct dialed_cc_interfaces *cc_interfaces;
 int core_id_return;

 ast_channel_lock(chan);
 if (!(datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
 ast_channel_unlock(chan);
 return -1;
 }

 cc_interfaces = datastore->data;
 core_id_return = cc_interfaces->ignore ? -1 : cc_interfaces->core_id;
 ast_channel_unlock(chan);
 return core_id_return;

}

ast_cc_get_monitor_by_recall_core_id()

struct ast_cc_monitor* ast_cc_get_monitor_by_recall_core_id	(	const int	core_id,
		const char *const	device_name
	)

Get the associated monitor given the device name and core_id.

Since

1.8

The function ast_cc_is_recall is helpful for determining if a call to a specific channel is a recall. However, once you have determined that this is a recall, you will most likely need access to the private data within the associated monitor. This function is what one uses to get that monitor.

Note

This function locks the list of monitors that correspond to the core_id passed in. Be sure that you have no potential lock order issues when calling this function.

Parameters

core_id	The core ID to which this recall corresponds. This likely will have been obtained using the ast_cc_is_recall function
device_name	Which device to find the monitor for.

Return values

NULL	Appropriate monitor does not exist
non-NULL	The monitor to use for this recall

Definition at line 3519 of file ccss.c.

References AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, cc_ref(), cc_unref(), ast_cc_interface::device_name, find_cc_core_instance(), ast_cc_monitor::interface, cc_core_instance::monitors, ast_cc_monitor::next, and NULL.

Referenced by sip_call().

{
 struct cc_core_instance *core_instance = find_cc_core_instance(core_id);
 struct ast_cc_monitor *monitor_iter;

 if (!core_instance) {
 return NULL;
 }

 AST_LIST_LOCK(core_instance->monitors);
 AST_LIST_TRAVERSE(core_instance->monitors, monitor_iter, next) {
 if (!strcmp(monitor_iter->interface->device_name, device_name)) {
 /* Found a monitor. */
 cc_ref(monitor_iter, "Hand the requester of the monitor a reference");
 break;
 }
 }
 AST_LIST_UNLOCK(core_instance->monitors);
 cc_unref(core_instance, "Done with core instance ref in ast_cc_get_monitor_by_recall_core_id");
 return monitor_iter;
}

ast_cc_get_param()

int ast_cc_get_param	(	struct ast_cc_config_params *	params,
		const char *const	name,
		char *	buf,
		size_t	buf_len
	)

get a CCSS configuration parameter, given its name

Note

Useful when reading input as a string, like from dialplan or manager.

Parameters

params	The CCSS configuration from which to get the value
name	The name of the CCSS parameter we want
buf	A preallocated buffer to hold the value
buf_len	The size of buf

Return values

0	Success
-1	Failure

Definition at line 759 of file ccss.c.

References agent_policy_to_str(), ast_copy_string(), ast_get_cc_agent_dialstring(), ast_get_cc_agent_policy(), ast_get_cc_callback_macro(), ast_get_cc_callback_sub(), ast_get_cc_max_agents(), ast_get_cc_max_monitors(), ast_get_cc_monitor_policy(), ast_get_cc_offer_timer(), ast_get_cc_recall_timer(), ast_get_ccbs_available_timer(), ast_get_ccnr_available_timer(), ast_log, LOG_WARNING, monitor_policy_to_str(), NULL, and value.

Referenced by acf_cc_read().

{
 const char *value = NULL;

 if (!strcasecmp(name, "cc_callback_macro")) {
 value = ast_get_cc_callback_macro(params);
 } else if (!strcasecmp(name, "cc_callback_sub")) {
 value = ast_get_cc_callback_sub(params);
 } else if (!strcasecmp(name, "cc_agent_policy")) {
 value = agent_policy_to_str(ast_get_cc_agent_policy(params));
 } else if (!strcasecmp(name, "cc_monitor_policy")) {
 value = monitor_policy_to_str(ast_get_cc_monitor_policy(params));
 } else if (!strcasecmp(name, "cc_agent_dialstring")) {
 value = ast_get_cc_agent_dialstring(params);
 }
 if (value) {
 ast_copy_string(buf, value, buf_len);
 return 0;
 }

 /* The rest of these are all ints of some sort and require some
 * snprintf-itude
 */

 if (!strcasecmp(name, "cc_offer_timer")) {
 snprintf(buf, buf_len, "%u", ast_get_cc_offer_timer(params));
 } else if (!strcasecmp(name, "ccnr_available_timer")) {
 snprintf(buf, buf_len, "%u", ast_get_ccnr_available_timer(params));
 } else if (!strcasecmp(name, "ccbs_available_timer")) {
 snprintf(buf, buf_len, "%u", ast_get_ccbs_available_timer(params));
 } else if (!strcasecmp(name, "cc_max_agents")) {
 snprintf(buf, buf_len, "%u", ast_get_cc_max_agents(params));
 } else if (!strcasecmp(name, "cc_max_monitors")) {
 snprintf(buf, buf_len, "%u", ast_get_cc_max_monitors(params));
 } else if (!strcasecmp(name, "cc_recall_timer")) {
 snprintf(buf, buf_len, "%u", ast_get_cc_recall_timer(params));
 } else {
 ast_log(LOG_WARNING, "%s is not a valid CC parameter. Ignoring.\n", name);
 return -1;
 }

 return 0;
}

ast_cc_is_config_param()

int ast_cc_is_config_param

(

const char *const

name

)

Is this a CCSS configuration parameter?

Since

1.8

Parameters

name	Name of configuration option being parsed.

Return values

1	Yes, this is a CCSS configuration parameter.
0	No, this is not a CCSS configuration parameter.

Definition at line 846 of file ccss.c.

Referenced by build_peer(), and process_dahdi().

{
 return (!strcasecmp(name, "cc_agent_policy") ||
 !strcasecmp(name, "cc_monitor_policy") ||
 !strcasecmp(name, "cc_offer_timer") ||
 !strcasecmp(name, "ccnr_available_timer") ||
 !strcasecmp(name, "ccbs_available_timer") ||
 !strcasecmp(name, "cc_max_agents") ||
 !strcasecmp(name, "cc_max_monitors") ||
 !strcasecmp(name, "cc_callback_macro") ||
 !strcasecmp(name, "cc_callback_sub") ||
 !strcasecmp(name, "cc_agent_dialstring") ||
 !strcasecmp(name, "cc_recall_timer"));
}

ast_cc_is_recall()

int ast_cc_is_recall	(	struct ast_channel *	chan,
		int *	core_id,
		const char *const	monitor_type
	)

Decide if a call to a particular channel is a CC recall.

Since

1.8

When a CC recall happens, it is important on the called side to know that the call is a CC recall and not a normal call. This function will determine first if the call in question is a CC recall. Then it will determine based on the chan parameter if the channel is being called is being recalled.

As a quick example, let's say a call is placed to SIP/1000 and SIP/1000 is currently on the phone. The caller requests CCBS. SIP/1000 finishes his call, and so the caller attempts to recall. Now, the dialplan administrator has set up this second call so that not only is SIP/1000 called, but also SIP/2000 is called. If SIP/1000's channel were passed to this function, the return value would be non-zero, but if SIP/2000's channel were passed into this function, then the return would be 0 since SIP/2000 was not one of the original devices dialed.

Note

This function may be called on a calling channel as well to determine if it is part of a CC recall.

This function will lock the channel as well as the list of monitors on the channel datastore, though the locks are not held at the same time. Be sure that you have no potential lock order issues here.

Parameters

	chan	The channel to check
[out]	core_id	If this is a valid CC recall, the core_id of the failed call will be placed in this output parameter
	monitor_type	Clarify which type of monitor type we are looking for if this is happening on a called channel. For incoming channels, this parameter is not used.

Return values

0	Either this is not a recall or it is but this channel is not part of the recall
non-zero	This is a recall and the channel in question is directly involved.

Definition at line 3438 of file ccss.c.

References ast_assert, ast_channel_datastore_find(), ast_channel_get_device_name(), ast_channel_lock, AST_CHANNEL_NAME, ast_channel_unlock, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_strlen_zero, cc_recall_ds_data::core_id, ast_datastore::data, ast_cc_interface::device_name, cc_recall_ds_data::ignore, ast_cc_monitor::interface, cc_recall_ds_data::interface_tree, ast_cc_interface::monitor_type, cc_recall_ds_data::nested, ast_cc_monitor::next, and NULL.

Referenced by cc_core_init_instance(), sip_call(), and wait_for_answer().

{
 struct ast_datastore *recall_datastore;
 struct cc_recall_ds_data *recall_data;
 struct cc_monitor_tree *interface_tree;
 char device_name[AST_CHANNEL_NAME];
 struct ast_cc_monitor *device_monitor;
 int core_id_candidate;

 ast_assert(core_id != NULL);

 *core_id = -1;

 ast_channel_lock(chan);
 if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
 /* Obviously not a recall if the datastore isn't present */
 ast_channel_unlock(chan);
 return 0;
 }

 recall_data = recall_datastore->data;

 if (recall_data->ignore) {
 /* Though this is a recall, the call to this particular interface is not part of the
 * recall either because this is a call forward or because this is not the first
 * invocation of Dial during this call
 */
 ast_channel_unlock(chan);
 return 0;
 }

 if (!recall_data->nested) {
 /* If the nested flag is not set, then this means that
 * the channel passed to this function is the caller making
 * the recall. This means that we shouldn't look through
 * the monitor tree for the channel because it shouldn't be
 * there. However, this is a recall though, so return true.
 */
 *core_id = recall_data->core_id;
 ast_channel_unlock(chan);
 return 1;
 }

 if (ast_strlen_zero(monitor_type)) {
 /* If someone passed a NULL or empty monitor type, then it is clear
 * the channel they passed in was an incoming channel, and so searching
 * the list of dialed interfaces is not going to be helpful. Just return
 * false immediately.
 */
 ast_channel_unlock(chan);
 return 0;
 }

 interface_tree = recall_data->interface_tree;
 ast_channel_get_device_name(chan, device_name, sizeof(device_name));
 /* We grab the value of the recall_data->core_id so that we
 * can unlock the channel before we start looking through the
 * interface list. That way we don't have to worry about a possible
 * clash between the channel lock and the monitor tree lock.
 */
 core_id_candidate = recall_data->core_id;
 ast_channel_unlock(chan);

 /*
 * Now we need to find out if the channel device name
 * is in the list of interfaces in the called tree.
 */
 AST_LIST_LOCK(interface_tree);
 AST_LIST_TRAVERSE(interface_tree, device_monitor, next) {
 if (!strcmp(device_monitor->interface->device_name, device_name) &&
 !strcmp(device_monitor->interface->monitor_type, monitor_type)) {
 /* BOOM! Device is in the tree! We have a winner! */
 *core_id = core_id_candidate;
 AST_LIST_UNLOCK(interface_tree);
 return 1;
 }
 }
 AST_LIST_UNLOCK(interface_tree);
 return 0;
}

ast_cc_monitor_callee_available()

int ast_cc_monitor_callee_available	(	const int	core_id,
		const char *const	debug,
			...
	)

Alert the core that a device being monitored has become available.

Since

1.8

Note

The code in the core will take care of making sure that the information gets passed up the ladder correctly.

core_id The core ID of the corresponding CC transaction

debug

Return values

0	Request successfully queued
-1	Request could not be queued

Definition at line 3798 of file ccss.c.

References CC_CALLEE_READY, and cc_request_state_change().

Referenced by cc_generic_monitor_destructor(), cc_generic_monitor_suspend(), cc_generic_monitor_unsuspend(), generic_monitor_devstate_tp_cb(), and handle_cc_notify().

{
 va_list ap;
 int res;

 va_start(ap, debug);
 res = cc_request_state_change(CC_CALLEE_READY, core_id, debug, ap);
 va_end(ap);
 return res;
}

ast_cc_monitor_count()

int ast_cc_monitor_count	(	const char *const	name,
		const char *const	type
	)

Return the number of outstanding CC requests to a specific device.

Since

1.8

Note

This function will lock the list of monitors stored on every instance of the CC core. Callers of this function should be aware of this and avoid any potential lock ordering problems.

Parameters

name	The name of the monitored device
type	The type of the monitored device (e.g. "generic")

Returns

The number of CC requests for the monitor

Definition at line 4368 of file ccss.c.

References ao2_t_callback, ast_log_dynamic_level, cc_logger_level, count_monitors_cb_data::count, count_monitors_cb(), count_monitors_cb_data::device_name, name, OBJ_NODATA, and type.

Referenced by ast_queue_cc_frame().

{
 struct count_monitors_cb_data data = {.device_name = name, .monitor_type = type,};

 ao2_t_callback(cc_core_instances, OBJ_NODATA, count_monitors_cb, &data, "Counting agents");
 ast_log_dynamic_level(cc_logger_level, "Counted %d monitors\n", data.count);
 return data.count;
}

ast_cc_monitor_failed()

int ast_cc_monitor_failed	(	int	core_id,
		const char *const	monitor_name,
		const char *const	debug,
			...
	)

Indicate that a failure has occurred on a specific monitor.

Since

1.8

If a monitor should detect that a failure has occurred when communicating with its endpoint, then ast_cc_monitor_failed should be called. The big difference between ast_cc_monitor_failed and ast_cc_failed is that ast_cc_failed indicates a global failure for a CC transaction, where as ast_cc_monitor_failed is localized to a particular monitor. When ast_cc_failed is called, the entire CC transaction is torn down. When ast_cc_monitor_failed is called, only the monitor on which the failure occurred is pruned from the tree of monitors.

If there are no more devices left to monitor when this function is called, then the core will fail the CC transaction globally.

Parameters

core_id	The core ID for the CC transaction
monitor_name	The name of the monitor on which the failure occurred
debug	A debug message to print to the CC log

Returns

void

Definition at line 3941 of file ccss.c.

References ast_calloc, ast_free, ast_strdup, ast_taskprocessor_push(), ast_vasprintf, cc_monitor_failed(), ast_cc_monitor_failure_data::core_id, ast_cc_monitor_failure_data::debug, and ast_cc_monitor_failure_data::device_name.

Referenced by ast_cc_available_timer_expire(), cc_handle_publish_error(), and handle_response_subscribe().

{
 struct ast_cc_monitor_failure_data *failure_data;
 int res;
 va_list ap;

 if (!(failure_data = ast_calloc(1, sizeof(*failure_data)))) {
 return -1;
 }

 if (!(failure_data->device_name = ast_strdup(monitor_name))) {
 ast_free(failure_data);
 return -1;
 }

 va_start(ap, debug);
 if (ast_vasprintf(&failure_data->debug, debug, ap) == -1) {
 va_end(ap);
 ast_free((char *)failure_data->device_name);
 ast_free(failure_data);
 return -1;
 }
 va_end(ap);

 failure_data->core_id = core_id;

 res = ast_taskprocessor_push(cc_core_taskprocessor, cc_monitor_failed, failure_data);
 if (res) {
 ast_free((char *)failure_data->device_name);
 ast_free((char *)failure_data->debug);
 ast_free(failure_data);
 }
 return res;
}

ast_cc_monitor_party_b_free()

int ast_cc_monitor_party_b_free

(

int

core_id

)

Alert a caller that though the callee has become free, the caller himself is not and may not call back.

When an ISDN PTMP monitor senses that his monitored party has become available, he will request the status of the called party. If he determines that the caller is currently not available, then he will call this function so that an appropriate message is sent to the caller.

Yes, you just read that correctly. The callee asks the caller what his current status is, and if the caller is currently unavailable, the monitor must send him a message anyway. WTF?

This function results in the agent's party_b_free callback being called. It is most likely that you will not need to actually implement the party_b_free callback in an agent because it is not likely that you will need to or even want to send a caller a message indicating the callee's status if the caller himself is not also free.

Parameters

core_id

The core ID of the CC transaction

Return values

0	Successfully alerted the core that party B is free
-1	Could not alert the core that party B is free

Definition at line 4051 of file ccss.c.

References ast_taskprocessor_push(), cc_party_b_free(), cc_unref(), and find_cc_core_instance().

{
 int res;
 struct cc_core_instance *core_instance = find_cc_core_instance(core_id);

 if (!core_instance) {
 return -1;
 }

 res = ast_taskprocessor_push(cc_core_taskprocessor, cc_party_b_free, core_instance);
 if (res) {
 cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
 }
 return res;
}

ast_cc_monitor_register()

int ast_cc_monitor_register

(

const struct ast_cc_monitor_callbacks *

callbacks

)

Register a set of monitor callbacks with the core.

Since

1.8

This is made so that at monitor creation time, the proper callbacks may be installed and the proper .init callback may be called for the monitor to establish private data.

Parameters

callbacks

The callbacks used by the monitor implementation

Return values

0	Successfully registered
-1	Failure to register

Definition at line 1184 of file ccss.c.

References ast_calloc, AST_RWLIST_INSERT_TAIL, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, cc_monitor_backend::callbacks, and cc_monitor_backend::next.

Referenced by load_module().

{
 struct cc_monitor_backend *backend = ast_calloc(1, sizeof(*backend));

 if (!backend) {
 return -1;
 }

 backend->callbacks = callbacks;

 AST_RWLIST_WRLOCK(&cc_monitor_backends);
 AST_RWLIST_INSERT_TAIL(&cc_monitor_backends, backend, next);
 AST_RWLIST_UNLOCK(&cc_monitor_backends);
 return 0;
}

ast_cc_monitor_request_acked()

int ast_cc_monitor_request_acked	(	int	core_id,
		const char *const	debug,
			...
	)

Indicate that an outbound entity has accepted our CC request.

Since

1.8

When we receive confirmation that an outbound device has accepted the CC request we sent it, this function must be called.

Parameters

core_id	core_id of the CC transaction
debug	optional string to print for debugging purposes

Return values

0	Success
-1	Failure

Definition at line 3787 of file ccss.c.

References CC_ACTIVE, and cc_request_state_change().

Referenced by cc_generic_monitor_request_cc(), cc_stop_ringing(), and handle_cc_notify().

{
 va_list ap;
 int res;

 va_start(ap, debug);
 res = cc_request_state_change(CC_ACTIVE, core_id, debug, ap);
 va_end(ap);
 return res;
}

ast_cc_monitor_status_request()

int ast_cc_monitor_status_request

(

int

core_id

)

Request the status of a caller or callers.

The following are all functions which are required due to the unique case where Asterisk is acting as the NT side of an ISDN PTMP connection to the caller and as the TE side of an ISDN PTMP connection to the callee. In such a case, there are several times where the PTMP monitor needs information from the agent in order to formulate the appropriate messages to send.

When an ISDN PTMP monitor senses that the callee has become available, it needs to know the current status of the caller in order to determine the appropriate response to send to the caller. In order to do this, the monitor calls this function. Responses will arrive asynchronously.

Note

Zero or more responses may come as a result.

Parameters

core_id

The core ID of the CC transaction

Return values

0	Successfully requested status
-1	Failed to request status

Definition at line 3986 of file ccss.c.

References ast_taskprocessor_push(), cc_status_request(), cc_unref(), and find_cc_core_instance().

{
 int res;
 struct cc_core_instance *core_instance = find_cc_core_instance(core_id);

 if (!core_instance) {
 return -1;
 }

 res = ast_taskprocessor_push(cc_core_taskprocessor, cc_status_request, core_instance);
 if (res) {
 cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
 }
 return res;
}

ast_cc_monitor_stop_ringing()

int ast_cc_monitor_stop_ringing

(

int

core_id

)

Alert a caller to stop ringing.

When an ISDN PTMP monitor becomes available, it is assumed that the agent will then cause the caller's phone to ring. In some cases, this is literally what happens. In other cases, it may be that the caller gets a visible indication on his phone that he may attempt to recall the callee. If multiple callers are recalled (since it may be possible to have a group of callers configured as a single party A), and one of those callers picks up his phone, then the ISDN PTMP monitor will alert the other callers to stop ringing. The agent's stop_ringing callback will be called, and it is up to the agent's driver to send an appropriate message to make his caller stop ringing.

Parameters

core_id

The core ID of the CC transaction

Return values

0	Successfully requested for the phone to stop ringing
-1	Could not request for the phone to stop ringing

Definition at line 4023 of file ccss.c.

References ast_taskprocessor_push(), cc_stop_ringing(), cc_unref(), and find_cc_core_instance().

{
 int res;
 struct cc_core_instance *core_instance = find_cc_core_instance(core_id);

 if (!core_instance) {
 return -1;
 }

 res = ast_taskprocessor_push(cc_core_taskprocessor, cc_stop_ringing, core_instance);
 if (res) {
 cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
 }
 return res;
}

ast_cc_monitor_unregister()

void ast_cc_monitor_unregister

(

const struct ast_cc_monitor_callbacks *

callbacks

)

Unregister a set of monitor callbacks with the core.

Since

1.8

If a module which makes use of a CC monitor is unloaded, then it may unregister its monitor callbacks with the core.

Parameters

callbacks

The callbacks used by the monitor implementation

Return values

0	Successfully unregistered
-1	Failure to unregister

Definition at line 1217 of file ccss.c.

References ast_free, AST_RWLIST_REMOVE_CURRENT, AST_RWLIST_TRAVERSE_SAFE_BEGIN, AST_RWLIST_TRAVERSE_SAFE_END, AST_RWLIST_UNLOCK, AST_RWLIST_WRLOCK, cc_monitor_backend::callbacks, and cc_monitor_backend::next.

Referenced by __unload_module(), and unload_module().

{
 struct cc_monitor_backend *backend;
 AST_RWLIST_WRLOCK(&cc_monitor_backends);
 AST_RWLIST_TRAVERSE_SAFE_BEGIN(&cc_monitor_backends, backend, next) {
 if (backend->callbacks == callbacks) {
 AST_RWLIST_REMOVE_CURRENT(next);
 ast_free(backend);
 break;
 }
 }
 AST_RWLIST_TRAVERSE_SAFE_END;
 AST_RWLIST_UNLOCK(&cc_monitor_backends);
}

ast_cc_offer()

int ast_cc_offer

(

struct ast_channel *

caller_chan

)

Offer CC to a caller.

Since

1.8

This function is called from ast_hangup if the caller is eligible to be offered call completion service.

Parameters

caller_chan

The calling channel

Return values

-1	Error
0	Success

Definition at line 3751 of file ccss.c.

References ast_channel_datastore_find(), ast_channel_lock, ast_channel_name(), ast_channel_unlock, cc_offer(), dialed_cc_interfaces::core_id, cc_recall_ds_data::core_id, ast_datastore::data, dialed_cc_interfaces::is_original_caller, and NULL.

Referenced by ast_hangup().

{
 int core_id;
 int res = -1;
 struct ast_datastore *datastore;
 struct dialed_cc_interfaces *cc_interfaces;
 char cc_is_offerable;

 ast_channel_lock(caller_chan);
 if (!(datastore = ast_channel_datastore_find(caller_chan, &dialed_cc_interfaces_info, NULL))) {
 ast_channel_unlock(caller_chan);
 return res;
 }

 cc_interfaces = datastore->data;
 cc_is_offerable = cc_interfaces->is_original_caller;
 core_id = cc_interfaces->core_id;
 ast_channel_unlock(caller_chan);

 if (cc_is_offerable) {
 res = cc_offer(core_id, "CC offered to caller %s", ast_channel_name(caller_chan));
 }
 return res;
}

ast_cc_request_is_within_limits()

int ast_cc_request_is_within_limits

(

void

)

Check if the incoming CC request is within the bounds set by the cc_max_requests configuration option.

Since

1.8

It is recommended that an entity which receives an incoming CC request calls this function before calling ast_cc_agent_accept_request. This way, immediate feedback can be given to the caller about why his request was rejected.

If this is not called and a state change to CC_CALLER_REQUESTED is made, then the core will still not allow for the request to succeed. However, if done this way, it may not be obvious to the requestor why the request failed.

Return values

0	Not within the limits. Fail.
non-zero	Within the limits. Success.

Definition at line 2482 of file ccss.c.

References cc_request_count, and global_cc_max_requests.

Referenced by cc_caller_requested(), cc_interfaces_datastore_init(), and ccreq_exec().

{
 return cc_request_count < global_cc_max_requests;
}

ast_cc_set_param()

int ast_cc_set_param	(	struct ast_cc_config_params *	params,
		const char *const	name,
		const char *	value
	)

set a CCSS configuration parameter, given its name

Note

Useful when parsing config files when used in conjunction with ast_ccss_is_cc_config_param.

Parameters

params	The parameter structure to set the value on
name	The name of the cc parameter
value	The value of the parameter

Return values

0	Success
-1	Failure

Definition at line 804 of file ccss.c.

References ast_log, ast_set_cc_agent_dialstring(), ast_set_cc_agent_policy(), ast_set_cc_callback_macro(), ast_set_cc_callback_sub(), ast_set_cc_max_agents(), ast_set_cc_max_monitors(), ast_set_cc_monitor_policy(), ast_set_cc_offer_timer(), ast_set_cc_recall_timer(), ast_set_ccbs_available_timer(), ast_set_ccnr_available_timer(), LOG_WARNING, str_to_agent_policy(), and str_to_monitor_policy().

Referenced by acf_cc_write(), build_peer(), and process_dahdi().

{
 unsigned int value_as_uint;
 if (!strcasecmp(name, "cc_agent_policy")) {
 return ast_set_cc_agent_policy(params, str_to_agent_policy(value));
 } else if (!strcasecmp(name, "cc_monitor_policy")) {
 return ast_set_cc_monitor_policy(params, str_to_monitor_policy(value));
 } else if (!strcasecmp(name, "cc_agent_dialstring")) {
 ast_set_cc_agent_dialstring(params, value);
 } else if (!strcasecmp(name, "cc_callback_macro")) {
 ast_set_cc_callback_macro(params, value);
 return 0;
 } else if (!strcasecmp(name, "cc_callback_sub")) {
 ast_set_cc_callback_sub(params, value);
 return 0;
 }

 if (sscanf(value, "%30u", &value_as_uint) != 1) {
 return -1;
 }

 if (!strcasecmp(name, "cc_offer_timer")) {
 ast_set_cc_offer_timer(params, value_as_uint);
 } else if (!strcasecmp(name, "ccnr_available_timer")) {
 ast_set_ccnr_available_timer(params, value_as_uint);
 } else if (!strcasecmp(name, "ccbs_available_timer")) {
 ast_set_ccbs_available_timer(params, value_as_uint);
 } else if (!strcasecmp(name, "cc_max_agents")) {
 ast_set_cc_max_agents(params, value_as_uint);
 } else if (!strcasecmp(name, "cc_max_monitors")) {
 ast_set_cc_max_monitors(params, value_as_uint);
 } else if (!strcasecmp(name, "cc_recall_timer")) {
 ast_set_cc_recall_timer(params, value_as_uint);
 } else {
 ast_log(LOG_WARNING, "%s is not a valid CC parameter. Ignoring.\n", name);
 return -1;
 }

 return 0;
}

ast_get_cc_agent_dialstring()

const char* ast_get_cc_agent_dialstring

(

struct ast_cc_config_params *

config

)

Get the cc_agent_dialstring.

Since

1.8

Parameters

config

The configuration to retrieve the cc_agent_dialstring from

Returns

The cc_agent_dialstring from this configuration

Definition at line 960 of file ccss.c.

References ast_cc_config_params::cc_agent_dialstring.

Referenced by ast_cc_get_param().

{
 return config->cc_agent_dialstring;
}

ast_get_cc_agent_policy()

enum ast_cc_agent_policies ast_get_cc_agent_policy

(

struct ast_cc_config_params *

config

)

Get the cc_agent_policy.

Since

1.8

Parameters

config

The configuration to retrieve the policy from

Returns

The current cc_agent_policy for this configuration

Definition at line 866 of file ccss.c.

References ast_cc_config_params::cc_agent_policy.

Referenced by ast_cc_call_init(), ast_cc_get_param(), build_peer(), cc_core_init_instance(), and find_agent_callbacks().

{
 return config->cc_agent_policy;
}

ast_get_cc_callback_macro()

const char* ast_get_cc_callback_macro

(

struct ast_cc_config_params *

config

)

Get the name of the callback_macro.

Since

1.8

Parameters

config

The configuration to retrieve the callback_macro from

Returns

The callback_macro name

Definition at line 994 of file ccss.c.

References ast_cc_config_params::cc_callback_macro.

Referenced by ast_cc_get_param(), and generic_recall().

{
 return config->cc_callback_macro;
}

ast_get_cc_callback_sub()

const char* ast_get_cc_callback_sub

(

struct ast_cc_config_params *

config

)

Get the name of the callback subroutine.

Since

11

Parameters

config

The configuration to retrieve the callback_sub from

Returns

The callback_sub name

Definition at line 999 of file ccss.c.

References ast_cc_config_params::cc_callback_sub.

Referenced by ast_cc_get_param(), and generic_recall().

{
 return config->cc_callback_sub;
}

ast_get_cc_max_agents()

unsigned int ast_get_cc_max_agents

(

struct ast_cc_config_params *

config

)

Get the cc_max_agents.

Since

1.8

Parameters

config

The configuration to retrieve the cc_max_agents from

Returns

The cc_max_agents from this configuration

Definition at line 974 of file ccss.c.

References ast_cc_config_params::cc_max_agents.

Referenced by ast_cc_get_param(), and cc_core_init_instance().

{
 return config->cc_max_agents;
}

ast_get_cc_max_monitors()

unsigned int ast_get_cc_max_monitors

(

struct ast_cc_config_params *

config

)

Get the cc_max_monitors.

Since

1.8

Parameters

config

The configuration to retrieve the cc_max_monitors from

Returns

The cc_max_monitors from this configuration

Definition at line 984 of file ccss.c.

References ast_cc_config_params::cc_max_monitors.

Referenced by ast_cc_get_param(), and ast_queue_cc_frame().

{
 return config->cc_max_monitors;
}

ast_get_cc_monitor_policy()

enum ast_cc_monitor_policies ast_get_cc_monitor_policy

(

struct ast_cc_config_params *

config

)

Get the cc_monitor_policy.

Since

1.8

Parameters

config

The configuration to retrieve the cc_monitor_policy from

Returns

The cc_monitor_policy retrieved from the configuration

Definition at line 883 of file ccss.c.

References ast_cc_config_params::cc_monitor_policy.

Referenced by analog_call(), ast_cc_call_failed(), ast_cc_get_param(), dahdi_cc_callback(), and sip_handle_cc().

{
 return config->cc_monitor_policy;
}

ast_get_cc_offer_timer()

unsigned int ast_get_cc_offer_timer

(

struct ast_cc_config_params *

config

)

Get the cc_offer_timer.

Since

1.8

Parameters

config

The configuration to retrieve the cc_offer_timer from

Returns

The cc_offer_timer from this configuration

Definition at line 900 of file ccss.c.

References ast_cc_config_params::cc_offer_timer.

Referenced by ast_cc_get_param(), cc_generic_agent_start_offer_timer(), and sip_cc_agent_start_offer_timer().

{
 return config->cc_offer_timer;
}

ast_get_cc_recall_timer()

unsigned int ast_get_cc_recall_timer

(

struct ast_cc_config_params *

config

)

Get the cc_recall_timer.

Since

1.8

Parameters

config

The configuration to retrieve the cc_recall_timer from

Returns

The cc_recall_timer from this configuration

Definition at line 930 of file ccss.c.

References ast_cc_config_params::cc_recall_timer.

Referenced by ast_cc_get_param(), and generic_recall().

{
 return config->cc_recall_timer;
}

ast_get_ccbs_available_timer()

unsigned int ast_get_ccbs_available_timer

(

struct ast_cc_config_params *

config

)

Get the ccbs_available_timer.

Since

1.8

Parameters

config

The configuration to retrieve the ccbs_available_timer from

Returns

The ccbs_available_timer from this configuration

Definition at line 945 of file ccss.c.

References ast_cc_config_params::ccbs_available_timer.

Referenced by ast_cc_get_param(), cc_generic_monitor_request_cc(), and sip_cc_monitor_request_cc().

{
 return config->ccbs_available_timer;
}

ast_get_ccnr_available_timer()

unsigned int ast_get_ccnr_available_timer

(

struct ast_cc_config_params *

config

)

Get the ccnr_available_timer.

Since

1.8

Parameters

config

The configuration to retrieve the ccnr_available_timer from

Returns

The ccnr_available_timer from this configuration

Definition at line 915 of file ccss.c.

References ast_cc_config_params::ccnr_available_timer.

Referenced by ast_cc_get_param(), cc_generic_monitor_request_cc(), and sip_cc_monitor_request_cc().

{
 return config->ccnr_available_timer;
}

ast_handle_cc_control_frame()

void ast_handle_cc_control_frame	(	struct ast_channel *	inbound,
		struct ast_channel *	outbound,
		void *	frame_data
	)

Properly react to a CC control frame.

Unless we are ignoring CC for some reason, we will always call this function when we read an AST_CONTROL_CC frame from an outbound channel.

This function will call cc_device_monitor_init to create the new cc_monitor for the device from which we read the frame. In addition, the new device will be added to the monitor tree on the dialed_cc_interfaces datastore on the inbound channel.

If this is the first AST_CONTROL_CC frame that we have handled for this call, then we will also initialize the CC core for this call.

Definition at line 2316 of file ccss.c.

References ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, AST_CONTROL_CC, ast_indicate_data(), AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log, ast_log_dynamic_level, call_destructor_with_no_monitor(), cc_core_init_instance(), cc_device_monitor_init(), cc_extension_monitor_change_is_valid(), cc_logger_level, cc_publish_available(), cc_ref(), cc_service_to_string(), cc_unref(), cc_core_instance::core_id, dialed_cc_interfaces::core_id, ast_datastore::data, cc_control_payload::device_name, ast_cc_interface::device_name, cc_control_payload::dialstring, ast_cc_monitor::dialstring, find_cc_core_instance(), dialed_cc_interfaces::ignore, ast_cc_monitor::interface, dialed_cc_interfaces::interface_tree, dialed_cc_interfaces::is_original_caller, LOG_WARNING, monitor, cc_control_payload::monitor_type, NULL, ast_cc_monitor::parent_id, cc_control_payload::private_data, and cc_control_payload::service.

Referenced by ast_cc_busy_interface(), ast_cc_call_failed(), and wait_for_answer().

{
 char *device_name;
 char *dialstring;
 struct ast_cc_monitor *monitor;
 struct ast_datastore *cc_datastore;
 struct dialed_cc_interfaces *cc_interfaces;
 struct cc_control_payload *cc_data = frame_data;
 struct cc_core_instance *core_instance;

 device_name = cc_data->device_name;
 dialstring = cc_data->dialstring;

 ast_channel_lock(inbound);
 if (!(cc_datastore = ast_channel_datastore_find(inbound, &dialed_cc_interfaces_info, NULL))) {
 ast_log(LOG_WARNING, "Unable to retrieve CC datastore while processing CC frame from '%s'. CC services will be unavailable.\n", device_name);
 ast_channel_unlock(inbound);
 call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
 return;
 }

 cc_interfaces = cc_datastore->data;

 if (cc_interfaces->ignore) {
 ast_channel_unlock(inbound);
 call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
 return;
 }

 if (!cc_interfaces->is_original_caller) {
 /* If the is_original_caller is not set on the *inbound* channel, then
 * it must be a local channel. As such, we do not want to create a core instance
 * or an agent for the local channel. Instead, we want to pass this along to the
 * other side of the local channel so that the original caller can benefit.
 */
 ast_channel_unlock(inbound);
 ast_indicate_data(inbound, AST_CONTROL_CC, cc_data, sizeof(*cc_data));
 return;
 }

 core_instance = find_cc_core_instance(cc_interfaces->core_id);
 if (!core_instance) {
 core_instance = cc_core_init_instance(inbound, cc_interfaces->interface_tree,
 cc_interfaces->core_id, cc_data);
 if (!core_instance) {
 cc_interfaces->ignore = 1;
 ast_channel_unlock(inbound);
 call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
 return;
 }
 }

 ast_channel_unlock(inbound);

 /* Yeah this kind of sucks, but luckily most people
 * aren't dialing thousands of interfaces on every call
 *
 * This traversal helps us to not create duplicate monitors in
 * case a device queues multiple CC control frames.
 */
 AST_LIST_LOCK(cc_interfaces->interface_tree);
 AST_LIST_TRAVERSE(cc_interfaces->interface_tree, monitor, next) {
 if (!strcmp(monitor->interface->device_name, device_name)) {
 ast_log_dynamic_level(cc_logger_level, "Core %d: Device %s sent us multiple CC control frames. Ignoring those beyond the first.\n",
 core_instance->core_id, device_name);
 AST_LIST_UNLOCK(cc_interfaces->interface_tree);
 cc_unref(core_instance, "Returning early from ast_handle_cc_control_frame. Unref core_instance");
 call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
 return;
 }
 }
 AST_LIST_UNLOCK(cc_interfaces->interface_tree);

 if (!(monitor = cc_device_monitor_init(device_name, dialstring, cc_data, core_instance->core_id))) {
 ast_log(LOG_WARNING, "Unable to create CC device interface for '%s'. CC services will be unavailable on this interface.\n", device_name);
 cc_unref(core_instance, "Returning early from ast_handle_cc_control_frame. Unref core_instance");
 call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
 return;
 }

 AST_LIST_LOCK(cc_interfaces->interface_tree);
 cc_ref(monitor, "monitor tree's reference to the monitor");
 AST_LIST_INSERT_TAIL(cc_interfaces->interface_tree, monitor, next);
 AST_LIST_UNLOCK(cc_interfaces->interface_tree);

 cc_extension_monitor_change_is_valid(core_instance, monitor->parent_id, monitor->interface->device_name, 0);

 cc_publish_available(cc_interfaces->core_id, device_name, cc_service_to_string(cc_data->service));

 cc_unref(core_instance, "Done with core_instance after handling CC control frame");
 cc_unref(monitor, "Unref reference from allocating monitor");
}

ast_ignore_cc()

void ast_ignore_cc

(

struct ast_channel *

chan

)

Mark the channel to ignore further CC activity.

Since

1.8

When a CC-capable application, such as Dial, has finished with all CC processing for a channel and knows that any further CC processing should be ignored, this function should be called.

Parameters

chan	The channel for which further CC processing should be ignored.

Return values

void

Definition at line 3720 of file ccss.c.

References ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, ast_datastore::data, dialed_cc_interfaces::ignore, cc_recall_ds_data::ignore, and NULL.

Referenced by dial_exec_full(), and do_forward().

{
 struct ast_datastore *cc_datastore;
 struct ast_datastore *cc_recall_datastore;
 struct dialed_cc_interfaces *cc_interfaces;
 struct cc_recall_ds_data *recall_cc_data;

 ast_channel_lock(chan);
 if ((cc_datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
 cc_interfaces = cc_datastore->data;
 cc_interfaces->ignore = 1;
 }

 if ((cc_recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
 recall_cc_data = cc_recall_datastore->data;
 recall_cc_data->ignore = 1;
 }
 ast_channel_unlock(chan);
}

AST_MODULE_SELF_SYM()

struct ast_module* AST_MODULE_SELF_SYM

(

void

)

Definition at line 4703 of file ccss.c.

ast_queue_cc_frame()

int ast_queue_cc_frame	(	struct ast_channel *	chan,
		const char *const	monitor_type,
		const char *const	dialstring,
		enum ast_cc_service_type	service,
		void *	private_data
	)

Queue an AST_CONTROL_CC frame.

Since

1.8

Note

Since this function calls ast_queue_frame, the channel will be locked during the course of this function.

Parameters

chan	The channel onto which to queue the frame
monitor_type	The type of monitor to use when CC is requested
dialstring	The dial string used to call the device
service	The type of CC service the device is willing to offer
private_data	If a native monitor is being used, and some channel-driver-specific private data has been allocated, then this parameter should contain a pointer to that data. If using a generic monitor, this parameter should remain NULL. Note that if this function should fail at some point, it is the responsibility of the caller to free the private data upon return.

Return values

0	Success
-1	Error

Definition at line 4149 of file ccss.c.

References ast_cc_build_frame(), ast_cc_monitor_count(), ast_channel_get_cc_config_params(), ast_channel_get_device_name(), AST_CHANNEL_NAME, ast_frfree, ast_get_cc_max_monitors(), ast_log, ast_queue_frame(), LOG_NOTICE, and retval.

Referenced by analog_call(), and sip_handle_cc().

{
 struct ast_frame frame = {0,};
 char device_name[AST_CHANNEL_NAME];
 int retval;
 struct ast_cc_config_params *cc_params;

 cc_params = ast_channel_get_cc_config_params(chan);
 if (!cc_params) {
 return -1;
 }
 ast_channel_get_device_name(chan, device_name, sizeof(device_name));
 if (ast_cc_monitor_count(device_name, monitor_type) >= ast_get_cc_max_monitors(cc_params)) {
 ast_log(LOG_NOTICE, "Not queuing a CC frame for device %s since it already has its maximum monitors allocated\n", device_name);
 return -1;
 }

 if (ast_cc_build_frame(chan, cc_params, monitor_type, device_name, dialstring, service, private_data, &frame)) {
 /* Frame building failed. We can't use this. */
 return -1;
 }
 retval = ast_queue_frame(chan, &frame);
 ast_frfree(&frame);
 return retval;
}

ast_set_cc_agent_dialstring()

void ast_set_cc_agent_dialstring	(	struct ast_cc_config_params *	config,
		const char *const	value
	)

Set the cc_agent_dialstring.

Since

1.8

Parameters

config	The configuration to set the cc_agent_dialstring on
value	The new cc_agent_dialstring we want to change to

Return values

void

Definition at line 965 of file ccss.c.

References ast_copy_string(), ast_strlen_zero, and ast_cc_config_params::cc_agent_dialstring.

Referenced by ast_cc_set_param().

{
 if (ast_strlen_zero(value)) {
 config->cc_agent_dialstring[0] = '\0';
 } else {
 ast_copy_string(config->cc_agent_dialstring, value, sizeof(config->cc_agent_dialstring));
 }
}

ast_set_cc_agent_policy()

int ast_set_cc_agent_policy	(	struct ast_cc_config_params *	config,
		enum ast_cc_agent_policies	value
	)

Set the cc_agent_policy.

Since

1.8

Parameters

config	The configuration to set the cc_agent_policy on
value	The new cc_agent_policy we want to change to

Return values

0	Success
-1	Failure (likely due to bad input)

Definition at line 871 of file ccss.c.

References AST_CC_AGENT_GENERIC, ast_cc_config_params::cc_agent_policy, and value.

Referenced by ast_cc_set_param(), and build_peer().

{
 /* Screw C and its weak type checking for making me have to do this
 * validation at runtime.
 */
 if (value < AST_CC_AGENT_NEVER || value > AST_CC_AGENT_GENERIC) {
 return -1;
 }
 config->cc_agent_policy = value;
 return 0;
}

ast_set_cc_callback_macro()

void ast_set_cc_callback_macro	(	struct ast_cc_config_params *	config,
		const char *const	value
	)

Set the callback_macro name.

Since

1.8

Parameters

config	The configuration to set the callback_macro on
value	The new callback macro we want to change to

Return values

void

Definition at line 1004 of file ccss.c.

References ast_copy_string(), ast_log, ast_strlen_zero, ast_cc_config_params::cc_callback_macro, and LOG_WARNING.

Referenced by ast_cc_set_param().

{
 ast_log(LOG_WARNING, "Usage of cc_callback_macro is deprecated. Please use cc_callback_sub instead.\n");
 if (ast_strlen_zero(value)) {
 config->cc_callback_macro[0] = '\0';
 } else {
 ast_copy_string(config->cc_callback_macro, value, sizeof(config->cc_callback_macro));
 }
}

ast_set_cc_callback_sub()

void ast_set_cc_callback_sub	(	struct ast_cc_config_params *	config,
		const char *const	value
	)

Set the callback subroutine name.

Since

11

Parameters

config	The configuration to set the callback_sub on
value	The new callback subroutine we want to change to

Return values

void

Definition at line 1014 of file ccss.c.

References ast_copy_string(), ast_strlen_zero, and ast_cc_config_params::cc_callback_sub.

Referenced by ast_cc_set_param().

{
 if (ast_strlen_zero(value)) {
 config->cc_callback_sub[0] = '\0';
 } else {
 ast_copy_string(config->cc_callback_sub, value, sizeof(config->cc_callback_sub));
 }
}

ast_set_cc_interfaces_chanvar()

int ast_set_cc_interfaces_chanvar	(	struct ast_channel *	chan,
		const char *const	extension
	)

Set the CC_INTERFACES channel variable for a channel using an.

Since

1.8

extension@context 

as a starting point

The CC_INTERFACES channel variable will have the interfaces that should be called back for a specific PBX instance. This version of the function is used mainly by local channels, wherein we need to set CC_INTERFACES based on an extension and context that appear in the middle of the tree of dialed interfaces.

Note

This function will lock the channel as well as the list of monitors stored on the channel's CC recall datastore, though neither are held at the same time. Callers of this function should be aware of potential lock ordering problems that may arise.

Parameters

chan	The channel to set the CC_INTERFACES variable on
extension	The name of the extension for which we're setting the variable. This should be in the form of exten@context

Definition at line 3668 of file ccss.c.

References ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, ast_free, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log_dynamic_level, ast_str_buffer(), ast_str_create, build_cc_interfaces_chanvar(), cc_logger_level, cc_recall_ds_data::core_id, ast_datastore::data, ast_cc_interface::device_name, ast_cc_monitor::interface, cc_recall_ds_data::interface_tree, NULL, pbx_builtin_setvar_helper(), and str.

Referenced by local_call().

{
 struct ast_datastore *recall_datastore;
 struct cc_monitor_tree *interface_tree;
 struct ast_cc_monitor *monitor_iter;
 struct cc_recall_ds_data *recall_data;
 struct ast_str *str = ast_str_create(64);
 int core_id;

 if (!str) {
 return -1;
 }

 ast_channel_lock(chan);
 if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
 ast_channel_unlock(chan);
 ast_free(str);
 return -1;
 }
 recall_data = recall_datastore->data;
 interface_tree = recall_data->interface_tree;
 core_id = recall_data->core_id;
 ast_channel_unlock(chan);

 AST_LIST_LOCK(interface_tree);
 AST_LIST_TRAVERSE(interface_tree, monitor_iter, next) {
 if (!strcmp(monitor_iter->interface->device_name, extension)) {
 break;
 }
 }

 if (!monitor_iter) {
 /* We couldn't find this extension. This may be because
 * we have been directed into an unexpected extension because
 * the admin has changed a CC_INTERFACES variable at some point.
 */
 AST_LIST_UNLOCK(interface_tree);
 ast_free(str);
 return -1;
 }

 build_cc_interfaces_chanvar(monitor_iter, &str);
 AST_LIST_UNLOCK(interface_tree);

 pbx_builtin_setvar_helper(chan, "CC_INTERFACES", ast_str_buffer(str));
 ast_log_dynamic_level(cc_logger_level, "Core %d: CC_INTERFACES set to %s\n",
 core_id, ast_str_buffer(str));

 ast_free(str);
 return 0;
}

ast_set_cc_max_agents()

void ast_set_cc_max_agents	(	struct ast_cc_config_params *	config,
		unsigned int	value
	)

Set the cc_max_agents.

Since

1.8

Parameters

config	The configuration to set the cc_max_agents on
value	The new cc_max_agents we want to change to

Return values

void

Definition at line 979 of file ccss.c.

References ast_cc_config_params::cc_max_agents, and value.

Referenced by ast_cc_set_param().

{
 config->cc_max_agents = value;
}

ast_set_cc_max_monitors()

void ast_set_cc_max_monitors	(	struct ast_cc_config_params *	config,
		unsigned int	value
	)

Set the cc_max_monitors.

Since

1.8

Parameters

config	The configuration to set the cc_max_monitors on
value	The new cc_max_monitors we want to change to

Return values

void

Definition at line 989 of file ccss.c.

References ast_cc_config_params::cc_max_monitors, and value.

Referenced by ast_cc_set_param().

{
 config->cc_max_monitors = value;
}

ast_set_cc_monitor_policy()

int ast_set_cc_monitor_policy	(	struct ast_cc_config_params *	config,
		enum ast_cc_monitor_policies	value
	)

Set the cc_monitor_policy.

Since

1.8

Parameters

config	The configuration to set the cc_monitor_policy on
value	The new cc_monitor_policy we want to change to

Return values

0	Success
-1	Failure (likely due to bad input)

Definition at line 888 of file ccss.c.

References AST_CC_MONITOR_ALWAYS, ast_cc_config_params::cc_monitor_policy, and value.

Referenced by ast_cc_set_param().

{
 /* Screw C and its weak type checking for making me have to do this
 * validation at runtime.
 */
 if (value < AST_CC_MONITOR_NEVER || value > AST_CC_MONITOR_ALWAYS) {
 return -1;
 }
 config->cc_monitor_policy = value;
 return 0;
}

ast_set_cc_offer_timer()

void ast_set_cc_offer_timer	(	struct ast_cc_config_params *	config,
		unsigned int	value
	)

Set the cc_offer_timer.

Since

1.8

Parameters

config	The configuration to set the cc_offer_timer on
value	The new cc_offer_timer we want to change to

Return values

void

Definition at line 905 of file ccss.c.

References ast_log, ast_cc_config_params::cc_offer_timer, LOG_WARNING, and value.

Referenced by ast_cc_set_param().

{
 /* 0 is an unreasonable value for any timer. Stick with the default */
 if (value == 0) {
 ast_log(LOG_WARNING, "0 is an invalid value for cc_offer_timer. Retaining value as %u\n", config->cc_offer_timer);
 return;
 }
 config->cc_offer_timer = value;
}

ast_set_cc_recall_timer()

void ast_set_cc_recall_timer	(	struct ast_cc_config_params *	config,
		unsigned int	value
	)

Set the cc_recall_timer.

Since

1.8

Parameters

config	The configuration to set the cc_recall_timer on
value	The new cc_recall_timer we want to change to

Return values

void

Definition at line 935 of file ccss.c.

References ast_log, ast_cc_config_params::cc_recall_timer, LOG_WARNING, and value.

Referenced by ast_cc_set_param().

{
 /* 0 is an unreasonable value for any timer. Stick with the default */
 if (value == 0) {
 ast_log(LOG_WARNING, "0 is an invalid value for ccnr_available_timer. Retaining value as %u\n", config->cc_recall_timer);
 return;
 }
 config->cc_recall_timer = value;
}

ast_set_ccbs_available_timer()

void ast_set_ccbs_available_timer	(	struct ast_cc_config_params *	config,
		unsigned int	value
	)

Set the ccbs_available_timer.

Since

1.8

Parameters

config	The configuration to set the ccbs_available_timer on
value	The new ccbs_available_timer we want to change to

Return values

void

Definition at line 950 of file ccss.c.

References ast_log, ast_cc_config_params::ccbs_available_timer, LOG_WARNING, and value.

Referenced by ast_cc_set_param().

{
 /* 0 is an unreasonable value for any timer. Stick with the default */
 if (value == 0) {
 ast_log(LOG_WARNING, "0 is an invalid value for ccbs_available_timer. Retaining value as %u\n", config->ccbs_available_timer);
 return;
 }
 config->ccbs_available_timer = value;
}

ast_set_ccnr_available_timer()

void ast_set_ccnr_available_timer	(	struct ast_cc_config_params *	config,
		unsigned int	value
	)

Set the ccnr_available_timer.

Since

1.8

Parameters

config	The configuration to set the ccnr_available_timer on
value	The new ccnr_available_timer we want to change to

Return values

void

Definition at line 920 of file ccss.c.

References ast_log, ast_cc_config_params::ccnr_available_timer, LOG_WARNING, and value.

Referenced by ast_cc_set_param().

{
 /* 0 is an unreasonable value for any timer. Stick with the default */
 if (value == 0) {
 ast_log(LOG_WARNING, "0 is an invalid value for ccnr_available_timer. Retaining value as %u\n", config->ccnr_available_timer);
 return;
 }
 config->ccnr_available_timer = value;
}

ast_setup_cc_recall_datastore()

int ast_setup_cc_recall_datastore	(	struct ast_channel *	chan,
		const int	core_id
	)

Set up a CC recall datastore on a channel.

Since

1.8

Implementers of protocol-specific CC agents will need to call this function in order for the channel to have the necessary interfaces to recall.

This function must be called by the implementer once it has been detected that an inbound call is a cc_recall. After allocating the channel, call this function, followed by ast_cc_set_cc_interfaces_chanvar. While it would be nice to be able to have the core do this automatically, it just cannot be done given the current architecture.

Definition at line 3405 of file ccss.c.

References ast_calloc, ast_channel_datastore_add(), ast_channel_lock, ast_channel_unlock, ast_datastore_alloc, ast_datastore_free(), ast_free, cc_ref(), cc_unref(), cc_core_instance::core_id, cc_recall_ds_data::core_id, ast_datastore::data, DATASTORE_INHERIT_FOREVER, find_cc_core_instance(), ast_datastore::inheritance, cc_recall_ds_data::interface_tree, cc_core_instance::monitors, and NULL.

Referenced by generic_recall(), and handle_request_invite().

{
 struct ast_datastore *recall_datastore = ast_datastore_alloc(&recall_ds_info, NULL);
 struct cc_recall_ds_data *recall_data;
 struct cc_core_instance *core_instance;

 if (!recall_datastore) {
 return -1;
 }

 if (!(recall_data = ast_calloc(1, sizeof(*recall_data)))) {
 ast_datastore_free(recall_datastore);
 return -1;
 }

 if (!(core_instance = find_cc_core_instance(core_id))) {
 ast_free(recall_data);
 ast_datastore_free(recall_datastore);
 return -1;
 }

 recall_data->interface_tree = cc_ref(core_instance->monitors,
 "Bump refcount for monitor tree for recall datastore");
 recall_data->core_id = core_id;
 recall_datastore->data = recall_data;
 recall_datastore->inheritance = DATASTORE_INHERIT_FOREVER;
 ast_channel_lock(chan);
 ast_channel_datastore_add(chan, recall_datastore);
 ast_channel_unlock(chan);
 cc_unref(core_instance, "Recall datastore set up. No need for core_instance ref");
 return 0;
}

build_cc_interfaces_chanvar()

static void build_cc_interfaces_chanvar ( struct ast_cc_monitor *  starting_point, struct ast_str **  str  )

static

Definition at line 3588 of file ccss.c.

References AST_LIST_NEXT, AST_LIST_TRAVERSE, ast_log, ast_str_strlen(), ast_str_truncate(), cc_unique_append(), extension_monitor_pvt::child_dialstrings, ast_cc_interface::device_name, ast_cc_monitor::dialstring, ast_cc_monitor::id, ast_cc_monitor::interface, extension_child_dialstring::is_valid, LOG_ERROR, ast_cc_monitor::next, extension_child_dialstring::original_dialstring, ast_cc_monitor::parent_id, and ast_cc_monitor::private_data.

Referenced by ast_cc_agent_set_interfaces_chanvar(), and ast_set_cc_interfaces_chanvar().

{
 struct extension_monitor_pvt *extension_pvt;
 struct extension_child_dialstring *child_dialstring;
 struct ast_cc_monitor *monitor_iter = starting_point;
 int top_level_id = starting_point->id;
 size_t length;

 /* Init to an empty string. */
 ast_str_truncate(*str, 0);

 /* First we need to take all of the is_valid child_dialstrings from
 * the extension monitor we found and add them to the CC_INTERFACES
 * chanvar
 */
 extension_pvt = starting_point->private_data;
 AST_LIST_TRAVERSE(&extension_pvt->child_dialstrings, child_dialstring, next) {
 if (child_dialstring->is_valid) {
 cc_unique_append(str, child_dialstring->original_dialstring);
 }
 }

 /* And now we get the dialstrings from each of the device monitors */
 while ((monitor_iter = AST_LIST_NEXT(monitor_iter, next))) {
 if (monitor_iter->parent_id == top_level_id) {
 cc_unique_append(str, monitor_iter->dialstring);
 }
 }

 /* str will have an extra '&' tacked onto the end of it, so we need
 * to get rid of that.
 */
 length = ast_str_strlen(*str);
 if (length) {
 ast_str_truncate(*str, length - 1);
 }
 if (length <= 1) {
 /* Nothing to recall? This should not happen. */
 ast_log(LOG_ERROR, "CC_INTERFACES is empty. starting device_name:'%s'\n",
 starting_point->interface->device_name);
 }
}

call_destructor_with_no_monitor()

static void call_destructor_with_no_monitor ( const char *const  monitor_type, void *  private_data  )

static

Definition at line 2216 of file ccss.c.

References ast_cc_monitor_callbacks::destructor, and find_monitor_callbacks().

Referenced by ast_cc_busy_interface(), and ast_handle_cc_control_frame().

{
 const struct ast_cc_monitor_callbacks *monitor_callbacks = find_monitor_callbacks(monitor_type);

 if (!monitor_callbacks) {
 return;
 }

 monitor_callbacks->destructor(private_data);
}

cancel_available_timer()

static void cancel_available_timer ( struct cc_core_instance *  core_instance )

static

Definition at line 3226 of file ccss.c.

References AST_CC_DEVICE_MONITOR, ast_cc_failed(), AST_LIST_LOCK, AST_LIST_REMOVE_CURRENT, AST_LIST_TRAVERSE_SAFE_BEGIN, AST_LIST_TRAVERSE_SAFE_END, AST_LIST_UNLOCK, ast_cc_monitor::available_timer_id, ast_cc_monitor::callbacks, ast_cc_monitor_callbacks::cancel_available_timer, cc_extension_monitor_change_is_valid(), cc_unref(), cc_core_instance::core_id, ast_cc_interface::device_name, has_device_monitors(), ast_cc_monitor::interface, ast_cc_interface::monitor_class, cc_core_instance::monitors, ast_cc_monitor::next, and ast_cc_monitor::parent_id.

Referenced by cc_recalling().

{
 struct ast_cc_monitor *monitor_iter;
 AST_LIST_LOCK(core_instance->monitors);
 AST_LIST_TRAVERSE_SAFE_BEGIN(core_instance->monitors, monitor_iter, next) {
 if (monitor_iter->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
 if (monitor_iter->callbacks->cancel_available_timer(monitor_iter, &monitor_iter->available_timer_id)) {
 AST_LIST_REMOVE_CURRENT(next);
 cc_extension_monitor_change_is_valid(core_instance, monitor_iter->parent_id,
 monitor_iter->interface->device_name, 1);
 cc_unref(monitor_iter, "cancel_available_timer failed. Unref list's reference to monitor");
 }
 }
 }
 AST_LIST_TRAVERSE_SAFE_END;

 if (!has_device_monitors(core_instance)) {
 ast_cc_failed(core_instance->core_id, "All device monitors failed to cancel their available timers");
 }
 AST_LIST_UNLOCK(core_instance->monitors);
}

cc_active()

static int cc_active ( struct cc_core_instance *  core_instance, struct cc_state_change_args *  args, enum cc_state  previous_state  )

static

Definition at line 3168 of file ccss.c.

References cc_core_instance::agent, AST_CC_AGENT_RESPONSE_SUCCESS, ast_cc_agent::callbacks, CC_CALLER_BUSY, CC_CALLER_REQUESTED, cc_publish_callerstopmonitoring(), cc_publish_requestacknowledged(), cc_core_instance::core_id, ast_cc_agent::device_name, ast_cc_agent_callbacks::respond, and unsuspend().

{
 /* Either
 * 1. Callee accepted CC request, call agent's ack callback.
 * 2. Caller became available, call agent's stop_monitoring callback and
 * call monitor's unsuspend callback.
 */
 if (previous_state == CC_CALLER_REQUESTED) {
 core_instance->agent->callbacks->respond(core_instance->agent,
 AST_CC_AGENT_RESPONSE_SUCCESS);
 cc_publish_requestacknowledged(core_instance->core_id, core_instance->agent->device_name);
 } else if (previous_state == CC_CALLER_BUSY) {
 cc_publish_callerstopmonitoring(core_instance->core_id, core_instance->agent->device_name);
 unsuspend(core_instance);
 }
 /* Not possible for previous_state to be anything else due to the is_state_change_valid check at the beginning */
 return 0;
}

cc_agent_callback_helper()

static int cc_agent_callback_helper ( void *  obj, void *  args, int  flags  )

static

Definition at line 444 of file ccss.c.

References cc_core_instance::agent, args, cc_callback_helper::args, ast_cc_agent::callbacks, cc_callback_helper::function, cc_callback_helper::type, and ast_cc_agent_callbacks::type.

Referenced by ast_cc_agent_callback().

{
 struct cc_core_instance *core_instance = obj;
 struct cc_callback_helper *helper = args;

 if (strcmp(core_instance->agent->callbacks->type, helper->type)) {
 return 0;
 }

 return helper->function(core_instance->agent, helper->args, flags);
}

cc_agent_init()

static struct ast_cc_agent* cc_agent_init ( struct ast_channel *  caller_chan, const char *const  caller_name, const int  core_id, struct cc_monitor_tree *  interface_tree  )

static

Definition at line 2554 of file ccss.c.

References agent_destroy(), ao2_t_alloc, ast_cc_config_params_init, ast_cc_copy_config_params(), ast_channel_get_cc_config_params(), ast_log_dynamic_level, ast_cc_agent::callbacks, cc_generic_agent_destructor(), cc_generic_agent_init(), cc_generic_agent_recall(), cc_generic_agent_respond(), cc_generic_agent_start_monitoring(), cc_generic_agent_start_offer_timer(), cc_generic_agent_status_request(), cc_generic_agent_stop_offer_timer(), cc_generic_agent_stop_ringing(), cc_logger_level, ast_cc_agent::cc_params, cc_unref(), check_callback_sanity(), ast_cc_agent::core_id, ast_cc_agent::device_name, find_agent_callbacks(), ast_cc_agent_callbacks::init, and NULL.

Referenced by cc_core_init_instance().

{
 struct ast_cc_agent *agent;
 struct ast_cc_config_params *cc_params;

 if (!(agent = ao2_t_alloc(sizeof(*agent) + strlen(caller_name), agent_destroy,
 "Allocating new ast_cc_agent"))) {
 return NULL;
 }

 agent->core_id = core_id;
 strcpy(agent->device_name, caller_name);

 cc_params = ast_channel_get_cc_config_params(caller_chan);
 if (!cc_params) {
 cc_unref(agent, "Could not get channel config params.");
 return NULL;
 }
 if (!(agent->cc_params = ast_cc_config_params_init())) {
 cc_unref(agent, "Could not init agent config params.");
 return NULL;
 }
 ast_cc_copy_config_params(agent->cc_params, cc_params);

 if (!(agent->callbacks = find_agent_callbacks(caller_chan))) {
 cc_unref(agent, "Could not find agent callbacks.");
 return NULL;
 }
 check_callback_sanity(agent->callbacks);

 if (agent->callbacks->init(agent, caller_chan)) {
 cc_unref(agent, "Agent init callback failed.");
 return NULL;
 }
 ast_log_dynamic_level(cc_logger_level, "Core %u: Created an agent for caller %s\n",
 agent->core_id, agent->device_name);
 return agent;
}

cc_available()

static int cc_available ( struct cc_core_instance *  core_instance, struct cc_state_change_args *  args, enum cc_state  previous_state  )

static

Definition at line 3057 of file ccss.c.

References ast_log, and LOG_WARNING.

{
 /* This should never happen... */
 ast_log(LOG_WARNING, "Someone requested to change to CC_AVAILABLE? Ignoring.\n");
 return -1;
}

cc_build_payload()

static int cc_build_payload ( struct ast_channel *  chan, struct ast_cc_config_params *  cc_params, const char *  monitor_type, const char *const  device_name, const char *  dialstring, enum ast_cc_service_type  service, void *  private_data, struct cc_control_payload *  payload  )

static

Definition at line 4121 of file ccss.c.

References ast_cc_copy_config_params(), ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, ast_copy_string(), cc_control_payload::config_params, ast_datastore::data, cc_control_payload::device_name, dialed_cc_interfaces::dial_parent_id, cc_control_payload::dialstring, cc_control_payload::monitor_type, NULL, cc_control_payload::parent_interface_id, cc_control_payload::private_data, cc_control_payload::service, and service.

Referenced by ast_cc_build_frame(), ast_cc_busy_interface(), and ast_cc_call_failed().

{
 struct ast_datastore *datastore;
 struct dialed_cc_interfaces *cc_interfaces;
 int dial_parent_id;

 ast_channel_lock(chan);
 datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL);
 if (!datastore) {
 ast_channel_unlock(chan);
 return -1;
 }
 cc_interfaces = datastore->data;
 dial_parent_id = cc_interfaces->dial_parent_id;
 ast_channel_unlock(chan);

 payload->monitor_type = monitor_type;
 payload->private_data = private_data;
 payload->service = service;
 ast_cc_copy_config_params(&payload->config_params, cc_params);
 payload->parent_interface_id = dial_parent_id;
 ast_copy_string(payload->device_name, device_name, sizeof(payload->device_name));
 ast_copy_string(payload->dialstring, dialstring, sizeof(payload->dialstring));
 return 0;
}

cc_callee_ready()

static int cc_callee_ready ( struct cc_core_instance *  core_instance, struct cc_state_change_args *  args, enum cc_state  previous_state  )

static

Definition at line 3187 of file ccss.c.

References cc_core_instance::agent, ast_cc_agent::callbacks, and ast_cc_agent_callbacks::callee_available.

{
 core_instance->agent->callbacks->callee_available(core_instance->agent);
 return 0;
}

cc_caller_busy()

static int cc_caller_busy ( struct cc_core_instance *  core_instance, struct cc_state_change_args *  args, enum cc_state  previous_state  )

static

Definition at line 3215 of file ccss.c.

References cc_core_instance::agent, ast_cc_agent::callbacks, cc_publish_callerstartmonitoring(), cc_core_instance::core_id, ast_cc_agent::device_name, ast_cc_agent_callbacks::start_monitoring, and suspend().

{
 /* Callee was available, but caller was busy, call agent's begin_monitoring callback
 * and call monitor's suspend callback.
 */
 suspend(core_instance);
 core_instance->agent->callbacks->start_monitoring(core_instance->agent);
 cc_publish_callerstartmonitoring(core_instance->core_id, core_instance->agent->device_name);
 return 0;
}

cc_caller_offered()

static int cc_caller_offered ( struct cc_core_instance *  core_instance, struct cc_state_change_args *  args, enum cc_state  previous_state  )

static

Definition at line 3064 of file ccss.c.

References cc_core_instance::agent, ast_cc_failed(), ast_log_dynamic_level, ast_cc_agent::callbacks, cc_logger_level, ast_cc_config_params::cc_offer_timer, ast_cc_agent::cc_params, cc_publish_offertimerstart(), cc_core_instance::core_id, ast_cc_agent::device_name, and ast_cc_agent_callbacks::start_offer_timer.

{
 if (core_instance->agent->callbacks->start_offer_timer(core_instance->agent)) {
 ast_cc_failed(core_instance->core_id, "Failed to start the offer timer for %s\n",
 core_instance->agent->device_name);
 return -1;
 }
 cc_publish_offertimerstart(core_instance->core_id, core_instance->agent->device_name, core_instance->agent->cc_params->cc_offer_timer);
 ast_log_dynamic_level(cc_logger_level, "Core %d: Started the offer timer for the agent %s!\n",
 core_instance->core_id, core_instance->agent->device_name);
 return 0;
}

cc_caller_requested()

static int cc_caller_requested ( struct cc_core_instance *  core_instance, struct cc_state_change_args *  args, enum cc_state  previous_state  )

static

Definition at line 3132 of file ccss.c.

References cc_core_instance::agent, AST_CC_AGENT_RESPONSE_FAILURE_TOO_MANY, ast_cc_failed(), ast_cc_request_is_within_limits(), ast_log, ast_cc_agent::callbacks, cc_core_instance::core_id, LOG_WARNING, request_cc(), ast_cc_agent_callbacks::respond, and ast_cc_agent_callbacks::stop_offer_timer.

{
 if (!ast_cc_request_is_within_limits()) {
 ast_log(LOG_WARNING, "Cannot request CC since there is no more room for requests\n");
 core_instance->agent->callbacks->respond(core_instance->agent,
 AST_CC_AGENT_RESPONSE_FAILURE_TOO_MANY);
 ast_cc_failed(core_instance->core_id, "Too many requests in the system");
 return -1;
 }
 core_instance->agent->callbacks->stop_offer_timer(core_instance->agent);
 request_cc(core_instance);
 return 0;
}

cc_cli_output_status()

static int cc_cli_output_status ( void *  data )

static

Definition at line 4494 of file ccss.c.

References ao2_container_count(), ao2_t_callback, ast_cli(), ast_free, OBJ_NODATA, and print_stats_cb().

Referenced by handle_cc_status().

{
 int *cli_fd = data;
 int count = ao2_container_count(cc_core_instances);

 if (!count) {
 ast_cli(*cli_fd, "There are currently no active call completion transactions\n");
 } else {
 ast_cli(*cli_fd, "%d Call completion transactions\n", count);
 ast_cli(*cli_fd, "Core ID\t\tCaller\t\t\t\tStatus\n");
 ast_cli(*cli_fd, "----------------------------------------------------------------------------\n");
 ao2_t_callback(cc_core_instances, OBJ_NODATA, print_stats_cb, cli_fd, "Printing stats to CLI");
 }
 ast_free(cli_fd);
 return 0;
}

cc_cli_print_monitor_stats()

static void cc_cli_print_monitor_stats ( struct ast_cc_monitor *  monitor, int  fd, int  parent_id  )

static

Definition at line 4461 of file ccss.c.

References AST_CC_DEVICE_MONITOR, ast_cli(), AST_LIST_NEXT, cc_service_to_string(), ast_cc_interface::device_name, ast_cc_monitor::id, ast_cc_monitor::interface, monitor, ast_cc_interface::monitor_class, ast_cc_monitor::next, ast_cc_monitor::parent_id, and ast_cc_monitor::service_offered.

Referenced by print_stats_cb().

{
 struct ast_cc_monitor *child_monitor_iter = monitor;
 if (!monitor) {
 return;
 }

 ast_cli(fd, "\t\t|-->%s", monitor->interface->device_name);
 if (monitor->interface->monitor_class == AST_CC_DEVICE_MONITOR) {
 ast_cli(fd, "(%s)", cc_service_to_string(monitor->service_offered));
 }
 ast_cli(fd, "\n");

 while ((child_monitor_iter = AST_LIST_NEXT(child_monitor_iter, next))) {
 if (child_monitor_iter->parent_id == monitor->id) {
 cc_cli_print_monitor_stats(child_monitor_iter, fd, child_monitor_iter->id);
 }
 }
}

cc_complete()

static int cc_complete ( struct cc_core_instance *  core_instance, struct cc_state_change_args *  args, enum cc_state  previous_state  )

static

Definition at line 3257 of file ccss.c.

References cc_core_instance::agent, ao2_t_unlink, cc_publish_recallcomplete(), cc_core_instance::core_id, and ast_cc_agent::device_name.

{
 /* Recall has made progress, call agent and monitor destructor functions
 */
 cc_publish_recallcomplete(core_instance->core_id, core_instance->agent->device_name);
 ao2_t_unlink(cc_core_instances, core_instance, "Unlink core instance since CC recall has completed");
 return 0;
}

cc_core_init_instance()

static struct cc_core_instance * cc_core_init_instance ( struct ast_channel *  caller_chan, struct cc_monitor_tree *  called_tree, const int  core_id, struct cc_control_payload *  cc_data  )

static

Definition at line 2940 of file ccss.c.

References cc_core_instance::agent, ao2_t_alloc, ao2_t_link, AST_CC_AGENT_GENERIC, ast_cc_is_recall(), ast_channel_get_cc_config_params(), ast_channel_get_device_name(), AST_CHANNEL_NAME, ast_get_cc_agent_policy(), ast_get_cc_max_agents(), ast_log_dynamic_level, cc_agent_init(), cc_core_instance_destructor(), cc_logger_level, cc_ref(), cc_unref(), cc_core_instance::core_id, count_agents(), kill_duplicate_offers(), cc_core_instance::monitors, and NULL.

Referenced by ast_handle_cc_control_frame().

{
 char caller[AST_CHANNEL_NAME];
 struct cc_core_instance *core_instance;
 struct ast_cc_config_params *cc_params;
 long agent_count;
 int recall_core_id;

 ast_channel_get_device_name(caller_chan, caller, sizeof(caller));
 cc_params = ast_channel_get_cc_config_params(caller_chan);
 if (!cc_params) {
 ast_log_dynamic_level(cc_logger_level, "Could not get CC parameters for %s\n",
 caller);
 return NULL;
 }
 /* First, we need to kill off other pending CC offers from caller. If the caller is going
 * to request a CC service, it may only be for the latest call he made.
 */
 if (ast_get_cc_agent_policy(cc_params) == AST_CC_AGENT_GENERIC) {
 kill_duplicate_offers(caller);
 }

 ast_cc_is_recall(caller_chan, &recall_core_id, NULL);
 agent_count = count_agents(caller, recall_core_id);
 if (agent_count >= ast_get_cc_max_agents(cc_params)) {
 ast_log_dynamic_level(cc_logger_level, "Caller %s already has the maximum number of agents configured\n", caller);
 return NULL;
 }

 /* Generic agents can only have a single outstanding CC request per caller. */
 if (agent_count > 0 && ast_get_cc_agent_policy(cc_params) == AST_CC_AGENT_GENERIC) {
 ast_log_dynamic_level(cc_logger_level, "Generic agents can only have a single outstanding request\n");
 return NULL;
 }

 /* Next, we need to create the core instance for this call */
 if (!(core_instance = ao2_t_alloc(sizeof(*core_instance), cc_core_instance_destructor, "Creating core instance for CC"))) {
 return NULL;
 }

 core_instance->core_id = core_id;
 if (!(core_instance->agent = cc_agent_init(caller_chan, caller, core_instance->core_id, called_tree))) {
 cc_unref(core_instance, "Couldn't allocate agent, unref core_instance");
 return NULL;
 }

 core_instance->monitors = cc_ref(called_tree, "Core instance getting ref to monitor tree");

 ao2_t_link(cc_core_instances, core_instance, "Link core instance into container");

 return core_instance;
}

cc_core_instance_cmp_fn()

static int cc_core_instance_cmp_fn ( void *  obj, void *  arg, int  flags  )

static

Definition at line 423 of file ccss.c.

References CMP_MATCH, CMP_STOP, and cc_core_instance::core_id.

Referenced by load_module().

{
 struct cc_core_instance *core_instance1 = obj;
 struct cc_core_instance *core_instance2 = arg;

 return core_instance1->core_id == core_instance2->core_id ? CMP_MATCH | CMP_STOP : 0;
}

cc_core_instance_destructor()

static void cc_core_instance_destructor ( void *  data )

static

Definition at line 2928 of file ccss.c.

References cc_core_instance::agent, ast_log_dynamic_level, cc_logger_level, cc_unref(), cc_core_instance::core_id, and cc_core_instance::monitors.

Referenced by cc_core_init_instance().

{
 struct cc_core_instance *core_instance = data;
 ast_log_dynamic_level(cc_logger_level, "Core %d: Destroying core instance\n", core_instance->core_id);
 if (core_instance->agent) {
 cc_unref(core_instance->agent, "Core instance is done with the agent now");
 }
 if (core_instance->monitors) {
 core_instance->monitors = cc_unref(core_instance->monitors, "Core instance is done with interface list");
 }
}

cc_core_instance_hash_fn()

static int cc_core_instance_hash_fn ( const void *  obj, const int  flags  )

static

Definition at line 417 of file ccss.c.

References cc_core_instance::core_id.

Referenced by load_module().

{
 const struct cc_core_instance *core_instance = obj;
 return core_instance->core_id;
}

cc_device_monitor_init()

static struct ast_cc_monitor* cc_device_monitor_init ( const char *const  device_name, const char *const  dialstring, const struct cc_control_payload *  cc_data, int  core_id  )

static

Definition at line 2250 of file ccss.c.

References ao2_t_alloc, ast_atomic_fetchadd_int(), ast_cc_config_params_init, ast_cc_copy_config_params(), AST_CC_DEVICE_MONITOR, ast_log_dynamic_level, ast_strdup, ast_cc_monitor::available_timer_id, ast_cc_monitor::callbacks, cc_interface_destroy(), cc_logger_level, cc_monitor_destroy(), cc_unref(), cc_control_payload::config_params, ast_cc_interface::config_params, ast_cc_monitor::core_id, ast_cc_interface::device_name, ast_cc_monitor::dialstring, find_monitor_callbacks(), ast_cc_monitor::id, ast_cc_monitor::interface, monitor, ast_cc_interface::monitor_class, cc_control_payload::monitor_type, ast_cc_interface::monitor_type, NULL, ast_cc_monitor::parent_id, cc_control_payload::parent_interface_id, cc_control_payload::private_data, ast_cc_monitor::private_data, cc_control_payload::service, and ast_cc_monitor::service_offered.

Referenced by ast_handle_cc_control_frame().

{
 struct ast_cc_interface *cc_interface;
 struct ast_cc_monitor *monitor;
 size_t device_name_len = strlen(device_name);
 int parent_id = cc_data->parent_interface_id;

 if (!(cc_interface = ao2_t_alloc(sizeof(*cc_interface) + device_name_len, cc_interface_destroy,
 "Allocating new ast_cc_interface"))) {
 return NULL;
 }

 if (!(cc_interface->config_params = ast_cc_config_params_init())) {
 cc_unref(cc_interface, "Failed to allocate config params, unref interface");
 return NULL;
 }

 if (!(monitor = ao2_t_alloc(sizeof(*monitor), cc_monitor_destroy, "Allocating new ast_cc_monitor"))) {
 cc_unref(cc_interface, "Failed to allocate monitor, unref interface");
 return NULL;
 }

 if (!(monitor->dialstring = ast_strdup(dialstring))) {
 cc_unref(monitor, "Failed to copy dialable name. Unref monitor");
 cc_unref(cc_interface, "Failed to copy dialable name");
 return NULL;
 }

 if (!(monitor->callbacks = find_monitor_callbacks(cc_data->monitor_type))) {
 cc_unref(monitor, "Failed to find monitor callbacks. Unref monitor");
 cc_unref(cc_interface, "Failed to find monitor callbacks");
 return NULL;
 }

 strcpy(cc_interface->device_name, device_name);
 monitor->id = ast_atomic_fetchadd_int(&dialed_cc_interface_counter, +1);
 monitor->parent_id = parent_id;
 monitor->core_id = core_id;
 monitor->service_offered = cc_data->service;
 monitor->private_data = cc_data->private_data;
 cc_interface->monitor_type = cc_data->monitor_type;
 cc_interface->monitor_class = AST_CC_DEVICE_MONITOR;
 monitor->interface = cc_interface;
 monitor->available_timer_id = -1;
 ast_cc_copy_config_params(cc_interface->config_params, &cc_data->config_params);
 ast_log_dynamic_level(cc_logger_level, "Core %d: Created a device cc interface for '%s' with id %u and parent %u\n",
 monitor->core_id, cc_interface->device_name, monitor->id, monitor->parent_id);
 return monitor;
}

cc_do_state_change()

static int cc_do_state_change ( void *  datap )

static

Definition at line 3285 of file ccss.c.

References cc_core_instance::agent, args, AST_CC_AGENT_RESPONSE_FAILURE_INVALID, ast_free, ast_log_dynamic_level, ast_cc_agent::callbacks, CC_CALLER_REQUESTED, cc_logger_level, cc_state_to_string(), cc_unref(), ccss_notify_device_state_change(), cc_state_change_args::core_id, cc_state_change_args::core_instance, cc_core_instance::current_state, cc_state_change_args::debug, is_state_change_valid(), ast_cc_agent_callbacks::respond, cc_state_change_args::state, and state_change_funcs.

Referenced by cc_request_state_change().

{
 struct cc_state_change_args *args = datap;
 struct cc_core_instance *core_instance;
 enum cc_state previous_state;
 int res;

 ast_log_dynamic_level(cc_logger_level, "Core %d: State change to %u requested. Reason: %s\n",
 args->core_id, args->state, args->debug);

 core_instance = args->core_instance;

 if (!is_state_change_valid(core_instance->current_state, args->state, core_instance->agent)) {
 ast_log_dynamic_level(cc_logger_level, "Core %d: Invalid state change requested. Cannot go from %s to %s\n",
 args->core_id, cc_state_to_string(core_instance->current_state), cc_state_to_string(args->state));
 if (args->state == CC_CALLER_REQUESTED) {
 /*
 * For out-of-order requests, we need to let the requester know that
 * we can't handle the request now.
 */
 core_instance->agent->callbacks->respond(core_instance->agent,
 AST_CC_AGENT_RESPONSE_FAILURE_INVALID);
 }
 ast_free(args);
 cc_unref(core_instance, "Unref core instance from when it was found earlier");
 return -1;
 }