Mon Jun 27 16:51:03 2011

Asterisk developer's documentation


ccss.h File Reference

Call Completion Supplementary Services API. More...

#include "asterisk.h"
#include "asterisk/linkedlists.h"
#include "asterisk/devicestate.h"

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

Defines

#define ast_cc_config_params_init()   __ast_cc_config_params_init(__FILE__, __LINE__, __PRETTY_FUNCTION__)
 Allocate and initialize an ast_cc_config_params structure.
#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.

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

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.
int ast_cc_agent_accept_request (int core_id, const char *const debug,...)
 Accept inbound CC request.
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.
int ast_cc_agent_caller_available (int core_id, const char *const debug,...)
 Indicate that a previously unavailable caller has become available.
int ast_cc_agent_caller_busy (int core_id, const char *const debug,...)
 Indicate that the caller is busy.
int ast_cc_agent_recalling (int core_id, const char *const debug,...)
 Tell the CC core that a caller is currently recalling.
int ast_cc_agent_register (const struct ast_cc_agent_callbacks *callbacks)
 Register a set of agent callbacks with the core.
int ast_cc_agent_set_interfaces_chanvar (struct ast_channel *chan)
 Set the first level CC_INTERFACES channel variable for a channel.
int ast_cc_agent_status_response (int core_id, enum ast_device_state devstate)
 Response with a caller's current status.
void ast_cc_agent_unregister (const struct ast_cc_agent_callbacks *callbacks)
 Unregister a set of agent callbacks with the core.
int ast_cc_available_timer_expire (const void *data)
 Scheduler callback for available timer expiration.
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.
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.
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.
int ast_cc_call_init (struct ast_channel *chan, int *ignore_cc)
 Start the CC process on a call.
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.
int ast_cc_completed (struct ast_channel *chan, const char *const debug,...)
 Indicate recall has been acknowledged.
void ast_cc_config_params_destroy (struct ast_cc_config_params *params)
 Free memory from CCSS configuration 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
void ast_cc_default_config_params (struct ast_cc_config_params *params)
 Set the specified CC config params to default values.
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.
int ast_cc_failed (int core_id, const char *const debug,...)
 Indicate failure has occurred.
int ast_cc_get_current_core_id (struct ast_channel *chan)
 Get the core id for the current call.
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.
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
int ast_cc_init (void)
 Initialize CCSS.
int ast_cc_is_config_param (const char *const name)
 Is this a CCSS configuration parameter?
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.
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.
int ast_cc_monitor_count (const char *const name, const char *const type)
 Return the number of outstanding CC requests to a specific device.
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.
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.
int ast_cc_monitor_register (const struct ast_cc_monitor_callbacks *callbacks)
 Register a set of monitor callbacks with the core.
int ast_cc_monitor_request_acked (int core_id, const char *const debug,...)
 Indicate that an outbound entity has accepted our CC request.
int ast_cc_monitor_status_request (int core_id)
 Request the status of a caller or callers.
int ast_cc_monitor_stop_ringing (int core_id)
 Alert a caller to stop ringing.
void ast_cc_monitor_unregister (const struct ast_cc_monitor_callbacks *callbacks)
 Unregister a set of monitor callbacks with the core.
int ast_cc_offer (struct ast_channel *caller_chan)
 Offer CC to a caller.
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.
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
const char * ast_get_cc_agent_dialstring (struct ast_cc_config_params *config)
 Get the cc_agent_dialstring.
enum ast_cc_agent_policies ast_get_cc_agent_policy (struct ast_cc_config_params *config)
 Get the cc_agent_policy.
const char * ast_get_cc_callback_macro (struct ast_cc_config_params *config)
 Get the name of the callback_macro.
unsigned int ast_get_cc_max_agents (struct ast_cc_config_params *config)
 Get the cc_max_agents.
unsigned int ast_get_cc_max_monitors (struct ast_cc_config_params *config)
 Get the cc_max_monitors.
enum ast_cc_monitor_policies ast_get_cc_monitor_policy (struct ast_cc_config_params *config)
 Get the cc_monitor_policy.
unsigned int ast_get_cc_offer_timer (struct ast_cc_config_params *config)
 Get the cc_offer_timer.
unsigned int ast_get_cc_recall_timer (struct ast_cc_config_params *config)
 Get the cc_recall_timer.
unsigned int ast_get_ccbs_available_timer (struct ast_cc_config_params *config)
 Get the ccbs_available_timer.
unsigned int ast_get_ccnr_available_timer (struct ast_cc_config_params *config)
 Get the ccnr_available_timer.
void ast_handle_cc_control_frame (struct ast_channel *inbound, struct ast_channel *outbound, void *frame_data)
 Properly react to a CC control frame.
void ast_ignore_cc (struct ast_channel *chan)
 Mark the channel to ignore further CC activity.
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.
void ast_set_cc_agent_dialstring (struct ast_cc_config_params *config, const char *const value)
 Set the cc_agent_dialstring.
int ast_set_cc_agent_policy (struct ast_cc_config_params *config, enum ast_cc_agent_policies value)
 Set the cc_agent_policy.
void ast_set_cc_callback_macro (struct ast_cc_config_params *config, const char *const value)
 Set the callback_macro name.
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 extension as a starting point.
void ast_set_cc_max_agents (struct ast_cc_config_params *config, unsigned int value)
 Set the cc_max_agents.
void ast_set_cc_max_monitors (struct ast_cc_config_params *config, unsigned int value)
 Set the cc_max_monitors.
int ast_set_cc_monitor_policy (struct ast_cc_config_params *config, enum ast_cc_monitor_policies value)
 Set the cc_monitor_policy.
void ast_set_cc_offer_timer (struct ast_cc_config_params *config, unsigned int value)
 Set the cc_offer_timer.
void ast_set_cc_recall_timer (struct ast_cc_config_params *config, unsigned int value)
 Set the cc_recall_timer.
void ast_set_ccbs_available_timer (struct ast_cc_config_params *config, unsigned int value)
 Set the ccbs_available_timer.
void ast_set_ccnr_available_timer (struct ast_cc_config_params *config, unsigned int value)
 Set the ccnr_available_timer.
int ast_setup_cc_recall_datastore (struct ast_channel *chan, const int core_id)
 Set up a CC recall datastore on a channel.


Detailed Description

Call Completion Supplementary Services API.

Author:
Mark Michelson <mmichelson@digium.com>

Definition in file ccss.h.


Define Documentation

 
#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:
NULL Unable to allocate the structure
non-NULL A pointer to the newly allocated and initialized structure

Definition at line 135 of file ccss.h.

Referenced by ast_channel_cc_params_init(), build_peer(), cc_agent_init(), cc_device_monitor_init(), channel_cc_params_copy(), dahdi_chan_conf_default(), duplicate_pseudo(), sip_alloc(), and temp_peer().

#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 472 of file ccss.h.

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


Typedef Documentation

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:
chan A channel involved in the call. What we want is on a datastore on both incoming and outgoing so either may be provided
cc_params The CC configuration parameters for the outbound target
monitor_type The type of monitor to use when CC is requested
device_name The name of the outbound target device.
dialstring The dial string used when calling this specific interface
private_data If a native monitor is being used, and some channel-driver-specific private data has been allocated, then this parameter should contain a pointer to that data. If using a generic monitor, this parameter should remain NULL. Note that if this function should fail at some point, it is the responsibility of the caller to free the private data upon return.
For channel types that fail ast_request when the device is busy, we call into the channel driver with ast_cc_callback. This is the callback that is called in that case for each device found which could have been returned by ast_request.

Returns:
Nothing

Definition at line 1583 of file ccss.h.


Enumeration Type Documentation

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

00059                         {
00060    /* Some agent types allow for a caller to
00061     * request CC without reaching the CC_CALLER_OFFERED
00062     * state. In other words, the caller can request
00063     * CC while he is still on the phone from the failed
00064     * call. The generic agent is an agent which allows
00065     * for this behavior.
00066     */
00067    AST_CC_AGENT_SKIP_OFFER = (1 << 0),
00068 };

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

00047                            {
00048    /*! Never offer CCSS to the caller */
00049    AST_CC_AGENT_NEVER,
00050    /*! Offer CCSS using native signaling */
00051    AST_CC_AGENT_NATIVE,
00052    /*! Use generic agent for caller */
00053    AST_CC_AGENT_GENERIC,
00054 };

enum 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 861 of file ccss.h.

00861                                   {
00862    /*! CC request accepted */
00863    AST_CC_AGENT_RESPONSE_SUCCESS,
00864    /*! CC request not allowed at this time. Invalid state transition. */
00865    AST_CC_AGENT_RESPONSE_FAILURE_INVALID,
00866    /*! Too many CC requests in the system. */
00867    AST_CC_AGENT_RESPONSE_FAILURE_TOO_MANY,
00868 };

enum 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 479 of file ccss.h.

00479                           {
00480    AST_CC_DEVICE_MONITOR,
00481    AST_CC_EXTENSION_MONITOR,
00482 };

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

00074                              {
00075    /*! Never accept CCSS offers from callee */
00076    AST_CC_MONITOR_NEVER,
00077    /* CCSS only available if callee offers it through signaling */
00078    AST_CC_MONITOR_NATIVE,
00079    /*! Always use CCSS generic monitor for callee
00080     * Note that if callee offers CCSS natively, we still
00081     * will use a generic CCSS monitor if this is set
00082     */
00083    AST_CC_MONITOR_GENERIC,
00084    /*! Accept native CCSS offers, but if no offer is present,
00085     * use a generic CCSS monitor
00086     */
00087    AST_CC_MONITOR_ALWAYS,
00088 };

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

00032                          {
00033    /* No Service available/requested */
00034    AST_CC_NONE,
00035    /* Call Completion Busy Subscriber */
00036    AST_CC_CCBS,
00037    /* Call Completion No Response */
00038    AST_CC_CCNR,
00039    /* Call Completion Not Logged In (currently SIP only) */
00040    AST_CC_CCNL,
00041 };


Function Documentation

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

Allocate and initialize an ast_cc_config_params structure.

Note:
Reasonable default values are chosen for the parameters upon allocation.
Return values:
NULL Unable to allocate the structure
non-NULL A pointer to the newly allocated and initialized structure

Definition at line 530 of file ccss.c.

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

00531 {
00532 #if defined(__AST_DEBUG_MALLOC)
00533    struct ast_cc_config_params *params = __ast_malloc(sizeof(*params), file, line, function);
00534 #else
00535    struct ast_cc_config_params *params = ast_malloc(sizeof(*params));
00536 #endif
00537 
00538    if (!params) {
00539       return NULL;
00540    }
00541 
00542    ast_cc_default_config_params(params);
00543    return params;
00544 }

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

Accept inbound CC request.

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

Parameters:
core_id core_id of the CC transaction
debug optional string to print for debugging purposes
Return values:
0 Success
-1 Failure

Definition at line 3431 of file ccss.c.

References CC_CALLER_REQUESTED, and cc_request_state_change().

Referenced by ccreq_exec(), handle_cc_subscribe(), and sig_pri_handle_cis_subcmds().

03432 {
03433    va_list ap;
03434    int res;
03435 
03436    va_start(ap, debug);
03437    res = cc_request_state_change(CC_CALLER_REQUESTED, core_id, debug, ap);
03438    va_end(ap);
03439    return res;
03440 }

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

Call a callback on all agents of a specific type.

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

Note:
Since agents are refcounted, and this function returns a reference to the agent, it is imperative that you decrement the refcount of the agent once you have finished using it.
Parameters:
flags astobj2 search flags
function an ao2 callback function to call
arg the argument to the callback function
type The type of agents to call the callback on

Definition at line 413 of file ccss.c.

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

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

00414 {
00415    struct cc_callback_helper helper = {.function = function, .args = args, .type = type};
00416    struct cc_core_instance *core_instance;
00417    if ((core_instance = ao2_t_callback(cc_core_instances, flags, cc_agent_callback_helper, &helper,
00418                "Calling provided agent callback function"))) {
00419       struct ast_cc_agent *agent = cc_ref(core_instance->agent, "An outside entity needs the agent");
00420       cc_unref(core_instance, "agent callback done with the core_instance");
00421       return agent;
00422    }
00423    return NULL;
00424 }

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

Indicate that a previously unavailable caller has become available.

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

Parameters:
core_id core_id of the CC transaction
debug optional string to print for debugging purposes
Return values:
0 Success
-1 Failure

Definition at line 3475 of file ccss.c.

References CC_ACTIVE, and cc_request_state_change().

Referenced by cc_esc_publish_handler(), generic_agent_devstate_cb(), and sig_pri_handle_cis_subcmds().

03476 {
03477    va_list ap;
03478    int res;
03479 
03480    va_start(ap, debug);
03481    res = cc_request_state_change(CC_ACTIVE, core_id, debug, ap);
03482    va_end(ap);
03483    return res;
03484 }

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

Indicate that the caller is busy.

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

Parameters:
core_id core_id of the CC transaction
debug optional string to print for debugging purposes
Return values:
0 Success
-1 Failure

Definition at line 3464 of file ccss.c.

References CC_CALLER_BUSY, and cc_request_state_change().

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

03465 {
03466    va_list ap;
03467    int res;
03468 
03469    va_start(ap, debug);
03470    res = cc_request_state_change(CC_CALLER_BUSY, core_id, debug, ap);
03471    va_end(ap);
03472    return res;
03473 }

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

Tell the CC core that a caller is currently recalling.

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

Parameters:
core_id core_id of the CC transaction
debug optional string to print for debugging purposes
Return values:
0 Success
-1 Failure

Definition at line 3486 of file ccss.c.

References CC_RECALLING, and cc_request_state_change().

Referenced by generic_recall(), get_destination(), and sig_pri_handle_subcmds().

03487 {
03488    va_list ap;
03489    int res;
03490 
03491    va_start(ap, debug);
03492    res = cc_request_state_change(CC_RECALLING, core_id, debug, ap);
03493    va_end(ap);
03494    return res;
03495 }

int ast_cc_agent_register ( const struct ast_cc_agent_callbacks callbacks  ) 

Register a set of agent callbacks with the core.

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

Parameters:
callbacks The callbacks used by the agent implementation
Return values:
0 Successfully registered
-1 Failure to register

Definition at line 917 of file ccss.c.

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

Referenced by ast_cc_init(), and load_module().

00918 {
00919    struct cc_agent_backend *backend = ast_calloc(1, sizeof(*backend));
00920 
00921    if (!backend) {
00922       return -1;
00923    }
00924 
00925    backend->callbacks = callbacks;
00926    AST_RWLIST_WRLOCK(&cc_agent_backends);
00927    AST_RWLIST_INSERT_TAIL(&cc_agent_backends, backend, next);
00928    AST_RWLIST_UNLOCK(&cc_agent_backends);
00929    return 0;
00930 }

int ast_cc_agent_set_interfaces_chanvar ( struct ast_channel chan  ) 

Set the first level CC_INTERFACES channel variable for a channel.

Since:
1.8
Note:
Implementers of protocol-specific CC agents should call this function after calling ast_setup_cc_recall_datastore.

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

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

Parameters:
chan The channel to set the CC_INTERFACES variable on

Definition at line 3286 of file ccss.c.

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

Referenced by generic_recall(), handle_request_invite(), and sig_pri_handle_subcmds().

03287 {
03288    struct ast_datastore *recall_datastore;
03289    struct cc_monitor_tree *interface_tree;
03290    struct ast_cc_monitor *monitor;
03291    struct cc_recall_ds_data *recall_data;
03292    struct ast_str *str = ast_str_create(64);
03293    int core_id;
03294 
03295    if (!str) {
03296       return -1;
03297    }
03298 
03299    ast_channel_lock(chan);
03300    if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
03301       ast_channel_unlock(chan);
03302       ast_free(str);
03303       return -1;
03304    }
03305    recall_data = recall_datastore->data;
03306    interface_tree = recall_data->interface_tree;
03307    core_id = recall_data->core_id;
03308    ast_channel_unlock(chan);
03309 
03310    AST_LIST_LOCK(interface_tree);
03311    monitor = AST_LIST_FIRST(interface_tree);
03312    build_cc_interfaces_chanvar(monitor, str);
03313    AST_LIST_UNLOCK(interface_tree);
03314 
03315    pbx_builtin_setvar_helper(chan, "CC_INTERFACES", ast_str_buffer(str));
03316    ast_log_dynamic_level(cc_logger_level, "Core %d: CC_INTERFACES set to %s\n",
03317          core_id, ast_str_buffer(str));
03318 
03319    ast_free(str);
03320    return 0;
03321 }

int ast_cc_agent_status_response ( int  core_id,
enum ast_device_state  devstate 
)

Response with a caller's current status.

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

Parameters:
core_id The core ID of the CC transaction
devstate The current state of the caller to which the agent pertains
Return values:
0 Successfully responded with our status
-1 Failed to respond with our status

Definition at line 3751 of file ccss.c.

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

Referenced by cc_generic_agent_status_request(), sig_pri_handle_cis_subcmds(), and sip_cc_agent_status_request().

03752 {
03753    struct cc_status_response_args *args;
03754    struct cc_core_instance *core_instance;
03755    int res;
03756 
03757    args = ast_calloc(1, sizeof(*args));
03758    if (!args) {
03759       return -1;
03760    }
03761 
03762    core_instance = find_cc_core_instance(core_id);
03763    if (!core_instance) {
03764       ast_free(args);
03765       return -1;
03766    }
03767 
03768    args->core_instance = core_instance;
03769    args->devstate = devstate;
03770 
03771    res = ast_taskprocessor_push(cc_core_taskprocessor, cc_status_response, args);
03772    if (res) {
03773       cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
03774       ast_free(args);
03775    }
03776    return res;
03777 }

void ast_cc_agent_unregister ( const struct ast_cc_agent_callbacks callbacks  ) 

Unregister a set of agent callbacks with the core.

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

Parameters:
callbacks The callbacks used by the agent implementation
Return values:
0 Successfully unregistered
-1 Failure to unregister

Definition at line 932 of file ccss.c.

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

Referenced by __unload_module(), and unload_module().

00933 {
00934    struct cc_agent_backend *backend;
00935    AST_RWLIST_WRLOCK(&cc_agent_backends);
00936    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&cc_agent_backends, backend, next) {
00937       if (backend->callbacks == callbacks) {
00938          AST_RWLIST_REMOVE_CURRENT(next);
00939          ast_free(backend);
00940          break;
00941       }
00942    }
00943    AST_RWLIST_TRAVERSE_SAFE_END;
00944    AST_RWLIST_UNLOCK(&cc_agent_backends);
00945 }

int ast_cc_available_timer_expire ( const void *  data  ) 

Scheduler callback for available timer expiration.

Since:
1.8
Note:
When arming the available timer from within a device monitor, you MUST use this function as the callback for the scheduler.
Parameters:
data A reference to the CC monitor on which the timer was running.

Definition at line 1184 of file ccss.c.

References ast_cc_monitor_failed(), cc_unref(), and monitor.

Referenced by cc_generic_monitor_request_cc(), and sip_cc_monitor_request_cc().

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

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

Create a CC Control frame.

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

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

Definition at line 3834 of file ccss.c.

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

Referenced by ast_queue_cc_frame().

03838 {
03839    struct cc_control_payload *payload = ast_calloc(1, sizeof(*payload));
03840 
03841    if (!payload) {
03842       return -1;
03843    }
03844    if (cc_build_payload(chan, cc_params, monitor_type, device_name, dialstring, service, private_data, payload)) {
03845       /* Something screwed up, we can't make a frame with this */
03846       ast_free(payload);
03847       return -1;
03848    }
03849    frame->frametype = AST_FRAME_CONTROL;
03850    frame->subclass.integer = AST_CONTROL_CC;
03851    frame->data.ptr = payload;
03852    frame->datalen = sizeof(*payload);
03853    frame->mallocd = AST_MALLOCD_DATA;
03854    return 0;
03855 }

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

Callback made from ast_cc_callback for certain channel types.

Since:
1.8
Parameters:
inbound Incoming asterisk channel.
cc_params The CC configuration parameters for the outbound target
monitor_type The type of monitor to use when CC is requested
device_name The name of the outbound target device.
dialstring The dial string used when calling this specific interface
private_data If a native monitor is being used, and some channel-driver-specific private data has been allocated, then this parameter should contain a pointer to that data. If using a generic monitor, this parameter should remain NULL. Note that if this function should fail at some point, it is the responsibility of the caller to free the private data upon return.
For channel types that fail ast_request when the device is busy, we call into the channel driver with ast_cc_callback. This is the callback that is called in that case for each device found which could have been returned by ast_request.

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

Definition at line 3890 of file ccss.c.

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

Referenced by dial_exec_full().

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

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

References AST_CAUSE_BUSY, AST_CAUSE_CONGESTION, AST_CC_CCBS, AST_CC_GENERIC_MONITOR_TYPE, AST_CC_MONITOR_GENERIC, ast_channel_get_cc_config_params(), ast_channel_get_device_name(), AST_CHANNEL_NAME, ast_get_cc_monitor_policy(), ast_handle_cc_control_frame(), cc_build_payload(), and ast_channel::hangupcause.

Referenced by dial_exec_full().

03858 {
03859    char device_name[AST_CHANNEL_NAME];
03860    struct cc_control_payload payload;
03861    struct ast_cc_config_params *cc_params;
03862 
03863    if (outgoing->hangupcause != AST_CAUSE_BUSY && outgoing->hangupcause != AST_CAUSE_CONGESTION) {
03864       /* It doesn't make sense to try to offer CCBS to the caller if the reason for ast_call
03865        * failing is something other than busy or congestion
03866        */
03867       return;
03868    }
03869 
03870    cc_params = ast_channel_get_cc_config_params(outgoing);
03871    if (!cc_params) {
03872       return;
03873    }
03874    if (ast_get_cc_monitor_policy(cc_params) != AST_CC_MONITOR_GENERIC) {
03875       /* This sort of CCBS only works if using generic CC. For native, we would end up sending
03876        * a CC request for a non-existent call. The far end will reject this every time
03877        */
03878       return;
03879    }
03880 
03881    ast_channel_get_device_name(outgoing, device_name, sizeof(device_name));
03882    if (cc_build_payload(outgoing, cc_params, AST_CC_GENERIC_MONITOR_TYPE, device_name,
03883       dialstring, AST_CC_CCBS, NULL, &payload)) {
03884       /* Something screwed up, we can't make a frame with this */
03885       return;
03886    }
03887    ast_handle_cc_control_frame(incoming, outgoing, &payload);
03888 }

int ast_cc_call_init ( struct ast_channel chan,
int *  ignore_cc 
)

Start the CC process on a call.

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

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

Parameters:
chan The inbound channel calling the CC-capable application.
[out] ignore_cc Will be set non-zero if no further CC actions need to be taken
Return values:
0 Success
-1 Failure

Definition at line 2091 of file ccss.c.

References AST_CC_AGENT_NEVER, ast_channel_datastore_find(), ast_channel_get_cc_config_params(), ast_channel_lock, 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_ref(), cc_unref(), ast_channel::context, dialed_cc_interfaces::core_id, ast_datastore::data, dialed_cc_interfaces::dial_parent_id, dialed_cc_interfaces_info, ast_channel::exten, dialed_cc_interfaces::ignore, dialed_cc_interfaces::interface_tree, ast_channel::macrocontext, ast_channel::macroexten, monitor, ast_channel::name, cc_monitor_backend::next, and S_OR.

Referenced by dial_exec_full().

02092 {
02093    /* There are three situations to deal with here:
02094     *
02095     * 1. The channel does not have a dialed_cc_interfaces datastore on
02096     * it. This means that this is the first time that Dial has
02097     * been called. We need to create/initialize the datastore.
02098     *
02099     * 2. The channel does have a cc_interface datastore on it and
02100     * the "ignore" indicator is 0. This means that a Local channel
02101     * was called by a "parent" dial. We can check the datastore's
02102     * parent field to see who the root of this particular dial tree
02103     * is.
02104     *
02105     * 3. The channel does have a cc_interface datastore on it and
02106     * the "ignore" indicator is 1. This means that a second Dial call
02107     * is being made from an extension. In this case, we do not
02108     * want to make any additions/modifications to the datastore. We
02109     * will instead set a flag to indicate that CCSS is completely
02110     * disabled for this Dial attempt.
02111     */
02112 
02113    struct ast_datastore *cc_interfaces_datastore;
02114    struct dialed_cc_interfaces *interfaces;
02115    struct ast_cc_monitor *monitor;
02116    struct ast_cc_config_params *cc_params;
02117 
02118    ast_channel_lock(chan);
02119 
02120    cc_params = ast_channel_get_cc_config_params(chan);
02121    if (!cc_params) {
02122       ast_channel_unlock(chan);
02123       return -1;
02124    }
02125    if (ast_get_cc_agent_policy(cc_params) == AST_CC_AGENT_NEVER) {
02126       /* We can't offer CC to this caller anyway, so don't bother with CC on this call
02127        */
02128       *ignore_cc = 1;
02129       ast_channel_unlock(chan);
02130       ast_log_dynamic_level(cc_logger_level, "Agent policy for %s is 'never'. CC not possible\n", chan->name);
02131       return 0;
02132    }
02133 
02134    if (!(cc_interfaces_datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
02135       /* Situation 1 has occurred */
02136       ast_channel_unlock(chan);
02137       return cc_interfaces_datastore_init(chan);
02138    }
02139    interfaces = cc_interfaces_datastore->data;
02140    ast_channel_unlock(chan);
02141 
02142    if (interfaces->ignore) {
02143       /* Situation 3 has occurred */
02144       *ignore_cc = 1;
02145       ast_log_dynamic_level(cc_logger_level, "Datastore is present with ignore flag set. Ignoring CC offers on this call\n");
02146       return 0;
02147    }
02148 
02149    /* Situation 2 has occurred */
02150    if (!(monitor = cc_extension_monitor_init(S_OR(chan->macroexten, chan->exten),
02151          S_OR(chan->macrocontext, chan->context), interfaces->dial_parent_id))) {
02152       return -1;
02153    }
02154    monitor->core_id = interfaces->core_id;
02155    AST_LIST_LOCK(interfaces->interface_tree);
02156    cc_ref(monitor, "monitor tree's reference to the monitor");
02157    AST_LIST_INSERT_TAIL(interfaces->interface_tree, monitor, next);
02158    AST_LIST_UNLOCK(interfaces->interface_tree);
02159    interfaces->dial_parent_id = monitor->id;
02160    cc_unref(monitor, "Unref monitor's allocation reference");
02161    return 0;
02162 }

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

Run a callback for potential matching destinations.

Since:
1.8
Note:
See the explanation in ast_channel_tech::cc_callback for more details.
Parameters:
inbound 
tech Channel technology to use
dest Channel/group/peer or whatever the specific technology uses
callback Function to call when a target is reached
Return values:
Always 0, I guess.

Definition at line 3902 of file ccss.c.

References ast_get_channel_tech(), and ast_channel_tech::cc_callback.

Referenced by dial_exec_full().

03903 {
03904    const struct ast_channel_tech *chantech = ast_get_channel_tech(tech);
03905 
03906    if (chantech && chantech->cc_callback) {
03907       chantech->cc_callback(inbound, dest, callback);
03908    }
03909 
03910    return 0;
03911 }

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

Indicate recall has been acknowledged.

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

Parameters:
chan The inbound channel making the CC recall
debug optional string to print for debugging purposes
Return values:
0 Success
-1 Failure

Definition at line 3497 of file ccss.c.

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

03498 {
03499    struct ast_datastore *recall_datastore;
03500    struct cc_recall_ds_data *recall_data;
03501    int core_id;
03502    va_list ap;
03503    int res;
03504 
03505    ast_channel_lock(chan);
03506    if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
03507       /* Silly! Why did you call this function if there's no recall DS? */
03508       ast_channel_unlock(chan);
03509       return -1;
03510    }
03511    recall_data = recall_datastore->data;
03512    if (recall_data->nested || recall_data->ignore) {
03513       /* If this is being called from a nested Dial, it is too
03514        * early to determine if the recall has actually completed.
03515        * The outermost dial is the only one with the authority to
03516        * declare the recall to be complete.
03517        *
03518        * Similarly, if this function has been called when the
03519        * recall has progressed beyond the first dial, this is not
03520        * a legitimate time to declare the recall to be done. In fact,
03521        * that should have been done already.
03522        */
03523       ast_channel_unlock(chan);
03524       return -1;
03525    }
03526    core_id = recall_data->core_id;
03527    ast_channel_unlock(chan);
03528    va_start(ap, debug);
03529    res = cc_request_state_change(CC_COMPLETE, core_id, debug, ap);
03530    va_end(ap);
03531    return res;
03532 }

void ast_cc_config_params_destroy ( struct ast_cc_config_params params  ) 

Free memory from CCSS configuration params.

Note:
Just a call to ast_free for now...
Parameters:
params Pointer to structure whose memory we need to free
Return values:
void 

Definition at line 546 of file ccss.c.

