Struct Config 

pub struct Config {
    pub initial_stream_window: u32,
    pub max_frame_size: u32,
    pub max_streams: usize,
    pub keepalive_interval: Option<Duration>,
    pub keepalive_timeout: Duration,
    pub open_timeout: Duration,
}

Tunable parameters for a Session.

Build via Config::builder or take Config::default for sensible defaults. Once a Session is constructed the configuration is immutable.

Fields

initial_stream_window: u32

Initial credit (in bytes) granted to each newly-opened receive stream. Doubles as the maximum amount of pending unread data the session will buffer per stream before exerting back-pressure on the peer.

max_frame_size: u32

Hard upper bound on the payload of a single Data frame. Larger user writes are transparently fragmented.

max_streams: usize

Hard cap on concurrently open streams. Attempts to exceed this raise Error::TooManyStreams.

keepalive_interval: Option<Duration>

Interval between automatic Ping frames. None disables keepalive.

keepalive_timeout: Duration

How long to wait for a Ping reply before declaring the session dead.

open_timeout: Duration

Maximum time Session::open will wait for the peer’s ACK.

Implementations

impl Config

pub const DEFAULT_INITIAL_STREAM_WINDOW: u32

Default initial per-stream window: 256 KiB.

pub const DEFAULT_MAX_FRAME_SIZE: u32

Default maximum single-frame payload: 64 KiB.

pub const DEFAULT_MAX_STREAMS: usize = 1024

Default maximum concurrent streams: 1024.

pub const DEFAULT_KEEPALIVE_INTERVAL: Duration

Default keepalive interval: 30 seconds.

pub const DEFAULT_KEEPALIVE_TIMEOUT: Duration

Default keepalive timeout: 30 seconds.

pub const DEFAULT_OPEN_TIMEOUT: Duration

Default open timeout: 10 seconds.

pub fn builder() -> ConfigBuilder

Start a new builder using the default configuration.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate 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.