Sat Apr 26 2014 22:03:26

Asterisk developer's documentation

Data Fields
sig_pri_chan Struct Reference

#include <sig_pri.h>

Collaboration diagram for sig_pri_chan:
Collaboration graph
[legend]

Data Fields

unsigned int allocated:1
 TRUE when this channel is allocated.
unsigned int alreadyhungup:1
struct pri_subcmd_aoc_e aoc_e
int aoc_s_request_invoke_id
unsigned int aoc_s_request_invoke_id_valid:1
q931_call * call
enum sig_pri_call_level call_level
int callingpres
void * chan_pvt
int channel
char cid_ani [AST_MAX_EXTENSION]
int cid_ani2
char cid_name [AST_MAX_EXTENSION]
char cid_num [AST_MAX_EXTENSION]
char cid_subaddr [AST_MAX_EXTENSION]
int cid_ton
char context [AST_MAX_CONTEXT]
char deferred_digits [AST_MAX_EXTENSION]
char dialdest [256]
unsigned int digital:1
char exten [AST_MAX_EXTENSION]
unsigned int hidecallerid:1
unsigned int hidecalleridname:1
unsigned int holding_aoce:1
unsigned int immediate:1
unsigned int inalarm:1
unsigned int is_call_waiting:1
 TRUE if this is a call waiting call.
unsigned int isidlecall:1
char keypad_digits [AST_MAX_EXTENSION]
 Keypad digits that came in with the SETUP message.
int logicalspan
int mastertrunkgroup
enum sig_pri_moh_state moh_state
char moh_suggested [MAX_MUSICCLASS]
char mohinterpret [MAX_MUSICCLASS]
unsigned int no_b_channel:1
 TRUE if this interface has no B channel. (call hold and call waiting)
unsigned int outgoing:1
struct ast_channel * owner
struct sig_pri_span * pri
unsigned int priexclusive:1
unsigned int priindication_oob:1
int prioffset
unsigned int progress:1
enum sig_pri_reset_state resetting
 Channel reset/restart state.
int reverse_charging_indication
 Reverse charging indication.
unsigned service_status
 Active SRVST_DBKEY out-of-service status value.
int stripmsd
unsigned int use_callerid:1
unsigned int use_callingpres:1
char user_tag [AST_MAX_EXTENSION]
 User tag for party id's sent from this device driver.
unsigned int waiting_for_aoce:1

Detailed Description

Definition at line 276 of file sig_pri.h.

Field Documentation

unsigned int allocated

TRUE when this channel is allocated.

Needed to hold an outgoing channel allocation before the owner pointer is created.

Note:
This is one of several items to check to see if a channel is available for use.

Definition at line 337 of file sig_pri.h.

Referenced by dahdi_show_channel(), pri_dchannel(), pri_fixup_principle(), sig_pri_available(), sig_pri_hangup(), and sig_pri_is_chan_in_use().

unsigned int alreadyhungup

TRUE if the call has already gone/hungup

Definition at line 323 of file sig_pri.h.

Referenced by pri_dchannel(), pri_fixup_principle(), sig_pri_hangup(), and sig_pri_new_ast_channel().

struct pri_subcmd_aoc_e aoc_e

Definition at line 316 of file sig_pri.h.

Referenced by pri_fixup_principle(), sig_pri_aoc_e_from_ast(), and sig_pri_hangup().

int aoc_s_request_invoke_id

If an AOC-S request was present for the call, this is the invoke_id to use for the response

Definition at line 317 of file sig_pri.h.

Referenced by pri_fixup_principle(), sig_pri_answer(), sig_pri_aoc_request_from_pri(), and sig_pri_aoc_s_from_ast().

unsigned int aoc_s_request_invoke_id_valid

This is set when the AOC-S invoke id is present

Definition at line 318 of file sig_pri.h.

Referenced by pri_fixup_principle(), sig_pri_answer(), sig_pri_aoc_request_from_pri(), sig_pri_aoc_s_from_ast(), and sig_pri_hangup().