References ast_free.

Referenced by __sip_destroy(), agent_destroy(), ast_channel_cc_params_init(), cc_interface_destroy(), channel_cc_params_destroy(), destroy_dahdi_pvt(), setup_dahdi(), and sip_destroy_peer().

00547 {
00548    ast_free(params);
00549 }

void ast_cc_copy_config_params ( struct ast_cc_config_params dest,
const struct ast_cc_config_params src 
)

copy CCSS configuration parameters from one structure to another

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

Parameters:
src The structure from which data is copied
dest The structure to which data is copied
Returns:
Nothing

Definition at line 708 of file ccss.c.

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

00709 {
00710    *dest = *src;
00711 }

void ast_cc_default_config_params ( struct ast_cc_config_params params  ) 

Set the specified CC config params to default values.

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

Parameters:
params CC config params to set to default values.
Returns:
Nothing

Definition at line 525 of file ccss.c.

References cc_default_params.

Referenced by __ast_cc_config_params_init().

00526 {
00527    *params = cc_default_params;
00528 }

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

Add a child dialstring to an extension monitor.

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

Parameters:
incoming The caller's channel
dialstring The dialstring used when requesting the outbound channel
device_name The device name associated with the requested outbound channel
Return values:
void 

Definition at line 1680 of file ccss.c.

References ast_calloc, ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, ast_copy_string(), AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, extension_monitor_pvt::child_dialstrings, ast_datastore::data, dialed_cc_interfaces::dial_parent_id, dialed_cc_interfaces_info, id, dialed_cc_interfaces::interface_tree, monitor, and cc_monitor_backend::next.

Referenced by dial_exec_full().

01681 {
01682    struct ast_datastore *cc_datastore;
01683    struct dialed_cc_interfaces *cc_interfaces;
01684    struct ast_cc_monitor *monitor;
01685    struct extension_monitor_pvt *extension_pvt;
01686    struct extension_child_dialstring *child_dialstring;
01687    struct cc_monitor_tree *interface_tree;
01688    int id;
01689 
01690    ast_channel_lock(incoming);
01691    if (!(cc_datastore = ast_channel_datastore_find(incoming, &dialed_cc_interfaces_info, NULL))) {
01692       ast_channel_unlock(incoming);
01693       return;
01694    }
01695 
01696    cc_interfaces = cc_datastore->data;
01697    interface_tree = cc_interfaces->interface_tree;
01698    id = cc_interfaces->dial_parent_id;
01699    ast_channel_unlock(incoming);
01700 
01701    AST_LIST_LOCK(interface_tree);
01702    AST_LIST_TRAVERSE(interface_tree, monitor, next) {
01703       if (monitor->id == id) {
01704          break;
01705       }
01706    }
01707 
01708    if (!monitor) {
01709       AST_LIST_UNLOCK(interface_tree);
01710       return;
01711    }
01712 
01713    extension_pvt = monitor->private_data;
01714    if (!(child_dialstring = ast_calloc(1, sizeof(*child_dialstring)))) {
01715       AST_LIST_UNLOCK(interface_tree);
01716       return;
01717    }
01718    ast_copy_string(child_dialstring->original_dialstring, dialstring, sizeof(child_dialstring->original_dialstring));
01719    ast_copy_string(child_dialstring->device_name, device_name, sizeof(child_dialstring->device_name));
01720    child_dialstring->is_valid = 1;
01721    AST_LIST_INSERT_TAIL(&extension_pvt->child_dialstrings, child_dialstring, next);
01722    AST_LIST_UNLOCK(interface_tree);
01723 }

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

Indicate failure has occurred.

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

Parameters:
core_id core_id of the CC transaction
debug optional string to print for debugging purposes
Return values:
0 Success
-1 Failure

Definition at line 3534 of file ccss.c.

References CC_FAILED, and cc_request_state_change().

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

03535 {
03536    va_list ap;
03537    int res;
03538 
03539    va_start(ap, debug);
03540    res = cc_request_state_change(CC_FAILED, core_id, debug, ap);
03541    va_end(ap);
03542    return res;
03543 }

int ast_cc_get_current_core_id ( struct ast_channel chan  ) 

Get the core id for the current call.

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

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

Parameters:
chan The channel from which to get the core_id.
Return values:
core_id on success
-1 Failure

Definition at line 2169 of file ccss.c.

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

Referenced by sig_pri_cc_generic_check(), and sip_handle_cc().

