Asterisk - The Open Source Telephony Project  GIT-master-a24979a
Data Fields
ast_fax_session_details Struct Reference

The data communicated between the high level applications and the generic fax function. More...

#include <res_fax.h>

Collaboration diagram for ast_fax_session_details:
Collaboration graph
[legend]

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_flags
 
int faxdetect_id
 
int faxdetect_timeout
 
int gateway_id
 
int gateway_timeout
 
const ast_string_field headerinfo
 
unsigned int id
 
int is_t38_negotiated
 
const ast_string_field localstationid
 
unsigned int maxrate
 
unsigned int minrate
 
enum ast_fax_modems modems
 
int negotiate_both
 
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
 
unsigned int t38timeout
 
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.

Definition at line 110 of file res_fax.h.

Field Documentation

◆ __field_mgr

struct ast_string_field_mgr __field_mgr

Definition at line 142 of file res_fax.h.

◆ __field_mgr_pool

struct ast_string_field_pool* __field_mgr_pool

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

Definition at line 142 of file res_fax.h.

◆ allow_audio

uint32_t allow_audio

allow audio mode FAX on T.38-capable channels

Definition at line 157 of file res_fax.h.

Referenced by receivefax_t38_init(), and sendfax_t38_init().

◆ caps

◆ debug

uint32_t debug

flag to send debug manager events

Definition at line 151 of file res_fax.h.

Referenced by fax_gateway_attach(), fax_session_new(), and set_logging().

◆ documents

struct ast_fax_documents documents

document(s) to be sent/received

Definition at line 117 of file res_fax.h.

Referenced by acf_faxopt_read(), generate_filenames_json(), generate_filenames_string(), and set_file().

◆ dontuse

uint32_t dontuse

dontuse dummy variable - do not ever use

Definition at line 148 of file res_fax.h.

◆ ecm

uint32_t ecm

flag indicating the use of Error Correction Mode (ECM)

Definition at line 153 of file res_fax.h.

Referenced by acf_faxopt_read(), set_ecm(), spandsp_fax_gateway_cleanup(), and spandsp_fax_gateway_start().

◆ error

const ast_string_field error

Definition at line 142 of file res_fax.h.

Referenced by acf_faxopt_read(), and set_channel_variables().

◆ faxdetect_flags

int faxdetect_flags

flags used for fax detection

Definition at line 189 of file res_fax.h.

Referenced by fax_detect_attach(), and fixup_callback().

◆ faxdetect_id

int faxdetect_id

the id of the faxdetect framehook for this channel

Definition at line 185 of file res_fax.h.

Referenced by acf_faxopt_read(), fax_detect_attach(), fax_detect_framehook(), and fixup_callback().

◆ faxdetect_timeout

int faxdetect_timeout

The timeout for this fax detect in ms

Definition at line 187 of file res_fax.h.

Referenced by fax_detect_attach(), fax_detect_framehook(), and fixup_callback().

◆ gateway_id

int gateway_id

the id of the t.38 gateway framehook for this channel

Definition at line 181 of file res_fax.h.

Referenced by acf_faxopt_read(), fax_gateway_detect_t38(), and fixup_callback().

◆ gateway_timeout

int gateway_timeout

The timeout for this gateway in ms

Definition at line 183 of file res_fax.h.

Referenced by fax_gateway_detect_t38(), fax_gateway_new(), and fax_gateway_request_t38().

◆ headerinfo

const ast_string_field headerinfo

Definition at line 142 of file res_fax.h.

Referenced by acf_faxopt_read(), generic_fax_exec(), and set_local_info().

◆ id

unsigned int id

◆ is_t38_negotiated

int is_t38_negotiated

◆ localstationid

const ast_string_field localstationid

◆ maxrate

unsigned int maxrate

override the maximum transmission rate with a channel varialbe

Definition at line 173 of file res_fax.h.

Referenced by acf_faxopt_read().

◆ minrate

unsigned int minrate

override the minimum transmission rate with a channel variable

Definition at line 171 of file res_fax.h.

Referenced by acf_faxopt_read().

◆ modems

enum ast_fax_modems modems

modem requirement for the session

Definition at line 107 of file res_fax.h.

Referenced by acf_faxopt_read(), and spandsp_modems().

◆ negotiate_both

int negotiate_both

Upon v21 detection the gateway sends negotiation requests to both T.38 endpoints, and do not wait on the "other" side to initiate

Definition at line 194 of file res_fax.h.

Referenced by acf_faxopt_read(), and fax_gateway_detect_v21().

◆ 

union { ... } option

◆ our_t38_parameters

struct ast_fax_t38_parameters our_t38_parameters

◆ pages_transferred

unsigned int pages_transferred

the number of pages sent/received during a fax session

Definition at line 144 of file res_fax.h.

Referenced by acf_faxopt_read(), set_channel_variables(), spandsp_fax_gateway_cleanup(), and t30_phase_e_handler().

◆ remotestationid

const ast_string_field remotestationid

Definition at line 142 of file res_fax.h.

Referenced by acf_faxopt_read(), and set_channel_variables().

◆ request_t38

uint32_t request_t38

send a T.38 reinvite

Definition at line 165 of file res_fax.h.

Referenced by sendfax_t38_init().

◆ resolution

const ast_string_field resolution

Definition at line 142 of file res_fax.h.

Referenced by acf_faxopt_read(), and set_channel_variables().

◆ result

const ast_string_field result

◆ resultstr

const ast_string_field resultstr

◆ send_ced

uint32_t send_ced

flag indicating whether CED should be sent (for receive mode)

Definition at line 161 of file res_fax.h.

◆ send_cng

uint32_t send_cng

flag indicating whether CNG should be sent (for send mode)

Definition at line 163 of file res_fax.h.

◆ statusevents

uint32_t statusevents

flag indicating the sending of status manager events

Definition at line 155 of file res_fax.h.

Referenced by report_fax_status().

◆ switch_to_t38

uint32_t switch_to_t38

indicating the session switched to T38

Definition at line 159 of file res_fax.h.

Referenced by spandsp_fax_switch_to_t38().

◆ t38timeout

unsigned int t38timeout

T.38 negotiation in ms

Definition at line 179 of file res_fax.h.

Referenced by acf_faxopt_read(), and receivefax_t38_init().

◆ their_t38_parameters

struct ast_fax_t38_parameters their_t38_parameters

the other endpoint's T.38 session parameters, if any

Definition at line 173 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().

◆ transfer_rate

const ast_string_field transfer_rate

Definition at line 142 of file res_fax.h.

Referenced by acf_faxopt_read(), and set_channel_variables().

◆ v21_detected

uint32_t v21_detected

a V.21 preamble was detected

Definition at line 167 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: