Skip to main content

Discipline

Struct Discipline 

Source
pub struct Discipline { /* private fields */ }

Implementations§

Source§

impl Discipline

Source

pub fn new(cfg: DisciplineConfig) -> Self

Source

pub fn freq_ppm(&self) -> f64

Current commanded frequency correction, ppm.

Source

pub fn poll_log2(&self) -> i8

Source

pub fn on_estimate( &mut self, offset: f64, freq_ppm_meas: Option<f64>, offset_sd: f64, ) -> Plan

Feed the latest combined estimate.

  • offset — seconds to add to the local clock, now.
  • freq_ppm_meas — residual frequency error from the regression (ppm, positive = local slow), if trusted.
  • offset_sd — residual noise of the estimate.
Source

pub fn retry_interval_s(&self) -> f64

How long to wait before trying again when an exchange yields nothing — lost, or rejected because the server was not yet usable.

This is the iburst spacing while the burst budget lasts, not the poll interval. A server that has only just started answers its first requests with the unsynchronised leap indicator, which a client must refuse; if that refusal then costs a full poll interval, a cold start is delayed by 16 seconds before the first usable sample. Measured against chrony under clknetsim, that single wait was most of an 8x convergence gap.

Nothing is consumed here: a failed exchange must not spend burst budget, or a few early losses would silently end the burst.

Trait Implementations§

Source§

impl Clone for Discipline

Source§

fn clone(&self) -> Discipline

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Discipline

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.