Struct SurbStoreConfig 

pub struct SurbStoreConfig {
    pub rb_capacity: usize,
    pub distress_threshold: usize,
    pub max_openers_per_pseudonym: usize,
    pub max_pseudonyms: usize,
    pub pseudonyms_lifetime: Duration,
    pub reply_opener_lifetime: Duration,
}

Configuration for the SURB cache.

The configuration options affect both the sending side (SURB creator) and the replying side (SURB consumer).

In the classical scenario (Entry - Relay 1 -... - Exit), the sending side is the Entry and the replying side is the Exit.

Fields

rb_capacity: usize

Size of the SURB ring buffer per pseudonym.

Affects only the replying side.

This indicates how many SURBs can be at most held to be used to send a reply back to the sending side.

Default is 15 000.

distress_threshold: usize

Threshold for the number of SURBs in the ring buffer, below which it is considered low (“SURB distress”).

Default is 500.

max_openers_per_pseudonym: usize

Maximum number of reply openers (SURB counterparts) per pseudonym.

Affects only the sending side when decrypting a received reply.

This mostly affects Sessions, as they use a fixed pseudonym. It reflects how many reply openers the initiator-side of a Session can hold, until the oldest ones are dropped. If the other party uses a SURB corresponding to a dropped reply opener, the reply message will be undecryptable by the initiator-side.

Default is 100 000.

max_pseudonyms: usize

The maximum number of distinct pseudonyms for which we hold a SURB ringbuffer.

Affects only the replying side.

For each pseudonym, there is a ring-buffer with capacity rb_capacity.

Default is 10 000.

pseudonyms_lifetime: Duration

Maximum lifetime of ring-buffer for each pseudonym.

Effects on sending side

This is the period for which we hold all reply openers for a pseudonym. If no more messages carrying SURBs are sent during this period, the entire stash of reply openers is dropped. Preventing receiving any more replies for that pseudonym.

Effects on replying side

If a pseudonym has not received any SURBs for this period, the entire ring buffer with rb_capacity (= all SURBs for this pseudonym) is dropped. Preventing from sending any more replies for that pseudonym.

Default is 600 seconds.

reply_opener_lifetime: Duration

Maximum lifetime of a reply opener.

Affects only the sending side.

A reply opener is distinguished using [HoprSurbId] and a pseudonym it belongs to. If a reply opener is not used to decrypt the received packet within this period, it is dropped. If the replying side uses the corresponding SURB to send a reply, it won’t be possible to decrypt it when received.

Default is 3600 seconds.

Trait Implementations

impl Clone for SurbStoreConfig

fn clone(&self) -> SurbStoreConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SurbStoreConfig

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

Formats the value using the given formatter.

impl Default for SurbStoreConfig

fn default() -> Self

Return SurbStoreConfig { rb_capacity: default_rb_capacity(), distress_threshold: default_distress_threshold(), max_openers_per_pseudonym: default_max_openers_per_pseudonym(), max_pseudonyms: default_max_pseudonyms(), pseudonyms_lifetime: default_pseudonyms_lifetime(), reply_opener_lifetime: default_reply_opener_lifetime() }

impl<'de> Deserialize<'de> for SurbStoreConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SurbStoreConfig

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

fn partial_cmp(&self, other: &SurbStoreConfig) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SurbStoreConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for SurbStoreConfig

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

impl<'v_a> ValidateArgs<'v_a> for SurbStoreConfig

type Args = ()

fn validate_with_args(&self, args: Self::Args) -> Result<(), ValidationErrors>

impl Copy for SurbStoreConfig

impl Eq for SurbStoreConfig

impl StructuralPartialEq for SurbStoreConfig