Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

Builder struct for [RealtimeClient]

Implementations

impl ClientBuilder

pub fn new(endpoint: impl Into<String>, access_token: impl Into<String>) -> Self

pub fn set_headers(&mut self, set_headers: HeaderMap) -> &mut Self

Sets the client headers. Headers always contain “X-Client-Info: realtime-rs/{version}”.

pub fn add_headers(&mut self, headers: HeaderMap) -> &mut Self

Merges provided HeaderMap with currently held headers

pub fn params(&mut self, params: HashMap<String, String>) -> &mut Self

Set endpoint URL params

pub fn heartbeat_interval(&mut self, heartbeat_interval: Duration) -> &mut Self

Set Duration between heartbeat packets. Default 29 seconds.

pub fn reconnect_interval( &mut self, reconnect_interval: ReconnectFn, ) -> &mut Self

Set the function to provide time between reconnection attempts The provided function should take a count of reconnect attempts and return a Duration to wait until the next attempt is made.

Don’t implement an untested timing function here in prod or you might make a few too many requests.

Defaults to stepped backoff

pub fn reconnect_max_attempts(&mut self, max_attempts: usize) -> &mut Self

Configure the number of recconect attempts to be made before erroring

pub fn connection_timeout(&mut self, timeout: Duration) -> &mut Self

Configure the duration to wait for a connection to succeed. Default: 10 seconds Minimum: 1 second

pub fn auth_url(&mut self, auth_url: impl Into<String>) -> &mut Self

Set the base URL for the auth server In live supabase deployments this is the same as the endpoint URL, and defaults as such. In local deployments this may need to be set manually

pub fn max_events_per_second(&mut self, count: usize) -> &mut Self

Sets the max messages we can send in a second. Default: 10

pub fn encode( &mut self, encode: impl Fn(RealtimeMessage) -> RealtimeMessage + 'static + Send + Sync, ) -> &mut Self

pub fn decode( &mut self, decode: impl Fn(RealtimeMessage) -> RealtimeMessage + 'static + Send + Sync, ) -> &mut Self

pub fn build( self, channel_callback_event_sender: CrossbeamEventSender<ChannelCallbackEvent>, connect_result_callback_event_sender: CrossbeamEventSender<ConnectResultCallbackEvent>, ) -> Client

Consume the Self and return a configured [RealtimeClient]