Asterisk - The Open Source Telephony Project GIT-master-55f4e6d
Data Structures | Macros | Typedefs | Enumerations | Functions
ccss.h File Reference

Call Completion Supplementary Services API. More...

#include "asterisk.h"
#include "asterisk/linkedlists.h"
#include "asterisk/devicestate.h"
Include dependency graph for ccss.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  ast_cc_agent
 
struct  ast_cc_agent_callbacks
 
struct  ast_cc_interface
 Structure with information about an outbound interface. More...
 
struct  ast_cc_monitor
 
struct  ast_cc_monitor_callbacks
 Callbacks defined by CC monitors. More...
 

Macros

#define ast_cc_config_params_init()   __ast_cc_config_params_init(__FILE__, __LINE__, __PRETTY_FUNCTION__)
 Allocate and initialize an ast_cc_config_params structure. More...
 
#define AST_CC_GENERIC_MONITOR_TYPE   "generic"
 

Typedefs

typedef void(* ast_cc_callback_fn) (struct ast_channel *chan, 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...
 

Enumerations

enum  ast_cc_agent_flags { AST_CC_AGENT_SKIP_OFFER = (1 << 0) }
 agent flags that can alter core behavior More...
 
enum  ast_cc_agent_policies { AST_CC_AGENT_NEVER , AST_CC_AGENT_NATIVE , AST_CC_AGENT_GENERIC }
 The various possibilities for cc_agent_policy values. More...
 
enum  ast_cc_agent_response_reason { AST_CC_AGENT_RESPONSE_SUCCESS , AST_CC_AGENT_RESPONSE_FAILURE_INVALID , AST_CC_AGENT_RESPONSE_FAILURE_TOO_MANY }
 
enum  ast_cc_monitor_class { AST_CC_DEVICE_MONITOR , AST_CC_EXTENSION_MONITOR }
 
enum  ast_cc_monitor_policies { AST_CC_MONITOR_NEVER , AST_CC_MONITOR_NATIVE , AST_CC_MONITOR_GENERIC , AST_CC_MONITOR_ALWAYS }
 The various possibilities for cc_monitor_policy values. More...
 
enum  ast_cc_service_type { AST_CC_NONE , AST_CC_CCBS , AST_CC_CCNR , AST_CC_CCNL }
 

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...
 
int ast_cc_agent_accept_request (int core_id, const char *const debug,...)
 Accept inbound CC request. More...
 
struct ast_cc_agentast_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. 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 *const 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_monitorast_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 *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_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...
 
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. 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_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...
 

Detailed Description

Call Completion Supplementary Services API.

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

Definition in file ccss.h.

Macro Definition Documentation

◆ ast_cc_config_params_init

#define ast_cc_config_params_init ( )    __ast_cc_config_params_init(__FILE__, __LINE__, __PRETTY_FUNCTION__)

Allocate and initialize an ast_cc_config_params structure.

Note
Reasonable default values are chosen for the parameters upon allocation.
Return values
NULLUnable to allocate the structure
non-NULLA pointer to the newly allocated and initialized structure

Definition at line 135 of file ccss.h.

◆ AST_CC_GENERIC_MONITOR_TYPE

#define AST_CC_GENERIC_MONITOR_TYPE   "generic"

It is recommended that monitors use a pointer to an ast_cc_monitor_callbacks::type when creating an AST_CONTROL_CC frame. Since the generic monitor callbacks are opaque and channel drivers will wish to use that, this string is made globally available for all to use

Definition at line 455 of file ccss.h.

Typedef Documentation

◆ ast_cc_callback_fn

typedef void(* ast_cc_callback_fn) (struct ast_channel *chan, 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
chanA channel involved in the call. What we want is on a datastore on both incoming and outgoing so either may be provided
cc_paramsThe CC configuration parameters for the outbound target
monitor_typeThe type of monitor to use when CC is requested
device_nameThe name of the outbound target device.
dialstringThe dial string used when calling this specific interface
private_dataIf 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.

Definition at line 1562 of file ccss.h.

Enumeration Type Documentation

◆ ast_cc_agent_flags

agent flags that can alter core behavior

Enumerator
AST_CC_AGENT_SKIP_OFFER 

Definition at line 59 of file ccss.h.

59 {
60 /* Some agent types allow for a caller to
61 * request CC without reaching the CC_CALLER_OFFERED
62 * state. In other words, the caller can request
63 * CC while he is still on the phone from the failed
64 * call. The generic agent is an agent which allows
65 * for this behavior.
66 */
67 AST_CC_AGENT_SKIP_OFFER = (1 << 0),
68};
@ AST_CC_AGENT_SKIP_OFFER
Definition: ccss.h:67

◆ ast_cc_agent_policies

The various possibilities for cc_agent_policy values.

Since
1.8
Enumerator
AST_CC_AGENT_NEVER 

Never offer CCSS to the caller

AST_CC_AGENT_NATIVE 

Offer CCSS using native signaling

AST_CC_AGENT_GENERIC 

Use generic agent for caller

Definition at line 47 of file ccss.h.

47 {
48 /*! Never offer CCSS to the caller */
50 /*! Offer CCSS using native signaling */
52 /*! Use generic agent for caller */
54};
@ AST_CC_AGENT_NEVER
Definition: ccss.h:49
@ AST_CC_AGENT_GENERIC
Definition: ccss.h:53
@ AST_CC_AGENT_NATIVE
Definition: ccss.h:51

◆ ast_cc_agent_response_reason

Enumerator
AST_CC_AGENT_RESPONSE_SUCCESS 

CC request accepted

AST_CC_AGENT_RESPONSE_FAILURE_INVALID 

CC request not allowed at this time. Invalid state transition.

AST_CC_AGENT_RESPONSE_FAILURE_TOO_MANY 

Too many CC requests in the system.

Definition at line 841 of file ccss.h.

841 {
842 /*! CC request accepted */
844 /*! CC request not allowed at this time. Invalid state transition. */
846 /*! Too many CC requests in the system. */
848};
@ AST_CC_AGENT_RESPONSE_FAILURE_INVALID
Definition: ccss.h:845
@ AST_CC_AGENT_RESPONSE_SUCCESS
Definition: ccss.h:843
@ AST_CC_AGENT_RESPONSE_FAILURE_TOO_MANY
Definition: ccss.h:847

◆ ast_cc_monitor_class

Used to determine which type of monitor an ast_cc_device_monitor is.

Enumerator
AST_CC_DEVICE_MONITOR 
AST_CC_EXTENSION_MONITOR 

Definition at line 462 of file ccss.h.

462 {
465};
@ AST_CC_EXTENSION_MONITOR
Definition: ccss.h:464
@ AST_CC_DEVICE_MONITOR
Definition: ccss.h:463

◆ ast_cc_monitor_policies

The various possibilities for cc_monitor_policy values.

Since
1.8
Enumerator
AST_CC_MONITOR_NEVER 

Never accept CCSS offers from callee

AST_CC_MONITOR_NATIVE 
AST_CC_MONITOR_GENERIC 

Always use CCSS generic monitor for callee Note that if callee offers CCSS natively, we still will use a generic CCSS monitor if this is set

AST_CC_MONITOR_ALWAYS 

Accept native CCSS offers, but if no offer is present, use a generic CCSS monitor

Definition at line 74 of file ccss.h.

74 {
75 /*! Never accept CCSS offers from callee */
77 /* CCSS only available if callee offers it through signaling */
79 /*! Always use CCSS generic monitor for callee
80 * Note that if callee offers CCSS natively, we still
81 * will use a generic CCSS monitor if this is set
82 */
84 /*! Accept native CCSS offers, but if no offer is present,
85 * use a generic CCSS monitor
86 */
88};
@ AST_CC_MONITOR_NEVER
Definition: ccss.h:76
@ AST_CC_MONITOR_ALWAYS
Definition: ccss.h:87
@ AST_CC_MONITOR_NATIVE
Definition: ccss.h:78
@ AST_CC_MONITOR_GENERIC
Definition: ccss.h:83

◆ ast_cc_service_type

Enumerator
AST_CC_NONE 
AST_CC_CCBS 
AST_CC_CCNR 
AST_CC_CCNL 

Definition at line 32 of file ccss.h.

32 {
33 /* No Service available/requested */
35 /* Call Completion Busy Subscriber */
37 /* Call Completion No Response */
39 /* Call Completion Not Logged In (currently SIP only) */
41};
@ AST_CC_CCNL
Definition: ccss.h:40
@ AST_CC_CCBS
Definition: ccss.h:36
@ AST_CC_NONE
Definition: ccss.h:34
@ AST_CC_CCNR
Definition: ccss.h:38

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
NULLUnable to allocate the structure
non-NULLA pointer to the newly allocated and initialized structure

Definition at line 680 of file ccss.c.

681{
682 struct ast_cc_config_params *params = __ast_malloc(sizeof(*params), file, line, function);
683
684 if (!params) {
685 return NULL;
686 }
687
689 return params;
690}
void * __ast_malloc(size_t size, const char *file, int lineno, const char *func) attribute_malloc
Definition: astmm.c:1628
void ast_cc_default_config_params(struct ast_cc_config_params *params)
Set the specified CC config params to default values.
Definition: ccss.c:675
#define NULL
Definition: resample.c:96

References __ast_malloc(), ast_cc_default_config_params(), make_ari_stubs::file, and NULL.

◆ 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_idcore_id of the CC transaction
debugoptional string to print for debugging purposes
Return values
0Success
-1Failure

Definition at line 3741 of file ccss.c.

3742{
3743 va_list ap;
3744 int res;
3745
3746 va_start(ap, debug);
3748 va_end(ap);
3749 return res;
3750}
@ CC_CALLER_REQUESTED
Definition: ccss.c:187
static int cc_request_state_change(enum cc_state state, const int core_id, const char *debug, va_list ap)
Definition: ccss.c:3295
static int debug
Global debug status.
Definition: res_xmpp.c:441

References CC_CALLER_REQUESTED, cc_request_state_change(), dialed_cc_interfaces::core_id, and debug.

Referenced by ccreq_exec().

◆ 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
flagsastobj2 search flags
functionan ao2 callback function to call
argthe argument to the callback function
typeThe type of agents to call the callback on

Definition at line 456 of file ccss.c.

457{
458 struct cc_callback_helper helper = {.function = function, .args = args, .type = type};
459 struct cc_core_instance *core_instance;
460 if ((core_instance = ao2_t_callback(cc_core_instances, flags, cc_agent_callback_helper, &helper,
461 "Calling provided agent callback function"))) {
462 struct ast_cc_agent *agent = cc_ref(core_instance->agent, "An outside entity needs the agent");
463 cc_unref(core_instance, "agent callback done with the core_instance");
464 return agent;
465 }
466 return NULL;
467}
#define ao2_t_callback(c, flags, cb_fn, arg, tag)
Definition: astobj2.h:1696
static void * cc_unref(void *obj, const char *debug)
Definition: ccss.c:149
static void * cc_ref(void *obj, const char *debug)
Definition: ccss.c:143
static struct ao2_container * cc_core_instances
Definition: ccss.c:326
static int cc_agent_callback_helper(void *obj, void *args, int flags)
Definition: ccss.c:444
static const char type[]
Definition: chan_ooh323.c:109
ao2_callback_fn * function
Definition: ccss.c:439
struct ast_cc_agent * agent
Definition: ccss.c:340
const char * args

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

◆ 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_idcore_id of the CC transaction
debugoptional string to print for debugging purposes
Return values
0Success
-1Failure

Definition at line 3785 of file ccss.c.

3786{
3787 va_list ap;
3788 int res;
3789
3790 va_start(ap, debug);
3791 res = cc_request_state_change(CC_ACTIVE, core_id, debug, ap);
3792 va_end(ap);
3793 return res;
3794}
@ CC_ACTIVE
Definition: ccss.c:190

References CC_ACTIVE, cc_request_state_change(), dialed_cc_interfaces::core_id, and debug.

Referenced by generic_agent_devstate_cb().

◆ 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_idcore_id of the CC transaction
debugoptional string to print for debugging purposes
Return values
0Success
-1Failure

Definition at line 3774 of file ccss.c.

3775{
3776 va_list ap;
3777 int res;
3778
3779 va_start(ap, debug);
3780 res = cc_request_state_change(CC_CALLER_BUSY, core_id, debug, ap);
3781 va_end(ap);
3782 return res;
3783}
@ CC_CALLER_BUSY
Definition: ccss.c:197

References CC_CALLER_BUSY, cc_request_state_change(), dialed_cc_interfaces::core_id, and debug.

Referenced by cc_generic_agent_recall().

◆ 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_idcore_id of the CC transaction
debugoptional string to print for debugging purposes
Return values
0Success
-1Failure

Definition at line 3796 of file ccss.c.

3797{
3798 va_list ap;
3799 int res;
3800
3801 va_start(ap, debug);
3802 res = cc_request_state_change(CC_RECALLING, core_id, debug, ap);
3803 va_end(ap);
3804 return res;
3805}
@ CC_RECALLING
Definition: ccss.c:201

References CC_RECALLING, cc_request_state_change(), dialed_cc_interfaces::core_id, and debug.

Referenced by generic_recall().

◆ 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
callbacksThe callbacks used by the agent implementation
Return values
0Successfully registered
-1Failure to register

Definition at line 1217 of file ccss.c.

1218{
1219 struct cc_agent_backend *backend = ast_calloc(1, sizeof(*backend));
1220
1221 if (!backend) {
1222 return -1;
1223 }
1224
1225 backend->callbacks = callbacks;
1229 return 0;
1230}
#define ast_calloc(num, len)
A wrapper for calloc()
Definition: astmm.h:202
#define AST_RWLIST_WRLOCK(head)
Write locks a list.
Definition: linkedlists.h:52
#define AST_RWLIST_UNLOCK(head)
Attempts to unlock a read/write based list.
Definition: linkedlists.h:151
#define AST_RWLIST_INSERT_TAIL
Definition: linkedlists.h:741
struct @468 callbacks
const struct ast_cc_agent_callbacks * callbacks
Definition: ccss.c:1212
struct cc_agent_backend * next
Definition: ccss.c:1211

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

Referenced by load_module().

◆ 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
chanThe channel to set the CC_INTERFACES variable on

Definition at line 3596 of file ccss.c.

3597{
3598 struct ast_datastore *recall_datastore;
3599 struct cc_monitor_tree *interface_tree;
3600 struct ast_cc_monitor *monitor;
3601 struct cc_recall_ds_data *recall_data;
3602 struct ast_str *str = ast_str_create(64);
3603 int core_id;
3604
3605 if (!str) {
3606 return -1;
3607 }
3608
3609 ast_channel_lock(chan);
3610 if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
3611 ast_channel_unlock(chan);
3612 ast_free(str);
3613 return -1;
3614 }
3615 recall_data = recall_datastore->data;
3616 interface_tree = recall_data->interface_tree;
3617 core_id = recall_data->core_id;
3618 ast_channel_unlock(chan);
3619
3620 AST_LIST_LOCK(interface_tree);
3621 monitor = AST_LIST_FIRST(interface_tree);
3623 AST_LIST_UNLOCK(interface_tree);
3624
3625 pbx_builtin_setvar_helper(chan, "CC_INTERFACES", ast_str_buffer(str));
3626 ast_log_dynamic_level(cc_logger_level, "Core %d: CC_INTERFACES set to %s\n",
3627 core_id, ast_str_buffer(str));
3628
3629 ast_free(str);
3630 return 0;
3631}
const char * str
Definition: app_jack.c:147
#define ast_free(a)
Definition: astmm.h:180
static const struct ast_datastore_info recall_ds_info
Definition: ccss.c:3366
static void build_cc_interfaces_chanvar(struct ast_cc_monitor *starting_point, struct ast_str **str)
Definition: ccss.c:3553
static int cc_logger_level
Definition: ccss.c:133
#define ast_channel_lock(chan)
Definition: channel.h:2922
#define ast_channel_unlock(chan)
Definition: channel.h:2923
struct ast_datastore * ast_channel_datastore_find(struct ast_channel *chan, const struct ast_datastore_info *info, const char *uid)
Find a datastore on a channel.
Definition: channel.c:2399
#define ast_log_dynamic_level(level,...)
Send a log message to a dynamically registered log level.
#define AST_LIST_LOCK(head)
Locks a list.
Definition: linkedlists.h:40
#define AST_LIST_UNLOCK(head)
Attempts to unlock a list.
Definition: linkedlists.h:140
#define AST_LIST_FIRST(head)
Returns the first entry contained in a list.
Definition: linkedlists.h:421
int pbx_builtin_setvar_helper(struct ast_channel *chan, const char *name, const char *value)
Add a variable to the channel variable stack, removing the most recently set value for the same name.
char * ast_str_buffer(const struct ast_str *buf)
Returns the string buffer within the ast_str buf.
Definition: strings.h:761
#define ast_str_create(init_len)
Create a malloc'ed dynamic length string.
Definition: strings.h:659
Structure for a data store object.
Definition: datastore.h:64
void * data
Definition: datastore.h:66
Support for dynamic strings.
Definition: strings.h:623
The "tree" of interfaces that is dialed.
Definition: ccss.c:323
struct cc_monitor_tree * interface_tree
Definition: ccss.c:3342

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

Referenced by generic_recall().

◆ 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_idThe core ID of the CC transaction
devstateThe current state of the caller to which the agent pertains
Return values
0Successfully responded with our status
-1Failed to respond with our status

Definition at line 4058 of file ccss.c.

4059{
4061 struct cc_core_instance *core_instance;
4062 int res;
4063
4064 args = ast_calloc(1, sizeof(*args));
4065 if (!args) {
4066 return -1;
4067 }
4068
4069 core_instance = find_cc_core_instance(core_id);
4070 if (!core_instance) {
4071 ast_free(args);
4072 return -1;
4073 }
4074
4075 args->core_instance = core_instance;
4076 args->devstate = devstate;
4077
4079 if (res) {
4080 cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
4081 ast_free(args);
4082 }
4083 return res;
4084}
static struct ast_taskprocessor * cc_core_taskprocessor
Definition: ccss.c:125
static struct cc_core_instance * find_cc_core_instance(const int core_id)
Definition: ccss.c:431
static int cc_status_response(void *data)
Definition: ccss.c:4037
int ast_taskprocessor_push(struct ast_taskprocessor *tps, int(*task_exe)(void *datap), void *datap) attribute_warn_unused_result
Push a task into the specified taskprocessor queue and signal the taskprocessor thread.

References args, ast_calloc, ast_free, ast_taskprocessor_push(), cc_core_taskprocessor, cc_status_response(), cc_unref(), cc_core_instance::core_id, and find_cc_core_instance().

Referenced by cc_generic_agent_status_request().

◆ 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
callbacksThe callbacks used by the agent implementation

Definition at line 1232 of file ccss.c.

1233{
1234 struct cc_agent_backend *backend;
1237 if (backend->callbacks == callbacks) {
1239 ast_free(backend);
1240 break;
1241 }
1242 }
1245}
#define AST_RWLIST_REMOVE_CURRENT
Definition: linkedlists.h:570
#define AST_RWLIST_TRAVERSE_SAFE_BEGIN
Definition: linkedlists.h:545
#define AST_RWLIST_TRAVERSE_SAFE_END
Definition: linkedlists.h:617

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, callbacks, and cc_agent_backend::next.

