Struct routinator::origins::OriginsHistory

pub struct OriginsHistory(_);

A shareable history of address orgins.

A value of this type allows access to the currently valid list of address origins and a list of diffs from earlier versions. The latter list is limited to a certain length. Older diffs are dropped.

These things are all hidden away behind an arc and a lock so you can copy and share values relatively cheaply and in a safe way.

Implementations

impl OriginsHistory

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

Creates a new history from the given initial data.

pub fn is_active(&self) -> bool

Returns whether the history is active already.

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

Returns a reference to the current list of address origins.

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 is available.

pub fn get(&self, serial: Serial) -> Option<Arc<OriginsDiff>>

Returns a diff from the given serial number.

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

pub fn serial(&self) -> Serial

Returns the serial number of the current version of the origin list.

pub fn current_and_serial(&self) -> Option<(Arc<AddressOrigins>, Serial)>

Returns the current list of address origins and its serial number.

pub fn current_and_metrics(&self) -> Option<(Arc<AddressOrigins>, Arc<Metrics>)>

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

pub fn server_metrics(&self) -> Arc<ServerMetrics>

pub fn update_times(&self) -> (Instant, Option<Instant>, Option<Duration>)

pub fn update(
    &self,
    report: OriginsReport,
    metrics: Metrics,
    exceptions: &LocalExceptions
) -> bool

Updates the history.

Produces a new list of address origins based on the route origins and local exceptions. If this list differs from the current list of address origins, adds a new version to the history.

The method returns whether it added a new version.

Note also that the method has to acquire the write lock on the history.

pub fn mark_update_start(&self)

Marks the beginning of an update cycle.

pub fn mark_update_done(&self)

Marks the end of an update cycle.

Trait Implementations

impl Clone for OriginsHistory

fn clone(&self) -> OriginsHistory

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OriginsHistory

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

Formats the value using the given formatter.

impl VrpSource for OriginsHistory

type FullIter = AddressOriginsIter

An iterator over the complete set of VRPs.

type DiffIter = DiffIter

An iterator over a difference between two sets of VRPs.

fn ready(&self) -> bool

Returns whether the source is ready to serve data.

fn notify(&self) -> State

Returns the current state of the source.

fn full(&self) -> (State, Self::FullIter)

Returns the current state and an iterator over the full set of VRPs.

fn diff(&self, state: State) -> Option<(State, Self::DiffIter)>

Returns the current state and an interator over differences in VPRs.

fn timing(&self) -> Timing

Returns the timing information for the current state.