Struct SessionsConfig

pub struct SessionsConfig {
    pub session_command_buffer: usize,
    pub session_event_buffer: usize,
    pub limits: SessionLimits,
    pub initial_internal_request_timeout: Duration,
    pub protocol_breach_request_timeout: Duration,
    pub pending_session_timeout: Duration,
}

Configuration options for peer session management.

Fields

session_command_buffer: usize

Size of the session command buffer (per session task).

session_event_buffer: usize

Size of the session event channel buffer.

limits: SessionLimits

Limits to enforce.

By default, no limits will be enforced.

initial_internal_request_timeout: Duration

The maximum initial time we wait for a response from the peer before we timeout a request internally.

protocol_breach_request_timeout: Duration

The amount of time we continue to wait for a response from the peer, even if we timed it out internally (initial_internal_request_timeout). Timeouts are not penalized but the session directly, however if a peer fails to respond at all (within PROTOCOL_BREACH_REQUEST_TIMEOUT) this is considered a protocol violation and results in a dropped session.

pending_session_timeout: Duration

The timeout after which a pending session attempt is considered failed.

Implementations

impl SessionsConfig

pub const fn with_session_event_buffer(self, n: usize) -> SessionsConfig

Sets the buffer size for the bounded communication channel between the manager and its sessions for events emitted by the sessions.

It is expected, that the background session task will stall if they outpace the manager. The buffer size provides backpressure on the network I/O.

pub fn with_upscaled_event_buffer(self, num_peers: usize) -> SessionsConfig

Helper function to set the buffer size for the bounded communication channel between the manager and its sessions for events emitted by the sessions.

This scales the buffer size based on the configured number of peers, where the base line is the default buffer size.

If the number of peers is greater than the default, the buffer size will be scaled up to match the default buffer size / max peers ratio.

Note: This is capped at 10 times the default buffer size.

Trait Implementations

impl Clone for SessionsConfig

fn clone(&self) -> SessionsConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SessionsConfig

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

Formats the value using the given formatter.

impl Default for SessionsConfig

fn default() -> SessionsConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SessionsConfig

where SessionsConfig: Default,

fn deserialize<__D>( __deserializer: __D, ) -> Result<SessionsConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SessionsConfig

fn eq(&self, other: &SessionsConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SessionsConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SessionsConfig

impl StructuralPartialEq for SessionsConfig

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 96 bytes