Referenced by __unload_module(), and unload_module().

◆ 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
dataA reference to the CC monitor on which the timer was running.

Definition at line 1487 of file ccss.c.

1488{
1489 struct ast_cc_monitor *monitor = (struct ast_cc_monitor *) data;
1490 int res;
1491 monitor->available_timer_id = -1;
1492 res = ast_cc_monitor_failed(monitor->core_id, monitor->interface->device_name, "Available timer expired for monitor");
1493 cc_unref(monitor, "Unref reference from scheduler\n");
1494 return res;
1495}
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.
Definition: ccss.c:3906
char device_name[1]
Definition: ccss.h:802
struct ast_cc_interface * interface
Definition: ccss.h:480
int core_id
Definition: ccss.h:494
int available_timer_id
Definition: ccss.h:513

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

◆ 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
chanA channel involved in the call. What we want is on a datastore on both incoming and outgoing so either may be provided
cc_paramsThe CC configuration parameters for the outbound target
monitor_typeThe type of monitor to use when CC is requested
device_nameThe name of the outbound target device.
dialstringThe dial string used when calling this specific interface
serviceWhat kind of CC service is being offered. (CCBS/CCNR/etc...)
private_dataIf 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]frameThe 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
-1Failure. At some point there was a failure. Do not attempt to use the frame in this case.
0Success

