h3x 0.6.1

Peer-to-peer DHTTP/3 transport over QUIC
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123

use std::{sync::Arc, time::Duration};

use crate::dquic::{
    log::{QLog, handy::NoopLogger},
    stream::{ProductStreamsConcurrencyController, handy::ConsistentConcurrency},
};

// ---------------------------------------------------------------------------
// Common
// ---------------------------------------------------------------------------

/// Configuration values that apply to both client and server roles.
#[derive(Clone)]
pub struct CommonQuicConfig {
    /// How long the connection should keep sending probe packets after going
    /// idle. `Duration::ZERO` (the default) disables deferred idle timeouts.
    pub defer_idle_timeout: Duration,
    /// Factory producing per-connection streams concurrency controllers.
    pub stream_strategy_factory: Arc<dyn ProductStreamsConcurrencyController>,
    /// QUIC-events logger (qlog). Defaults to a no-op logger.
    pub qlogger: Arc<dyn QLog + Send + Sync>,
    /// Whether 0-RTT should be enabled if the crypto context permits it.
    pub enable_0rtt: bool,
    /// Enable SSL key logging via `SSLKEYLOGFILE` for debugging captures.
    pub enable_sslkeylog: bool,
}

impl Default for CommonQuicConfig {
    fn default() -> Self {
        Self {
            defer_idle_timeout: Duration::ZERO,
            stream_strategy_factory: Arc::new(ConsistentConcurrency::new),
            qlogger: Arc::new(NoopLogger),
            enable_0rtt: false,
            enable_sslkeylog: false,
        }
    }
}

impl std::fmt::Debug for CommonQuicConfig {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("CommonQuicConfig")
            .field("defer_idle_timeout", &self.defer_idle_timeout)
            .field("enable_0rtt", &self.enable_0rtt)
            .field("enable_sslkeylog", &self.enable_sslkeylog)
            .finish_non_exhaustive()
    }
}

impl PartialEq for CommonQuicConfig {
    fn eq(&self, other: &Self) -> bool {
        self.defer_idle_timeout == other.defer_idle_timeout
            && self.enable_0rtt == other.enable_0rtt
            && self.enable_sslkeylog == other.enable_sslkeylog
            && Arc::ptr_eq(
                &self.stream_strategy_factory,
                &other.stream_strategy_factory,
            )
            && Arc::ptr_eq(&self.qlogger, &other.qlogger)
    }
}

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

    #[test]
    fn default_uses_noop_components_and_disabled_features() {
        let config = CommonQuicConfig::default();

        assert_eq!(config.defer_idle_timeout, Duration::ZERO);
        assert!(!config.enable_0rtt);
        assert!(!config.enable_sslkeylog);
        assert_eq!(
            format!("{config:?}"),
            "CommonQuicConfig { defer_idle_timeout: 0ns, enable_0rtt: false, enable_sslkeylog: false, .. }",
        );
    }

    #[test]
    fn clone_preserves_dynamic_component_identity() {
        let config = CommonQuicConfig {
            defer_idle_timeout: Duration::from_secs(5),
            enable_0rtt: true,
            enable_sslkeylog: true,
            ..Default::default()
        };

        let cloned = config.clone();

        assert_eq!(config, cloned);
        assert!(Arc::ptr_eq(
            &config.stream_strategy_factory,
            &cloned.stream_strategy_factory,
        ));
        assert!(Arc::ptr_eq(&config.qlogger, &cloned.qlogger));
    }

    #[test]
    fn equality_requires_same_values_and_same_dynamic_component_arcs() {
        let config = CommonQuicConfig::default();

        let mut different_timeout = config.clone();
        different_timeout.defer_idle_timeout = Duration::from_secs(1);
        assert_ne!(config, different_timeout);

        let mut different_zero_rtt = config.clone();
        different_zero_rtt.enable_0rtt = true;
        assert_ne!(config, different_zero_rtt);

        let mut different_sslkeylog = config.clone();
        different_sslkeylog.enable_sslkeylog = true;
        assert_ne!(config, different_sslkeylog);

        let mut different_strategy = config.clone();
        different_strategy.stream_strategy_factory = Arc::new(ConsistentConcurrency::new);
        assert_ne!(config, different_strategy);

        let mut different_logger = config.clone();
        different_logger.qlogger = Arc::new(NoopLogger);
        assert_ne!(config, different_logger);
    }
}