Struct WebSocketChannelManager 

pub struct WebSocketChannelManager { /* private fields */ }

WebSocket-based notification channel. The manager maintains the list of subscriptions and emits serialised change notifications on a tokio::sync::broadcast channel that upstream HTTP servers attach WebSocket tasks to.

Implementations

impl WebSocketChannelManager

pub fn new() -> Self

pub fn with_heartbeat(self, interval: Duration) -> Self

Override the heartbeat interval (default 30s).

pub fn heartbeat_interval(&self) -> Duration

Internal test hook.

pub async fn subscribe(&self, topic: &str, base_url: &str) -> Subscription

Register a new WebSocket subscription. Returns the receive_from URL the client should connect to.

pub async fn unsubscribe(&self, id: &str)

Remove a subscription.

pub fn stream(&self) -> Receiver<ChangeNotification>

Subscribe to the broadcast stream. Each delivered message is a pre-serialised ChangeNotification that the transport layer writes to the WebSocket frame.

pub async fn active_subscriptions(&self) -> usize

Number of active subscriptions.

pub async fn pump_from_storage( self, rx: Receiver<StorageEvent>, pod_base: String, )

Attach this manager to a stream of storage events. Each event is translated into an Activity Streams notification and broadcast to every connected client whose subscription topic covers the event path.

Trait Implementations

impl Clone for WebSocketChannelManager

fn clone(&self) -> WebSocketChannelManager

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for WebSocketChannelManager

fn default() -> Self

Returns the “default value” for a type.

impl Notifications for WebSocketChannelManager

fn subscribe<'life0, 'async_trait>( &'life0 self, subscription: Subscription, ) -> Pin<Box<dyn Future<Output = Result<(), PodError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Register a subscription for a topic.

fn unsubscribe<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), PodError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove a subscription.

fn publish<'life0, 'life1, 'async_trait>( &'life0 self, _topic: &'life1 str, notification: ChangeNotification, ) -> Pin<Box<dyn Future<Output = Result<(), PodError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Deliver a notification to all subscribers of topic.