Definition at line 4141 of file ccss.c.

4145{
4146 struct cc_control_payload *payload = ast_calloc(1, sizeof(*payload));
4147
4148 if (!payload) {
4149 return -1;
4150 }
4151 if (cc_build_payload(chan, cc_params, monitor_type, device_name, dialstring, service, private_data, payload)) {
4152 /* Something screwed up, we can't make a frame with this */
4153 ast_free(payload);
4154 return -1;
4155 }
4158 frame->data.ptr = payload;
4159 frame->datalen = sizeof(*payload);
4160 frame->mallocd = AST_MALLOCD_DATA;
4161 return 0;
4162}
enum ast_cc_service_type service
Definition: ccss.c:383
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)
Definition: ccss.c:4086
#define AST_MALLOCD_DATA
@ AST_FRAME_CONTROL
@ AST_CONTROL_CC
struct ast_frame_subclass subclass
union ast_frame::@226 data
enum ast_frame_type frametype
The payload for an AST_CONTROL_CC frame.
Definition: ccss.c:221
const char * monitor_type
The type of monitor to allocate.
Definition: ccss.c:239
char device_name[AST_CHANNEL_NAME]
Name of device to be monitored.
Definition: ccss.c:292
char dialstring[AST_CHANNEL_NAME]
Recall dialstring.
Definition: ccss.c:304
void * private_data
Private data allocated by the callee.
Definition: ccss.c:256

References ast_calloc, AST_CONTROL_CC, AST_FRAME_CONTROL, ast_free, AST_MALLOCD_DATA, cc_build_payload(), ast_frame::data, ast_frame::datalen, cc_control_payload::device_name, cc_control_payload::dialstring, ast_frame::frametype, ast_frame_subclass::integer, ast_frame::mallocd, cc_control_payload::monitor_type, cc_control_payload::private_data, ast_frame::ptr, service, and ast_frame::subclass.

Referenced by ast_queue_cc_frame().

◆ 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
inboundIncoming asterisk channel.
cc_paramsThe CC configuration parameters for the outbound target
monitor_typeThe type of monitor to use when CC is requested
device_nameThe name of the outbound target device.
dialstringThe dial string used when calling this specific interface
private_dataIf 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 4197 of file ccss.c.

4199{
4200 struct cc_control_payload payload;
4201 if (cc_build_payload(inbound, cc_params, monitor_type, device_name, dialstring, AST_CC_CCBS, private_data, &payload)) {
4202 /* Something screwed up. Don't try to handle this payload */
4204 return;
4205 }
4206 ast_handle_cc_control_frame(inbound, NULL, &payload);
4207}
void ast_handle_cc_control_frame(struct ast_channel *inbound, struct ast_channel *outbound, void *frame_data)
Properly react to a CC control frame.
Definition: ccss.c:2293
static void call_destructor_with_no_monitor(const char *const monitor_type, void *private_data)
Definition: ccss.c:2192

References AST_CC_CCBS, ast_handle_cc_control_frame(), call_destructor_with_no_monitor(), cc_build_payload(), cc_control_payload::device_name, cc_control_payload::dialstring, cc_control_payload::monitor_type, NULL, and cc_control_payload::private_data.

Referenced by dial_exec_full().

◆ 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 4164 of file ccss.c.

4165{
4166 char device_name[AST_CHANNEL_NAME];
4167 struct cc_control_payload payload;
4168 struct ast_cc_config_params *cc_params;
4169
4171 /* It doesn't make sense to try to offer CCBS to the caller if the reason for ast_call
4172 * failing is something other than busy or congestion
4173 */
4174 return;
4175 }
4176
4178 if (!cc_params) {
4179 return;
4180 }
4182 /* This sort of CCBS only works if using generic CC. For native, we would end up sending
4183 * a CC request for a non-existent call. The far end will reject this every time
4184 */
4185 return;
4186 }
4187
4188 ast_channel_get_device_name(outgoing, device_name, sizeof(device_name));
4189 if (cc_build_payload(outgoing, cc_params, AST_CC_GENERIC_MONITOR_TYPE, device_name,
4190 dialstring, AST_CC_CCBS, NULL, &payload)) {
4191 /* Something screwed up, we can't make a frame with this */
4192 return;
4193 }
4194 ast_handle_cc_control_frame(incoming, outgoing, &payload);
4195}
#define AST_CAUSE_CONGESTION
Definition: causes.h:153
#define AST_CAUSE_BUSY
Definition: causes.h:149
enum ast_cc_monitor_policies ast_get_cc_monitor_policy(struct ast_cc_config_params *config)
Get the cc_monitor_policy.
Definition: ccss.c:876
#define AST_CC_GENERIC_MONITOR_TYPE
Definition: ccss.h:455
int ast_channel_get_device_name(struct ast_channel *chan, char *device_name, size_t name_buffer_length)
Get a device name given its channel structure.
Definition: channel.c:10496
int ast_channel_hangupcause(const struct ast_channel *chan)
#define AST_CHANNEL_NAME
Definition: channel.h:171
struct ast_cc_config_params * ast_channel_get_cc_config_params(struct ast_channel *chan)
Get the CCSS parameters from a channel.
Definition: channel.c:10474

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

◆ 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
chanThe inbound channel calling the CC-capable application.
[out]ignore_ccWill be set non-zero if no further CC actions need to be taken
Return values
0Success
-1Failure

Definition at line 2386 of file ccss.c.