02170 {
02171    struct ast_datastore *datastore;
02172    struct dialed_cc_interfaces *cc_interfaces;
02173    int core_id_return;
02174 
02175    ast_channel_lock(chan);
02176    if (!(datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
02177       ast_channel_unlock(chan);
02178       return -1;
02179    }
02180 
02181    cc_interfaces = datastore->data;
02182    core_id_return = cc_interfaces->ignore ? -1 : cc_interfaces->core_id;
02183    ast_channel_unlock(chan);
02184    return core_id_return;
02185 
02186 }

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

Get the associated monitor given the device name and core_id.

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

Note:
This function locks the list of monitors that correspond to the core_id passed in. Be sure that you have no potential lock order issues when calling this function.
Parameters:
core_id The core ID to which this recall corresponds. This likely will have been obtained using the ast_cc_is_recall function
device_name Which device to find the monitor for.
Return values:
NULL Appropriate monitor does not exist
non-NULL The monitor to use for this recall

Definition at line 3174 of file ccss.c.

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

Referenced by sig_pri_call(), sig_pri_cc_generic_check(), and sip_call().

03175 {
03176    struct cc_core_instance *core_instance = find_cc_core_instance(core_id);
03177    struct ast_cc_monitor *monitor_iter;
03178 
03179    if (!core_instance) {
03180       return NULL;
03181    }
03182 
03183    AST_LIST_LOCK(core_instance->monitors);
03184    AST_LIST_TRAVERSE(core_instance->monitors, monitor_iter, next) {
03185       if (!strcmp(monitor_iter->interface->device_name, device_name)) {
03186          /* Found a monitor. */
03187          cc_ref(monitor_iter, "Hand the requester of the monitor a reference");
03188          break;
03189       }
03190    }
03191    AST_LIST_UNLOCK(core_instance->monitors);
03192    cc_unref(core_instance, "Done with core instance ref in ast_cc_get_monitor_by_recall_core_id");
03193    return monitor_iter;
03194 }

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

get a CCSS configuration parameter, given its name

Note:
Useful when reading input as a string, like from dialplan or manager.
Parameters:
params The CCSS configuration from which to get the value
name The name of the CCSS parameter we want
buf A preallocated buffer to hold the value
buf_len The size of buf
Return values:
0 Success
-1 Failure

Definition at line 612 of file ccss.c.

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

Referenced by acf_cc_read().

00614 {
00615    const char *value = NULL;
00616 
00617    if (!strcasecmp(name, "cc_callback_macro")) {
00618       value = ast_get_cc_callback_macro(params);
00619    } else if (!strcasecmp(name, "cc_agent_policy")) {
00620       value = agent_policy_to_str(ast_get_cc_agent_policy(params));
00621    } else if (!strcasecmp(name, "cc_monitor_policy")) {
00622       value = monitor_policy_to_str(ast_get_cc_monitor_policy(params));
00623    } else if (!strcasecmp(name, "cc_agent_dialstring")) {
00624       value = ast_get_cc_agent_dialstring(params);
00625    }
00626    if (value) {
00627       ast_copy_string(buf, value, buf_len);
00628       return 0;
00629    }
00630 
00631    /* The rest of these are all ints of some sort and require some
00632     * snprintf-itude
00633     */
00634 
00635    if (!strcasecmp(name, "cc_offer_timer")) {
00636       snprintf(buf, buf_len, "%u", ast_get_cc_offer_timer(params));
00637    } else if (!strcasecmp(name, "ccnr_available_timer")) {
00638       snprintf(buf, buf_len, "%u", ast_get_ccnr_available_timer(params));
00639    } else if (!strcasecmp(name, "ccbs_available_timer")) {
00640       snprintf(buf, buf_len, "%u", ast_get_ccbs_available_timer(params));
00641    } else if (!strcasecmp(name, "cc_max_agents")) {
00642       snprintf(buf, buf_len, "%u", ast_get_cc_max_agents(params));
00643    } else if (!strcasecmp(name, "cc_max_monitors")) {
00644       snprintf(buf, buf_len, "%u", ast_get_cc_max_monitors(params));
00645    } else if (!strcasecmp(name, "cc_recall_timer")) {
00646       snprintf(buf, buf_len, "%u", ast_get_cc_recall_timer(params));
00647    } else {
00648       ast_log(LOG_WARNING, "%s is not a valid CC parameter. Ignoring.\n", name);
00649       return -1;
00650    }
00651 
00652    return 0;
00653 }

int ast_cc_init ( void   ) 

Initialize CCSS.

Since:
1.8
Performs startup routines necessary for CC operation.

Return values:
0 Success
nonzero Failure

Definition at line 4218 of file ccss.c.

References ao2_t_container_alloc, ARRAY_LEN, ast_cc_agent_register(), ast_cc_monitor_register(), ast_cli_register_multiple(), ast_logger_register_level(), ast_register_application2(), ast_sched_thread_create(), ast_taskprocessor_get(), cc_cli, cc_core_instance_cmp_fn(), cc_core_instance_hash_fn(), cc_core_instances, cc_core_taskprocessor, cc_sched_thread, cccancel_exec(), ccreq_exec(), generic_agent_callbacks, generic_monitor_cbs, generic_monitor_cmp_fn(), generic_monitor_hash_fn(), generic_monitors, initialize_cc_max_requests(), and TPS_REF_DEFAULT.

Referenced by main().

04219 {
04220    int res;
04221 
04222    if (!(cc_core_instances = ao2_t_container_alloc(CC_CORE_INSTANCES_BUCKETS,
04223                cc_core_instance_hash_fn, cc_core_instance_cmp_fn,
04224                "Create core instance container"))) {
04225       return -1;
04226    }
04227    if (!(generic_monitors = ao2_t_container_alloc(CC_CORE_INSTANCES_BUCKETS,
04228                generic_monitor_hash_fn, generic_monitor_cmp_fn,
04229                "Create generic monitor container"))) {
04230       return -1;
04231    }
04232    if (!(cc_core_taskprocessor = ast_taskprocessor_get("CCSS core", TPS_REF_DEFAULT))) {
04233       return -1;
04234    }
04235    if (!(cc_sched_thread = ast_sched_thread_create())) {
04236       return -1;
04237    }
04238    res = ast_register_application2(ccreq_app, ccreq_exec, NULL, NULL, NULL);
04239    res |= ast_register_application2(cccancel_app, cccancel_exec, NULL, NULL, NULL);
04240    res |= ast_cc_monitor_register(&generic_monitor_cbs);
04241    res |= ast_cc_agent_register(&generic_agent_callbacks);
04242    ast_cli_register_multiple(cc_cli, ARRAY_LEN(cc_cli));
04243    cc_logger_level = ast_logger_register_level(CC_LOGGER_LEVEL_NAME);
04244    dialed_cc_interface_counter = 1;
04245    initialize_cc_max_requests();
04246    return res;
04247 }

int ast_cc_is_config_param ( const char *const   name  ) 

Is this a CCSS configuration parameter?

Since:
1.8
Parameters:
name Name of configuration option being parsed.
Return values:
1 Yes, this is a CCSS configuration parameter.
0 No, this is not a CCSS configuration parameter.

Definition at line 694 of file ccss.c.

Referenced by build_peer().

00695 {
00696    return (!strcasecmp(name, "cc_agent_policy") ||
00697             !strcasecmp(name, "cc_monitor_policy") ||
00698             !strcasecmp(name, "cc_offer_timer") ||
00699             !strcasecmp(name, "ccnr_available_timer") ||
00700             !strcasecmp(name, "ccbs_available_timer") ||
00701             !strcasecmp(name, "cc_max_agents") ||
00702             !strcasecmp(name, "cc_max_monitors") ||
00703             !strcasecmp(name, "cc_callback_macro") ||
00704             !strcasecmp(name, "cc_agent_dialstring") ||
00705             !strcasecmp(name, "cc_recall_timer"));
00706 }

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

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

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

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

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

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

Parameters:
chan The channel to check
[out] core_id If this is a valid CC recall, the core_id of the failed call will be placed in this output parameter
monitor_type Clarify which type of monitor type we are looking for if this is happening on a called channel. For incoming channels, this parameter is not used.
Return values:
0 Either this is not a recall or it is but this channel is not part of the recall
non-zero This is a recall and the channel in question is directly involved.

Definition at line 3093 of file ccss.c.

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

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

03094 {
03095    struct ast_datastore *recall_datastore;
03096    struct cc_recall_ds_data *recall_data;
03097    struct cc_monitor_tree *interface_tree;
03098    char device_name[AST_CHANNEL_NAME];
03099    struct ast_cc_monitor *device_monitor;
03100    int core_id_candidate;
03101 
03102    ast_assert(core_id != NULL);
03103 
03104    *core_id = -1;
03105 
03106    ast_channel_lock(chan);
03107    if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
03108       /* Obviously not a recall if the datastore isn't present */
03109       ast_channel_unlock(chan);
03110       return 0;
03111    }
03112 
03113    recall_data = recall_datastore->data;
03114 
03115    if (recall_data->ignore) {
03116       /* Though this is a recall, the call to this particular interface is not part of the
03117        * recall either because this is a call forward or because this is not the first
03118        * invocation of Dial during this call
03119        */
03120       ast_channel_unlock(chan);
03121       return 0;
03122    }
03123 
03124    if (!recall_data->nested) {
03125       /* If the nested flag is not set, then this means that
03126        * the channel passed to this function is the caller making
03127        * the recall. This means that we shouldn't look through
03128        * the monitor tree for the channel because it shouldn't be
03129        * there. However, this is a recall though, so return true.
03130        */
03131       *core_id = recall_data->core_id;
03132       ast_channel_unlock(chan);
03133       return 1;
03134    }
03135 
03136    if (ast_strlen_zero(monitor_type)) {
03137       /* If someone passed a NULL or empty monitor type, then it is clear
03138        * the channel they passed in was an incoming channel, and so searching
03139        * the list of dialed interfaces is not going to be helpful. Just return
03140        * false immediately.
03141        */
03142       ast_channel_unlock(chan);
03143       return 0;
03144    }
03145 
03146    interface_tree = recall_data->interface_tree;
03147    ast_channel_get_device_name(chan, device_name, sizeof(device_name));
03148    /* We grab the value of the recall_data->core_id so that we
03149     * can unlock the channel before we start looking through the
03150     * interface list. That way we don't have to worry about a possible
03151     * clash between the channel lock and the monitor tree lock.
03152     */
03153    core_id_candidate = recall_data->core_id;
03154    ast_channel_unlock(chan);
03155 
03156    /*
03157     * Now we need to find out if the channel device name
03158     * is in the list of interfaces in the called tree.
03159     */
03160    AST_LIST_LOCK(interface_tree);
03161    AST_LIST_TRAVERSE(interface_tree, device_monitor, next) {
03162       if (!strcmp(device_monitor->interface->device_name, device_name) &&
03163             !strcmp(device_monitor->interface->monitor_type, monitor_type)) {
03164          /* BOOM! Device is in the tree! We have a winner! */
03165          *core_id = core_id_candidate;
03166          AST_LIST_UNLOCK(interface_tree);
03167          return 1;
03168       }
03169    }
03170    AST_LIST_UNLOCK(interface_tree);
03171    return 0;
03172 }

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.
Parameters:
core_id The core ID of the corresponding CC transaction
debug 
Return values:
0 Request successfully queued
-1 Request could not be queued

Definition at line 3453 of file ccss.c.

References CC_CALLEE_READY, and cc_request_state_change().

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

03454 {
03455    va_list ap;
03456    int res;
03457 
03458    va_start(ap, debug);
03459    res = cc_request_state_change(CC_CALLEE_READY, core_id, debug, ap);
03460    va_end(ap);
03461    return res;
03462 }

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

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

Since:
1.8
Note:
This function will lock the list of monitors stored on every instance of the CC core. Callers of this function should be aware of this and avoid any potential lock ordering problems.
Parameters:
name The name of the monitored device
type The type of the monitored device (e.g. "generic")
Returns:
The number of CC requests for the monitor

Definition at line 4010 of file ccss.c.

References ao2_t_callback, ast_log_dynamic_level, cc_core_instances, count_monitors_cb_data::count, count_monitors_cb(), count_monitors_cb_data::device_name, and OBJ_NODATA.

Referenced by ast_queue_cc_frame().

04011 {
04012    struct count_monitors_cb_data data = {.device_name = name, .monitor_type = type,};
04013 
04014    ao2_t_callback(cc_core_instances, OBJ_NODATA, count_monitors_cb, &data, "Counting agents");
04015    ast_log_dynamic_level(cc_logger_level, "Counted %d monitors\n", data.count);
04016    return data.count;
04017 }

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

Indicate that a failure has occurred on a specific monitor.

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

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

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

Definition at line 3599 of file ccss.c.

References ast_calloc, ast_free, ast_strdup, ast_taskprocessor_push(), ast_vasprintf, cc_core_taskprocessor, and cc_monitor_failed().

Referenced by ast_cc_available_timer_expire(), cc_handle_publish_error(), handle_response(), and sig_pri_handle_cis_subcmds().

03600 {
03601    struct ast_cc_monitor_failure_data *failure_data;
03602    int res;
03603    va_list ap;
03604 
03605    if (!(failure_data = ast_calloc(1, sizeof(*failure_data)))) {
03606       return -1;
03607    }
03608 
03609    if (!(failure_data->device_name = ast_strdup(monitor_name))) {
03610       ast_free(failure_data);
03611       return -1;
03612    }
03613 
03614    va_start(ap, debug);
03615    if (ast_vasprintf(&failure_data->debug, debug, ap) == -1) {
03616       va_end(ap);
03617       ast_free((char *)failure_data->device_name);
03618       ast_free(failure_data);
03619       return -1;
03620    }
03621    va_end(ap);
03622 
03623    failure_data->core_id = core_id;
03624 
03625    res = ast_taskprocessor_push(cc_core_taskprocessor, cc_monitor_failed, failure_data);
03626    if (res) {
03627       ast_free((char *)failure_data->device_name);
03628       ast_free((char *)failure_data->debug);
03629       ast_free(failure_data);
03630    }
03631    return res;
03632 }

int ast_cc_monitor_party_b_free ( int  core_id  ) 

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

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

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

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

Parameters:
core_id The core ID of the CC transaction
Return values:
0 Successfully alerted the core that party B is free
-1 Could not alert the core that party B is free

Definition at line 3709 of file ccss.c.

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

Referenced by sig_pri_handle_cis_subcmds().

03710 {
03711    int res;
03712    struct cc_core_instance *core_instance = find_cc_core_instance(core_id);
03713 
03714    if (!core_instance) {
03715       return -1;
03716    }
03717 
03718    res = ast_taskprocessor_push(cc_core_taskprocessor, cc_party_b_free, core_instance);
03719    if (res) {
03720       cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
03721    }
03722    return res;
03723 }

int ast_cc_monitor_register ( const struct ast_cc_monitor_callbacks callbacks  ) 

Register a set of monitor callbacks with the core.

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

Parameters:
callbacks The callbacks used by the monitor implementation
Return values:
0 Successfully registered
-1 Failure to register

