iroh-relay 1.0.2

Iroh's relay server and client
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

//! Default values used in the relay.

/// The default QUIC port used by the Relay server to accept QUIC connections
/// for QUIC address discovery
///
/// The port is "QUIC" typed on a phone keypad.
pub const DEFAULT_RELAY_QUIC_PORT: u16 = 7842;

/// The default HTTP port used by the Relay server.
pub const DEFAULT_HTTP_PORT: u16 = 80;

/// The default HTTPS port used by the Relay server.
pub const DEFAULT_HTTPS_PORT: u16 = 443;

/// The default metrics port used by the Relay server.
pub const DEFAULT_METRICS_PORT: u16 = 9090;

/// The default capacity of the key cache for the relay server.
///
/// Sized for 1 million concurrent clients.
/// memory usage will be (32 + 8 + 8 + 8) * 1_000_000 = 56MB on 64 bit,
/// which seems reasonable for a server.
pub const DEFAULT_KEY_CACHE_CAPACITY: usize = 1024 * 1024;

/// Contains all timeouts that we use in `iroh`.
#[cfg(not(wasm_browser))]
pub mod timeouts {
    use n0_future::time::Duration;

    /// Timeout used by the relay client while connecting to the relay server,
    /// using `TcpStream::connect`
    pub(crate) const DIAL_ENDPOINT_TIMEOUT: Duration = Duration::from_millis(1500);

    /// Happy Eyeballs (RFC 8305) Connection Attempt Delay: the maximum time to
    /// wait before starting the next connection attempt. A faster failure
    /// starts the next attempt immediately.
    pub(crate) const CONNECTION_ATTEMPT_DELAY: Duration = Duration::from_millis(250);

    /// Happy Eyeballs (RFC 8305) Resolution Delay: when the non-preferred
    /// address family resolves first, wait this long for the preferred family
    /// before starting to connect, so the preference is honored.
    pub(crate) const RESOLUTION_DELAY: Duration = Duration::from_millis(50);

    /// Default timeout for DNS queries issued by [`DnsResolver`].
    ///
    /// [`DnsResolver`]: iroh_dns::dns::DnsResolver
    pub(crate) const DNS_TIMEOUT: Duration = Duration::from_secs(3);

    /// Maximum time the server will attempt to get a successful write to the connection.
    #[cfg(feature = "server")]
    pub const SERVER_WRITE_TIMEOUT: Duration = Duration::from_secs(2);
}