Struct RealtimeClientBuilder 

pub struct RealtimeClientBuilder { /* private fields */ }

Builder for RealtimeClient.

Implementations

impl RealtimeClientBuilder

pub fn new(url: impl Into<String>, token: impl Into<String>) -> Self

Creates a realtime client builder with the default SDK identity.

pub fn identity(self, identity: ClientIdentity) -> Self

Sets the client identity used in realtime headers and connection init.

pub fn connect_timeout(self, timeout: Duration) -> Self

Sets the timeout for opening the WebSocket and receiving ConnectionOpen.

pub fn without_connect_timeout(self) -> Self

Disables the connect timeout.

pub fn rpc_timeout(self, timeout: Duration) -> Self

Sets the timeout for each RPC invocation.

pub fn without_rpc_timeout(self) -> Self

Disables the per-RPC timeout.

pub fn max_in_flight_rpcs(self, maximum: usize) -> Self

Sets the maximum number of RPCs awaiting responses on one session.

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

Configures protocol heartbeat interval and pong deadline.

pub fn without_heartbeat(self) -> Self

Disables multiplexed-session protocol heartbeat pings.

pub async fn connect(self) -> Result<RealtimeClient, RealtimeError>

Opens the WebSocket connection and waits for ConnectionOpen.

pub async fn connect_session(self) -> Result<RealtimeSession, RealtimeError>

Opens one WebSocket and starts a multiplexed session for concurrent RPC calls and pushed events.

Trait Implementations

impl Clone for RealtimeClientBuilder

fn clone(&self) -> RealtimeClientBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeClientBuilder

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

Formats the value using the given formatter.