tycho-network 0.3.7

A peer-to-peer networking library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

use std::time::Duration;

use bytesize::ByteSize;
use serde::{Deserialize, Serialize};
use tycho_util::serde_helpers;

// TODO: add max storage item size
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(default)]
pub struct DhtConfig {
    /// DHT K parameter.
    ///
    /// Default: 6.
    pub max_k: usize,

    /// Maximum time to live for peer info.
    ///
    /// Default: 1 hour.
    #[serde(with = "serde_helpers::humantime")]
    pub max_peer_info_ttl: Duration,

    /// Maximum time to live for stored values.
    ///
    /// Default: 1 hour.
    #[serde(with = "serde_helpers::humantime")]
    pub max_stored_value_ttl: Duration,

    /// Maximum storage capacity (number of entries).
    ///
    /// Default: 16 MiB.
    pub max_storage_capacity: ByteSize,

    /// Time until a stored item is considered idle and can be removed.
    ///
    /// Default: unlimited.
    #[serde(with = "serde_helpers::humantime")]
    pub storage_item_time_to_idle: Option<Duration>,

    /// A period of refreshing the local peer info.
    ///
    /// Default: 1 minute.
    #[serde(with = "serde_helpers::humantime")]
    pub local_info_refresh_period: Duration,

    /// A period of storing the local peer info into the DHT.
    ///
    /// Default: 10 minutes.
    #[serde(with = "serde_helpers::humantime")]
    pub local_info_announce_period: Duration,

    /// A maximum value of a random jitter for the peer announce period.
    ///
    /// Default: 1 minute.
    #[serde(with = "serde_helpers::humantime")]
    pub local_info_announce_period_max_jitter: Duration,

    /// A period of updating and populating the routing table.
    ///
    /// Default: 10 minutes.
    #[serde(with = "serde_helpers::humantime")]
    pub routing_table_refresh_period: Duration,

    /// A maximum value of a random jitter for the routing table refresh period.
    ///
    /// Default: 1 minutes.
    #[serde(with = "serde_helpers::humantime")]
    pub routing_table_refresh_period_max_jitter: Duration,

    /// The capacity of the announced peers channel.
    ///
    /// Default: 10.
    pub announced_peers_channel_capacity: usize,

    /// A period of refilling bootstrap peers in the routing table.
    ///
    /// Default: 1 minutes.
    #[serde(with = "serde_helpers::humantime")]
    pub bootstrap_peers_refill_period: Option<Duration>,

    /// Timeout for DHT query request.
    ///
    /// Default: 500 ms.
    #[serde(with = "serde_helpers::humantime")]
    pub request_timeout: Duration,
}

impl Default for DhtConfig {
    fn default() -> Self {
        Self {
            max_k: 6,
            max_peer_info_ttl: Duration::from_secs(3600),
            max_stored_value_ttl: Duration::from_secs(3600),
            max_storage_capacity: ByteSize::mib(16),
            storage_item_time_to_idle: None,
            local_info_refresh_period: Duration::from_secs(60),
            local_info_announce_period: Duration::from_secs(600),
            local_info_announce_period_max_jitter: Duration::from_secs(60),
            routing_table_refresh_period: Duration::from_secs(600),
            routing_table_refresh_period_max_jitter: Duration::from_secs(60),
            announced_peers_channel_capacity: 10,
            bootstrap_peers_refill_period: Some(Duration::from_secs(60)),
            request_timeout: Duration::from_millis(500),
        }
    }
}