Struct WebSocketConfig 

pub struct WebSocketConfig {
    pub url: String,
    pub authorization: Option<String>,
    pub auto_reconnect: bool,
    pub reconnect_interval: Duration,
    pub ping_interval: Duration,
    pub ping_timeout: Duration,
    pub max_reconnect_attempts: Option<u32>,
    pub filtered_events: Option<Vec<String>>,
}

WebSocket-specific configuration.

Fields

url: String

Websocket event channel URL. eg: ws://192.168.1.2:3000/ws

authorization: Option<String>

Optional Websocket authorization header token.

auto_reconnect: bool

Should the websocket connection automatically reconnect if disconnected.

reconnect_interval: Duration

Interval to use between reconnection attempts.

ping_interval: Duration

The interval between sending websocket pings.

ping_timeout: Duration

Timeout duration for missing pings.

max_reconnect_attempts: Option<u32>

Maximum reconnection attempts (None = unlimited).

filtered_events: Option<Vec<String>>

Optional set of events that should be listened to. This is added to the websocket connection URI, and the server filters out events before sending them. By default, all events are sent when none are selected.

Implementations

impl WebSocketConfig

pub const WS_DEFAULT_RECONNECT_INTERVAL: u64 = 5

The default interval to use between connection attempts. Sequential attempts use a backoff up to 60 seconds.

pub const WS_DEFAULT_PING_INTERVAL: u64 = 10

The interval between sending ping messages.

pub const WS_DEFAULT_PING_TIMEOUT: u64 = 30

The duration between the last ping to count as a timeout.

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

Create a new WebSocket configuration with default settings.

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

Set the authorization token.

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

Enable or disable auto-reconnection.

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

Set the reconnection interval.

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

Set the ping interval.

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

Set the ping timeout.

pub fn with_max_reconnect_attempts(self, max_attempts: Option<u32>) -> Self

Set maximum reconnection attempts (None = unlimited).

pub fn with_filtered_events( self, events: Option<Vec<impl Into<String>>>, ) -> Self

Set filtered listen events, this is included in the connection query-string. The provided Vec should contain every event name that should be sent by the server. If None, filtering is disabled so all events are sent.

Trait Implementations

impl Clone for WebSocketConfig

fn clone(&self) -> WebSocketConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketConfig

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

Formats the value using the given formatter.

impl Default for WebSocketConfig

Available on crate feature websocket only.

fn default() -> Self

Returns the “default value” for a type.

impl From<WebSocketConfig> for ClientConfig

Available on crate feature websocket only.

fn from(ws: WebSocketConfig) -> Self

Converts to this type from the input type.