Struct kitsune_p2p_types::config::tuning_params_struct::KitsuneP2pTuningParams

#[non_exhaustive]
pub struct KitsuneP2pTuningParams {

    pub gossip_strategy: String,
    pub gossip_loop_iteration_delay_ms: u32,
    pub gossip_output_target_mbps: f64,
    pub gossip_peer_on_success_next_gossip_delay_ms: u32,
    pub gossip_peer_on_error_next_gossip_delay_ms: u32,
    pub default_rpc_single_timeout_ms: u32,
    pub default_rpc_multi_remote_agent_count: u32,
    pub default_rpc_multi_timeout_ms: u32,
    pub agent_info_expires_after_ms: u32,
    pub tls_in_mem_session_storage: u32,
    pub proxy_keepalive_ms: u32,
    pub proxy_to_expire_ms: u32,
    pub concurrent_limit_per_thread: usize,
    pub tx2_quic_max_idle_timeout_ms: u32,
    pub tx2_pool_max_connection_count: usize,
    pub tx2_channel_count_per_connection: usize,
    pub tx2_implicit_timeout_ms: u32,
    pub tx2_initial_connect_retry_delay_ms: usize,
}

Network tuning parameters. This is serialized carefully so all the values can be represented as strings in YAML - and we will be able to proceed with a printed warning for tuning params that are removed, but still specified in configs.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

gossip_strategy: String

Gossip strategy to use. [Default: simple-bloom]

gossip_loop_iteration_delay_ms: u32

Delay between gossip loop iteration. [Default: 1s]

gossip_output_target_mbps: f64

The gossip loop will attempt to rate-limit output to this count mega bits per second. [Default: 0.5]

gossip_peer_on_success_next_gossip_delay_ms: u32

How long should we hold off talking to a peer we’ve previously spoken successfully to. [Default: 1 minute]

gossip_peer_on_error_next_gossip_delay_ms: u32

How long should we hold off talking to a peer we’ve previously gotten errors speaking to. [Default: 5 minute]

default_rpc_single_timeout_ms: u32

Default timeout for rpc single. [Default: 30s]

default_rpc_multi_remote_agent_count: u32

Default agent count for rpc multi. [Default: 2]

default_rpc_multi_timeout_ms: u32

Default timeout for rpc multi. [Default: 30s]

agent_info_expires_after_ms: u32

Default agent expires after milliseconds. [Default: 20 minutes]

tls_in_mem_session_storage: u32

Tls in-memory session storage capacity. [Default: 512]

proxy_keepalive_ms: u32

How often should NAT nodes refresh their proxy contract? [Default: 2 minutes]

proxy_to_expire_ms: u32

How often should proxy nodes prune their ProxyTo list? Note - to function this should be > proxy_keepalive_ms. [Default: 5 minutes]

concurrent_limit_per_thread: usize

Mainly used as the for_each_concurrent limit, this restricts the number of active polled futures on a single thread. [Default: 4096]

tx2_quic_max_idle_timeout_ms: u32

tx2 quic max_idle_timeout [Default: 30 seconds]

tx2_pool_max_connection_count: usize

tx2 pool max connection count [Default: 4096]

tx2_channel_count_per_connection: usize

tx2 channel count per connection [Default: 16]

tx2_implicit_timeout_ms: u32

tx2 timeout used for passive background operations like reads / responds. [Default: 30 seconds]

tx2_initial_connect_retry_delay_ms: usize

tx2 initial connect retry delay (note, this delay is currenty exponentially backed off– multiplied by 2x on every loop) [Default: 200 ms]

Implementations

impl KitsuneP2pTuningParams

pub fn implicit_timeout(&self) -> KitsuneTimeout

Generate a KitsuneTimeout instance based on the tuning parameter tx2_implicit_timeout_ms

Trait Implementations

impl Clone for KitsuneP2pTuningParams

fn clone(&self) -> KitsuneP2pTuningParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KitsuneP2pTuningParams

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

Formats the value using the given formatter.

impl Default for KitsuneP2pTuningParams

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for KitsuneP2pTuningParams

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<KitsuneP2pTuningParams> for KitsuneP2pTuningParams

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for KitsuneP2pTuningParams

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for KitsuneP2pTuningParams