Struct ConnectOptions

pub struct ConnectOptions {
    pub block_async_connect: bool,
    pub strategy: ConnectStrategy,
    pub url: Option<String>,
    pub connect_timeout: Option<Duration>,
    pub retry_interval: Option<Duration>,
}

ConnectOptions is used to configure the WebSocket connectivity behavior.

@category WebSocket

Fields

block_async_connect: bool

Indicates if the async fn connect() method should return immediately or block until the connection is established.

strategy: ConnectStrategy

ConnectStrategy used to configure the retry or fallback behavior.

url: Option<String>

Optional url that will change the current URL of the WebSocket. Note that the URL overrides the use of resolver.

connect_timeout: Option<Duration>

Optional timeout that will change the timeout of the WebSocket connection process. Timeout is the period after which the async connection attempt is aborted. Timeout is followed by the retry delay if the [ConnectionStrategy] is set to Retry.

retry_interval: Option<Duration>

Retry interval denotes the time to wait before attempting to reconnect.

Implementations

impl ConnectOptions

pub fn blocking_fallback() -> Self

pub fn blocking_retry() -> Self

pub fn non_blocking_retry() -> Self

pub fn with_url<S: Display>(self, url: S) -> Self

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

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

pub fn connect_timeout(&self) -> Duration

pub fn retry_interval(&self) -> Duration

Trait Implementations

impl Clone for ConnectOptions

fn clone(&self) -> ConnectOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectOptions

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

Formats the value using the given formatter.

impl Default for ConnectOptions

fn default() -> Self

Returns the “default value” for a type.