Mon Jun 27 16:51:23 2011

Asterisk developer's documentation


chan_list Struct Reference

Channel call record structure. More...


Data Fields

int addr
 From associated B channel: B Channel mISDN driver layer ID from mISDN_get_layerid().
char allowed_bearers [BUFFERSIZE+1]
 The "allowed_bearers" string read in from /etc/asterisk/misdn.conf.
ast_channelast
 Associated Asterisk channel structure.
int ast_dsp
 TRUE if we will use the Asterisk DSP to detect DTMF/Fax.
char ast_rd_buf [4096]
 Read buffer for inbound audio from pipe[0].
misdn_bchannelbc
 Associated B channel structure.
char context [AST_MAX_CONTEXT]
 Incoming call dialplan context identifier.
int dropped_frame_cnt
 Number of outgoing audio frames dropped since last debug gripe message.
ast_dspdsp
 Allocated DSP controller.
int far_alerting
 TRUE if we must do the ringback tones.
int faxdetect
 Fax detection option. (0:no 1:yes 2:yes+nojump).
int faxdetect_timeout
 Number of seconds to detect a Fax machine when detection enabled.
timeval faxdetect_tv
 Starting time of fax detection with timeout when nonzero.
int faxhandled
 TRUE if a fax has been detected.
ast_frame frame
 Inbound audio frame returned by misdn_read().
hold_info hold
 HELD channel call information.
int ignore_dtmf
 TRUE if DTMF digits are to be passed inband only.
int incoming_early_audio
 TRUE if you want to send Tone Indications to an incoming ISDN channel on a TE Port.
misdn_jbjb
 Allocated jitterbuffer controller.
int jb_len
 Jitterbuffer length.
int jb_upper_threshold
 Jitterbuffer upper threshold.
unsigned int l3id
 From associated B channel: Layer 3 process ID.
char mohinterpret [MAX_MUSICCLASS]
 The configured music-on-hold class to use for this call.
int need_busy
 TRUE if we could send an AST_CONTROL_BUSY if needed.
int need_hangup
 TRUE if a channel can be hung up by calling asterisk directly when done.
int need_queue_hangup
 TRUE if a hangup needs to be queued.
chan_listnext
 Next channel call record in the list.
int noautorespond_on_setup
 TRUE of we are not to respond immediately to a SETUP message. Check the dialplan first.
int norxtone
int notxtone
 TRUE if we are not to generate tones (Playtones).
int nttimeout
 TRUE if NT should disconnect an overlap dialing call when a timeout occurs.
int originator
 Who originally created this channel. ORG_AST or ORG_MISDN.
int overlap_dial
 Enables overlap dialing for the set amount of seconds. (0 = Disabled).
int overlap_dial_task
 Overlap dialing timeout Task ID. -1 if not running.
timeval overlap_tv
 Overlap timer start time. Timer restarted for every digit received.
ast_mutex_t overlap_tv_lock
 overlap_tv access lock.
int pipe [2]
 Pipe file descriptor handles array. Read from pipe[0], write to pipe[1].
enum misdn_chan_state state
 State of the channel.
int toggle_ec
 TRUE if echo canceller is enabled. Value is toggled.
ast_tone_zone_soundts
 Tone zone sound used for dialtone generation.


Detailed Description

Channel call record structure.

Definition at line 347 of file chan_misdn.c.


Field Documentation

int addr

From associated B channel: B Channel mISDN driver layer ID from mISDN_get_layerid().

Note:
Used only for debug display messages.

Definition at line 517 of file chan_misdn.c.

Referenced by cb_events(), and print_bc_info().

char allowed_bearers[BUFFERSIZE+1]

The "allowed_bearers" string read in from /etc/asterisk/misdn.conf.

Definition at line 351 of file chan_misdn.c.

Referenced by cb_events(), and read_config().

struct ast_channel* ast

Associated Asterisk channel structure.

Definition at line 485 of file chan_misdn.c.

