Struct routinator::payload::PayloadHistory

pub struct PayloadHistory { /* fields omitted */ }

The history of the validated payload.

Implementations

impl PayloadHistory

pub fn from_config(config: &Config) -> Self

Creates a new history from the configuration.

pub fn is_active(&self) -> bool

Returns whether the history is already active.

The history becoes active once the first validation has finished.

pub fn current(&self) -> Option<Arc<PayloadSnapshot>>

Returns a shareable reference to the current payload snapshot.

If the history isn’t active yet, returns None.

pub fn refresh_wait(&self) -> Duration

Returns the duration until the next refresh should start.

pub fn update_wait(&self) -> Duration

Returns the duration until a new set of data will likely be available.

Because the update duration can vary widely, this is a guess at best.

pub fn delta_since(&self, serial: Serial) -> Option<Arc<PayloadDelta>>

Returns a delta from the given serial number to the current set.

The serial is what the requestor has last seen. The method produces a delta from that version to the current version if it can. If it can’t, this is either because it doesn’t have enough history data or because the serial is actually in the future.

The method returns an arc’d delta so it can return the delta from the previous version which is the most likely scenario for RTR.

pub fn serial(&self) -> Serial

Returns the serial number of the current data set.

pub fn session(&self) -> u64

Returns the session ID.

pub fn rtr_session(&self) -> u16

Returns the RTR version of the session ID.

This is the last 16 bits of the full session ID.

pub fn metrics(&self) -> Option<Arc<Metrics>>

Returns the current metrics if they are available yet.

pub fn last_update_start(&self) -> DateTime<Utc>

Returns the time the last update was started.

pub fn last_update_done(&self) -> Option<DateTime<Utc>>

Returns the time the last update has concluded.

pub fn last_update_duration(&self) -> Option<Duration>

Returns the time the last update has concluded.

pub fn created(&self) -> Option<DateTime<Utc>>

Returns the time the current payload snapshot was created.

The value returned guarantees that no two snapshots where created within the second. Consequently, it may occasionally be off by a second or two.

Trait Implementations

impl Clone for PayloadHistory

fn clone(&self) -> PayloadHistory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PayloadHistory

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

Formats the value using the given formatter.