Definition at line 862 of file ccss.c.

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

Referenced by ast_cc_init(), and load_module().

00863 {
00864    struct cc_monitor_backend *backend = ast_calloc(1, sizeof(*backend));
00865 
00866    if (!backend) {
00867       return -1;
00868    }
00869 
00870    backend->callbacks = callbacks;
00871 
00872    AST_RWLIST_WRLOCK(&cc_monitor_backends);
00873    AST_RWLIST_INSERT_TAIL(&cc_monitor_backends, backend, next);
00874    AST_RWLIST_UNLOCK(&cc_monitor_backends);
00875    return 0;
00876 }

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

Indicate that an outbound entity has accepted our CC request.

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

Parameters:
core_id core_id of the CC transaction
debug optional string to print for debugging purposes
Return values:
0 Success
-1 Failure

Definition at line 3442 of file ccss.c.

References CC_ACTIVE, and cc_request_state_change().

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

03443 {
03444    va_list ap;
03445    int res;
03446 
03447    va_start(ap, debug);
03448    res = cc_request_state_change(CC_ACTIVE, core_id, debug, ap);
03449    va_end(ap);
03450    return res;
03451 }

int ast_cc_monitor_status_request ( int  core_id  ) 

Request the status of a caller or callers.

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

Note:
Zero or more responses may come as a result.
Parameters:
core_id The core ID of the CC transaction
Return values:
0 Successfully requested status
-1 Failed to request status

Definition at line 3644 of file ccss.c.

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

Referenced by sig_pri_handle_cis_subcmds().

03645 {
03646    int res;
03647    struct cc_core_instance *core_instance = find_cc_core_instance(core_id);
03648 
03649    if (!core_instance) {
03650       return -1;
03651    }
03652 
03653    res = ast_taskprocessor_push(cc_core_taskprocessor, cc_status_request, core_instance);
03654    if (res) {
03655       cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
03656    }
03657    return res;
03658 }

int ast_cc_monitor_stop_ringing ( int  core_id  ) 

Alert a caller to stop ringing.

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

Parameters:
core_id The core ID of the CC transaction
Return values:
0 Successfully requested for the phone to stop ringing
-1 Could not request for the phone to stop ringing

Definition at line 3681 of file ccss.c.

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

Referenced by sig_pri_handle_cis_subcmds().

03682 {
03683    int res;
03684    struct cc_core_instance *core_instance = find_cc_core_instance(core_id);
03685 
03686    if (!core_instance) {
03687       return -1;
03688    }
03689 
03690    res = ast_taskprocessor_push(cc_core_taskprocessor, cc_stop_ringing, core_instance);
03691    if (res) {
03692       cc_unref(core_instance, "Unref core instance. ast_taskprocessor_push failed");
03693    }
03694    return res;
03695 }

void ast_cc_monitor_unregister ( const struct ast_cc_monitor_callbacks callbacks  ) 

Unregister a set of monitor callbacks with the core.

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

Parameters:
callbacks The callbacks used by the monitor implementation
Return values:
0 Successfully unregistered
-1 Failure to unregister

Definition at line 895 of file ccss.c.

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

Referenced by __unload_module(), and unload_module().

00896 {
00897    struct cc_monitor_backend *backend;
00898    AST_RWLIST_WRLOCK(&cc_monitor_backends);
00899    AST_RWLIST_TRAVERSE_SAFE_BEGIN(&cc_monitor_backends, backend, next) {
00900       if (backend->callbacks == callbacks) {
00901          AST_RWLIST_REMOVE_CURRENT(next);
00902          ast_free(backend);
00903          break;
00904       }
00905    }
00906    AST_RWLIST_TRAVERSE_SAFE_END;
00907    AST_RWLIST_UNLOCK(&cc_monitor_backends);
00908 }

int ast_cc_offer ( struct ast_channel caller_chan  ) 

Offer CC to a caller.

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

Parameters:
caller_chan The calling channel
Return values:
-1 Error
0 Success

Definition at line 3406 of file ccss.c.

References ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, cc_offer(), cc_recall_ds_data::core_id, dialed_cc_interfaces::core_id, ast_datastore::data, dialed_cc_interfaces_info, dialed_cc_interfaces::is_original_caller, and ast_channel::name.

Referenced by ast_hangup().

03407 {
03408    int core_id;
03409    int res = -1;
03410    struct ast_datastore *datastore;
03411    struct dialed_cc_interfaces *cc_interfaces;
03412    char cc_is_offerable;
03413 
03414    ast_channel_lock(caller_chan);
03415    if (!(datastore = ast_channel_datastore_find(caller_chan, &dialed_cc_interfaces_info, NULL))) {
03416       ast_channel_unlock(caller_chan);
03417       return res;
03418    }
03419 
03420    cc_interfaces = datastore->data;
03421    cc_is_offerable = cc_interfaces->is_original_caller;
03422    core_id = cc_interfaces->core_id;
03423    ast_channel_unlock(caller_chan);
03424 
03425    if (cc_is_offerable) {
03426       res = cc_offer(core_id, "CC offered to caller %s", caller_chan->name);
03427    }
03428    return res;
03429 }

int ast_cc_request_is_within_limits ( void   ) 

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

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

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

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

Definition at line 2164 of file ccss.c.

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

02165 {
02166    return cc_request_count < global_cc_max_requests;
02167 }

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

set a CCSS configuration parameter, given its name

Note:
Useful when parsing config files when used in conjunction with ast_ccss_is_cc_config_param.
Parameters:
params The parameter structure to set the value on
name The name of the cc parameter
value The value of the parameter
Return values:
0 Success
-1 Failure

Definition at line 655 of file ccss.c.

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

Referenced by acf_cc_write(), and build_peer().

00657 {
00658    unsigned int value_as_uint;
00659    if (!strcasecmp(name, "cc_agent_policy")) {
00660       return ast_set_cc_agent_policy(params, str_to_agent_policy(value));
00661    } else if (!strcasecmp(name, "cc_monitor_policy")) {
00662       return ast_set_cc_monitor_policy(params, str_to_monitor_policy(value));
00663    } else if (!strcasecmp(name, "cc_agent_dialstring")) {
00664       ast_set_cc_agent_dialstring(params, value);
00665    } else if (!strcasecmp(name, "cc_callback_macro")) {
00666       ast_set_cc_callback_macro(params, value);
00667       return 0;
00668    }
00669 
00670    if (!sscanf(value, "%30u", &value_as_uint) == 1) {
00671       return -1;
00672    }
00673 
00674    if (!strcasecmp(name, "cc_offer_timer")) {
00675       ast_set_cc_offer_timer(params, value_as_uint);
00676    } else if (!strcasecmp(name, "ccnr_available_timer")) {
00677       ast_set_ccnr_available_timer(params, value_as_uint);
00678    } else if (!strcasecmp(name, "ccbs_available_timer")) {
00679       ast_set_ccbs_available_timer(params, value_as_uint);
00680    } else if (!strcasecmp(name, "cc_max_agents")) {
00681       ast_set_cc_max_agents(params, value_as_uint);
00682    } else if (!strcasecmp(name, "cc_max_monitors")) {
00683       ast_set_cc_max_monitors(params, value_as_uint);
00684    } else if (!strcasecmp(name, "cc_recall_timer")) {
00685       ast_set_cc_recall_timer(params, value_as_uint);
00686    } else {
00687       ast_log(LOG_WARNING, "%s is not a valid CC parameter. Ignoring.\n", name);
00688       return -1;
00689    }
00690 
00691    return 0;
00692 }

const char* ast_get_cc_agent_dialstring ( struct ast_cc_config_params config  ) 

Get the cc_agent_dialstring.

Since:
1.8
Parameters:
config The configuration to retrieve the cc_agent_dialstring from
Returns:
The cc_agent_dialstring from this configuration

Definition at line 807 of file ccss.c.

References config.

Referenced by ast_cc_get_param(), and generic_recall().

00808 {
00809    return config->cc_agent_dialstring;
00810 }

enum ast_cc_agent_policies ast_get_cc_agent_policy ( struct ast_cc_config_params config  ) 

Get the cc_agent_policy.

Since:
1.8
Parameters:
config The configuration to retrieve the policy from
Returns:
The current cc_agent_policy for this configuration

Definition at line 713 of file ccss.c.

References config.

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

00714 {
00715    return config->cc_agent_policy;
00716 }

const char* ast_get_cc_callback_macro ( struct ast_cc_config_params config  ) 

Get the name of the callback_macro.

Since:
1.8
Parameters:
config The configuration to retrieve the callback_macro from
Returns:
The callback_macro name

Definition at line 841 of file ccss.c.

References config.

Referenced by ast_cc_get_param(), and generic_recall().

00842 {
00843    return config->cc_callback_macro;
00844 }

unsigned int ast_get_cc_max_agents ( struct ast_cc_config_params config  ) 

Get the cc_max_agents.

Since:
1.8
Parameters:
config The configuration to retrieve the cc_max_agents from
Returns:
The cc_max_agents from this configuration

Definition at line 821 of file ccss.c.

References config.

Referenced by ast_cc_get_param(), and cc_core_init_instance().

00822 {
00823    return config->cc_max_agents;
00824 }

unsigned int ast_get_cc_max_monitors ( struct ast_cc_config_params config  ) 

Get the cc_max_monitors.

Since:
1.8
Parameters:
config The configuration to retrieve the cc_max_monitors from
Returns:
The cc_max_monitors from this configuration

Definition at line 831 of file ccss.c.

References config.

Referenced by ast_cc_get_param(), and ast_queue_cc_frame().

00832 {
00833    return config->cc_max_monitors;
00834 }

enum ast_cc_monitor_policies ast_get_cc_monitor_policy ( struct ast_cc_config_params config  ) 

Get the cc_monitor_policy.

