t38_core_state_s Struct Reference

#include <t38_core.h>

List of all members.

Public Attributes

t38_tx_packet_handler_t * tx_packet_handler
void * tx_packet_user_data
t38_rx_indicator_handler_t * rx_indicator_handler
t38_rx_data_handler_t * rx_data_handler
t38_rx_missing_handler_t * rx_missing_handler
void * rx_user_data
int data_rate_management_method
int data_transport_protocol
int fill_bit_removal
int mmr_transcoding
int jbig_transcoding
int max_buffer_size
int max_datagram_size
int t38_version
int fastest_image_data_rate
int indicator_tx_count
 The number of times an indicator packet will be sent. Numbers greater than one will increase reliability for UDP transmission. Zero is valid, to suppress all indicator packets for TCP transmission.
int data_tx_count
 The number of times a data packet which does not end transmission will be sent. Numbers greater than one will increase reliability for UDP transmission. Zero is not valid.
int data_end_tx_count
 The number of times a data packet which ends transmission will be sent. Numbers greater than one will increase reliability for UDP transmission. Zero is not valid.
int check_sequence_numbers
int tx_seq_no
int rx_expected_seq_no
int current_rx_indicator
int current_rx_data_type
int current_rx_field_type
int current_tx_indicator
int v34_rate
int missing_packets
logging_state_t logging


Detailed Description

Core T.38 state, common to all modes of T.38.

Member Data Documentation

t38_tx_packet_handler_t* t38_core_state_s::tx_packet_handler

Handler routine to transmit IFP packets generated by the T.38 protocol engine

Referenced by t38_core_send_data(), t38_core_send_data_multi_field(), and t38_core_send_indicator().

An opaque pointer passed to tx_packet_handler

Referenced by t38_core_send_data(), t38_core_send_data_multi_field(), and t38_core_send_indicator().

t38_rx_indicator_handler_t* t38_core_state_s::rx_indicator_handler

Handler routine to process received indicator packets

Referenced by t38_core_rx_ifp_packet().

t38_rx_data_handler_t* t38_core_state_s::rx_data_handler

Handler routine to process received data packets

Referenced by t38_core_rx_ifp_packet().

t38_rx_missing_handler_t* t38_core_state_s::rx_missing_handler

Handler routine to process the missing packet condition

Referenced by t38_core_rx_ifp_packet().

An opaque pointer passed to any of the above receive handling routines

Referenced by t38_core_rx_ifp_packet().

NOTE - Bandwidth reduction shall only be done on suitable Phase C data, i.e., MH, MR and - in the case of transcoding to JBIG - MMR. MMR and JBIG require reliable data transport such as that provided by TCP. When transcoding is selected, it shall be applied to every suitable page in a call.

Method 1: Local generation of TCF (required for use with TCP). Method 2: Transfer of TCF is required for use with UDP (UDPTL or RTP). Method 2 is not recommended for use with TCP.

Referenced by t38_set_data_rate_management_method().

The emitting gateway may indicate a preference for either UDP/UDPTL, or UDP/RTP, or TCP for transport of T.38 IFP Packets. The receiving device selects the transport protocol.

Referenced by t38_set_data_transport_protocol().

Indicates the capability to remove and insert fill bits in Phase C, non-ECM data to reduce bandwidth in the packet network.

Referenced by t38_set_fill_bit_removal().

Indicates the ability to convert to/from MMR from/to the line format to improve the compression of the data, and reduce the bandwidth, in the packet network.

Referenced by t38_set_mmr_transcoding().

Indicates the ability to convert to/from JBIG to reduce bandwidth.

Referenced by t38_set_jbig_transcoding().

For UDP (UDPTL or RTP) modes, this option indicates the maximum number of octets that can be stored on the remote device before an overflow condition occurs. It is the responsibility of the transmitting application to limit the transfer rate to prevent an overflow. The negotiated data rate should be used to determine the rate at which data is being removed from the buffer.

This option indicates the maximum size of a UDPTL packet or the maximum size of the payload within an RTP packet that can be accepted by the remote device.

This is the version number of ITU-T Rec. T.38. New versions shall be compatible with previous versions.

Referenced by t38_core_rx_ifp_packet(), and t38_set_t38_version().

The fastest data rate supported by the T.38 channel.

Referenced by t38_gateway_set_supported_modems().

TRUE if IFP packet sequence numbers are relevant. For some transports, like TPKT over TCP they are not relevent.

Referenced by t38_core_rx_ifp_packet().

The sequence number for the next packet to be transmitted

Referenced by t38_core_send_data(), t38_core_send_data_multi_field(), and t38_core_send_indicator().

The sequence number expected in the next received packet

Referenced by t38_core_rx_ifp_packet().

The current receive indicator - i.e. the last indicator received

Referenced by t38_core_rx_ifp_packet().

The current receive data type - i.e. the last data type received

Referenced by t38_core_rx_ifp_packet().

The current receive field type - i.e. the last field_type received

Referenced by t38_core_rx_ifp_packet().

The current transmit indicator - i.e. the last indicator transmitted

Referenced by t38_core_send_indicator().

The bit rate for V.34 operation

A count of missing receive packets. This count might not be accurate if the received packet numbers jump wildly.

Referenced by t38_core_rx_ifp_packet().


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

Generated on Tue Oct 7 20:25:53 2008 for spandsp by  doxygen 1.5.6