q931_call* call

opaque libpri call control structure

Definition at line 350 of file sig_pri.h.

Referenced by dahdi_bridge(), dahdi_show_channel(), pri_dchannel(), pri_find_principle_by_call(), pri_fixup_principle(), pri_send_callrerouting_facility_exec(), pri_send_keypad_facility_exec(), pri_ss_thread(), sig_pri_answer(), sig_pri_aoc_d_from_ast(), sig_pri_aoc_s_from_ast(), sig_pri_call(), sig_pri_cc_agent_init(), sig_pri_chan_alarm_notify(), sig_pri_cli_show_channels(), sig_pri_digit_begin(), sig_pri_hangup(), sig_pri_indicate(), sig_pri_is_chan_in_use(), sig_pri_kill_call(), sig_pri_moh_fsm_idle(), sig_pri_moh_fsm_notify(), sig_pri_moh_fsm_pend_hold(), sig_pri_moh_retrieve_call(), sig_pri_redirecting_update(), and sig_pri_sendtext().

enum sig_pri_call_level call_level

Call establishment life cycle level for simple comparisons.

Definition at line 353 of file sig_pri.h.

Referenced by pri_dchannel(), pri_fixup_principle(), pri_ss_thread(), sig_pri_answer(), sig_pri_call(), sig_pri_cli_show_channels(), sig_pri_dial_complete(), sig_pri_digit_begin(), sig_pri_handle_hold(), sig_pri_hangup(), and sig_pri_indicate().

int callingpres

The value of calling presentation that we're going to use when placing a PRI call

Definition at line 293 of file sig_pri.h.

Referenced by pri_dchannel(), sig_pri_handle_subcmds(), and sig_pri_set_caller_id().

void* chan_pvt

Private structure of the user of this module.

Definition at line 364 of file sig_pri.h.

Referenced by available(), pri_queue_control(), sig_pri_ami_channel_event(), sig_pri_chan_new(), sig_pri_deadlock_avoidance_private(), sig_pri_dial_complete(), sig_pri_dial_digits(), sig_pri_dsp_reset_and_flush_digits(), sig_pri_fixup_chans(), sig_pri_get_orig_dialstring(), sig_pri_init_config(), sig_pri_lock_private(), sig_pri_make_cc_dialstring(), sig_pri_new_ast_channel(), sig_pri_open_media(), sig_pri_play_tone(), sig_pri_set_alarm(), sig_pri_set_caller_id(), sig_pri_set_dialing(), sig_pri_set_digital(), sig_pri_set_dnid(), sig_pri_set_echocanceller(), sig_pri_set_outgoing(), sig_pri_set_rdnis(), and sig_pri_unlock_private().

int channel

Channel Number or CRV

Definition at line 288 of file sig_pri.h.

Referenced by dahdi_new_pri_nobch_channel(), do_idle_thread(), handle_pri_destroy_span(), mkintf(), pri_check_restart(), pri_dchannel(), pri_fixup_principle(), pri_maintenance_bservice(), sig_pri_call(), sig_pri_cli_show_channels(), sig_pri_cmp_pri_chans(), sig_pri_hangup(), and sig_pri_request().

char cid_ani[AST_MAX_EXTENSION]

Definition at line 297 of file sig_pri.h.

Referenced by pri_dchannel(), and sig_pri_set_caller_id().

int cid_ani2

Automatic Number Identification number (Alternate PRI caller ID number)

Definition at line 291 of file sig_pri.h.

Referenced by pri_dchannel(), and sig_pri_set_caller_id().

char cid_name[AST_MAX_EXTENSION]

Definition at line 296 of file sig_pri.h.

Referenced by pri_dchannel(), sig_pri_handle_subcmds(), sig_pri_hangup(), and sig_pri_set_caller_id().

char cid_num[AST_MAX_EXTENSION]

Definition at line 294 of file sig_pri.h.