2387{
2388 /* There are three situations to deal with here:
2389 *
2390 * 1. The channel does not have a dialed_cc_interfaces datastore on
2391 * it. This means that this is the first time that Dial has
2392 * been called. We need to create/initialize the datastore.
2393 *
2394 * 2. The channel does have a cc_interface datastore on it and
2395 * the "ignore" indicator is 0. This means that a Local channel
2396 * was called by a "parent" dial. We can check the datastore's
2397 * parent field to see who the root of this particular dial tree
2398 * is.
2399 *
2400 * 3. The channel does have a cc_interface datastore on it and
2401 * the "ignore" indicator is 1. This means that a second Dial call
2402 * is being made from an extension. In this case, we do not
2403 * want to make any additions/modifications to the datastore. We
2404 * will instead set a flag to indicate that CCSS is completely
2405 * disabled for this Dial attempt.
2406 */
2407
2408 struct ast_datastore *cc_interfaces_datastore;
2410 struct ast_cc_monitor *monitor;
2411 struct ast_cc_config_params *cc_params;
2412
2413 ast_channel_lock(chan);
2414
2415 cc_params = ast_channel_get_cc_config_params(chan);
2416 if (!cc_params) {
2417 ast_channel_unlock(chan);
2418 return -1;
2419 }
2420 if (ast_get_cc_agent_policy(cc_params) == AST_CC_AGENT_NEVER) {
2421 /* We can't offer CC to this caller anyway, so don't bother with CC on this call
2422 */
2423 *ignore_cc = 1;
2424 ast_channel_unlock(chan);
2425 ast_log_dynamic_level(cc_logger_level, "Agent policy for %s is 'never'. CC not possible\n", ast_channel_name(chan));
2426 return 0;
2427 }
2428
2429 if (!(cc_interfaces_datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
2430 /* Situation 1 has occurred */
2431 ast_channel_unlock(chan);
2432 return cc_interfaces_datastore_init(chan);
2433 }
2434 interfaces = cc_interfaces_datastore->data;
2435 ast_channel_unlock(chan);
2436
2437 if (interfaces->ignore) {
2438 /* Situation 3 has occurred */
2439 *ignore_cc = 1;
2440 ast_log_dynamic_level(cc_logger_level, "Datastore is present with ignore flag set. Ignoring CC offers on this call\n");
2441 return 0;
2442 }
2443
2444 /* Situation 2 has occurred */
2445 if (!(monitor = cc_extension_monitor_init(ast_channel_exten(chan),
2446 ast_channel_context(chan),
2447 interfaces->dial_parent_id))) {
2448 return -1;
2449 }
2450 monitor->core_id = interfaces->core_id;
2451 AST_LIST_LOCK(interfaces->interface_tree);
2452 cc_ref(monitor, "monitor tree's reference to the monitor");
2453 AST_LIST_INSERT_TAIL(interfaces->interface_tree, monitor, next);
2454 AST_LIST_UNLOCK(interfaces->interface_tree);
2455 interfaces->dial_parent_id = monitor->id;
2456 cc_unref(monitor, "Unref monitor's allocation reference");
2457 return 0;
2458}
static const struct ast_datastore_info dialed_cc_interfaces_info
Definition: ccss.c:1967
enum ast_cc_agent_policies ast_get_cc_agent_policy(struct ast_cc_config_params *config)
Get the cc_agent_policy.
Definition: ccss.c:859
static struct ast_cc_monitor * cc_extension_monitor_init(const char *const exten, const char *const context, const unsigned int parent_id)
Definition: ccss.c:2067
static int cc_interfaces_datastore_init(struct ast_channel *chan)
Definition: ccss.c:2116
const char * ast_channel_name(const struct ast_channel *chan)
const char * ast_channel_context(const struct ast_channel *chan)
const char * ast_channel_exten(const struct ast_channel *chan)
static struct ao2_container * interfaces
Container for registered format interfaces.
Definition: format.c:65
#define AST_LIST_INSERT_TAIL(head, elm, field)
Appends a list entry to the tail of a list.
Definition: linkedlists.h:731
unsigned int id
Definition: ccss.h:485

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_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, ast_datastore::data, dialed_cc_interfaces_info, ast_cc_monitor::id, interfaces, and NULL.

Referenced by dial_exec_full().

◆ 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
techChannel technology to use
destChannel/group/peer or whatever the specific technology uses
callbackFunction to call when a target is reached
Return values
0Always, I guess.

Definition at line 4209 of file ccss.c.

4210{
4211 const struct ast_channel_tech *chantech = ast_get_channel_tech(tech);
4212
4213 if (chantech && chantech->cc_callback) {
4214 chantech->cc_callback(inbound, dest, callback);
4215 }
4216
4217 return 0;
4218}
const struct ast_channel_tech * ast_get_channel_tech(const char *name)
Get a channel technology structure by name.
Definition: channel.c:592
Structure to describe a channel "technology", ie a channel driver See for examples:
Definition: channel.h:628
int(* cc_callback)(struct ast_channel *inbound, const char *dest, ast_cc_callback_fn callback)
Call a function with cc parameters as a function parameter.
Definition: channel.h:827

References ast_get_channel_tech(), and ast_channel_tech::cc_callback.

Referenced by dial_exec_full().

◆ 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
chanThe inbound channel making the CC recall
debugoptional string to print for debugging purposes
Return values
0Success
-1Failure

Definition at line 3807 of file ccss.c.

3808{
3809 struct ast_datastore *recall_datastore;
3810 struct cc_recall_ds_data *recall_data;
3811 int core_id;
3812 va_list ap;
3813 int res;
3814
3815 ast_channel_lock(chan);
3816 if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
3817 /* Silly! Why did you call this function if there's no recall DS? */
3818 ast_channel_unlock(chan);
3819 return -1;
3820 }
3821 recall_data = recall_datastore->data;
3822 if (recall_data->nested || recall_data->ignore) {
3823 /* If this is being called from a nested Dial, it is too
3824 * early to determine if the recall has actually completed.
3825 * The outermost dial is the only one with the authority to
3826 * declare the recall to be complete.
3827 *
3828 * Similarly, if this function has been called when the
3829 * recall has progressed beyond the first dial, this is not
3830 * a legitimate time to declare the recall to be done. In fact,
3831 * that should have been done already.
3832 */
3833 ast_channel_unlock(chan);
3834 return -1;
3835 }
3836 core_id = recall_data->core_id;
3837 ast_channel_unlock(chan);
3838 va_start(ap, debug);
3840 va_end(ap);
3841 return res;
3842}
@ CC_COMPLETE
Definition: ccss.c:205

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, debug, cc_recall_ds_data::ignore, cc_recall_ds_data::nested, NULL, and recall_ds_info.

Referenced by wait_for_answer().

◆ 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
paramsPointer to structure whose memory we need to free

Definition at line 692 of file ccss.c.

693{
694 ast_free(params);
695}

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

◆ 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
srcThe structure from which data is copied
destThe structure to which data is copied

Definition at line 854 of file ccss.c.

855{
856 *dest = *src;
857}

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

◆ 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
paramsCC config params to set to default values.

Definition at line 675 of file ccss.c.

676{
677 *params = cc_default_params;
678}
static const struct ast_cc_config_params cc_default_params
Definition: ccss.c:662

References cc_default_params.

Referenced by __ast_cc_config_params_init().

◆ 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
incomingThe caller's channel
dialstringThe dialstring used when requesting the outbound channel
device_nameThe device name associated with the requested outbound channel

Definition at line 1983 of file ccss.c.

1984{
1985 struct ast_datastore *cc_datastore;
1986 struct dialed_cc_interfaces *cc_interfaces;
1987 struct ast_cc_monitor *monitor;
1988 struct extension_monitor_pvt *extension_pvt;
1989 struct extension_child_dialstring *child_dialstring;
1990 struct cc_monitor_tree *interface_tree;
1991 int id;
1992
1993 ast_channel_lock(incoming);
1994 if (!(cc_datastore = ast_channel_datastore_find(incoming, &dialed_cc_interfaces_info, NULL))) {
1995 ast_channel_unlock(incoming);
1996 return;
1997 }
1998
1999 cc_interfaces = cc_datastore->data;
2000 interface_tree = cc_interfaces->interface_tree;
2001 id = cc_interfaces->dial_parent_id;
2002 ast_channel_unlock(incoming);
2003
2004 AST_LIST_LOCK(interface_tree);
2005 AST_LIST_TRAVERSE(interface_tree, monitor, next) {
2006 if (monitor->id == id) {
2007 break;
2008 }
2009 }
2010
2011 if (!monitor) {
2012 AST_LIST_UNLOCK(interface_tree);
2013 return;
2014 }
2015
2016 extension_pvt = monitor->private_data;
2017 if (!(child_dialstring = ast_calloc(1, sizeof(*child_dialstring)))) {
2018 AST_LIST_UNLOCK(interface_tree);
2019 return;
2020 }
2021 ast_copy_string(child_dialstring->original_dialstring, dialstring, sizeof(child_dialstring->original_dialstring));
2022 ast_copy_string(child_dialstring->device_name, device_name, sizeof(child_dialstring->device_name));
2023 child_dialstring->is_valid = 1;
2024 AST_LIST_INSERT_TAIL(&extension_pvt->child_dialstrings, child_dialstring, next);
2025 AST_LIST_UNLOCK(interface_tree);
2026}
enum queue_result id
Definition: app_queue.c:1638
#define AST_LIST_TRAVERSE(head, var, field)
Loops over (traverses) the entries in a list.
Definition: linkedlists.h:491
void ast_copy_string(char *dst, const char *src, size_t size)
Size-limited null-terminating string copy.
Definition: strings.h:425
void * private_data
Data that is private to a monitor technology.
Definition: ccss.h:527
struct cc_monitor_tree * interface_tree
Definition: ccss.c:1907
unsigned int dial_parent_id
Definition: ccss.c:1880
Data regarding an extension monitor's child's dialstrings.
Definition: ccss.c:1738
char device_name[AST_CHANNEL_NAME]
The name of the device being dialed.
Definition: ccss.c:1773
int is_valid
Is this structure valid for use in CC_INTERFACES?
Definition: ccss.c:1788
char original_dialstring[AST_CHANNEL_NAME]
the original dialstring used to call a particular device
Definition: ccss.c:1754
Private data for an extension monitor.
Definition: ccss.c:1795
struct extension_monitor_pvt::@326 child_dialstrings

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, dialed_cc_interfaces_info, id, ast_cc_monitor::id, dialed_cc_interfaces::interface_tree, extension_child_dialstring::is_valid, NULL, extension_child_dialstring::original_dialstring, and ast_cc_monitor::private_data.

Referenced by dial_exec_full().

◆ 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_idcore_id of the CC transaction
debugoptional string to print for debugging purposes
Return values
0Success
-1Failure

Definition at line 3844 of file ccss.c.

3845{
3846 va_list ap;
3847 int res;
3848
3849 va_start(ap, debug);
3850 res = cc_request_state_change(CC_FAILED, core_id, debug, ap);
3851 va_end(ap);
3852 return res;
3853}
@ CC_FAILED
Definition: ccss.c:210

References CC_FAILED, cc_request_state_change(), cc_recall_ds_data::core_id, and debug.

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

◆ 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
chanThe channel from which to get the core_id.
Return values
core_idon success
-1Failure

Definition at line 2465 of file ccss.c.

