lightyear_sync 0.27.0

IO primitives for the lightyear 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

//! Compute Diagnostics based on ping statistics (jitter, RTT)

use bevy_app::{App, Plugin};
use bevy_diagnostic::{Diagnostic, DiagnosticPath, Diagnostics, RegisterDiagnostic};

use crate::ping::manager::PingManager;
use core::time::Duration;

/// Plugin to compute some network diagnostics related to pings
pub struct PingDiagnosticsPlugin {
    pub history_len: usize,
    pub flush_interval: Duration,
}

impl Default for PingDiagnosticsPlugin {
    fn default() -> Self {
        Self {
            history_len: 60,
            flush_interval: Duration::from_millis(100),
        }
    }
}

impl PingDiagnosticsPlugin {
    /// Jitter
    pub const JITTER: DiagnosticPath = DiagnosticPath::const_new("ping.jitter.ms");

    /// Round Trip Time (RTT)
    pub const RTT: DiagnosticPath = DiagnosticPath::const_new("ping.rtt.ms");

    /// Number of pings sent
    pub const PINGS_SENT: DiagnosticPath = DiagnosticPath::const_new("ping.ping_sent_count");

    /// Number of pongs received
    pub const PONGS_RECEIVED: DiagnosticPath =
        DiagnosticPath::const_new("ping.pong_received_count");

    /// Number of RTT samples received from pongs or packet acknowledgements.
    pub const LATENCY_SAMPLES_RECEIVED: DiagnosticPath =
        DiagnosticPath::const_new("ping.latency_sample_count");

    pub(crate) fn add_measurements(manager: &PingManager, mut diagnostics: Diagnostics) {
        diagnostics.add_measurement(&Self::JITTER, || manager.jitter().as_secs_f64() * 1000.0);
        diagnostics.add_measurement(&Self::RTT, || manager.rtt().as_secs_f64() * 1000.0);
        diagnostics.add_measurement(&Self::PINGS_SENT, || manager.pings_sent as f64);
        diagnostics.add_measurement(&Self::PONGS_RECEIVED, || manager.pongs_recv as f64);
        diagnostics.add_measurement(&Self::LATENCY_SAMPLES_RECEIVED, || {
            manager.latency_samples_recv() as f64
        });
    }
}

impl Plugin for PingDiagnosticsPlugin {
    fn build(&self, app: &mut App) {
        app.register_diagnostic(
            Diagnostic::new(Self::JITTER)
                .with_suffix("ms")
                .with_max_history_length(self.history_len),
        );
        app.register_diagnostic(
            Diagnostic::new(Self::RTT)
                .with_suffix("ms")
                .with_max_history_length(self.history_len),
        );
        app.register_diagnostic(
            Diagnostic::new(Self::PINGS_SENT)
                .with_suffix("")
                .with_max_history_length(self.history_len),
        );
        app.register_diagnostic(
            Diagnostic::new(Self::PONGS_RECEIVED)
                .with_suffix("")
                .with_max_history_length(self.history_len),
        );
        app.register_diagnostic(
            Diagnostic::new(Self::LATENCY_SAMPLES_RECEIVED)
                .with_suffix("")
                .with_max_history_length(self.history_len),
        );
    }
}