Mon Mar 19 11:30:57 2012

Asterisk developer's documentation


ast_fax_session Struct Reference

The data required to handle a fax session. More...

#include <res_fax.h>


Data Fields

ast_channelchan
char * chan_uniqueid
char * channame
ast_fax_debug_infodebug_info
ast_fax_session_detailsdetails
int fd
unsigned long frames_received
unsigned long frames_sent
unsigned int id
ast_smoothersmoother
enum ast_fax_state state
ast_fax_techtech
void * tech_pvt


Detailed Description

The data required to handle a fax session.

Definition at line 178 of file res_fax.h.


Field Documentation

struct ast_channel* chan

Asterisk channel using the fax session

Definition at line 200 of file res_fax.h.

char* chan_uniqueid

unique ID of the Asterisk channel using the fax session

Definition at line 198 of file res_fax.h.

Referenced by destroy_session().

char* channame

name of the Asterisk channel using the fax session

Definition at line 196 of file res_fax.h.

Referenced by debug_check_frame_for_silence(), destroy_session(), and spandsp_fax_new().

struct ast_fax_debug_info* debug_info

fax debugging structure

Definition at line 202 of file res_fax.h.

Referenced by debug_check_frame_for_silence(), destroy_session(), and generic_fax_exec().

struct ast_fax_session_details* details

fax session details structure

Definition at line 184 of file res_fax.h.

Referenced by destroy_session(), spandsp_fax_cli_show_session(), spandsp_fax_new(), spandsp_fax_start(), spandsp_fax_switch_to_t38(), and t30_phase_e_handler().

int fd

session file descriptor

Definition at line 182 of file res_fax.h.

Referenced by generic_fax_exec(), spandsp_fax_destroy(), and spandsp_fax_new().

unsigned long frames_received

fax frames received

Definition at line 186 of file res_fax.h.

Referenced by generic_fax_exec().

unsigned long frames_sent

fax frames sent

Definition at line 188 of file res_fax.h.

Referenced by generic_fax_exec().

unsigned int id

session id

Definition at line 180 of file res_fax.h.

Referenced by cli_fax_show_session(), debug_check_frame_for_silence(), fax_session_tab_complete(), generic_fax_exec(), session_cmp_cb(), session_hash_cb(), spandsp_fax_cli_show_session(), spandsp_fax_new(), spandsp_fax_read(), spandsp_fax_start(), spandsp_fax_write(), and t30_phase_e_handler().

struct ast_smoother* smoother

used to take variable-sized frames in and output frames of an expected size to the fax stack

Definition at line 204 of file res_fax.h.

Referenced by destroy_session(), and generic_fax_exec().

enum ast_fax_state state

fax state

Definition at line 194 of file res_fax.h.

Referenced by destroy_session(), fax_session_new(), fax_session_release(), fax_session_reserve(), spandsp_fax_cli_show_session(), spandsp_fax_new(), spandsp_fax_read(), spandsp_fax_start(), and spandsp_fax_write().

struct ast_fax_tech* tech

the fax technology callbacks

Definition at line 190 of file res_fax.h.

Referenced by cli_fax_show_session(), destroy_session(), fax_session_release(), and generic_fax_exec().

void* tech_pvt

private implementation pointer

Definition at line 192 of file res_fax.h.

Referenced by destroy_session(), spandsp_fax_cancel(), spandsp_fax_cli_show_session(), spandsp_fax_destroy(), spandsp_fax_read(), spandsp_fax_start(), spandsp_fax_switch_to_t38(), spandsp_fax_write(), and t30_phase_e_handler().


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