Referenced by pri_dchannel(), pri_ss_thread(), sig_pri_handle_subcmds(), sig_pri_hangup(), and sig_pri_set_caller_id().

char cid_subaddr[AST_MAX_EXTENSION]

Definition at line 295 of file sig_pri.h.

Referenced by pri_dchannel(), sig_pri_handle_subcmds(), sig_pri_hangup(), and sig_pri_set_caller_id().

int cid_ton

Type Of Number (TON)

Definition at line 292 of file sig_pri.h.

Referenced by pri_dchannel(), sig_pri_handle_subcmds(), and sig_pri_set_caller_id().

char context[AST_MAX_CONTEXT]

Definition at line 285 of file sig_pri.h.

Referenced by mkintf(), pri_dchannel(), pri_fixup_principle(), and sig_pri_init_config().

char deferred_digits[AST_MAX_EXTENSION]

'w' deferred dialing digits.

Definition at line 310 of file sig_pri.h.

Referenced by pri_dchannel(), pri_fixup_principle(), and sig_pri_call().

char dialdest[256]

Definition at line 304 of file sig_pri.h.

Referenced by pri_dchannel(), sig_pri_call(), and sig_pri_digit_begin().

unsigned int digital

Definition at line 339 of file sig_pri.h.

Referenced by pri_dchannel(), pri_fixup_principle(), sig_pri_answer(), sig_pri_call(), sig_pri_indicate(), and sig_pri_set_digital().

char exten[AST_MAX_EXTENSION]

Definition at line 300 of file sig_pri.h.

Referenced by pri_dchannel(), pri_ss_thread(), sig_pri_hangup(), and sig_pri_request().

unsigned int hidecallerid

Definition at line 278 of file sig_pri.h.

Referenced by mkintf(), pri_fixup_principle(), sig_pri_call(), and sig_pri_init_config().

unsigned int hidecalleridname

Hide just the name not the number for legacy PBX use

Definition at line 279 of file sig_pri.h.

Referenced by mkintf(), pri_fixup_principle(), sig_pri_call(), and sig_pri_init_config().

unsigned int holding_aoce

received AOC-E msg from asterisk. holding for disconnect/release

Definition at line 320 of file sig_pri.h.

Referenced by pri_dchannel(), pri_fixup_principle(), sig_pri_aoc_e_from_ast(), and sig_pri_hangup().

unsigned int immediate

Answer before getting digits?

Definition at line 280 of file sig_pri.h.

Referenced by mkintf(), pri_dchannel(), pri_fixup_principle(), and sig_pri_init_config().

unsigned int inalarm

Definition at line 322 of file sig_pri.h.

Referenced by dahdi_pri_update_span_devstate(), mkintf(), sig_pri_is_chan_in_use(), and sig_pri_set_alarm().

unsigned int is_call_waiting

TRUE if this is a call waiting call.

Definition at line 344 of file sig_pri.h.

Referenced by pri_dchannel(), pri_fixup_principle(), sig_pri_call(), sig_pri_cw_available(), and sig_pri_hangup().

unsigned int isidlecall

TRUE if this is an idle call

Definition at line 324 of file sig_pri.h.

Referenced by pri_dchannel(), pri_fixup_principle(), and sig_pri_new_ast_channel().

char keypad_digits[AST_MAX_EXTENSION]

Keypad digits that came in with the SETUP message.

Definition at line 307 of file sig_pri.h.

Referenced by pri_dchannel(), and pri_fixup_principle().

int logicalspan

logical span number within trunk group

Definition at line 357 of file sig_pri.h.

Referenced by pri_dchannel(), pri_find_empty_chan(), pri_find_principle(), pri_fixup_principle(), PVT_TO_CHANNEL(), and sig_pri_chan_new().

int mastertrunkgroup

what trunk group is our master

Definition at line 358 of file sig_pri.h.

Referenced by pri_fixup_principle(), PVT_TO_CHANNEL(), and sig_pri_chan_new().

enum sig_pri_moh_state moh_state

Definition at line 313 of file sig_pri.h.

Referenced by pri_fixup_principle(), sig_pri_moh_fsm_event(), sig_pri_moh_fsm_hold(), sig_pri_moh_fsm_hold_req(), sig_pri_moh_fsm_idle(), sig_pri_moh_fsm_moh(), sig_pri_moh_fsm_notify(), sig_pri_moh_fsm_pend_hold(), sig_pri_moh_fsm_pend_unhold(), sig_pri_moh_fsm_retrieve_fail(), and sig_pri_moh_fsm_retrieve_req().

char moh_suggested[MAX_MUSICCLASS]

Music class suggested with AST_CONTROL_HOLD.

Definition at line 312 of file sig_pri.h.

Referenced by pri_fixup_principle(), sig_pri_indicate(), sig_pri_moh_fsm_hold(), sig_pri_moh_fsm_hold_req(), sig_pri_moh_fsm_idle(), sig_pri_moh_fsm_moh(), sig_pri_moh_fsm_notify(), and sig_pri_moh_fsm_pend_hold().

char mohinterpret[MAX_MUSICCLASS]

Definition at line 286 of file sig_pri.h.

Referenced by mkintf(), pri_fixup_principle(), sig_pri_indicate(), sig_pri_init_config(), sig_pri_moh_fsm_hold(), sig_pri_moh_fsm_hold_req(), sig_pri_moh_fsm_idle(), sig_pri_moh_fsm_moh(), sig_pri_moh_fsm_notify(), and sig_pri_moh_fsm_pend_hold().

unsigned int no_b_channel

TRUE if this interface has no B channel. (call hold and call waiting)

Definition at line 341 of file sig_pri.h.

Referenced by dahdi_new_pri_nobch_channel(), dahdi_pri_update_span_devstate(), pri_check_restart(), pri_dchannel(), pri_find_empty_chan(), pri_find_empty_nobch(), pri_find_principle(), pri_fixup_principle(), sig_pri_available_check(), sig_pri_cli_show_channels(), sig_pri_handle_hold(), sig_pri_indicate(), and sig_pri_open_media().

unsigned int outgoing

Definition at line 338 of file sig_pri.h.

Referenced by pri_dchannel(), pri_fixup_principle(), sig_pri_cc_generic_check(), sig_pri_indicate(), and sig_pri_set_outgoing().

struct ast_channel* owner

Definition at line 347 of file sig_pri.h.

Referenced by do_idle_thread(), func_pri_dchannel_chanpos_callid(), pri_dchannel(), pri_fixup_principle(), pri_queue_frame(), pri_queue_pvt_cause_data(), pri_ss_thread(), sig_pri_ami_channel_event(), sig_pri_attempt_transfer(), sig_pri_call(), sig_pri_cc_available(), sig_pri_cc_generic_check(), sig_pri_chan_alarm_notify(), sig_pri_cli_show_channels(), sig_pri_fixup(), sig_pri_handle_hold(), sig_pri_handle_hold_ack(), sig_pri_handle_hold_rej(), sig_pri_handle_retrieve(), sig_pri_handle_retrieve_ack(), sig_pri_handle_retrieve_rej(), sig_pri_handle_subcmds(), sig_pri_hangup(), sig_pri_is_chan_in_use(), sig_pri_kill_call(), sig_pri_lock_owner(), sig_pri_new_ast_channel(), and sig_pri_send_aoce_termination_request().

struct sig_pri_span* pri

Definition at line 349 of file sig_pri.h.

