Struct LiveRouter 

pub struct LiveRouter { /* private fields */ }

Client router for the REST API live data endpoints.

Implementations

impl LiveRouter

pub fn new(uri: &str, prefix: &str, timeout_s: f64, http: Client) -> Self

Creates a new live router.

pub fn is_connected(&self) -> bool

Returns true if the websocket connection is open.

pub fn connect(&mut self) -> Result<()>

Opens the websocket connection.

The router timeout bounds the entire connection process: the TCP connect phase uses it as a connect timeout, and it is applied as the socket read and write timeout before the TLS and WebSocket handshake. This ensures a stalled or hanging host cannot block for longer than timeout_s, and that live operations afterwards cannot block indefinitely if the server stalls.

pub fn disconnect(&mut self)

Closes the websocket connection (no-op if not connected).

pub fn set_data( &mut self, data: IndexMap<String, InstructionValue>, ) -> Result<()>

Sets data via the websocket connection.

pub fn get_data(&mut self, complete: bool) -> Result<IndexMap<String, Value>>

Gets data via the websocket connection.

If complete is false, only changed data is retrieved, else all.

Trait Implementations

impl Debug for LiveRouter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.