Referenced by cb_events(), dialtone_indicate(), do_immediate_setup(), find_hold_active_call(), get_chan_by_ast(), get_chan_by_ast_name(), handle_cli_misdn_send_digit(), handle_cli_misdn_show_channel(), handle_cli_misdn_show_channels(), hangup_chan(), misdn_answer(), misdn_attempt_transfer(), misdn_copy_redirecting_from_ast(), misdn_digit_end(), misdn_facility_ie_handler(), misdn_fixup(), misdn_hangup(), misdn_indication(), misdn_new(), misdn_overlap_dial_task(), misdn_update_connected_line(), misdn_write(), pbx_start_chan(), print_bc_info(), process_ast_dsp(), read_config(), release_chan(), release_chan_early(), send_digit_to_chan(), stop_indicate(), and update_config().

int ast_dsp

TRUE if we will use the Asterisk DSP to detect DTMF/Fax.

Note:
The "astdtmf" boolean read in from /etc/asterisk/misdn.conf

Definition at line 454 of file chan_misdn.c.

Referenced by misdn_read(), misdn_set_opt_exec(), process_ast_dsp(), and read_config().

char ast_rd_buf[4096]

Read buffer for inbound audio from pipe[0].

Definition at line 419 of file chan_misdn.c.

Referenced by misdn_read().

struct misdn_bchannel* bc

Associated B channel structure.

Definition at line 490 of file chan_misdn.c.

Referenced by cb_events(), chan_misdn_jb_empty(), cl_queue_chan(), config_jitterbuffer(), dialtone_indicate(), find_chan_by_bc(), find_hold_active_call(), find_hold_call(), handle_cli_misdn_send_display(), handle_cli_misdn_send_facility(), handle_cli_misdn_show_channel(), handle_cli_misdn_show_channels(), handle_cli_misdn_toggle_echocancel(), hangup_chan(), hanguptone_indicate(), misdn_answer(), misdn_bridge(), misdn_call(), misdn_copy_redirecting_from_ast(), misdn_digit_end(), misdn_facility_exec(), misdn_fixup(), misdn_hangup(), misdn_indication(), misdn_overlap_dial_task(), misdn_read(), misdn_request(), misdn_send_text(), misdn_set_opt_exec(), misdn_update_connected_line(), misdn_write(), process_ast_dsp(), read_config(), release_chan(), start_bc_tones(), stop_indicate(), and update_config().

char context[AST_MAX_CONTEXT]

Incoming call dialplan context identifier.

Note:
The "context" string read in from /etc/asterisk/misdn.conf

Definition at line 523 of file chan_misdn.c.

Referenced by cb_events(), misdn_overlap_dial_task(), and read_config().

int dropped_frame_cnt

Number of outgoing audio frames dropped since last debug gripe message.

Definition at line 534 of file chan_misdn.c.

Referenced by misdn_write().

struct ast_dsp* dsp

Allocated DSP controller.

Note:
ast_dsp_new() creates the DSP controller.

Must use ast_dsp_free() to clean up.

Definition at line 480 of file chan_misdn.c.

Referenced by chan_list_destructor(), misdn_set_opt_exec(), process_ast_dsp(), and read_config().

int far_alerting

TRUE if we must do the ringback tones.

Note:
The "far_alerting" boolean read in from /etc/asterisk/misdn.conf

Definition at line 540 of file chan_misdn.c.

Referenced by cb_events(), and read_config().

int faxdetect

Fax detection option. (0:no 1:yes 2:yes+nojump).

Note:
The "faxdetect" option string read in from /etc/asterisk/misdn.conf

It is settable by the misdn_set_opt() application.

Definition at line 431 of file chan_misdn.c.

Referenced by misdn_read(), misdn_set_opt_exec(), process_ast_dsp(), and read_config().

int faxdetect_timeout

Number of seconds to detect a Fax machine when detection enabled.

Note:
0 disables the timeout.

The "faxdetect_timeout" value read in from /etc/asterisk/misdn.conf

Definition at line 438 of file chan_misdn.c.

