Struct tokio_yamux::config::Config

pub struct Config {
    pub accept_backlog: usize,
    pub enable_keepalive: bool,
    pub keepalive_interval: Duration,
    pub connection_write_timeout: Duration,
    pub max_stream_count: usize,
    pub max_stream_window_size: u32,
    pub send_buffer_size: usize,
    pub recv_buffer_size: usize,
}

Configuration of session and stream

Fields

accept_backlog: usize

AcceptBacklog is used to limit how many streams may be waiting an accept.

enable_keepalive: bool

EnableKeepalive is used to do a period keep alive messages using a ping.

keepalive_interval: Duration

KeepAliveInterval is how often to perform the keep alive

connection_write_timeout: Duration

ConnectionWriteTimeout is meant to be a "safety valve" timeout after we which will suspect a problem with the underlying connection and close it. This is only applied to writes, where's there's generally an expectation that things will move along quickly.

max_stream_count: usize

Max stream count

max_stream_window_size: u32

MaxStreamWindowSize is used to control the maximum window size that we allow for a stream.

send_buffer_size: usize

default is 1Mb

recv_buffer_size: usize

default is 1Mb

Methods

impl Config

pub const fn recv_event_size(&self) -> usize

see https://github.com/rust-lang/rust/issues/57563 can't use if to filter out 0, so add one to avoid this case

pub const fn send_event_size(&self) -> usize

see https://github.com/rust-lang/rust/issues/57563 can't use if to filter out 0, so add one to avoid this case

Trait Implementations

impl Copy for Config

impl Default for Config

fn default() -> Config

Returns the "default value" for a type.

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.