Struct WsConnect 

pub struct WsConnect { /* private fields */ }

Available on crate feature ws-base only.

Simple connection details for a websocket connection.

Implementations

impl WsConnect

pub fn new<S>(url: S) -> WsConnect

where S: Into<String>,

Creates a new websocket connection configuration.

If the URL contains credentials (e.g. wss://user:pass@host), they are automatically extracted and set as the Authorization header.

pub fn with_auth(self, auth: Authorization) -> WsConnect

Sets the authorization header.

pub fn with_auth_opt(self, auth: Option<Authorization>) -> WsConnect

Sets the optional authorization header.

This replaces the current Authorization.

pub const fn with_config(self, config: WebSocketConfig) -> WsConnect

Sets the websocket config.

pub fn url(&self) -> &str

Get the URL string of the connection.

pub const fn auth(&self) -> Option<&Authorization>

Get the authorization header.

pub const fn config(&self) -> Option<&WebSocketConfig>

Get the websocket config.

pub const fn with_max_retries(self, max_retries: u32) -> WsConnect

Sets the max number of retries before failing and exiting the connection. Default is 10.

pub const fn with_retry_interval(self, retry_interval: Duration) -> WsConnect

Sets the base interval between retries.

Reconnect retries use capped exponential backoff from this base interval. Default is 3 seconds.

pub const fn with_keepalive_interval( self, keepalive_interval: Duration, ) -> WsConnect

Sets the keepalive ping interval.

A ping is sent if no other messages have been sent within this interval. If the server does not respond with a pong before the next ping is due, the connection is considered dead and will be closed.

Default is 10 seconds.

Trait Implementations

impl Clone for WsConnect

fn clone(&self) -> WsConnect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsConnect

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

Formats the value using the given formatter.

impl IntoClientRequest for WsConnect

fn into_client_request(self) -> Result<Request<()>, Error>

Convert into a Request that can be used for a client connection.

impl PubSubConnect for WsConnect

fn is_local(&self) -> bool

Returns true if the transport connects to a local resource.

async fn connect( &self, ) -> Result<ConnectionHandle, RpcError<TransportErrorKind>>

Spawn the backend, returning a handle to it.

fn try_reconnect( &self, ) -> impl Send + Future<Output = Result<ConnectionHandle, RpcError<TransportErrorKind>>>

Attempt to reconnect the transport.

fn into_service( self, ) -> impl Send + Future<Output = Result<PubSubFrontend, RpcError<TransportErrorKind>>>

Convert the configuration object into a service with a running backend.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 160 bytes