Thu Apr 16 06:48:42 2015

Asterisk developer's documentation


ast_fax_tech Struct Reference

used to register a FAX technology module with res_fax More...

#include <res_fax.h>

Collaboration diagram for ast_fax_tech:

Collaboration graph
[legend]

Data Fields

int(*const cancel_session )(struct ast_fax_session *)
enum ast_fax_capabilities caps
char *(*const cli_show_capabilities )(int)
char *(*const cli_show_session )(struct ast_fax_session *, int)
char *(*const cli_show_settings )(int)
char *(*const cli_show_stats )(int)
const char *const description
void(*const destroy_session )(struct ast_fax_session *)
int(*const generate_silence )(struct ast_fax_session *)
struct ast_modulemodule
void *(*const new_session )(struct ast_fax_session *, struct ast_fax_tech_token *)
struct ast_frame *(*const read )(struct ast_fax_session *)
void(*const release_token )(struct ast_fax_tech_token *)
struct ast_fax_tech_token *(*const reserve_session )(struct ast_fax_session *)
int(*const start_session )(struct ast_fax_session *)
int(*const switch_to_t38 )(struct ast_fax_session *)
const char *const type
const char *const version
int(*const write )(struct ast_fax_session *, const struct ast_frame *)

Detailed Description

used to register a FAX technology module with res_fax

Definition at line 208 of file res_fax.h.


Field Documentation

int(* const cancel_session)(struct ast_fax_session *)

cancels a fax session

Referenced by generic_fax_exec().

the ast_fax_capabilities supported by the fax technology

Definition at line 216 of file res_fax.h.

Referenced by fax_session_new(), and fax_session_reserve().

char*(* const cli_show_capabilities)(int)

displays capabilities of the fax technology

Referenced by cli_fax_show_capabilities().

char*(* const cli_show_session)(struct ast_fax_session *, int)

displays details about the fax session

Referenced by cli_fax_show_session().

char*(* const cli_show_settings)(int)

displays settings from the fax technology module

Referenced by cli_fax_show_settings().

char*(* const cli_show_stats)(int)

displays statistics from the fax technology module

Referenced by cli_fax_show_stats().

const char* const description

a short description of the fax technology

Definition at line 212 of file res_fax.h.

Referenced by ast_fax_tech_register(), cli_fax_show_capabilities(), cli_fax_show_settings(), cli_fax_show_version(), fax_session_new(), and fax_session_reserve().

void(* const destroy_session)(struct ast_fax_session *)

destroys an existing fax session

Referenced by destroy_session().

int(* const generate_silence)(struct ast_fax_session *)

initiates the generation of silence to the fax session

Referenced by generic_fax_exec().

struct ast_module* module [read]

module information for the fax technology

Definition at line 218 of file res_fax.h.

Referenced by destroy_session(), fax_session_new(), fax_session_reserve(), and load_module().

void*(* const new_session)(struct ast_fax_session *, struct ast_fax_tech_token *)

creates a new fax session, optionally using a previously-reserved token

Referenced by fax_session_new().

struct ast_frame*(* const read)(struct ast_fax_session *) [read]

sends an Asterisk frame to res_fax

Referenced by generic_fax_exec().

void(* const release_token)(struct ast_fax_tech_token *)

releases an unused session token

Referenced by fax_session_release().

struct ast_fax_tech_token*(* const reserve_session)(struct ast_fax_session *) [read]

reserves a session for future use; returns a token

Referenced by fax_session_reserve().

int(* const start_session)(struct ast_fax_session *)

starts the fax session

Referenced by generic_fax_exec().

int(* const switch_to_t38)(struct ast_fax_session *)

switches an existing dual-mode session from audio to T.38

Referenced by generic_fax_exec().

const char* const type

the type of fax session supported with this ast_fax_tech structure

Definition at line 210 of file res_fax.h.

Referenced by ast_fax_tech_register(), ast_fax_tech_unregister(), cli_fax_show_capabilities(), cli_fax_show_sessions(), and cli_fax_show_settings().

const char* const version

version string of the technology module

Definition at line 214 of file res_fax.h.

Referenced by cli_fax_show_version().

int(* const write)(struct ast_fax_session *, const struct ast_frame *)

writes an Asterisk frame to the fax session

Referenced by generic_fax_exec().


The documentation for this struct was generated from the following file:

Generated on Thu Apr 16 06:48:42 2015 for Asterisk - The Open Source Telephony Project by  doxygen 1.5.6