Mon Mar 19 11:30:59 2012

Asterisk developer's documentation


sig_pri_span Struct Reference

#include <sig_pri.h>


Data Fields

unsigned int allow_call_waiting_calls:1
 TRUE if we will allow incoming ISDN call waiting calls.
int aoc_passthrough_flag
unsigned int aoce_delayhangup:1
unsigned int append_msn_to_user_tag:1
sig_pri_callbackcalls
ast_cc_config_paramscc_params
int cc_ptmp_recall_mode
int cc_qsig_signaling_link_req
int cc_qsig_signaling_link_rsp
struct {
   char   context [AST_MAX_CONTEXT]
   unsigned int   hidecallerid:1
   unsigned int   hidecalleridname:1
   unsigned int   immediate:1
   char   mohinterpret [MAX_MUSICCLASS]
   unsigned int   priexclusive:1
   unsigned int   priindication_oob:1
   int   stripmsd
   unsigned int   use_callerid:1
   unsigned int   use_callingpres:1
ch_cfg
int congestion_devstate
 Congestion device state of the span.
int dchan_logical_span [SIG_PRI_NUM_DCHANS]
int dchanavail [SIG_PRI_NUM_DCHANS]
pridchans [SIG_PRI_NUM_DCHANS]
int debug
int dialplan
int discardremoteholdretrieval
unsigned int enable_service_message_support:1
int facilityenable
int fds [SIG_PRI_NUM_DCHANS]
unsigned int hold_disconnect_transfer:1
 TRUE if held calls are transferred on disconnect.
char idlecontext [AST_MAX_CONTEXT]
char idledial [AST_MAX_EXTENSION]
char idleext [AST_MAX_EXTENSION]
unsigned int inbanddisconnect:1
char initial_user_tag [AST_MAX_EXTENSION]
 Initial user tag for party id's sent from this device driver.
char internationalprefix [10]
time_t lastreset
int localdialplan
char localprefix [20]
ast_mutex_t lock
pthread_t master
int max_call_waiting_calls
 Number of extra outgoing calls to allow on a span before considering that span congested.
sig_pri_mbox mbox [SIG_PRI_MAX_MWI_MAILBOXES]
 Active MWI mailboxes.
int minidle
int minunused
char msn_list [AST_MAX_EXTENSION]
char mwi_mailboxes [SIG_PRI_MAX_MWI_MAILBOX_STR]
 Comma separated list of mailboxes to indicate MWI.
char nationalprefix [10]
int new_chan_seq
void * no_b_chan_end
void * no_b_chan_iflist
unsigned int no_d_channels:1
int nodetype
int nsf
int num_call_waiting_calls
 Number of outstanding call waiting calls.
int numchans
int overlapdial
pripri
int pritimers [PRI_MAX_TIMERS]
char privateprefix [20]
sig_pri_chanpvts [SIG_PRI_MAX_CHANNELS]
int qsigchannelmapping
long resetinterval
int resetpos
int resetting
int sig
int span
int switchtype
unsigned int transfer:1
 TRUE if call transfer is enabled for the span.
int trunkgroup
char unknownprefix [20]


Detailed Description

Definition at line 322 of file sig_pri.h.


Field Documentation

unsigned int allow_call_waiting_calls

TRUE if we will allow incoming ISDN call waiting calls.

Definition at line 359 of file sig_pri.h.

int aoc_passthrough_flag

Represents what AOC messages (S,D,E) are allowed to pass-through

Definition at line 338 of file sig_pri.h.

Referenced by sig_pri_aoc_request_from_pri(), and sig_pri_indicate().

unsigned int aoce_delayhangup

defines whether the aoce_delayhangup option is enabled or not

Definition at line 339 of file sig_pri.h.

unsigned int append_msn_to_user_tag

TRUE if a new call's sig_pri_chan.user_tag[] has the MSN appended to the initial_user_tag[].

Definition at line 365 of file sig_pri.h.

Referenced by pri_ss_thread(), and sig_pri_call().

struct sig_pri_callback* calls

Definition at line 459 of file sig_pri.h.

Referenced by prepare_pri(), sig_pri_cc_monitor_instance_destroy(), sig_pri_cc_monitor_instance_init(), sig_pri_handle_dchan_exception(), sig_pri_init_config(), and sig_pri_span_devstate_changed().

struct ast_cc_config_params* cc_params

CC config parameters for each new call.

Definition at line 324 of file sig_pri.h.

Referenced by dahdi_cc_callback(), and dahdi_new().

int cc_ptmp_recall_mode

CC PTMP recall mode. globalRecall(0), specificRecall(1)

Definition at line 401 of file sig_pri.h.

int cc_qsig_signaling_link_req

CC Q.SIG signaling link retention (Party A) release(0), retain(1), do-not-care(2)

Definition at line 402 of file sig_pri.h.

int cc_qsig_signaling_link_rsp

CC Q.SIG signaling link retention (Party B) release(0), retain(1)

Definition at line 403 of file sig_pri.h.

struct { ... } ch_cfg

Referenced by my_pri_init_config(), and sig_pri_init_config().

int congestion_devstate

Congestion device state of the span.

AST_DEVICE_NOT_INUSE - Span does not have all B channels in use. AST_DEVICE_BUSY - All B channels are in use. AST_DEVICE_UNAVAILABLE - Span is in alarm.

Note:
Device name: DAHDI/I/congestion.

Definition at line 469 of file sig_pri.h.

Referenced by dahdi_devicestate(), and dahdi_pri_update_span_devstate().

char context[AST_MAX_CONTEXT]

Definition at line 420 of file sig_pri.h.

Referenced by my_pri_init_config(), and sig_pri_init_config().

int dchan_logical_span[SIG_PRI_NUM_DCHANS]

Logical offset the DCHAN sits in

Definition at line 334 of file sig_pri.h.

Referenced by prepare_pri().

int dchanavail[SIG_PRI_NUM_DCHANS]

Whether each channel is available

Definition at line 431 of file sig_pri.h.

Referenced by pri_dchannel(), pri_event_alarm(), pri_event_noalarm(), pri_is_up(), sig_pri_cli_show_span(), and sig_pri_cli_show_spans().

struct pri* dchans[SIG_PRI_NUM_DCHANS]

Actual d-channels

Definition at line 442 of file sig_pri.h.

Referenced by handle_pri_show_debug(), pri_active_dchan_index(), pri_dchannel(), pri_event_noalarm(), pri_find_dchan(), sig_pri_cli_show_span(), sig_pri_cli_show_spans(), and sig_pri_start_pri().

int debug

set to true if to dump PRI event info

Definition at line 432 of file sig_pri.h.

Referenced by pri_dchannel().

int dialplan

Dialing plan

Definition at line 366 of file sig_pri.h.

Referenced by sig_pri_call().

int discardremoteholdretrieval

shall remote hold or remote retrieval notifications be discarded?

Definition at line 328 of file sig_pri.h.

unsigned int enable_service_message_support

enable SERVICE message support

Definition at line 343 of file sig_pri.h.

Referenced by sig_pri_start_pri().

int facilityenable

Enable facility IEs

Definition at line 329 of file sig_pri.h.

Referenced by sig_pri_call().

int fds[SIG_PRI_NUM_DCHANS]

FD's for d-channels

Definition at line 335 of file sig_pri.h.

Referenced by dahdi_close_pri_fd(), my_handle_dchan_exception(), prepare_pri(), pri_dchannel(), and sig_pri_start_pri().

unsigned int hidecallerid

Definition at line 413 of file sig_pri.h.

Referenced by my_pri_init_config(), and sig_pri_init_config().

unsigned int hidecalleridname

Hide just the name not the number for legacy PBX use

Definition at line 414 of file sig_pri.h.

Referenced by my_pri_init_config(), and sig_pri_init_config().

unsigned int hold_disconnect_transfer

TRUE if held calls are transferred on disconnect.

Definition at line 350 of file sig_pri.h.

char idlecontext[AST_MAX_CONTEXT]

What context to use for idle

Definition at line 392 of file sig_pri.h.

Referenced by do_idle_thread(), and pri_dchannel().

char idledial[AST_MAX_EXTENSION]

What to dial before dumping

Definition at line 393 of file sig_pri.h.

Referenced by do_idle_thread(), and pri_dchannel().

char idleext[AST_MAX_EXTENSION]

Where to idle extra calls

Definition at line 391 of file sig_pri.h.

Referenced by do_idle_thread(), and pri_dchannel().

unsigned int immediate

Answer before getting digits?

Definition at line 415 of file sig_pri.h.

Referenced by my_pri_init_config(), and sig_pri_init_config().

unsigned int inbanddisconnect

Should we support inband audio after receiving DISCONNECT?

Definition at line 346 of file sig_pri.h.

char initial_user_tag[AST_MAX_EXTENSION]

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

Note:
String set by config file.

Definition at line 389 of file sig_pri.h.

Referenced by pri_ss_thread(), and sig_pri_call().

char internationalprefix[10]

country access code ('00' for european dialplans)

Definition at line 368 of file sig_pri.h.

Referenced by apply_plan_to_number(), and sig_pri_call().

time_t lastreset

time when unused channels were last reset

Definition at line 458 of file sig_pri.h.

Referenced by pri_check_restart(), and pri_dchannel().

int localdialplan

Local dialing plan

Definition at line 367 of file sig_pri.h.

Referenced by sig_pri_call().

char localprefix[20]

area access code + area code ('0'+area code for european dialplans)

Definition at line 370 of file sig_pri.h.

Referenced by apply_plan_to_number().

ast_mutex_t lock

libpri access Mutex

Definition at line 457 of file sig_pri.h.

Referenced by dahdi_bridge(), destroy_all_channels(), pri_dchannel(), pri_grab(), pri_rel(), pri_ss_thread(), sig_pri_attempt_transfer(), sig_pri_available(), sig_pri_cc_agent_callee_available(), sig_pri_cc_agent_destructor(), sig_pri_cc_agent_init(), sig_pri_cc_agent_party_b_free(), sig_pri_cc_agent_req_rsp(), sig_pri_cc_agent_status_req(), sig_pri_cc_agent_stop_ringing(), sig_pri_cc_monitor_instance_destroy(), sig_pri_cc_monitor_req_cc(), sig_pri_cc_monitor_status_rsp(), sig_pri_cc_monitor_suspend(), sig_pri_cc_monitor_unsuspend(), sig_pri_cli_show_channels(), sig_pri_cli_show_span(), sig_pri_new_ast_channel(), sig_pri_send_mwi_indication(), sig_pri_start_pri(), and unload_module().

pthread_t master

Thread of master

Definition at line 456 of file sig_pri.h.

Referenced by __unload_module(), dahdi_restart(), and pri_grab().

int max_call_waiting_calls

Number of extra outgoing calls to allow on a span before considering that span congested.

Definition at line 410 of file sig_pri.h.

Referenced by sig_pri_cw_available().

struct sig_pri_mbox mbox[SIG_PRI_MAX_MWI_MAILBOXES]

Active MWI mailboxes.

Definition at line 376 of file sig_pri.h.

Referenced by sig_pri_mwi_cache_update(), sig_pri_start_pri(), and sig_pri_stop_pri().

int minidle

Min # of "idling" calls to keep active

Definition at line 395 of file sig_pri.h.

Referenced by pri_dchannel().

int minunused

Min # of channels to keep empty

Definition at line 394 of file sig_pri.h.

Referenced by pri_dchannel().

char mohinterpret[MAX_MUSICCLASS]

Definition at line 421 of file sig_pri.h.

Referenced by my_pri_init_config(), and sig_pri_init_config().

char msn_list[AST_MAX_EXTENSION]

Comma separated list of MSNs to handle. Empty if disabled.

Definition at line 390 of file sig_pri.h.

char mwi_mailboxes[SIG_PRI_MAX_MWI_MAILBOX_STR]

Comma separated list of mailboxes to indicate MWI.

Note:
Empty if disabled.

Format: mailbox_number[]{,mailbox_number[]}

String is split apart when span is started.

Definition at line 383 of file sig_pri.h.

Referenced by sig_pri_start_pri().

char nationalprefix[10]

area access code ('0' for european dialplans)

Definition at line 369 of file sig_pri.h.

Referenced by apply_plan_to_number(), and sig_pri_call().

int new_chan_seq

New struct ast_channel sequence number

Definition at line 437 of file sig_pri.h.

void* no_b_chan_end

List of private structures of the user of this module for no B channel interfaces. (hold and call waiting interfaces)

Definition at line 453 of file sig_pri.h.

Referenced by dahdi_nobch_extract(), and dahdi_nobch_insert().

void* no_b_chan_iflist

List of private structures of the user of this module for no B channel interfaces. (hold and call waiting interfaces)

Definition at line 448 of file sig_pri.h.

Referenced by dahdi_nobch_extract(), dahdi_nobch_insert(), and destroy_all_channels().

unsigned int no_d_channels

TRUE if we have already whined about no D channels available.

Definition at line 439 of file sig_pri.h.

int nodetype

Node type

Definition at line 396 of file sig_pri.h.

Referenced by pri_ss_thread(), sig_pri_call(), sig_pri_cc_generic_check(), and sig_pri_start_pri().

int nsf

Network-Specific Facilities

Definition at line 398 of file sig_pri.h.

Referenced by dahdi_chan_conf_default().

int num_call_waiting_calls

Number of outstanding call waiting calls.

Note:
Must be zero to allow new calls from asterisk to immediately allocate a B channel.

Definition at line 429 of file sig_pri.h.

Referenced by dahdi_request(), sig_pri_cw_available(), and sig_pri_hangup().

int numchans

Num of channels we represent

Definition at line 454 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_find_principle_by_call(), pri_fixup_principle(), sig_pri_cli_show_channels(), sig_pri_cw_available(), and sig_pri_sort_pri_chans().

int overlapdial

In overlap dialing mode

Definition at line 326 of file sig_pri.h.

Referenced by dahdi_handle_event(), dahdi_read(), pri_ss_thread(), sig_pri_cli_show_span(), and sig_pri_indicate().

struct pri* pri

Currently active D-channel

Definition at line 443 of file sig_pri.h.

Referenced by dahdi_handle_event(), dahdi_unlink_pri_pvt(), destroy_all_channels(), handle_pri_show_channels(), handle_pri_show_debug(), handle_pri_show_span(), handle_pri_show_spans(), pri_active_dchan_index(), pri_check_restart(), pri_dchannel(), pri_find_dchan(), 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_callee_available(), sig_pri_cc_agent_destructor(), sig_pri_cc_agent_init(), sig_pri_cc_agent_party_b_free(), sig_pri_cc_agent_req_rsp(), sig_pri_cc_agent_status_req(), sig_pri_cc_agent_stop_ringing(), sig_pri_cc_monitor_instance_destroy(), sig_pri_cc_monitor_req_cc(), sig_pri_cc_monitor_status_rsp(), sig_pri_cc_monitor_suspend(), sig_pri_cc_monitor_unsuspend(), sig_pri_chan_alarm_notify(), sig_pri_cli_show_span(), sig_pri_cli_show_spans(), sig_pri_handle_cis_subcmds(), sig_pri_handle_retrieve(), sig_pri_hangup(), sig_pri_indicate(), sig_pri_kill_call(), sig_pri_mwi_event_cb(), sig_pri_redirecting_update(), sig_pri_send_mwi_indication(), and sig_pri_transfer_rsp().

unsigned int priexclusive

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

Definition at line 416 of file sig_pri.h.

Referenced by my_pri_init_config(), and sig_pri_init_config().

unsigned int priindication_oob

Definition at line 417 of file sig_pri.h.

Referenced by my_pri_init_config(), and sig_pri_init_config().

int pritimers[PRI_MAX_TIMERS]

Definition at line 325 of file sig_pri.h.

char privateprefix[20]

for private dialplans

Definition at line 371 of file sig_pri.h.

Referenced by apply_plan_to_number().

struct sig_pri_chan* pvts[SIG_PRI_MAX_CHANNELS]

Member channel pvt structs

Definition at line 455 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_find_principle_by_call(), pri_fixup_principle(), pri_queue_control(), pri_queue_frame(), sig_pri_attempt_transfer(), sig_pri_cc_available(), sig_pri_cc_generic_check(), sig_pri_cli_show_channels(), sig_pri_cw_available(), sig_pri_handle_hold(), sig_pri_handle_retrieve(), sig_pri_kill_call(), sig_pri_lock_owner(), sig_pri_send_aoce_termination_request(), and sig_pri_sort_pri_chans().

int qsigchannelmapping

QSIG channel mapping type

Definition at line 327 of file sig_pri.h.

long resetinterval

Interval (in seconds) for resetting unused channels

Definition at line 373 of file sig_pri.h.

Referenced by pri_dchannel().

int resetpos

current position during a reset (-1 if not started)

Definition at line 435 of file sig_pri.h.

Referenced by pri_check_restart(), and pri_dchannel().

int resetting

true if span is being reset/restarted

Definition at line 434 of file sig_pri.h.

Referenced by pri_check_restart(), and pri_dchannel().

int sig

ISDN signalling type (SIG_PRI, SIG_BRI, SIG_BRI_PTMP, etc...)

Definition at line 436 of file sig_pri.h.

Referenced by pri_dchannel(), sig_pri_cc_generic_check(), and sig_pri_start_pri().

int span

span number put into user output messages

Definition at line 433 of file sig_pri.h.

Referenced by dahdi_pri_update_span_devstate(), is_group_or_channel_match(), my_handle_dchan_exception(), pri_check_restart(), pri_dchannel(), pri_find_fixup_principle(), sig_pri_cli_show_channels(), sig_pri_digit_begin(), sig_pri_handle_cis_subcmds(), sig_pri_handle_hold(), sig_pri_handle_retrieve(), and sig_pri_start_pri().

int stripmsd

Definition at line 412 of file sig_pri.h.

Referenced by my_pri_init_config(), and sig_pri_init_config().

int switchtype

Type of switch to emulate

Definition at line 397 of file sig_pri.h.

Referenced by pri_dchannel(), and sig_pri_start_pri().

unsigned int transfer

TRUE if call transfer is enabled for the span.

Note:
Support switch-side transfer (called 2BCT, RLT or other names)

Definition at line 356 of file sig_pri.h.

Referenced by dahdi_bridge().

int trunkgroup

What our trunkgroup is

Definition at line 399 of file sig_pri.h.

Referenced by handle_pri_service_generic(), and pri_resolve_span().

char unknownprefix[20]

for unknown dialplans

Definition at line 372 of file sig_pri.h.

Referenced by apply_plan_to_number().

unsigned int use_callerid

Whether or not to use caller id on this channel

Definition at line 418 of file sig_pri.h.

Referenced by my_pri_init_config(), and sig_pri_init_config().

unsigned int use_callingpres

Whether to use the callingpres the calling switch sends

Definition at line 419 of file sig_pri.h.

Referenced by my_pri_init_config(), and sig_pri_init_config().


The documentation for this struct was generated from the following file:
Generated on Mon Mar 19 11:30:59 2012 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7