Struct WebSocketHandle 

pub struct WebSocketHandle { /* private fields */ }

Handle to a running WebSocket event stream.

Cheaply cloneable via the inner broadcast sender. Drop all handles and call shutdown to tear down the background task.

Implementations

impl WebSocketHandle

pub fn connect( ws_url: Url, reconnect: ReconnectConfig, cancel: CancellationToken, cookie: Option<String>, tls_mode: TlsMode, ) -> Result<Self, Error>

Connect to the controller WebSocket and spawn the reconnection loop.

Returns immediately once the background task is spawned. The first connection attempt happens asynchronously – subscribe to the event receiver to start consuming events.

pub fn subscribe(&self) -> Receiver<Arc<UnifiEvent>>

Get a new broadcast receiver for the event stream.

Multiple consumers can subscribe concurrently. If a consumer falls behind, it receives broadcast::error::RecvError::Lagged.

pub fn shutdown(&self)

Signal the background task to shut down gracefully.