Trait foca::Runtime

pub trait Runtime<T>
where
    T: Identity,
{
    // Required methods
    fn notify(&mut self, notification: Notification<T>);
    fn send_to(&mut self, to: T, data: &[u8]);
    fn submit_after(&mut self, event: Timer<T>, after: Duration);
}

A Runtime is Foca’s gateway to the real world: here is where implementations decide how to interact with the network, the hardware timer and the user.

Implementations may react directly to it for a fully synchronous behavior or accumulate-then-drain when dispatching via fancier mechanisms like async.

Required Methods

fn notify(&mut self, notification: Notification<T>)

Whenever something changes Foca’s state significantly a notification is emitted.

It’s the best mechanism to watch for membership changes and allows implementors to keep track of the cluster state without having direct access to the running Foca instance.

Implementations may completely disregard this if desired.

fn send_to(&mut self, to: T, data: &[u8])

This is how Foca connects to an actual transport.

Implementations are responsible for the actual delivery.

fn submit_after(&mut self, event: Timer<T>, after: Duration)

Request to schedule the delivery of a given event after a specified duration.

Implementations MUST ensure that every event is delivered. Foca is very tolerant to delays, but non-delivery will cause errors.

Implementations on Foreign Types

impl<T, R> Runtime<T> for &mut R

where T: Identity, R: Runtime<T>,

fn notify(&mut self, notification: Notification<T>)

fn send_to(&mut self, to: T, data: &[u8])

fn submit_after(&mut self, event: Timer<T>, after: Duration)

Implementors

impl<T: Identity> Runtime<T> for AccumulatingRuntime<T>