Referenced by misdn_read(), misdn_set_opt_exec(), and read_config().

struct timeval faxdetect_tv

Starting time of fax detection with timeout when nonzero.

Definition at line 443 of file chan_misdn.c.

Referenced by misdn_read().

int faxhandled

TRUE if a fax has been detected.

Definition at line 448 of file chan_misdn.c.

Referenced by misdn_read(), and process_ast_dsp().

struct ast_frame frame

Inbound audio frame returned by misdn_read().

Definition at line 424 of file chan_misdn.c.

Referenced by misdn_read(), and misdn_write().

struct hold_info hold

HELD channel call information.

Definition at line 505 of file chan_misdn.c.

Referenced by cb_events(), find_hold_active_call(), find_hold_call(), find_hold_call_l3(), handle_cli_misdn_show_channels(), misdn_attempt_transfer(), misdn_hangup(), misdn_indication(), misdn_read(), misdn_write(), and release_chan_early().

int ignore_dtmf

TRUE if DTMF digits are to be passed inband only.

Note:
It is settable by the misdn_set_opt() application.

Definition at line 408 of file chan_misdn.c.

Referenced by cb_events(), misdn_bridge(), misdn_set_opt_exec(), and read_config().

int incoming_early_audio

TRUE if you want to send Tone Indications to an incoming ISDN channel on a TE Port.

Note:
The "incoming_early_audio" boolean read in from /etc/asterisk/misdn.conf

Definition at line 402 of file chan_misdn.c.

Referenced by misdn_indication(), and read_config().

struct misdn_jb* jb

Allocated jitterbuffer controller.

Note:
misdn_jb_init() creates the jitterbuffer.

Must use misdn_jb_destroy() to clean up.

Definition at line 473 of file chan_misdn.c.

Referenced by chan_list_destructor(), chan_misdn_jb_empty(), and config_jitterbuffer().

int jb_len

Jitterbuffer length.

Note:
The "jitterbuffer" value read in from /etc/asterisk/misdn.conf

Definition at line 460 of file chan_misdn.c.

Referenced by config_jitterbuffer(), misdn_set_opt_exec(), and read_config().

int jb_upper_threshold

Jitterbuffer upper threshold.

Note:
The "jitterbuffer_upper_threshold" value read in from /etc/asterisk/misdn.conf

Definition at line 466 of file chan_misdn.c.

Referenced by config_jitterbuffer(), misdn_set_opt_exec(), and read_config().

unsigned int l3id

From associated B channel: Layer 3 process ID.

Note:
Used to find the HELD channel call record when retrieving a call.

Definition at line 511 of file chan_misdn.c.

Referenced by cb_events(), find_hold_call_l3(), handle_cli_misdn_show_channels(), misdn_call(), misdn_fixup(), misdn_hangup(), and print_bc_info().

char mohinterpret[MAX_MUSICCLASS]

The configured music-on-hold class to use for this call.

Note:
The "musicclass" string read in from /etc/asterisk/misdn.conf

Definition at line 529 of file chan_misdn.c.

Referenced by misdn_indication(), and read_config().

int need_busy

TRUE if we could send an AST_CONTROL_BUSY if needed.

Definition at line 372 of file chan_misdn.c.

Referenced by cb_events(), misdn_hangup(), and send_cause2ast().

int need_hangup

TRUE if a channel can be hung up by calling asterisk directly when done.

Definition at line 367 of file chan_misdn.c.

Referenced by hangup_chan(), misdn_hangup(), misdn_request(), and pbx_start_chan().

int need_queue_hangup

TRUE if a hangup needs to be queued.

Note:
This is a debug flag only used to catch calls to hangup_chan() that are already hungup.

Definition at line 362 of file chan_misdn.c.

Referenced by hangup_chan(), and misdn_hangup().

struct chan_list* next

Next channel call record in the list.

Definition at line 578 of file chan_misdn.c.

