Struct Config

pub struct Config {

    pub signal_allow_plain_text: bool,
    pub initial_webrtc_config: String,
    pub connection_count_max: u32,
    pub send_buffer_bytes_max: u32,
    pub recv_buffer_bytes_max: u32,
    pub incoming_message_bytes_max: u32,
    pub message_size_max: u32,
    pub internal_event_channel_size: u32,
    pub timeout: Duration,
    pub backoff_start: Duration,
    pub backoff_max: Duration,
    pub preflight: Option<(PreflightSendCb, PreflightCheckCb)>,
    pub backend_module: BackendModule,
    pub backend_module_config: Option<Value>,
}

Tx5 endpoint configuration.

Fields

signal_allow_plain_text: bool

Allow plain text (non-tls) signal server connections.

initial_webrtc_config: String

Initial webrtc peer connection config. Defaults to {}.

connection_count_max: u32

Maximum count of open connections. Default 4096.

send_buffer_bytes_max: u32

Max backend send buffer bytes (per connection). Default 64 KiB.

recv_buffer_bytes_max: u32

Max backend recv buffer bytes (per connection). Default 64 KiB.

incoming_message_bytes_max: u32

Maximum receive message reconstruction bytes in memory (accross entire endpoint). Default 512 MiB.

message_size_max: u32

Maximum size of an individual message. Default 16 MiB.

internal_event_channel_size: u32

Internal event channel size. Default is 1024.

timeout: Duration

Default timeout for network operations. Default 60 seconds.

backoff_start: Duration

Starting backoff duration for retries. Default 5 seconds.

backoff_max: Duration

Max backoff duration for retries. Default 60 seconds.

preflight: Option<(PreflightSendCb, PreflightCheckCb)>

If the protocol should manage a preflight message, set the callbacks here, otherwise no preflight will be sent nor validated. Default: None.

backend_module: BackendModule

The backend connection module to use. For the most part you should just leave this at the default.

backend_module_config: Option<Value>

The backend module config to use. For the most part you should just leave this set at None, to get the default backend config.

Trait Implementations

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.