Struct yamux::Config

pub struct Config { /* fields omitted */ }

Yamux configuration.

The default configuration values are as follows:

• receive window = 256 KiB
• max. buffer size (per stream) = 1 MiB
• max. number of streams = 8192
• window update mode = on receive
• read after close = true
• lazy open = false

Methods

impl Config

pub fn set_receive_window(&mut self, n: u32) -> &mut Self

Set the receive window (must be >= 256 KiB).

Panics

If the given receive window is < 256 KiB.

pub fn set_max_buffer_size(&mut self, n: usize) -> &mut Self

Set the max. buffer size per stream.

pub fn set_max_num_streams(&mut self, n: usize) -> &mut Self

Set the max. number of streams.

pub fn set_window_update_mode(&mut self, m: WindowUpdateMode) -> &mut Self

Set the window update mode to use.

pub fn set_read_after_close(&mut self, b: bool) -> &mut Self

Allow or disallow streams to read from buffered data after the connection has been closed.

pub fn set_lazy_open(&mut self, b: bool) -> &mut Self

Enable or disable the sending of an initial window update frame when opening outbound streams.

When enabled, opening a new outbound stream will not result in an immediate send of a frame, instead the first outbound data frame will be marked as opening a stream.

When disabled (the current default), opening a new outbound stream will result in a window update frame being sent immediately to the remote. This allows opening a stream with a custom receive window size (cf. Config::set_receive_window) which the remote can directly make use of.

Trait Implementations

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.

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.