Struct foca::AccumulatingRuntime

pub struct AccumulatingRuntime<T> { /* private fields */ }

A Runtime implementation that’s good enough for simple use-cases.

It accumulates all events that happen during an interaction with crate::Foca and users must drain those and react accordingly.

Better runtimes would react directly to the events, intead of needlessly storing the events in a queue.

Users must drain the runtime immediately after interacting with foca. Example:

See it in use at examples/foca_insecure_udp_agent.rs

Implementations

impl<T> AccumulatingRuntime<T>

pub fn new() -> Self

Create a new AccumulatingRuntime

pub fn to_send(&mut self) -> Option<(T, Bytes)>

Yields data to be sent to a cluster member T in the order they’ve happened.

Users are expected to drain it until it yields None after every interaction with crate::Foca

pub fn to_schedule(&mut self) -> Option<(Duration, Timer<T>)>

Yields timer events and how far in the future they must be given back to the foca instance that produced it

Users are expected to drain it until it yields None after every interaction with crate::Foca

pub fn to_notify(&mut self) -> Option<Notification<T>>

Yields event notifications in the order they’ve happened

Users are expected to drain it until it yields None after every interaction with crate::Foca

pub fn backlog(&self) -> usize

Returns how many unhandled events are left in this runtime

Should be brought down to zero after every interaction with crate::Foca

Trait Implementations

impl<T> Default for AccumulatingRuntime<T>

fn default() -> Self

Returns the “default value” for a type.

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

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

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

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

This is how Foca connects to an actual transport.

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

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