Referenced by do_idle_thread(), handle_pri_destroy_span(), handle_pri_show_channels(), handle_pri_show_debug(), handle_pri_show_span(), handle_pri_show_spans(), pri_dchannel(), pri_send_callrerouting_facility_exec(), pri_send_keypad_facility_exec(), pri_ss_thread(), sig_pri_answer(), sig_pri_aoc_d_from_ast(), sig_pri_aoc_request_from_pri(), sig_pri_aoc_s_from_ast(), sig_pri_available(), sig_pri_call(), sig_pri_cc_agent_init(), sig_pri_chan_alarm_notify(), sig_pri_chan_new(), sig_pri_digit_begin(), sig_pri_hangup(), sig_pri_indicate(), sig_pri_moh_fsm_idle(), sig_pri_moh_fsm_notify(), sig_pri_moh_fsm_pend_hold(), sig_pri_moh_retrieve_call(), sig_pri_new_ast_channel(), sig_pri_redirecting_update(), sig_pri_sendtext(), and sig_pri_set_alarm().

unsigned int priexclusive

Whether or not to override and use exculsive mode for channel selection

Definition at line 281 of file sig_pri.h.

Referenced by mkintf(), pri_fixup_principle(), sig_pri_call(), and sig_pri_init_config().

unsigned int priindication_oob

Definition at line 282 of file sig_pri.h.

Referenced by mkintf(), pri_fixup_principle(), sig_pri_indicate(), and sig_pri_init_config().

int prioffset

channel number in span

Definition at line 356 of file sig_pri.h.

Referenced by pri_dchannel(), pri_find_empty_chan(), pri_find_principle(), PVT_TO_CHANNEL(), sig_pri_chan_new(), sig_pri_moh_fsm_idle(), sig_pri_moh_fsm_notify(), and sig_pri_moh_fsm_pend_hold().

unsigned int progress

TRUE if the call has seen inband-information progress through the network

Definition at line 325 of file sig_pri.h.

Referenced by pri_dchannel(), pri_fixup_principle(), sig_pri_hangup(), and sig_pri_indicate().

enum sig_pri_reset_state resetting

Channel reset/restart state.

Definition at line 355 of file sig_pri.h.

Referenced by dahdi_show_channel(), pri_check_restart(), pri_dchannel(), sig_pri_is_chan_in_use(), and sig_pri_set_alarm().

int reverse_charging_indication

Reverse charging indication.

-1 - No reverse charging, 1 - Reverse charging, 0,2-7 - Reserved for future use

Definition at line 373 of file sig_pri.h.

Referenced by pri_dchannel(), and pri_fixup_principle().

unsigned service_status

Active SRVST_DBKEY out-of-service status value.

Definition at line 361 of file sig_pri.h.

Referenced by pri_check_restart(), pri_dchannel(), and sig_pri_is_chan_available().

int stripmsd

Definition at line 287 of file sig_pri.h.

Referenced by mkintf(), pri_fixup_principle(), sig_pri_call(), sig_pri_extract_called_num_subaddr(), and sig_pri_init_config().

unsigned int use_callerid

Whether or not to use caller id on this channel

Definition at line 283 of file sig_pri.h.

Referenced by mkintf(), pri_dchannel(), pri_fixup_principle(), and sig_pri_init_config().

unsigned int use_callingpres

Whether to use the callingpres the calling switch sends

Definition at line 284 of file sig_pri.h.

Referenced by mkintf(), pri_fixup_principle(), sig_pri_call(), and sig_pri_init_config().

char user_tag[AST_MAX_EXTENSION]

User tag for party id's sent from this device driver.

Definition at line 299 of file sig_pri.h.

Referenced by pri_dchannel(), pri_fixup_principle(), pri_ss_thread(), sig_pri_call(), sig_pri_handle_subcmds(), sig_pri_hangup(), and sig_pri_set_caller_id().

unsigned int waiting_for_aoce

Delaying hangup for AOC-E msg. If this is set and AOC-E is received, continue with hangup before timeout period.

Definition at line 319 of file sig_pri.h.

Referenced by pri_fixup_principle(), sig_pri_hangup(), sig_pri_indicate(), and sig_pri_send_aoce_termination_request().

The documentation for this struct was generated from the following file: