The data communicated between the high level applications and the generic fax function. More...
#include <res_fax.h>
Data Fields | |
| struct ast_string_field_mgr | __field_mgr |
| struct ast_string_field_pool * | __field_mgr_pool |
| enum ast_fax_capabilities | caps |
| struct ast_fax_documents | documents |
| const ast_string_field | error |
| int | faxdetect_id |
| int | gateway_id |
| int | gateway_timeout |
| const ast_string_field | headerinfo |
| unsigned int | id |
| const ast_string_field | localstationid |
| unsigned int | maxrate |
| unsigned int | minrate |
| enum ast_fax_modems | modems |
| union { | |
| struct { | |
| uint32_t allow_audio:2 | |
| uint32_t debug:2 | |
| uint32_t ecm:1 | |
| uint32_t request_t38:1 | |
| uint32_t send_ced:1 | |
| uint32_t send_cng:1 | |
| uint32_t statusevents:2 | |
| uint32_t switch_to_t38:1 | |
| uint32_t v21_detected:1 | |
| } | |
| uint32_t dontuse | |
| } | option |
| struct ast_fax_t38_parameters | our_t38_parameters |
| unsigned int | pages_transferred |
| const ast_string_field | remotestationid |
| const ast_string_field | resolution |
| const ast_string_field | result |
| const ast_string_field | resultstr |
| struct ast_fax_t38_parameters | their_t38_parameters |
| const ast_string_field | transfer_rate |
Detailed Description
The data communicated between the high level applications and the generic fax function.
Field Documentation
| struct ast_string_field_mgr __field_mgr |
resolution negotiated during the fax session. This is stored in the FAXRESOLUTION channel variable when the fax session completes
transfer rate negotiated during the fax session. This is stored in the FAXBITRATE channel variable when the fax session completes
local station identification. This is set from the LOCALSTATIONID channel variable before the fax session starts
remote station identification. This is stored in the REMOTESTATIONID channel variable after the fax session completes
headerinfo variable is set from the LOCALHEADERINFO channel variable before the fax session starts
the result of the fax session
a more descriptive result string of the fax session
the error reason of the fax session
| uint32_t allow_audio |
allow audio mode FAX on T.38-capable channels
Definition at line 156 of file res_fax.h.
Referenced by receivefax_exec(), receivefax_t38_init(), sendfax_exec(), and sendfax_t38_init().
| enum ast_fax_capabilities caps |
fax session capability requirements. The caps field is used to select the proper fax technology module before the session starts
Definition at line 112 of file res_fax.h.
Referenced by cli_session_operation(), cli_session_type(), destroy_session(), fax_gateway_new(), fax_session_new(), fax_session_reserve(), generic_fax_exec(), receivefax_exec(), receivefax_t38_init(), report_fax_status(), sendfax_exec(), sendfax_t38_init(), set_fax_t38_caps(), set_file(), spandsp_fax_cancel(), spandsp_fax_cli_show_session(), spandsp_fax_destroy(), spandsp_fax_new(), spandsp_fax_start(), spandsp_fax_write(), t30_phase_e_handler(), and t38_tx_packet_handler().
| uint32_t debug |
flag to send debug manager events
Definition at line 150 of file res_fax.h.
Referenced by fax_session_new(), receivefax_exec(), sendfax_exec(), and set_logging().
| struct ast_fax_documents documents |
document(s) to be sent/received
Definition at line 118 of file res_fax.h.
Referenced by acf_faxopt_read(), destroy_session_details(), generate_filenames_string(), receivefax_exec(), sendfax_exec(), session_details_new(), and set_file().
| uint32_t ecm |
flag indicating the use of Error Correction Mode (ECM)
Definition at line 152 of file res_fax.h.
Referenced by acf_faxopt_read(), acf_faxopt_write(), session_details_new(), set_ecm(), spandsp_fax_gateway_cleanup(), and spandsp_fax_gateway_start().
| const ast_string_field error |
Definition at line 141 of file res_fax.h.
Referenced by acf_faxopt_read(), fax_gateway_detect_t38(), fax_gateway_framehook(), and set_channel_variables().
| int faxdetect_id |
the id of the faxdetect framehook for this channel
Definition at line 182 of file res_fax.h.
Referenced by acf_faxopt_read(), acf_faxopt_write(), fax_detect_attach(), fax_detect_framehook(), and session_details_new().
| int gateway_id |
the id of the t.38 gateway framehook for this channel
Definition at line 178 of file res_fax.h.
Referenced by acf_faxopt_read(), acf_faxopt_write(), fax_gateway_detect_t38(), fax_gateway_framehook(), receivefax_exec(), sendfax_exec(), and session_details_new().
| int gateway_timeout |
the timeout for this gateway in seconds
Definition at line 180 of file res_fax.h.
Referenced by acf_faxopt_write(), fax_gateway_detect_t38(), fax_gateway_framehook(), fax_gateway_new(), fax_gateway_request_t38(), and session_details_new().
| const ast_string_field headerinfo |
Definition at line 141 of file res_fax.h.
Referenced by acf_faxopt_read(), acf_faxopt_write(), generic_fax_exec(), and set_local_info().
| unsigned int id |
session id
Definition at line 116 of file res_fax.h.
Referenced by acf_faxopt_read(), and fax_session_new().
Definition at line 141 of file res_fax.h.
Referenced by acf_faxopt_read(), acf_faxopt_write(), generic_fax_exec(), report_fax_status(), set_channel_variables(), and set_local_info().
| unsigned int maxrate |
override the maximum transmission rate with a channel varialbe
Definition at line 172 of file res_fax.h.
Referenced by acf_faxopt_read(), acf_faxopt_write(), receivefax_exec(), sendfax_exec(), and session_details_new().
| unsigned int minrate |
override the minimum transmission rate with a channel variable
Definition at line 170 of file res_fax.h.
Referenced by acf_faxopt_read(), acf_faxopt_write(), receivefax_exec(), sendfax_exec(), and session_details_new().
| enum ast_fax_modems modems |
modem requirement for the session
Definition at line 114 of file res_fax.h.
Referenced by acf_faxopt_read(), acf_faxopt_write(), receivefax_exec(), sendfax_exec(), session_details_new(), and spandsp_modems().
| union { ... } option |
session details flags for options
Referenced by acf_faxopt_read(), acf_faxopt_write(), fax_gateway_detect_v21(), fax_session_new(), receivefax_exec(), receivefax_t38_init(), report_fax_status(), sendfax_exec(), sendfax_t38_init(), session_details_new(), set_ecm(), set_logging(), spandsp_fax_gateway_cleanup(), spandsp_fax_gateway_start(), spandsp_fax_switch_to_t38(), and spandsp_v21_detect().
our T.38 session parameters, if any
Definition at line 174 of file res_fax.h.
Referenced by fax_gateway_detect_t38(), fax_gateway_request_t38(), find_or_create_details(), generic_fax_exec(), receivefax_t38_init(), sendfax_t38_init(), and spandsp_fax_gateway_start().
| unsigned int pages_transferred |
the number of pages sent/received during a fax session
Definition at line 143 of file res_fax.h.
Referenced by acf_faxopt_read(), set_channel_variables(), spandsp_fax_gateway_cleanup(), and t30_phase_e_handler().
Definition at line 141 of file res_fax.h.
Referenced by acf_faxopt_read(), and set_channel_variables().
| uint32_t request_t38 |
send a T.38 reinvite
Definition at line 164 of file res_fax.h.
Referenced by sendfax_exec(), sendfax_t38_init(), and session_details_new().
| const ast_string_field resolution |
Definition at line 141 of file res_fax.h.
Referenced by acf_faxopt_read(), and set_channel_variables().
| const ast_string_field result |
Definition at line 141 of file res_fax.h.
Referenced by acf_faxopt_read(), fax_gateway_detect_t38(), fax_gateway_framehook(), generic_fax_exec(), set_channel_variables(), and t30_phase_e_handler().
| const ast_string_field resultstr |
Definition at line 141 of file res_fax.h.
Referenced by acf_faxopt_read(), fax_gateway_detect_t38(), fax_gateway_framehook(), set_channel_variables(), and t30_phase_e_handler().
| uint32_t send_ced |
flag indicating whether CED should be sent (for receive mode)
Definition at line 160 of file res_fax.h.
Referenced by receivefax_exec(), and session_details_new().
| uint32_t send_cng |
flag indicating whether CNG should be sent (for send mode)
Definition at line 162 of file res_fax.h.
Referenced by sendfax_exec(), and session_details_new().
| uint32_t statusevents |
flag indicating the sending of status manager events
Definition at line 154 of file res_fax.h.
Referenced by receivefax_exec(), report_fax_status(), sendfax_exec(), and session_details_new().
| uint32_t switch_to_t38 |
indicating the session switched to T38
Definition at line 158 of file res_fax.h.
Referenced by spandsp_fax_switch_to_t38().
the other endpoint's T.38 session parameters, if any
Definition at line 176 of file res_fax.h.
Referenced by fax_gateway_detect_t38(), find_or_create_details(), generic_fax_exec(), receivefax_t38_init(), sendfax_t38_init(), spandsp_fax_gateway_start(), and spandsp_fax_start().
Definition at line 141 of file res_fax.h.
Referenced by acf_faxopt_read(), and set_channel_variables().
| uint32_t v21_detected |
a V.21 preamble was detected
Definition at line 166 of file res_fax.h.
Referenced by fax_gateway_detect_v21(), and spandsp_v21_detect().
The documentation for this struct was generated from the following file:
