Struct SocketBuilder

pub struct SocketBuilder<I, O> { /* private fields */ }

Builder for Socket Uses the DEFAULT_* consts for backoff and retry config

Implementations

impl<I, O> SocketBuilder<I, O>

where I: SocketInput, O: SocketOutput, Message: TryFrom<I>, <Message as TryFrom<I>>::Error: Debug, <O as TryFrom<Message>>::Error: Debug,

pub fn new(url: String) -> Self

Create a new builder from the given url with other config set to defaults

pub fn set_url(self, url: String) -> Self

Update the builder url

pub fn set_backoff_min(self, backoff_min: Duration) -> Self

Update the minimum backoff duration (must be > 0 millis)

pub fn set_backoff_max(self, backoff_max: Option<Duration>) -> Self

Update the maximum backoff duration (if set must be < u32::MAX millis)

pub fn set_max_retries(self, max_retries: u32) -> Self

Update the maximum number of retry attempts

pub fn set_stable_timeout(self, stable_timeout: Duration) -> Self

Update the stable timeout. Must be <= u32::MAX millis

This determines how long a connection needs to stay open after a retry before it is considered stable and the retry counter is reset to 0

pub fn open(self) -> Result<Socket<I, O>, Error<I, O>>

Attempts to create a reconnecting websocket and do the initial open It’s set up to error at this poing because the kind of errors that can occur here are likely fatal (See gloo::net::websocket::futures::WebSocket::open for details). These could be panics but the consumer may want to display the error to the user or fallback to plain http

Trait Implementations

impl<I: Debug, O: Debug> Debug for SocketBuilder<I, O>

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

Formats the value using the given formatter.