Struct SurbBalancerConfig

pub struct SurbBalancerConfig {
    pub target_surb_buffer_size: u64,
    pub max_surbs_per_sec: u64,
    pub surb_decay: Option<(Duration, f64)>,
}

Configuration for the SurbBalancer.

Fields

target_surb_buffer_size: u64

The desired number of SURBs to be always kept as a buffer locally or at the Session counterparty.

The SurbBalancer will try to maintain approximately this number of SURBs locally or remotely (at the counterparty) at all times.

The local buffer is maintained by regulating the egress from the Session. The remote buffer (at session counterparty) is maintained by regulating the flow of non-organic SURBs via keep-alive messages.

It does not make sense to set this value higher than the max_surb_buffer_size configuration at the counterparty.

Default is 7000 SURBs.

max_surbs_per_sec: u64

Maximum outflow of SURBs.

• In the context of the local SURB buffer, this is the maximum egress Session traffic.
• In the context of the remote SURB buffer, this is the maximum egress of keep-alive messages to the counterparty.

The default is 5000 (which is 2500 packets/second currently)

surb_decay: Option<(Duration, f64)>

Sets what percentage of the target buffer size should be discarded at each window.

The [SurbBalancer] will discard the given percentage of target_surb_buffer_size at each window with the given Duration.

The default is (60, 0.05) (5% of the target buffer size is discarded every 60 seconds).

Trait Implementations

impl Clone for SurbBalancerConfig

fn clone(&self) -> SurbBalancerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurbBalancerConfig

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

Formats the value using the given formatter.

impl Default for SurbBalancerConfig

fn default() -> SurbBalancerConfig

Return SurbBalancerConfig { target_surb_buffer_size: 7_000, max_surbs_per_sec: 5_000, surb_decay: Some((Duration :: from_secs(60), 0.05)) }

impl PartialEq for SurbBalancerConfig

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

impl StructuralPartialEq for SurbBalancerConfig