Struct RealtimeOptions 

pub struct RealtimeOptions {
    pub api_key: String,
    pub url: String,
    pub reconnect: Option<ReconnectOptions>,
    pub heartbeat: Option<HeartbeatOptions>,
    pub token_provider: Option<TokenProvider>,
    pub auth_in_query: bool,
    pub compression: bool,
}

Available on crate feature realtime and (crate features realtime or webhooks) only.

Configuration for a RealtimeClient.

Fields

api_key: String

Radion API key, sent as the X-API-Key header.

url: String

WebSocket endpoint. Defaults to DEFAULT_WS_URL.

reconnect: Option<ReconnectOptions>

Reconnect policy, or None to disable auto-reconnect.

heartbeat: Option<HeartbeatOptions>

Heartbeat policy, or None to disable heartbeats.

token_provider: Option<TokenProvider>

User JWT provider for the public-key (pk_jwt_) flow. None = secret key. Resolved on every (re)connect.

auth_in_query: bool

Send credentials in the URL query instead of headers. Defaults to false; enable for header-stripping proxies or gateways.

compression: bool

Available on crate feature compression only.

Ask the server for zlib-compressed binary frames. Defaults to false.

Implementations

impl RealtimeOptions

pub fn new(api_key: impl Into<String>) -> Self

Options for the given API key with default URL, reconnect, and heartbeat.

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

Override the WebSocket endpoint.

pub fn reconnect(self, options: ReconnectOptions) -> Self

Tune the reconnect policy.

pub fn disable_reconnect(self) -> Self

Disable auto-reconnect.

pub fn heartbeat(self, options: HeartbeatOptions) -> Self

Tune the heartbeat policy.

pub fn disable_heartbeat(self) -> Self

Disable heartbeats.

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

Set a static user JWT for the public-key (pk_jwt_) flow.

pub fn token_provider(self, provider: TokenProvider) -> Self

Set a user JWT provider, called on every (re)connect for a fresh token.

pub fn auth_in_query(self, enabled: bool) -> Self

Send credentials in the URL query string instead of headers.

pub fn compression(self, enabled: bool) -> Self

Available on crate feature compression only.

Ask the server for zlib-compressed binary frames.

Adds compress=zlib to the connect URL. The server then sends event frames as binary zlib, which the client inflates before parsing. Text frames still work, so mixed traffic is fine.

Trait Implementations

impl Clone for RealtimeOptions

fn clone(&self) -> RealtimeOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RealtimeOptions

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

Formats the value using the given formatter.