Struct Hub 

pub struct Hub<T: TransportPort + 'static> { /* private fields */ }

The watch hub over one engine. Cheap to clone: clones share one hub.

Implementations

impl<T: TransportPort + 'static> Hub<T>

pub fn new( engine: Arc<Engine<T>>, options: WatchOptions, ) -> Result<Self, String>

A hub over engine, under checked options. It starts its notification receiver, so it must be made inside a Tokio runtime.

pub fn options(&self) -> &WatchOptions

The hub’s settings.

pub fn watch(&self, point: Point) -> Result<Lease, WatchError>

A lease on point, starting its watch if it has none. A new watch goes to its device’s scheduler, started with it when the device has none.

pub fn peek(&self, point: &Point) -> Option<Snapshot>

point’s latest values, if it is watched: nothing is sent.

pub fn seq(&self) -> u64

The hub’s sequence number: every change takes the next one, so a point changed since an earlier reading of this when its Snapshot::seq is greater.

pub fn stats(&self) -> HubStats

The hub’s footprint now.

pub async fn shutdown(&self, wait: Duration) -> bool

Stop every watch, wait up to wait for their cancels, and stop the notification receiver. Later watch calls fail. True when every cancel finished in time; the subscriptions of those that didn’t lapse with their lifetime.

Trait Implementations

impl<T: TransportPort + 'static> Clone for Hub<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.