net-mesh 0.21.0

High-performance, schema-agnostic, backend-agnostic event bus
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

//! Tunables for the NAT-traversal subsystem.
//!
//! Defaults match the values locked in `docs/NAT_TRAVERSAL_PLAN.md`.
//! Callers override via `MeshBuilder`-exposed setters once the
//! per-stage wiring lands; defaults are sized so a caller who
//! enables `nat-traversal` without further configuration gets
//! sensible behavior out of the box.

use std::time::Duration;

/// Configuration for the NAT-traversal subsystem. Every value has
/// a default matching the plan; non-default values are accepted
/// via the SDK's `MeshBuilder` once stage 5 lands.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TraversalConfig {
    /// Per-probe timeout on a reflex request. The requester waits
    /// at most this long for the peer's reflex response before
    /// giving up on that probe and consulting the classification
    /// state machine with fewer data points.
    ///
    /// Default: 3 s — long enough for a routed multi-hop probe
    /// over a lossy link, short enough that a dead peer doesn't
    /// stall classification for noticeable time.
    pub reflex_timeout: Duration,

    /// Aggregate budget for the startup classification sweep.
    /// Multiple reflex probes run in parallel; classification
    /// records an `Unknown` and moves on after this deadline even
    /// if fewer than two responses have arrived.
    ///
    /// Default: 5 s.
    pub classify_deadline: Duration,

    /// Delay between `PunchIntroduce` receipt and the first
    /// keep-alive send. The 500 ms window gives both sides time
    /// to arm their timers + firewalls time to install state for
    /// the outbound connection-tracking row, while staying well
    /// under NTP-level clock skew.
    ///
    /// Default: 500 ms.
    pub punch_fire_lead: Duration,

    /// How long the receiver waits for inbound traffic on the
    /// punched path before declaring the single-shot punch
    /// failed (plan decision 10 — no internal retry).
    ///
    /// Default: 5 s.
    pub punch_deadline: Duration,

    /// How often the port-mapping renewal task re-issues the
    /// router mapping. Active only when the `port-mapping`
    /// cargo feature is on AND
    /// `MeshBuilder::try_port_mapping(true)` opted in.
    ///
    /// Default: 30 min — much shorter than the 3600 s TTL we
    /// request, matches plan decision 12.
    pub port_mapping_renewal: Duration,
}

impl Default for TraversalConfig {
    fn default() -> Self {
        Self {
            reflex_timeout: Duration::from_secs(3),
            classify_deadline: Duration::from_secs(5),
            punch_fire_lead: Duration::from_millis(500),
            punch_deadline: Duration::from_secs(5),
            port_mapping_renewal: Duration::from_secs(30 * 60),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn defaults_match_plan() {
        // Guard against accidental tuning drift. Any change here
        // needs a matching update to docs/NAT_TRAVERSAL_PLAN.md.
        let cfg = TraversalConfig::default();
        assert_eq!(cfg.reflex_timeout, Duration::from_secs(3));
        assert_eq!(cfg.classify_deadline, Duration::from_secs(5));
        assert_eq!(cfg.punch_fire_lead, Duration::from_millis(500));
        assert_eq!(cfg.punch_deadline, Duration::from_secs(5));
        assert_eq!(cfg.port_mapping_renewal, Duration::from_secs(1800));
    }
}