pub struct PushHub { /* private fields */ }server only.Expand description
A fan-out of state changes to every connection of one principal, with
RFC 8887 §4.3.5.1 pushState tokens and replay.
The deployment calls publish after every write and
gives each connection a clone as its PushSource. Keep one hub per
principal (or per set of accounts a caller sees): a hub does no
access filtering, and its pushState “encodes the entire server state
visible to the user”.
The hub keeps the last capacity changes. A pushState it issued is
answered with the changes since then, merged into one notification;
if some were already dropped, with the latest state of every type the
hub has seen (a superset: a client’s /changes call for a type that
did not change returns nothing). A token it did not issue (another
hub, or a hub from before a restart) replays nothing, and the client
resyncs with /changes. Tokens are opaque strings.
Each wake of a slow connection merges all changes since its last
notification into one, keeping the latest state per type; extra
members of merged changes are dropped.
use std::collections::BTreeMap;
use jmap_websocket::server::PushHub;
use jmap_websocket::jmap_types::{Id, State, StateChange};
let hub = PushHub::new(256);
let mut types = BTreeMap::new();
types.insert("Email".to_owned(), State::from("e2"));
let mut changed = BTreeMap::new();
changed.insert(Id::from("a1"), types);
hub.publish(StateChange::new(changed));
assert!(!hub.push_state().is_empty());Implementations§
Source§impl PushHub
impl PushHub
Sourcepub fn new(capacity: usize) -> Self
pub fn new(capacity: usize) -> Self
A hub that keeps the last capacity changes for replay (at least
one).
Sourcepub fn publish(&self, change: StateChange)
pub fn publish(&self, change: StateChange)
Record a state change and wake every subscribed connection.
A change with no accounts is ignored; extra members are not kept.
Sourcepub fn push_state(&self) -> String
pub fn push_state(&self) -> String
The pushState token for everything published so far.
Trait Implementations§
Source§impl PushSource for PushHub
impl PushSource for PushHub
Source§fn subscribe(
&mut self,
enable: &WebSocketPushEnable,
) -> BoxStream<'static, WsStateChange>
fn subscribe( &mut self, enable: &WebSocketPushEnable, ) -> BoxStream<'static, WsStateChange>
enable: yield every later state change,
and first, when enable.push_state is a token this source issued,
the changes since it (“the server SHOULD immediately send all
changes since that state token”, §4.3.5.2). Read more