Since:
1.8
Parameters:
config The configuration to retrieve the cc_monitor_policy from
Returns:
The cc_monitor_policy retrieved from the configuration

Definition at line 730 of file ccss.c.

References config.

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

00731 {
00732    return config->cc_monitor_policy;
00733 }

unsigned int ast_get_cc_offer_timer ( struct ast_cc_config_params config  ) 

Get the cc_offer_timer.

Since:
1.8
Parameters:
config The configuration to retrieve the cc_offer_timer from
Returns:
The cc_offer_timer from this configuration

Definition at line 747 of file ccss.c.

References config.

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

00748 {
00749    return config->cc_offer_timer;
00750 }

unsigned int ast_get_cc_recall_timer ( struct ast_cc_config_params config  ) 

Get the cc_recall_timer.

Since:
1.8
Parameters:
config The configuration to retrieve the cc_recall_timer from
Returns:
The cc_recall_timer from this configuration

Definition at line 777 of file ccss.c.

References config.

Referenced by ast_cc_get_param(), and generic_recall().

00778 {
00779    return config->cc_recall_timer;
00780 }

unsigned int ast_get_ccbs_available_timer ( struct ast_cc_config_params config  ) 

Get the ccbs_available_timer.

Since:
1.8
Parameters:
config The configuration to retrieve the ccbs_available_timer from
Returns:
The ccbs_available_timer from this configuration

Definition at line 792 of file ccss.c.

References config.

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

00793 {
00794    return config->ccbs_available_timer;
00795 }

unsigned int ast_get_ccnr_available_timer ( struct ast_cc_config_params config  ) 

Get the ccnr_available_timer.

Since:
1.8
Parameters:
config The configuration to retrieve the ccnr_available_timer from
Returns:
The ccnr_available_timer from this configuration

Definition at line 762 of file ccss.c.

References config.

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

00763 {
00764    return config->ccnr_available_timer;
00765 }

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

Properly react to a CC control frame.

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

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

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

Definition at line 1993 of file ccss.c.

References ast_channel_datastore_find(), ast_channel_lock, ast_channel_unlock, AST_CONTROL_CC, ast_indicate_data(), AST_LIST_INSERT_TAIL, AST_LIST_LOCK, AST_LIST_TRAVERSE, AST_LIST_UNLOCK, ast_log(), ast_log_dynamic_level, call_destructor_with_no_monitor(), cc_core_init_instance(), cc_device_monitor_init(), cc_extension_monitor_change_is_valid(), cc_ref(), cc_service_to_string(), cc_unref(), dialed_cc_interfaces::core_id, cc_core_instance::core_id, ast_datastore::data, cc_control_payload::device_name, dialed_cc_interfaces_info, ast_cc_monitor::dialstring, cc_control_payload::dialstring, EVENT_FLAG_CC, find_cc_core_instance(), dialed_cc_interfaces::ignore, dialed_cc_interfaces::interface_tree, dialed_cc_interfaces::is_original_caller, LOG_WARNING, manager_event, monitor, cc_control_payload::monitor_type, cc_monitor_backend::next, cc_control_payload::private_data, and cc_control_payload::service.

Referenced by ast_cc_busy_interface(), and ast_cc_call_failed().

01994 {
01995    char *device_name;
01996    char *dialstring;
01997    struct ast_cc_monitor *monitor;
01998    struct ast_datastore *cc_datastore;
01999    struct dialed_cc_interfaces *cc_interfaces;
02000    struct cc_control_payload *cc_data = frame_data;
02001    struct cc_core_instance *core_instance;
02002 
02003    device_name = cc_data->device_name;
02004    dialstring = cc_data->dialstring;
02005 
02006    ast_channel_lock(inbound);
02007    if (!(cc_datastore = ast_channel_datastore_find(inbound, &dialed_cc_interfaces_info, NULL))) {
02008       ast_log(LOG_WARNING, "Unable to retrieve CC datastore while processing CC frame from '%s'. CC services will be unavailable.\n", device_name);
02009       ast_channel_unlock(inbound);
02010       call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
02011       return;
02012    }
02013 
02014    cc_interfaces = cc_datastore->data;
02015 
02016    if (cc_interfaces->ignore) {
02017       ast_channel_unlock(inbound);
02018       call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
02019       return;
02020    }
02021 
02022    if (!cc_interfaces->is_original_caller) {
02023       /* If the is_original_caller is not set on the *inbound* channel, then
02024        * it must be a local channel. As such, we do not want to create a core instance
02025        * or an agent for the local channel. Instead, we want to pass this along to the
02026        * other side of the local channel so that the original caller can benefit.
02027        */
02028       ast_channel_unlock(inbound);
02029       ast_indicate_data(inbound, AST_CONTROL_CC, cc_data, sizeof(*cc_data));
02030       return;
02031    }
02032 
02033    core_instance = find_cc_core_instance(cc_interfaces->core_id);
02034    if (!core_instance) {
02035       core_instance = cc_core_init_instance(inbound, cc_interfaces->interface_tree,
02036          cc_interfaces->core_id, cc_data);
02037       if (!core_instance) {
02038          cc_interfaces->ignore = 1;
02039          ast_channel_unlock(inbound);
02040          call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
02041          return;
02042       }
02043    }
02044 
02045    ast_channel_unlock(inbound);
02046 
02047    /* Yeah this kind of sucks, but luckily most people
02048     * aren't dialing thousands of interfaces on every call
02049     *
02050     * This traversal helps us to not create duplicate monitors in
02051     * case a device queues multiple CC control frames.
02052     */
02053    AST_LIST_LOCK(cc_interfaces->interface_tree);
02054    AST_LIST_TRAVERSE(cc_interfaces->interface_tree, monitor, next) {
02055       if (!strcmp(monitor->interface->device_name, device_name)) {
02056          ast_log_dynamic_level(cc_logger_level, "Core %d: Device %s sent us multiple CC control frames. Ignoring those beyond the first.\n",
02057                core_instance->core_id, device_name);
02058          AST_LIST_UNLOCK(cc_interfaces->interface_tree);
02059          cc_unref(core_instance, "Returning early from ast_handle_cc_control_frame. Unref core_instance");
02060          call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
02061          return;
02062       }
02063    }
02064    AST_LIST_UNLOCK(cc_interfaces->interface_tree);
02065 
02066    if (!(monitor = cc_device_monitor_init(device_name, dialstring, cc_data, core_instance->core_id))) {
02067       ast_log(LOG_WARNING, "Unable to create CC device interface for '%s'. CC services will be unavailable on this interface.\n", device_name);
02068       cc_unref(core_instance, "Returning early from ast_handle_cc_control_frame. Unref core_instance");
02069       call_destructor_with_no_monitor(cc_data->monitor_type, cc_data->private_data);
02070       return;
02071    }
02072 
02073    AST_LIST_LOCK(cc_interfaces->interface_tree);
02074    cc_ref(monitor, "monitor tree's reference to the monitor");
02075    AST_LIST_INSERT_TAIL(cc_interfaces->interface_tree, monitor, next);
02076    AST_LIST_UNLOCK(cc_interfaces->interface_tree);
02077 
02078    cc_extension_monitor_change_is_valid(core_instance, monitor->parent_id, monitor->interface->device_name, 0);
02079 
02080    manager_event(EVENT_FLAG_CC, "CCAvailable",
02081       "CoreID: %d\r\n"
02082       "Callee: %s\r\n"
02083       "Service: %s\r\n",
02084       cc_interfaces->core_id, device_name, cc_service_to_string(cc_data->service)
02085    );
02086 
02087    cc_unref(core_instance, "Done with core_instance after handling CC control frame");
02088    cc_unref(monitor, "Unref reference from allocating monitor");
02089 }

void ast_ignore_cc ( struct ast_channel chan  ) 

Mark the channel to ignore further CC activity.

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

Parameters:
chan The channel for which further CC processing should be ignored.
Return values:
void 

Definition at line 3375 of file ccss.c.

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

Referenced by dial_exec_full(), and do_forward().