2466{
2467 struct ast_datastore *datastore;
2468 struct dialed_cc_interfaces *cc_interfaces;
2469 int core_id_return;
2470
2471 ast_channel_lock(chan);
2472 if (!(datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
2473 ast_channel_unlock(chan);
2474 return -1;
2475 }
2476
2477 cc_interfaces = datastore->data;
2478 core_id_return = cc_interfaces->ignore ? -1 : cc_interfaces->core_id;
2479 ast_channel_unlock(chan);
2480 return core_id_return;
2481
2482}

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

◆ 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_idThe core ID to which this recall corresponds. This likely will have been obtained using the ast_cc_is_recall function
device_nameWhich device to find the monitor for.
Return values
NULLAppropriate monitor does not exist
non-NULLThe monitor to use for this recall

Definition at line 3486 of file ccss.c.

3487{
3488 struct cc_core_instance *core_instance = find_cc_core_instance(core_id);
3489 struct ast_cc_monitor *monitor_iter;
3490
3491 if (!core_instance) {
3492 return NULL;
3493 }
3494
3495 AST_LIST_LOCK(core_instance->monitors);
3496 AST_LIST_TRAVERSE(core_instance->monitors, monitor_iter, next) {
3497 if (!strcmp(monitor_iter->interface->device_name, device_name)) {
3498 /* Found a monitor. */
3499 cc_ref(monitor_iter, "Hand the requester of the monitor a reference");
3500 break;
3501 }
3502 }
3503 AST_LIST_UNLOCK(core_instance->monitors);
3504 cc_unref(core_instance, "Done with core instance ref in ast_cc_get_monitor_by_recall_core_id");
3505 return monitor_iter;
3506}
struct ast_cc_monitor * next
Definition: ccss.h:528
struct cc_monitor_tree * monitors
Definition: ccss.c:344

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

◆ 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
paramsThe CCSS configuration from which to get the value
nameThe name of the CCSS parameter we want
bufA preallocated buffer to hold the value
buf_lenThe size of buf
Return values
0Success
-1Failure

Definition at line 758 of file ccss.c.

760{
761 const char *value = NULL;
762
763 if (!strcasecmp(name, "cc_callback_sub")) {
765 } else if (!strcasecmp(name, "cc_agent_policy")) {
767 } else if (!strcasecmp(name, "cc_monitor_policy")) {
769 } else if (!strcasecmp(name, "cc_agent_dialstring")) {
771 }
772 if (value) {
773 ast_copy_string(buf, value, buf_len);
774 return 0;
775 }
776
777 /* The rest of these are all ints of some sort and require some
778 * snprintf-itude
779 */
780
781 if (!strcasecmp(name, "cc_offer_timer")) {
782 snprintf(buf, buf_len, "%u", ast_get_cc_offer_timer(params));
783 } else if (!strcasecmp(name, "ccnr_available_timer")) {
784 snprintf(buf, buf_len, "%u", ast_get_ccnr_available_timer(params));
785 } else if (!strcasecmp(name, "ccbs_available_timer")) {
786 snprintf(buf, buf_len, "%u", ast_get_ccbs_available_timer(params));
787 } else if (!strcasecmp(name, "cc_max_agents")) {
788 snprintf(buf, buf_len, "%u", ast_get_cc_max_agents(params));
789 } else if (!strcasecmp(name, "cc_max_monitors")) {
790 snprintf(buf, buf_len, "%u", ast_get_cc_max_monitors(params));
791 } else if (!strcasecmp(name, "cc_recall_timer")) {
792 snprintf(buf, buf_len, "%u", ast_get_cc_recall_timer(params));
793 } else {
794 ast_log(LOG_WARNING, "%s is not a valid CC parameter. Ignoring.\n", name);
795 return -1;
796 }
797
798 return 0;
799}
#define ast_log
Definition: astobj2.c:42
unsigned int ast_get_cc_recall_timer(struct ast_cc_config_params *config)
Get the cc_recall_timer.
Definition: ccss.c:923
static const char * agent_policy_to_str(enum ast_cc_agent_policies policy)
Definition: ccss.c:727
unsigned int ast_get_cc_offer_timer(struct ast_cc_config_params *config)
Get the cc_offer_timer.
Definition: ccss.c:893
unsigned int ast_get_ccbs_available_timer(struct ast_cc_config_params *config)
Get the ccbs_available_timer.
Definition: ccss.c:938
unsigned int ast_get_ccnr_available_timer(struct ast_cc_config_params *config)
Get the ccnr_available_timer.
Definition: ccss.c:908
unsigned int ast_get_cc_max_agents(struct ast_cc_config_params *config)
Get the cc_max_agents.
Definition: ccss.c:967
const char * ast_get_cc_callback_sub(struct ast_cc_config_params *config)
Get the name of the callback subroutine.
Definition: ccss.c:987
unsigned int ast_get_cc_max_monitors(struct ast_cc_config_params *config)
Get the cc_max_monitors.
Definition: ccss.c:977
static const char * monitor_policy_to_str(enum ast_cc_monitor_policies policy)
Definition: ccss.c:742
const char * ast_get_cc_agent_dialstring(struct ast_cc_config_params *config)
Get the cc_agent_dialstring.
Definition: ccss.c:953
char buf[BUFSIZE]
Definition: eagi_proxy.c:66
static const char name[]
Definition: format_mp3.c:68
#define LOG_WARNING
int value
Definition: syslog.c:37

References agent_policy_to_str(), ast_copy_string(), ast_get_cc_agent_dialstring(), ast_get_cc_agent_policy(), 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, buf, LOG_WARNING, monitor_policy_to_str(), name, NULL, and value.

Referenced by acf_cc_read().

◆ 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
nameName of configuration option being parsed.
Return values
1Yes, this is a CCSS configuration parameter.
0No, this is not a CCSS configuration parameter.

Definition at line 840 of file ccss.c.

841{
842 return (!strcasecmp(name, "cc_agent_policy") ||
843 !strcasecmp(name, "cc_monitor_policy") ||
844 !strcasecmp(name, "cc_offer_timer") ||
845 !strcasecmp(name, "ccnr_available_timer") ||
846 !strcasecmp(name, "ccbs_available_timer") ||
847 !strcasecmp(name, "cc_max_agents") ||
848 !strcasecmp(name, "cc_max_monitors") ||
849 !strcasecmp(name, "cc_callback_sub") ||
850 !strcasecmp(name, "cc_agent_dialstring") ||
851 !strcasecmp(name, "cc_recall_timer"));
852}

References name.

Referenced by process_dahdi().

◆ 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
chanThe channel to check
[out]core_idIf this is a valid CC recall, the core_id of the failed call will be placed in this output parameter
monitor_typeClarify 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
0Either this is not a recall or it is but this channel is not part of the recall
non-zeroThis is a recall and the channel in question is directly involved.

Definition at line 3405 of file ccss.c.

3406{
3407 struct ast_datastore *recall_datastore;
3408 struct cc_recall_ds_data *recall_data;
3409 struct cc_monitor_tree *interface_tree;
3410 char device_name[AST_CHANNEL_NAME];
3411 struct ast_cc_monitor *device_monitor;
3412 int core_id_candidate;
3413
3415
3416 *core_id = -1;
3417
3418 ast_channel_lock(chan);
3419 if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
3420 /* Obviously not a recall if the datastore isn't present */
3421 ast_channel_unlock(chan);
3422 return 0;
3423 }
3424
3425 recall_data = recall_datastore->data;
3426
3427 if (recall_data->ignore) {
3428 /* Though this is a recall, the call to this particular interface is not part of the
3429 * recall either because this is a call forward or because this is not the first
3430 * invocation of Dial during this call
3431 */
3432 ast_channel_unlock(chan);
3433 return 0;
3434 }
3435
3436 if (!recall_data->nested) {
3437 /* If the nested flag is not set, then this means that
3438 * the channel passed to this function is the caller making
3439 * the recall. This means that we shouldn't look through
3440 * the monitor tree for the channel because it shouldn't be
3441 * there. However, this is a recall though, so return true.
3442 */
3443 *core_id = recall_data->core_id;
3444 ast_channel_unlock(chan);
3445 return 1;
3446 }
3447
3448 if (ast_strlen_zero(monitor_type)) {
3449 /* If someone passed a NULL or empty monitor type, then it is clear
3450 * the channel they passed in was an incoming channel, and so searching
3451 * the list of dialed interfaces is not going to be helpful. Just return
3452 * false immediately.
3453 */
3454 ast_channel_unlock(chan);
3455 return 0;
3456 }
3457
3458 interface_tree = recall_data->interface_tree;
3459 ast_channel_get_device_name(chan, device_name, sizeof(device_name));
3460 /* We grab the value of the recall_data->core_id so that we
3461 * can unlock the channel before we start looking through the
3462 * interface list. That way we don't have to worry about a possible
3463 * clash between the channel lock and the monitor tree lock.
3464 */
3465 core_id_candidate = recall_data->core_id;
3466 ast_channel_unlock(chan);
3467
3468 /*
3469 * Now we need to find out if the channel device name
3470 * is in the list of interfaces in the called tree.
3471 */
3472 AST_LIST_LOCK(interface_tree);
3473 AST_LIST_TRAVERSE(interface_tree, device_monitor, next) {
3474 if (!strcmp(device_monitor->interface->device_name, device_name) &&
3475 !strcmp(device_monitor->interface->monitor_type, monitor_type)) {
3476 /* BOOM! Device is in the tree! We have a winner! */
3477 *core_id = core_id_candidate;
3478 AST_LIST_UNLOCK(interface_tree);
3479 return 1;
3480 }
3481 }
3482 AST_LIST_UNLOCK(interface_tree);
3483 return 0;
3484}
static force_inline int attribute_pure ast_strlen_zero(const char *s)
Definition: strings.h:65
const char * monitor_type
The type of monitor that should be used for this interface.
Definition: ccss.h:793
#define ast_assert(a)
Definition: utils.h:739

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(), ast_cc_monitor::core_id, 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, NULL, and recall_ds_info.

Referenced by cc_core_init_instance(), and wait_for_answer().

◆ 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
0Request successfully queued
-1Request could not be queued

Definition at line 3763 of file ccss.c.

3764{
3765 va_list ap;
3766 int res;
3767
3768 va_start(ap, debug);
3769 res = cc_request_state_change(CC_CALLEE_READY, core_id, debug, ap);
3770 va_end(ap);
3771 return res;
3772}
@ CC_CALLEE_READY
Definition: ccss.c:193

References CC_CALLEE_READY, cc_request_state_change(), dialed_cc_interfaces::core_id, and debug.

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

◆ 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
nameThe name of the monitored device
typeThe type of the monitored device (e.g. "generic")
Returns
The number of CC requests for the monitor

Definition at line 4333 of file ccss.c.