Referenced by cl_dequeue_chan(), cl_queue_chan(), find_chan_by_bc(), find_hold_active_call(), find_hold_call(), find_hold_call_l3(), get_chan_by_ast(), get_chan_by_ast_name(), handle_cli_misdn_show_channel(), handle_cli_misdn_show_channels(), and misdn_chan_is_valid().

int noautorespond_on_setup

TRUE of we are not to respond immediately to a SETUP message. Check the dialplan first.

Note:
The "noautorespond_on_setup" boolean read in from /etc/asterisk/misdn.conf

Definition at line 383 of file chan_misdn.c.

Referenced by cb_events(), do_immediate_setup(), and read_config().

int norxtone

Boolean assigned values but the value is not used.

Definition at line 385 of file chan_misdn.c.

Referenced by dialtone_indicate(), print_bc_info(), start_bc_tones(), and stop_bc_tones().

int notxtone

TRUE if we are not to generate tones (Playtones).

Definition at line 390 of file chan_misdn.c.

Referenced by dialtone_indicate(), misdn_write(), print_bc_info(), start_bc_tones(), and stop_bc_tones().

int nttimeout

TRUE if NT should disconnect an overlap dialing call when a timeout occurs.

Note:
The "nttimeout" boolean read in from /etc/asterisk/misdn.conf

Definition at line 546 of file chan_misdn.c.

Referenced by cb_events(), and read_config().

int originator

Who originally created this channel. ORG_AST or ORG_MISDN.

Definition at line 377 of file chan_misdn.c.

Referenced by cb_events(), misdn_facility_ie_handler(), misdn_hangup(), misdn_indication(), misdn_set_opt_exec(), print_bc_info(), read_config(), release_chan(), and release_chan_early().

int overlap_dial

Enables overlap dialing for the set amount of seconds. (0 = Disabled).

Note:
The "overlapdial" value read in from /etc/asterisk/misdn.conf

Definition at line 558 of file chan_misdn.c.

Referenced by cb_events(), chan_list_destructor(), misdn_overlap_dial_task(), and read_config().

int overlap_dial_task

Overlap dialing timeout Task ID. -1 if not running.

Definition at line 563 of file chan_misdn.c.

Referenced by cb_events(), chan_list_destructor(), misdn_overlap_dial_task(), and read_config().

struct timeval overlap_tv

Overlap timer start time. Timer restarted for every digit received.

Definition at line 573 of file chan_misdn.c.

Referenced by cb_events(), and misdn_overlap_dial_task().

ast_mutex_t overlap_tv_lock

overlap_tv access lock.

Definition at line 568 of file chan_misdn.c.

Referenced by cb_events(), chan_list_destructor(), misdn_overlap_dial_task(), and read_config().

int pipe[2]

Pipe file descriptor handles array. Read from pipe[0], write to pipe[1].

Definition at line 414 of file chan_misdn.c.

Referenced by cb_events(), chan_list_destructor(), misdn_new(), and misdn_read().

enum misdn_chan_state state

State of the channel.

Definition at line 356 of file chan_misdn.c.

Referenced by cb_events(), do_immediate_setup(), find_hold_active_call(), misdn_answer(), misdn_attempt_transfer(), misdn_call(), misdn_digit_end(), misdn_get_ch_state(), misdn_hangup(), misdn_indication(), misdn_overlap_dial_task(), misdn_update_connected_line(), release_chan(), release_chan_early(), send_cause2ast(), and wait_for_digits().

int toggle_ec

TRUE if echo canceller is enabled. Value is toggled.

Definition at line 395 of file chan_misdn.c.

Referenced by handle_cli_misdn_toggle_echocancel().

struct ast_tone_zone_sound* ts

Tone zone sound used for dialtone generation.

Note:
Used as a boolean. Non-NULL to prod generation if enabled.

Definition at line 552 of file chan_misdn.c.

Referenced by dialtone_indicate(), misdn_write(), and stop_indicate().


The documentation for this struct was generated from the following file:
Generated on Mon Jun 27 16:51:23 2011 for Asterisk - The Open Source Telephony Project by  doxygen 1.4.7