rtime-core 0.14.0

Core types, clock algorithms (Marzullo source selection, PI servo, clock filter), and configuration for the rTime NTP/PTP time synchronization daemon
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

use std::net::SocketAddr;

use crate::clock::LeapIndicator;
use crate::timestamp::{NtpDuration, NtpTimestamp};

/// Unique identifier for a time source.
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
pub enum SourceId {
    Ntp {
        address: SocketAddr,
        reference_id: u32,
    },
    Ptp {
        clock_identity: [u8; 8],
        port_number: u16,
    },
    RefClock {
        driver: String,
        unit: u8,
    },
}

impl std::fmt::Display for SourceId {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Ntp { address, .. } => write!(f, "NTP:{}", address),
            Self::Ptp {
                clock_identity,
                port_number,
            } => {
                write!(
                    f,
                    "PTP:{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}{:02x}-{}",
                    clock_identity[0],
                    clock_identity[1],
                    clock_identity[2],
                    clock_identity[3],
                    clock_identity[4],
                    clock_identity[5],
                    clock_identity[6],
                    clock_identity[7],
                    port_number
                )
            }
            Self::RefClock { driver, unit } => write!(f, "REF:{}({})", driver, unit),
        }
    }
}

/// Measurement from a single time source after filtering.
#[derive(Clone, Debug)]
pub struct SourceMeasurement {
    pub id: SourceId,
    /// Offset from local clock.
    pub offset: NtpDuration,
    /// Round-trip delay.
    pub delay: NtpDuration,
    /// Error bound.
    pub dispersion: NtpDuration,
    /// RMS jitter estimate.
    pub jitter: f64,
    /// Stratum of this source.
    pub stratum: u8,
    /// Leap indicator from source.
    pub leap_indicator: LeapIndicator,
    /// Root delay to primary reference.
    pub root_delay: NtpDuration,
    /// Root dispersion.
    pub root_dispersion: NtpDuration,
    /// When this measurement was taken.
    pub time: NtpTimestamp,
}

impl SourceMeasurement {
    /// Root distance: total error budget from this source to the primary reference.
    /// root_distance = root_delay/2 + root_dispersion + |delay|/2 + dispersion
    pub fn root_distance(&self) -> NtpDuration {
        self.root_delay.abs() / 2 + self.root_dispersion + self.delay.abs() / 2 + self.dispersion
    }
}