03376 {
03377    struct ast_datastore *cc_datastore;
03378    struct ast_datastore *cc_recall_datastore;
03379    struct dialed_cc_interfaces *cc_interfaces;
03380    struct cc_recall_ds_data *recall_cc_data;
03381 
03382    ast_channel_lock(chan);
03383    if ((cc_datastore = ast_channel_datastore_find(chan, &dialed_cc_interfaces_info, NULL))) {
03384       cc_interfaces = cc_datastore->data;
03385       cc_interfaces->ignore = 1;
03386    }
03387 
03388    if ((cc_recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
03389       recall_cc_data = cc_recall_datastore->data;
03390       recall_cc_data->ignore = 1;
03391    }
03392    ast_channel_unlock(chan);
03393 }

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

Queue an AST_CONTROL_CC frame.

Since:
1.8
Note:
Since this function calls ast_queue_frame, the channel will be locked during the course of this function.
Parameters:
chan The channel onto which to queue the frame
monitor_type The type of monitor to use when CC is requested
dialstring The dial string used to call the device
service The type of CC service the device is willing to offer
private_data If a native monitor is being used, and some channel-driver-specific private data has been allocated, then this parameter should contain a pointer to that data. If using a generic monitor, this parameter should remain NULL. Note that if this function should fail at some point, it is the responsibility of the caller to free the private data upon return.
Return values:
0 Success
-1 Error

Definition at line 3807 of file ccss.c.

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

Referenced by analog_call(), sig_pri_cc_generic_check(), and sip_handle_cc().

03809 {
03810    struct ast_frame frame = {0,};
03811    char device_name[AST_CHANNEL_NAME];
03812    int retval;
03813    struct ast_cc_config_params *cc_params;
03814 
03815    cc_params = ast_channel_get_cc_config_params(chan);
03816    if (!cc_params) {
03817       return -1;
03818    }
03819    ast_channel_get_device_name(chan, device_name, sizeof(device_name));
03820    if (ast_cc_monitor_count(device_name, monitor_type) >= ast_get_cc_max_monitors(cc_params)) {
03821       ast_log(LOG_NOTICE, "Not queuing a CC frame for device %s since it already has its maximum monitors allocated\n", device_name);
03822       return -1;
03823    }
03824 
03825    if (ast_cc_build_frame(chan, cc_params, monitor_type, device_name, dialstring, service, private_data, &frame)) {
03826       /* Frame building failed. We can't use this. */
03827       return -1;
03828    }
03829    retval = ast_queue_frame(chan, &frame);
03830    ast_frfree(&frame);
03831    return retval;
03832 }

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

Set the cc_agent_dialstring.

Since:
1.8
Parameters:
config The configuration to set the cc_agent_dialstring on
value The new cc_agent_dialstring we want to change to
Return values:
void 

Definition at line 812 of file ccss.c.

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

Referenced by ast_cc_set_param().

00813 {
00814    if (ast_strlen_zero(value)) {
00815       config->cc_agent_dialstring[0] = '\0';
00816    } else {
00817       ast_copy_string(config->cc_agent_dialstring, value, sizeof(config->cc_agent_dialstring));
00818    }
00819 }

int ast_set_cc_agent_policy ( struct ast_cc_config_params config,
enum ast_cc_agent_policies  value 
)

Set the cc_agent_policy.

Since:
1.8
Parameters:
config The configuration to set the cc_agent_policy on
value The new cc_agent_policy we want to change to
Return values:
0 Success
-1 Failure (likely due to bad input)

Definition at line 718 of file ccss.c.

References AST_CC_AGENT_GENERIC, and config.

Referenced by ast_cc_set_param(), and build_peer().

00719 {
00720    /* Screw C and its weak type checking for making me have to do this
00721     * validation at runtime.
00722     */
00723    if (value < AST_CC_AGENT_NEVER || value > AST_CC_AGENT_GENERIC) {
00724       return -1;
00725    }
00726    config->cc_agent_policy = value;
00727    return 0;
00728 }

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

Set the callback_macro name.

Since:
1.8
Parameters:
config The configuration to set the callback_macro on
value The new callback macro we want to change to
Return values:
void 

Definition at line 846 of file ccss.c.

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

Referenced by ast_cc_set_param().

00847 {
00848    if (ast_strlen_zero(value)) {
00849       config->cc_callback_macro[0] = '\0';
00850    } else {
00851       ast_copy_string(config->cc_callback_macro, value, sizeof(config->cc_callback_macro));
00852    }
00853 }

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 extension as a starting point.

Since:
1.8
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 chan_local, wherein we need to set CC_INTERFACES based on an extension and context that appear in the middle of the tree of dialed interfaces

Note:
This function will lock the channel as well as the list of monitors stored on the channel's CC recall datastore, though neither are held at the same time. Callers of this function should be aware of potential lock ordering problems that may arise.
Parameters:
chan The channel to set the CC_INTERFACES variable on
extension The name of the extension for which we're setting the variable. This should be in the form of "exten@context"

Definition at line 3323 of file ccss.c.

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

Referenced by local_call().

03324 {
03325    struct ast_datastore *recall_datastore;
03326    struct cc_monitor_tree *interface_tree;
03327    struct ast_cc_monitor *monitor_iter;
03328    struct cc_recall_ds_data *recall_data;
03329    struct ast_str *str = ast_str_create(64);
03330    int core_id;
03331 
03332    if (!str) {
03333       return -1;
03334    }
03335 
03336    ast_channel_lock(chan);
03337    if (!(recall_datastore = ast_channel_datastore_find(chan, &recall_ds_info, NULL))) {
03338       ast_channel_unlock(chan);
03339       ast_free(str);
03340       return -1;
03341    }
03342    recall_data = recall_datastore->data;
03343    interface_tree = recall_data->interface_tree;
03344    core_id = recall_data->core_id;
03345    ast_channel_unlock(chan);
03346 
03347    AST_LIST_LOCK(interface_tree);
03348    AST_LIST_TRAVERSE(interface_tree, monitor_iter, next) {
03349       if (!strcmp(monitor_iter->interface->device_name, extension)) {
03350          break;
03351       }
03352    }
03353 
03354    if (!monitor_iter) {
03355       /* We couldn't find this extension. This may be because
03356        * we have been directed into an unexpected extension because
03357        * the admin has changed a CC_INTERFACES variable at some point.
03358        */
03359       AST_LIST_UNLOCK(interface_tree);
03360       ast_free(str);
03361       return -1;
03362    }
03363 
03364    build_cc_interfaces_chanvar(monitor_iter, str);
03365    AST_LIST_UNLOCK(interface_tree);
03366 
03367    pbx_builtin_setvar_helper(chan, "CC_INTERFACES", ast_str_buffer(str));
03368    ast_log_dynamic_level(cc_logger_level, "Core %d: CC_INTERFACES set to %s\n",
03369          core_id, ast_str_buffer(str));
03370 
03371    ast_free(str);
03372    return 0;
03373 }

void ast_set_cc_max_agents ( struct ast_cc_config_params config,
unsigned int  value 
)

Set the cc_max_agents.

Since:
1.8
Parameters:
config The configuration to set the cc_max_agents on
value The new cc_max_agents we want to change to
Return values:
void 

Definition at line 826 of file ccss.c.

References config.

Referenced by ast_cc_set_param().

00827 {
00828    config->cc_max_agents = value;
00829 }

void ast_set_cc_max_monitors ( struct ast_cc_config_params config,
unsigned int  value 
)

Set the cc_max_monitors.

Since:
1.8
Parameters:
config The configuration to set the cc_max_monitors on
value The new cc_max_monitors we want to change to
Return values:
void 

Definition at line 836 of file ccss.c.

References config.

Referenced by ast_cc_set_param().

00837 {
00838    config->cc_max_monitors = value;
00839 }

int ast_set_cc_monitor_policy ( struct ast_cc_config_params config,
enum ast_cc_monitor_policies  value 
)

Set the cc_monitor_policy.

Since:
1.8
Parameters:
config The configuration to set the cc_monitor_policy on
value The new cc_monitor_policy we want to change to
Return values:
0 Success
-1 Failure (likely due to bad input)

Definition at line 735 of file ccss.c.

References AST_CC_MONITOR_ALWAYS, and config.

Referenced by ast_cc_set_param().

00736 {
00737    /* Screw C and its weak type checking for making me have to do this
00738     * validation at runtime.
00739     */
00740    if (value < AST_CC_MONITOR_NEVER || value > AST_CC_MONITOR_ALWAYS) {
00741       return -1;
00742    }
00743    config->cc_monitor_policy = value;
00744    return 0;
00745 }

void ast_set_cc_offer_timer ( struct ast_cc_config_params config,
unsigned int  value 
)

Set the cc_offer_timer.

Since:
1.8
Parameters:
config The configuration to set the cc_offer_timer on
value The new cc_offer_timer we want to change to
Return values:
void 

Definition at line 752 of file ccss.c.

References ast_log(), config, and LOG_WARNING.

Referenced by ast_cc_set_param().

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

void ast_set_cc_recall_timer ( struct ast_cc_config_params config,
unsigned int  value 
)

Set the cc_recall_timer.

Since:
1.8
Parameters:
config The configuration to set the cc_recall_timer on
value The new cc_recall_timer we want to change to
Return values:
void 

Definition at line 782 of file ccss.c.

References ast_log(), config, and LOG_WARNING.

Referenced by ast_cc_set_param().

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

void ast_set_ccbs_available_timer ( struct ast_cc_config_params config,
unsigned int  value 
)

Set the ccbs_available_timer.

Since:
1.8
Parameters:
config The configuration to set the ccbs_available_timer on
value The new ccbs_available_timer we want to change to
Return values:
void 

Definition at line 797 of file ccss.c.

References ast_log(), config, and LOG_WARNING.

Referenced by ast_cc_set_param().

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

void ast_set_ccnr_available_timer ( struct ast_cc_config_params config,
unsigned int  value 
)

Set the ccnr_available_timer.

Since:
1.8
Parameters:
config The configuration to set the ccnr_available_timer on
value The new ccnr_available_timer we want to change to
Return values:
void 

Definition at line 767 of file ccss.c.

References ast_log(), config, and LOG_WARNING.

Referenced by ast_cc_set_param().

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

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

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

Referenced by generic_recall(), handle_request_invite(), and sig_pri_handle_subcmds().

03061 {
03062    struct ast_datastore *recall_datastore = ast_datastore_alloc(&recall_ds_info, NULL);
03063    struct cc_recall_ds_data *recall_data;
03064    struct cc_core_instance *core_instance;
03065 
03066    if (!recall_datastore) {
03067       return -1;
03068    }
03069 
03070    if (!(recall_data = ast_calloc(1, sizeof(*recall_data)))) {
03071       ast_datastore_free(recall_datastore);
03072       return -1;
03073    }
03074 
03075    if (!(core_instance = find_cc_core_instance(core_id))) {
03076       ast_free(recall_data);
03077       ast_datastore_free(recall_datastore);
03078       return -1;
03079    }
03080 
03081    recall_data->interface_tree = cc_ref(core_instance->monitors,
03082          "Bump refcount for monitor tree for recall datastore");
03083    recall_data->core_id = core_id;
03084    recall_datastore->data = recall_data;
03085    recall_datastore->inheritance = DATASTORE_INHERIT_FOREVER;
03086    ast_channel_lock(chan);
03087    ast_channel_datastore_add(chan, recall_datastore);
03088    ast_channel_unlock(chan);
03089    cc_unref(core_instance, "Recall datastore set up. No need for core_instance ref");
03090    return 0;
03091 }


Generated on Mon Jun 27 16:51:03 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7