4334{
4335 struct count_monitors_cb_data data = {.device_name = name, .monitor_type = type,};
4336
4337 ao2_t_callback(cc_core_instances, OBJ_NODATA, count_monitors_cb, &data, "Counting agents");
4338 ast_log_dynamic_level(cc_logger_level, "Counted %d monitors\n", data.count);
4339 return data.count;
4340}
@ OBJ_NODATA
Definition: astobj2.h:1044
static int count_monitors_cb(void *obj, void *arg, int flags)
Definition: ccss.c:4313
const char * device_name
Definition: ccss.c:4308

References ao2_t_callback, ast_log_dynamic_level, cc_core_instances, 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().

◆ 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_idThe core ID for the CC transaction
monitor_nameThe name of the monitor on which the failure occurred
debugA debug message to print to the CC log

Definition at line 3906 of file ccss.c.

3907{
3908 struct ast_cc_monitor_failure_data *failure_data;
3909 int res;
3910 va_list ap;
3911
3912 if (!(failure_data = ast_calloc(1, sizeof(*failure_data)))) {
3913 return -1;
3914 }
3915
3916 if (!(failure_data->device_name = ast_strdup(monitor_name))) {
3917 ast_free(failure_data);
3918 return -1;
3919 }
3920
3921 va_start(ap, debug);
3922 if (ast_vasprintf(&failure_data->debug, debug, ap) == -1) {
3923 va_end(ap);
3924 ast_free((char *)failure_data->device_name);
3925 ast_free(failure_data);
3926 return -1;
3927 }
3928 va_end(ap);
3929
3930 failure_data->core_id = core_id;
3931
3933 if (res) {
3934 ast_free((char *)failure_data->device_name);
3935 ast_free((char *)failure_data->debug);
3936 ast_free(failure_data);
3937 }
3938 return res;
3939}
#define ast_strdup(str)
A wrapper for strdup()
Definition: astmm.h:241
#define ast_vasprintf(ret, fmt, ap)
A wrapper for vasprintf()
Definition: astmm.h:278
static int cc_monitor_failed(void *data)
Definition: ccss.c:3861
const char * device_name
Definition: ccss.c:3856

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

Referenced by ast_cc_available_timer_expire().

◆ 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_idThe core ID of the CC transaction
Return values
0Successfully alerted the core that party B is free
-1Could not alert the core that party B is free

Definition at line 4016 of file ccss.c.

4017{
4018 int res;
4019 struct cc_core_instance *core_instance = find_cc_core_instance(core_id);
4020
4021 if (!core_instance) {
4022 return -1;
4023 }
4024
4026 if (res) {
4027 cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
4028 }
4029 return res;
4030}
static int cc_party_b_free(void *data)
Definition: ccss.c:4004

References ast_taskprocessor_push(), cc_core_taskprocessor, cc_party_b_free(), cc_unref(), cc_core_instance::core_id, and find_cc_core_instance().

◆ 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
callbacksThe callbacks used by the monitor implementation
Return values
0Successfully registered
-1Failure to register

Definition at line 1162 of file ccss.c.

1163{
1164 struct cc_monitor_backend *backend = ast_calloc(1, sizeof(*backend));
1165
1166 if (!backend) {
1167 return -1;
1168 }
1169
1170 backend->callbacks = callbacks;
1171
1175 return 0;
1176}
const struct ast_cc_monitor_callbacks * callbacks
Definition: ccss.c:1157
struct cc_monitor_backend * next
Definition: ccss.c:1156

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

Referenced by load_module().

◆ 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_idcore_id of the CC transaction
debugoptional string to print for debugging purposes
Return values
0Success
-1Failure

Definition at line 3752 of file ccss.c.

3753{
3754 va_list ap;
3755 int res;
3756
3757 va_start(ap, debug);
3758 res = cc_request_state_change(CC_ACTIVE, core_id, debug, ap);
3759 va_end(ap);
3760 return res;
3761}

References CC_ACTIVE, cc_request_state_change(), dialed_cc_interfaces::core_id, and debug.

Referenced by cc_generic_monitor_request_cc(), and cc_stop_ringing().

◆ 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_idThe core ID of the CC transaction
Return values
0Successfully requested status
-1Failed to request status

Definition at line 3951 of file ccss.c.

3952{
3953 int res;
3954 struct cc_core_instance *core_instance = find_cc_core_instance(core_id);
3955
3956 if (!core_instance) {
3957 return -1;
3958 }
3959
3961 if (res) {
3962 cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
3963 }
3964 return res;
3965}
static int cc_status_request(void *data)
Definition: ccss.c:3941

References ast_taskprocessor_push(), cc_core_taskprocessor, cc_status_request(), cc_unref(), cc_core_instance::core_id, and find_cc_core_instance().

◆ 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_idThe core ID of the CC transaction
Return values
0Successfully requested for the phone to stop ringing
-1Could not request for the phone to stop ringing

Definition at line 3988 of file ccss.c.

3989{
3990 int res;
3991 struct cc_core_instance *core_instance = find_cc_core_instance(core_id);
3992
3993 if (!core_instance) {
3994 return -1;
3995 }
3996
3998 if (res) {
3999 cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
4000 }
4001 return res;
4002}
static int cc_stop_ringing(void *data)
Definition: ccss.c:3967

References ast_taskprocessor_push(), cc_core_taskprocessor, cc_stop_ringing(), cc_unref(), cc_core_instance::core_id, and find_cc_core_instance().

◆ 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
callbacksThe callbacks used by the monitor implementation

Definition at line 1195 of file ccss.c.

1196{
1197 struct cc_monitor_backend *backend;
1200 if (backend->callbacks == callbacks) {
1202 ast_free(backend);
1203 break;
1204 }
1205 }
1208}

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, callbacks, and cc_monitor_backend::next.

Referenced by __unload_module(), and unload_module().

◆ 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_chanThe calling channel
Return values
-1Error
0Success

Definition at line 3716 of file ccss.c.

3717{
3718 int core_id;
3719 int res = -1;
3720 struct ast_datastore *datastore;
3721 struct dialed_cc_interfaces *cc_interfaces;
3722 char cc_is_offerable;
3723
3724 ast_channel_lock(caller_chan);
3725 if (!(datastore = ast_channel_datastore_find(caller_chan, &dialed_cc_interfaces_info, NULL))) {
3726 ast_channel_unlock(caller_chan);
3727 return res;
3728 }
3729
3730 cc_interfaces = datastore->data;
3731 cc_is_offerable = cc_interfaces->is_original_caller;
3732 core_id = cc_interfaces->core_id;
3733 ast_channel_unlock(caller_chan);
3734
3735 if (cc_is_offerable) {
3736 res = cc_offer(core_id, "CC offered to caller %s", ast_channel_name(caller_chan));
3737 }
3738 return res;
3739}
static int cc_offer(const int core_id, const char *const debug,...)
Definition: ccss.c:3705
char is_original_caller
Definition: ccss.c:1903

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_info, dialed_cc_interfaces::is_original_caller, and NULL.

Referenced by ast_hangup().

◆ 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
0Not within the limits. Fail.
non-zeroWithin the limits. Success.

Definition at line 2460 of file ccss.c.

2461{
2463}
static unsigned int global_cc_max_requests
Definition: ccss.c:137
static int cc_request_count
Definition: ccss.c:141

References cc_request_count, and global_cc_max_requests.

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

◆ 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
paramsThe parameter structure to set the value on
nameThe name of the cc parameter
valueThe value of the parameter
Return values
0Success
-1Failure

Definition at line 801 of file ccss.c.

803{
804 unsigned int value_as_uint;
805 if (!strcasecmp(name, "cc_agent_policy")) {
807 } else if (!strcasecmp(name, "cc_monitor_policy")) {
809 } else if (!strcasecmp(name, "cc_agent_dialstring")) {
811 } else if (!strcasecmp(name, "cc_callback_sub")) {
813 return 0;
814 }
815
816 if (sscanf(value, "%30u", &value_as_uint) != 1) {
817 return -1;
818 }
819
820 if (!strcasecmp(name, "cc_offer_timer")) {
821 ast_set_cc_offer_timer(params, value_as_uint);
822 } else if (!strcasecmp(name, "ccnr_available_timer")) {
823 ast_set_ccnr_available_timer(params, value_as_uint);
824 } else if (!strcasecmp(name, "ccbs_available_timer")) {
825 ast_set_ccbs_available_timer(params, value_as_uint);
826 } else if (!strcasecmp(name, "cc_max_agents")) {
827 ast_set_cc_max_agents(params, value_as_uint);
828 } else if (!strcasecmp(name, "cc_max_monitors")) {
829 ast_set_cc_max_monitors(params, value_as_uint);
830 } else if (!strcasecmp(name, "cc_recall_timer")) {
831 ast_set_cc_recall_timer(params, value_as_uint);
832 } else {
833 ast_log(LOG_WARNING, "%s is not a valid CC parameter. Ignoring.\n", name);
834 return -1;
835 }
836
837 return 0;
838}
int ast_set_cc_agent_policy(struct ast_cc_config_params *config, enum ast_cc_agent_policies value)
Set the cc_agent_policy.
Definition: ccss.c:864
void ast_set_cc_max_monitors(struct ast_cc_config_params *config, unsigned int value)
Set the cc_max_monitors.
Definition: ccss.c:982
void ast_set_ccbs_available_timer(struct ast_cc_config_params *config, unsigned int value)
Set the ccbs_available_timer.
Definition: ccss.c:943
void ast_set_cc_callback_sub(struct ast_cc_config_params *config, const char *const value)
Set the callback subroutine name.
Definition: ccss.c:992
void ast_set_cc_agent_dialstring(struct ast_cc_config_params *config, const char *const value)
Set the cc_agent_dialstring.
Definition: ccss.c:958
void ast_set_cc_offer_timer(struct ast_cc_config_params *config, unsigned int value)
Set the cc_offer_timer.
Definition: ccss.c:898
void ast_set_cc_max_agents(struct ast_cc_config_params *config, unsigned int value)
Set the cc_max_agents.
Definition: ccss.c:972
static enum ast_cc_monitor_policies str_to_monitor_policy(const char *const value)
Definition: ccss.c:711
void ast_set_ccnr_available_timer(struct ast_cc_config_params *config, unsigned int value)
Set the ccnr_available_timer.
Definition: ccss.c:913
static enum ast_cc_agent_policies str_to_agent_policy(const char *const value)
Definition: ccss.c:697
int ast_set_cc_monitor_policy(struct ast_cc_config_params *config, enum ast_cc_monitor_policies value)
Set the cc_monitor_policy.
Definition: ccss.c:881
void ast_set_cc_recall_timer(struct ast_cc_config_params *config, unsigned int value)
Set the cc_recall_timer.
Definition: ccss.c:928

