Struct SessionGlobalConfig 

pub struct SessionGlobalConfig {
    pub idle_timeout: Duration,
    pub maximum_sessions: u32,
    pub establish_max_retries: u32,
    pub establish_retry_timeout: Duration,
    pub balancer_sampling_interval: Duration,
    pub balancer_minimum_surb_buffer_duration: Duration,
}

Global configuration of Sessions and the Session manager.

Fields

idle_timeout: Duration

Maximum time before an idle Session is closed.

Defaults to 3 minutes.

maximum_sessions: u32

The maximum number of outgoing or incoming Sessions that are allowed by the Session manager.

Minimum is 1, the maximum is given by the Session tag range. Default is 2048.

establish_max_retries: u32

Maximum retries to attempt to establish the Session Set 0 for no retries.

Defaults to 3, maximum is 20.

establish_retry_timeout: Duration

Delay between Session establishment retries.

Default is 2 seconds.

balancer_sampling_interval: Duration

Sampling interval for SURB balancer in milliseconds.

Default is 500 milliseconds.

balancer_minimum_surb_buffer_duration: Duration

Minimum runway of received SURBs in seconds.

This applies to incoming Sessions on Exit nodes only and is the main indicator of how the egress traffic will be shaped, unless the NoRateControl Session capability is specified during initiation.

Default is 5 seconds, minimum is 1 second.

Trait Implementations

impl Clone for SessionGlobalConfig

fn clone(&self) -> SessionGlobalConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SessionGlobalConfig

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

Formats the value using the given formatter.

impl Default for SessionGlobalConfig

fn default() -> SessionGlobalConfig

Return SessionGlobalConfig { idle_timeout: default_session_idle_timeout(), maximum_sessions: default_session_max_sessions(), establish_max_retries: default_session_establish_max_retries(), establish_retry_timeout: default_session_establish_retry_delay(), balancer_sampling_interval: default_session_balancer_sampling(), balancer_minimum_surb_buffer_duration: default_session_balancer_buffer_duration() }

impl<'de> Deserialize<'de> for SessionGlobalConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SessionGlobalConfig

fn eq(&self, other: &SessionGlobalConfig) -> 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 SessionGlobalConfig

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 Validate for SessionGlobalConfig

fn validate(&self) -> Result<(), ValidationErrors>

impl<'v_a> ValidateArgs<'v_a> for SessionGlobalConfig

type Args = ()

fn validate_with_args( &self, args: <SessionGlobalConfig as ValidateArgs<'v_a>>::Args, ) -> Result<(), ValidationErrors>

impl Copy for SessionGlobalConfig

impl Eq for SessionGlobalConfig

impl StructuralPartialEq for SessionGlobalConfig