Mon Oct 8 12:39:31 2012

Asterisk developer's documentation


ast_cc_monitor Struct Reference

#include <ccss.h>


Data Fields

int available_timer_id
ast_cc_monitor_callbackscallbacks
int core_id
char * dialstring
 Name that should be used to recall specified interface.
unsigned int id
ast_cc_interfaceinterface
struct {
   ast_cc_monitor *   next
next
unsigned int parent_id
void * private_data
 Data that is private to a monitor technology.
enum ast_cc_service_type service_offered


Detailed Description

Definition at line 493 of file ccss.h.


Field Documentation

int available_timer_id

The ID of the available timer used by the current monitor

Definition at line 530 of file ccss.h.

Referenced by cancel_available_timer(), cc_monitor_failed(), and request_cc().

struct ast_cc_monitor_callbacks* callbacks

Monitor callbacks

Definition at line 534 of file ccss.h.

Referenced by cancel_available_timer(), cc_monitor_failed(), cc_status_response(), request_cc(), suspend(), and unsuspend().

int core_id

The instance of the CC core to which this monitor belongs

Definition at line 511 of file ccss.h.

Referenced by cc_monitor_failed(), and sig_pri_cc_generic_check().

char* dialstring

Name that should be used to recall specified interface.

When issuing a CC recall, some technologies will require that a name other than the device name is dialed. For instance, with SIP, a specific URI will be used which chan_sip will be able to recognize as being a CC recall. Similarly, ISDN will need a specific dial string to know that the call is a recall.

Definition at line 526 of file ccss.h.

Referenced by ast_handle_cc_control_frame(), and build_cc_interfaces_chanvar().

unsigned int id

Every interface has an id that uniquely identifies it. It is formed by incrementing a counter.

Definition at line 502 of file ccss.h.

Referenced by build_cc_interfaces_chanvar(), cc_cli_print_monitor_stats(), and cc_extension_monitor_change_is_valid().

struct ast_cc_interface* interface

Information regarding the interface.

Definition at line 497 of file ccss.h.

Referenced by ast_cc_get_monitor_by_recall_core_id(), ast_cc_is_recall(), ast_set_cc_interfaces_chanvar(), build_cc_interfaces_chanvar(), cancel_available_timer(), cc_monitor_failed(), cc_status_response(), count_monitors_cb(), has_device_monitors(), request_cc(), suspend(), and unsuspend().

struct { ... } next

struct ast_cc_monitor* next

Definition at line 545 of file ccss.h.

unsigned int parent_id

The ID of this monitor's parent. If this monitor is at the top of the tree, then his parent will be 0.

Definition at line 507 of file ccss.h.

Referenced by build_cc_interfaces_chanvar(), cc_cli_print_monitor_stats(), cc_device_monitor_init(), and cc_monitor_failed().

void* private_data

Data that is private to a monitor technology.

Most channel drivers that implement CC monitors will have to allocate data that the CC core does not care about but which is vital to the operation of the monitor. This data is stored in this pointer so that the channel driver may use it as needed

Definition at line 544 of file ccss.h.

Referenced by build_cc_interfaces_chanvar(), cc_extension_monitor_change_is_valid(), and sip_call().

enum ast_cc_service_type service_offered

The type of call completion service offered by a device.

Definition at line 515 of file ccss.h.


The documentation for this struct was generated from the following file:
Generated on Mon Oct 8 12:39:31 2012 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7