References ast_log, ast_set_cc_agent_dialstring(), ast_set_cc_agent_policy(), 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, name, str_to_agent_policy(), str_to_monitor_policy(), and value.

Referenced by acf_cc_write(), and process_dahdi().

◆ 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
configThe configuration to retrieve the cc_agent_dialstring from
Returns
The cc_agent_dialstring from this configuration

Definition at line 953 of file ccss.c.

954{
955 return config->cc_agent_dialstring;
956}
static const char config[]
Definition: chan_ooh323.c:111

References config.

Referenced by ast_cc_get_param(), and generic_recall().

◆ 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
configThe configuration to retrieve the policy from
Returns
The current cc_agent_policy for this configuration

Definition at line 859 of file ccss.c.

860{
861 return config->cc_agent_policy;
862}

References config.

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

◆ 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
configThe configuration to retrieve the callback_sub from
Returns
The callback_sub name

Definition at line 987 of file ccss.c.

988{
989 return config->cc_callback_sub;
990}

References config.

Referenced by ast_cc_get_param(), and generic_recall().

◆ 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
configThe configuration to retrieve the cc_max_agents from
Returns
The cc_max_agents from this configuration

Definition at line 967 of file ccss.c.

968{
969 return config->cc_max_agents;
970}

References config.

Referenced by ast_cc_get_param(), and cc_core_init_instance().

◆ 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
configThe configuration to retrieve the cc_max_monitors from
Returns
The cc_max_monitors from this configuration

Definition at line 977 of file ccss.c.

978{
979 return config->cc_max_monitors;
980}

References config.

Referenced by ast_cc_get_param(), and ast_queue_cc_frame().

◆ 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
configThe configuration to retrieve the cc_monitor_policy from
Returns
The cc_monitor_policy retrieved from the configuration

Definition at line 876 of file ccss.c.

877{
878 return config->cc_monitor_policy;
879}

References config.

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

◆ 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
configThe configuration to retrieve the cc_offer_timer from
Returns
The cc_offer_timer from this configuration

Definition at line 893 of file ccss.c.

894{
895 return config->cc_offer_timer;
896}

References config.

Referenced by ast_cc_get_param(), and cc_generic_agent_start_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
configThe configuration to retrieve the cc_recall_timer from
Returns
The cc_recall_timer from this configuration

Definition at line 923 of file ccss.c.

924{
925 return config->cc_recall_timer;
926}

References config.

Referenced by ast_cc_get_param(), and generic_recall().

◆ 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
configThe configuration to retrieve the ccbs_available_timer from
Returns
The ccbs_available_timer from this configuration

Definition at line 938 of file ccss.c.

939{
940 return config->ccbs_available_timer;
941}

References config.

Referenced by ast_cc_get_param(), and cc_generic_monitor_request_cc().

◆ 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
configThe configuration to retrieve the ccnr_available_timer from
Returns
The ccnr_available_timer from this configuration

Definition at line 908 of file ccss.c.

909{
910 return config->ccnr_available_timer;
911}

References config.

Referenced by ast_cc_get_param(), and cc_generic_monitor_request_cc().

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

Since
1.8

When a CC-capable application, such as Dial, receives a frame of type AST_CONTROL_CC, then it may call this function in order to have the device which sent the frame added to the tree of interfaces which is kept on the inbound channel.

Parameters
inboundThe inbound channel
outboundThe outbound channel (The one from which the CC frame was read)
frame_dataThe ast_frame's data.ptr field.

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 2293 of file ccss.c.

2294{
2295 char *device_name;
2296 char *dialstring;
2297 struct ast_cc_monitor *monitor;
2298 struct ast_datastore *cc_datastore;
2299 struct dialed_cc_interfaces *cc_interfaces;
2300 struct cc_control_payload *cc_data = frame_data;
2301 struct cc_core_instance *core_instance;
2302
2303 device_name = cc_data->device_name;
2304 dialstring = cc_data->dialstring;
2305
2306 ast_channel_lock(inbound);
2307 if (!(cc_datastore = ast_channel_datastore_find(inbound, &dialed_cc_interfaces_info, NULL))) {
2308 ast_log(LOG_WARNING, "Unable to retrieve CC datastore while processing CC frame from '%s'. CC services will be unavailable.\n", device_name);
2309 ast_channel_unlock(inbound);
2311 return;
2312 }
2313
2314 cc_interfaces = cc_datastore->data;
2315
2316 if (cc_interfaces->ignore) {
2317 ast_channel_unlock(inbound);
2319 return;
2320 }
2321
2322 if (!cc_interfaces->is_original_caller) {
2323 /* If the is_original_caller is not set on the *inbound* channel, then
2324 * it must be a local channel. As such, we do not want to create a core instance
2325 * or an agent for the local channel. Instead, we want to pass this along to the
2326 * other side of the local channel so that the original caller can benefit.
2327 */
2328 ast_channel_unlock(inbound);
2329 ast_indicate_data(inbound, AST_CONTROL_CC, cc_data, sizeof(*cc_data));
2330 return;
2331 }
2332
2333 core_instance = find_cc_core_instance(cc_interfaces->core_id);
2334 if (!core_instance) {
2335 core_instance = cc_core_init_instance(inbound, cc_interfaces->interface_tree,
2336 cc_interfaces->core_id, cc_data);
2337 if (!core_instance) {
2338 cc_interfaces->ignore = 1;
2339 ast_channel_unlock(inbound);
2341 return;
2342 }
2343 }
2344
2345 ast_channel_unlock(inbound);
2346
2347 /* Yeah this kind of sucks, but luckily most people
2348 * aren't dialing thousands of interfaces on every call
2349 *
2350 * This traversal helps us to not create duplicate monitors in
2351 * case a device queues multiple CC control frames.
2352 */
2353 AST_LIST_LOCK(cc_interfaces->interface_tree);
2354 AST_LIST_TRAVERSE(cc_interfaces->interface_tree, monitor, next) {
2355 if (!strcmp(monitor->interface->device_name, device_name)) {
2356 ast_log_dynamic_level(cc_logger_level, "Core %d: Device %s sent us multiple CC control frames. Ignoring those beyond the first.\n",
2357 core_instance->core_id, device_name);
2358 AST_LIST_UNLOCK(cc_interfaces->interface_tree);
2359 cc_unref(core_instance, "Returning early from ast_handle_cc_control_frame. Unref core_instance");
2361 return;
2362 }
2363 }
2364 AST_LIST_UNLOCK(cc_interfaces->interface_tree);
2365
2366 if (!(monitor = cc_device_monitor_init(device_name, dialstring, cc_data, core_instance->core_id))) {
2367 ast_log(LOG_WARNING, "Unable to create CC device interface for '%s'. CC services will be unavailable on this interface.\n", device_name);
2368 cc_unref(core_instance, "Returning early from ast_handle_cc_control_frame. Unref core_instance");
2370 return;
2371 }
2372
2373 AST_LIST_LOCK(cc_interfaces->interface_tree);
2374 cc_ref(monitor, "monitor tree's reference to the monitor");
2375 AST_LIST_INSERT_TAIL(cc_interfaces->interface_tree, monitor, next);
2376 AST_LIST_UNLOCK(cc_interfaces->interface_tree);
2377
2378 cc_extension_monitor_change_is_valid(core_instance, monitor->parent_id, monitor->interface->device_name, 0);
2379
2380 cc_publish_available(cc_interfaces->core_id, device_name, cc_service_to_string(cc_data->service));
2381
2382 cc_unref(core_instance, "Done with core_instance after handling CC control frame");
2383 cc_unref(monitor, "Unref reference from allocating monitor");
2384}
static void cc_publish_available(int core_id, const char *callee, const char *service)
Definition: ccss.c:1041
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)
Definition: ccss.c:2907
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)
Definition: ccss.c:2227
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)
Definition: ccss.c:2028
static const char * cc_service_to_string(enum ast_cc_service_type service)
Definition: ccss.c:412
int ast_indicate_data(struct ast_channel *chan, int condition, const void *data, size_t datalen)
Indicates condition of channel, with payload.
Definition: channel.c:4653
unsigned int parent_id
Definition: ccss.h:490
enum ast_cc_service_type service
Service offered by the endpoint.
Definition: ccss.c:265

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, ast_cc_interface::device_name, cc_control_payload::device_name, dialed_cc_interfaces_info, ast_cc_monitor::dialstring, cc_control_payload::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, 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().

◆ 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
chanThe channel for which further CC processing should be ignored.

Definition at line 3685 of file ccss.c.

