Asterisk.org: Developer Documentation (Mon Mar 12 2012)

Mon Mar 12 2012 21:48:25

Asterisk developer's documentation

#include <sig_pri.h>

Collaboration diagram for sig_pri_chan:

Collaboration graph

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
struct sig_pri_callback *	calls
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	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
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
unsigned int	resetting:1
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 197 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 254 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 239 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 232 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 233 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 234 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 267 of file sig_pri.h.

Referenced by dahdi_bridge(), dahdi_show_channel(), pri_dchannel(), pri_find_principle(), 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(), and sig_pri_redirecting_update().

enum sig_pri_call_level call_level

Call establishment life cycle level for simple comparisons.

Definition at line 270 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_digit_begin(), 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 214 of file sig_pri.h.

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

Private structure of the user of this module.

Definition at line 280 of file sig_pri.h.

Referenced by available(), pri_queue_control(), sig_pri_ami_channel_event(), sig_pri_chan_new(), 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_rdnis(), and sig_pri_unlock_private().

Channel Number or CRV

Definition at line 209 of file sig_pri.h.

Referenced by dahdi_new_pri_nobch_channel(), do_idle_thread(), 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 218 of file sig_pri.h.

Referenced by pri_dchannel(), and sig_pri_set_caller_id().

Automatic Number Identification number (Alternate PRI caller ID number)

Definition at line 212 of file sig_pri.h.

Referenced by pri_dchannel(), and sig_pri_set_caller_id().

char cid_name[AST_MAX_EXTENSION]

Definition at line 217 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 215 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 216 of file sig_pri.h.

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

Type Of Number (TON)

Definition at line 213 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 206 of file sig_pri.h.

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

char dialdest[256]

Definition at line 225 of file sig_pri.h.

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

unsigned int digital

Definition at line 256 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 221 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 199 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 200 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 236 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 201 of file sig_pri.h.

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

unsigned int inalarm

Definition at line 238 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 261 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 240 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 228 of file sig_pri.h.

Referenced by pri_dchannel(), and pri_fixup_principle().

int logicalspan

logical span number within trunk group

Definition at line 272 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 273 of file sig_pri.h.

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

char mohinterpret[MAX_MUSICCLASS]

Definition at line 207 of file sig_pri.h.

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

unsigned int no_b_channel

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

Definition at line 258 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 255 of file sig_pri.h.

Referenced by pri_dchannel(), pri_fixup_principle(), sig_pri_call(), sig_pri_cc_generic_check(), sig_pri_hangup(), sig_pri_indicate(), and sig_pri_request().

unsigned int priexclusive

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

Definition at line 202 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 203 of file sig_pri.h.

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

channel number in span

Definition at line 271 of file sig_pri.h.

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

unsigned int progress

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

Definition at line 241 of file sig_pri.h.

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

unsigned int resetting

TRUE if this channel is being reset/restarted

Definition at line 242 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 289 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 276 of file sig_pri.h.

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

Definition at line 208 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 204 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 205 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 220 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 235 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:

sig_pri.h

sig_pri_chan
Generated on Mon Mar 12 2012 21:48:26 for Asterisk - The Open Source Telephony Project by 1.7.5.1