3686{
3687 struct ast_datastore *cc_datastore;
3688 struct ast_datastore *cc_recall_datastore;
3689 struct dialed_cc_interfaces *cc_interfaces;
3690 struct cc_recall_ds_data *recall_cc_data;
3691
3692 ast_channel_lock(chan);
3693 if ((cc_datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
3694 cc_interfaces = cc_datastore->data;
3695 cc_interfaces->ignore = 1;
3696 }
3697
3698 if ((cc_recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
3699 recall_cc_data = cc_recall_datastore->data;
3700 recall_cc_data->ignore = 1;
3701 }
3702 ast_channel_unlock(chan);
3703}

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

Referenced by dial_exec_full(), and do_forward().

◆ 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
chanThe channel onto which to queue the frame
monitor_typeThe type of monitor to use when CC is requested
dialstringThe dial string used to call the device
serviceThe type of CC service the device is willing to offer
private_dataIf 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
0Success
-1Error

Definition at line 4114 of file ccss.c.

4116{
4117 struct ast_frame frame = {0,};
4118 char device_name[AST_CHANNEL_NAME];
4119 int retval;
4120 struct ast_cc_config_params *cc_params;
4121
4122 cc_params = ast_channel_get_cc_config_params(chan);
4123 if (!cc_params) {
4124 return -1;
4125 }
4126 ast_channel_get_device_name(chan, device_name, sizeof(device_name));
4127 if (ast_cc_monitor_count(device_name, monitor_type) >= ast_get_cc_max_monitors(cc_params)) {
4128 ast_log(LOG_NOTICE, "Not queuing a CC frame for device %s since it already has its maximum monitors allocated\n", device_name);
4129 return -1;
4130 }
4131
4132 if (ast_cc_build_frame(chan, cc_params, monitor_type, device_name, dialstring, service, private_data, &frame)) {
4133 /* Frame building failed. We can't use this. */
4134 return -1;
4135 }
4136 retval = ast_queue_frame(chan, &frame);
4137 ast_frfree(&frame);
4138 return retval;
4139}
int ast_cc_monitor_count(const char *const name, const char *const type)
Return the number of outstanding CC requests to a specific device.
Definition: ccss.c:4333
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.
Definition: ccss.c:4141
int ast_queue_frame(struct ast_channel *chan, struct ast_frame *f)
Queue one or more frames to a channel's frame queue.
Definition: channel.c:1139
static ENTRY retval
Definition: hsearch.c:50
#define ast_frfree(fr)
#define LOG_NOTICE
Data structure associated with a single frame of data.

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, retval, and service.

Referenced by analog_call().

◆ 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
configThe configuration to set the cc_agent_dialstring on
valueThe new cc_agent_dialstring we want to change to

Definition at line 958 of file ccss.c.

959{
960 if (ast_strlen_zero(value)) {
961 config->cc_agent_dialstring[0] = '\0';
962 } else {
963 ast_copy_string(config->cc_agent_dialstring, value, sizeof(config->cc_agent_dialstring));
964 }
965}

References ast_copy_string(), ast_strlen_zero(), config, and value.

Referenced by ast_cc_set_param().

◆ 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
configThe configuration to set the cc_agent_policy on
valueThe new cc_agent_policy we want to change to
Return values
0Success
-1Failure (likely due to bad input)

Definition at line 864 of file ccss.c.

865{
866 /* Screw C and its weak type checking for making me have to do this
867 * validation at runtime.
868 */
869 if (value < AST_CC_AGENT_NEVER || value > AST_CC_AGENT_GENERIC) {
870 return -1;
871 }
872 config->cc_agent_policy = value;
873 return 0;
874}

References AST_CC_AGENT_GENERIC, config, and value.

Referenced by ast_cc_set_param().

◆ 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
configThe configuration to set the callback_sub on
valueThe new callback subroutine we want to change to

Definition at line 992 of file ccss.c.

993{
994 if (ast_strlen_zero(value)) {
995 config->cc_callback_sub[0] = '\0';
996 } else {
997 ast_copy_string(config->cc_callback_sub, value, sizeof(config->cc_callback_sub));
998 }
999}

References ast_copy_string(), ast_strlen_zero(), config, and value.

Referenced by ast_cc_set_param().

◆ 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
chanThe channel to set the CC_INTERFACES variable on
extensionThe name of the extension for which we're setting the variable. This should be in the form of
exten@context 

Definition at line 3633 of file ccss.c.

3634{
3635 struct ast_datastore *recall_datastore;
3636 struct cc_monitor_tree *interface_tree;
3637 struct ast_cc_monitor *monitor_iter;
3638 struct cc_recall_ds_data *recall_data;
3639 struct ast_str *str = ast_str_create(64);
3640 int core_id;
3641
3642 if (!str) {
3643 return -1;
3644 }
3645
3646 ast_channel_lock(chan);
3647 if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
3648 ast_channel_unlock(chan);
3649 ast_free(str);
3650 return -1;
3651 }
3652 recall_data = recall_datastore->data;
3653 interface_tree = recall_data->interface_tree;
3654 core_id = recall_data->core_id;
3655 ast_channel_unlock(chan);
3656
3657 AST_LIST_LOCK(interface_tree);
3658 AST_LIST_TRAVERSE(interface_tree, monitor_iter, next) {
3659 if (!strcmp(monitor_iter->interface->device_name, extension)) {
3660 break;
3661 }
3662 }
3663
3664 if (!monitor_iter) {
3665 /* We couldn't find this extension. This may be because
3666 * we have been directed into an unexpected extension because
3667 * the admin has changed a CC_INTERFACES variable at some point.
3668 */
3669 AST_LIST_UNLOCK(interface_tree);
3670 ast_free(str);
3671 return -1;
3672 }
3673
3674 build_cc_interfaces_chanvar(monitor_iter, &str);
3675 AST_LIST_UNLOCK(interface_tree);
3676
3677 pbx_builtin_setvar_helper(chan, "CC_INTERFACES", ast_str_buffer(str));
3678 ast_log_dynamic_level(cc_logger_level, "Core %d: CC_INTERFACES set to %s\n",
3679 core_id, ast_str_buffer(str));
3680
3681 ast_free(str);
3682 return 0;
3683}
structure to hold extensions

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

Referenced by local_call().

◆ 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
configThe configuration to set the cc_max_agents on
valueThe new cc_max_agents we want to change to

Definition at line 972 of file ccss.c.

973{
974 config->cc_max_agents = value;
975}

References config, and value.

Referenced by ast_cc_set_param().

◆ 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
configThe configuration to set the cc_max_monitors on
valueThe new cc_max_monitors we want to change to

Definition at line 982 of file ccss.c.

983{
984 config->cc_max_monitors = value;
985}

References config, and value.

Referenced by ast_cc_set_param().

◆ 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
configThe configuration to set the cc_monitor_policy on
valueThe new cc_monitor_policy we want to change to
Return values
0Success
-1Failure (likely due to bad input)

Definition at line 881 of file ccss.c.

882{
883 /* Screw C and its weak type checking for making me have to do this
884 * validation at runtime.
885 */
886 if (value < AST_CC_MONITOR_NEVER || value > AST_CC_MONITOR_ALWAYS) {
887 return -1;
888 }
889 config->cc_monitor_policy = value;
890 return 0;
891}

References AST_CC_MONITOR_ALWAYS, config, and value.

Referenced by ast_cc_set_param().

◆ 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
configThe configuration to set the cc_offer_timer on
valueThe new cc_offer_timer we want to change to

Definition at line 898 of file ccss.c.

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

References ast_log, config, LOG_WARNING, and value.

Referenced by ast_cc_set_param().

◆ 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
configThe configuration to set the cc_recall_timer on
valueThe new cc_recall_timer we want to change to

Definition at line 928 of file ccss.c.

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

References ast_log, config, LOG_WARNING, and value.

Referenced by ast_cc_set_param().

◆ 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
configThe configuration to set the ccbs_available_timer on
valueThe new ccbs_available_timer we want to change to

Definition at line 943 of file ccss.c.

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

References ast_log, config, LOG_WARNING, and value.

Referenced by ast_cc_set_param().

◆ 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
configThe configuration to set the ccnr_available_timer on
valueThe new ccnr_available_timer we want to change to

Definition at line 913 of file ccss.c.

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

References ast_log, config, LOG_WARNING, and value.

Referenced by ast_cc_set_param().

◆ 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 3372 of file ccss.c.

3373{
3374 struct ast_datastore *recall_datastore = ast_datastore_alloc(&recall_ds_info, NULL);
3375 struct cc_recall_ds_data *recall_data;
3376 struct cc_core_instance *core_instance;
3377
3378 if (!recall_datastore) {
3379 return -1;
3380 }
3381
3382 if (!(recall_data = ast_calloc(1, sizeof(*recall_data)))) {
3383 ast_datastore_free(recall_datastore);
3384 return -1;
3385 }
3386
3387 if (!(core_instance = find_cc_core_instance(core_id))) {
3388 ast_free(recall_data);
3389 ast_datastore_free(recall_datastore);
3390 return -1;
3391 }
3392
3393 recall_data->interface_tree = cc_ref(core_instance->monitors,
3394 "Bump refcount for monitor tree for recall datastore");
3395 recall_data->core_id = core_id;
3396 recall_datastore->data = recall_data;
3397 recall_datastore->inheritance = DATASTORE_INHERIT_FOREVER;
3398 ast_channel_lock(chan);
3399 ast_channel_datastore_add(chan, recall_datastore);
3400 ast_channel_unlock(chan);
3401 cc_unref(core_instance, "Recall datastore set up. No need for core_instance ref");
3402 return 0;
3403}
int ast_channel_datastore_add(struct ast_channel *chan, struct ast_datastore *datastore)
Add a datastore to a channel.
Definition: channel.c:2385
#define DATASTORE_INHERIT_FOREVER
Definition: channel.h:192
#define ast_datastore_alloc(info, uid)
Definition: datastore.h:85
int ast_datastore_free(struct ast_datastore *datastore)
Free a data store object.
Definition: datastore.c:68
unsigned int inheritance
Definition: datastore.h:69

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

Referenced by generic_recall().