Skip to main content

ManagedWsConfigBuilder

Struct ManagedWsConfigBuilder 

Source
pub struct ManagedWsConfigBuilder<S: State = Empty> { /* private fields */ }
Expand description

Use builder syntax to set the inputs and finish with build().

Implementations§

Source§

impl<S: State> ManagedWsConfigBuilder<S>

Source

pub fn build(self) -> ManagedWsConfig
where S: IsComplete,

Finish building and return the requested object

Source

pub fn initial_backoff( self, value: Duration, ) -> ManagedWsConfigBuilder<SetInitialBackoff<S>>
where S::InitialBackoff: IsUnset,

Optional (Some / Option setters). Default: Duration::from_secs(1).

Initial delay before the first reconnect attempt.

Default: 1 second

Source

pub fn maybe_initial_backoff( self, value: Option<Duration>, ) -> ManagedWsConfigBuilder<SetInitialBackoff<S>>
where S::InitialBackoff: IsUnset,

Optional (Some / Option setters). Default: Duration::from_secs(1).

Initial delay before the first reconnect attempt.

Default: 1 second

Source

pub fn max_backoff( self, value: Duration, ) -> ManagedWsConfigBuilder<SetMaxBackoff<S>>
where S::MaxBackoff: IsUnset,

Optional (Some / Option setters). Default: Duration::from_secs(30).

Maximum delay between reconnect attempts.

Default: 30 seconds

Source

pub fn maybe_max_backoff( self, value: Option<Duration>, ) -> ManagedWsConfigBuilder<SetMaxBackoff<S>>
where S::MaxBackoff: IsUnset,

Optional (Some / Option setters). Default: Duration::from_secs(30).

Maximum delay between reconnect attempts.

Default: 30 seconds

Source

pub fn max_retries(self, value: u32) -> ManagedWsConfigBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

Optional (Some / Option setters). Maximum number of consecutive reconnect attempts before giving up. None means retry forever.

Default: None (infinite retries)

Source

pub fn maybe_max_retries( self, value: Option<u32>, ) -> ManagedWsConfigBuilder<SetMaxRetries<S>>
where S::MaxRetries: IsUnset,

Optional (Some / Option setters). Maximum number of consecutive reconnect attempts before giving up. None means retry forever.

Default: None (infinite retries)

Source

pub fn channel_capacity( self, value: usize, ) -> ManagedWsConfigBuilder<SetChannelCapacity<S>>
where S::ChannelCapacity: IsUnset,

Optional (Some / Option setters). Default: 10_000.

Event channel buffer size. When the buffer is full and the consumer isn’t keeping up, new events are dropped to keep the WebSocket connection alive. A warning is logged when this happens.

Default: 10_000

Source

pub fn maybe_channel_capacity( self, value: Option<usize>, ) -> ManagedWsConfigBuilder<SetChannelCapacity<S>>
where S::ChannelCapacity: IsUnset,

Optional (Some / Option setters). Default: 10_000.

Event channel buffer size. When the buffer is full and the consumer isn’t keeping up, new events are dropped to keep the WebSocket connection alive. A warning is logged when this happens.

Default: 10_000

Source

pub fn ws_config( self, value: WebsocketConfig, ) -> ManagedWsConfigBuilder<SetWsConfig<S>>
where S::WsConfig: IsUnset,

Optional (Some / Option setters). Underlying WebSocket connection config (e.g. handshake timeout).

Source

pub fn maybe_ws_config( self, value: Option<WebsocketConfig>, ) -> ManagedWsConfigBuilder<SetWsConfig<S>>
where S::WsConfig: IsUnset,

Optional (Some / Option setters). Underlying WebSocket connection config (e.g. handshake timeout).

Source

pub fn idle_timeout( self, value: Duration, ) -> ManagedWsConfigBuilder<SetIdleTimeout<S>>
where S::IdleTimeout: IsUnset,

Optional (Some / Option setters). Default: Duration::from_secs(60).

Force a reconnect if no server message arrives within this window.

Protects against zombie connections — TCP keepalives and WebSocket ping/pong keep the socket nominally alive, but the server can stop sending data without closing. Without this, the handle sits on a dead stream indefinitely.

Duration::ZERO disables the timer. Cmd-path acks (subscribe, order responses) DO count as server-pushed messages and reset the clock.

Default: 60 seconds

Source

pub fn maybe_idle_timeout( self, value: Option<Duration>, ) -> ManagedWsConfigBuilder<SetIdleTimeout<S>>
where S::IdleTimeout: IsUnset,

Optional (Some / Option setters). Default: Duration::from_secs(60).

Force a reconnect if no server message arrives within this window.

Protects against zombie connections — TCP keepalives and WebSocket ping/pong keep the socket nominally alive, but the server can stop sending data without closing. Without this, the handle sits on a dead stream indefinitely.

Duration::ZERO disables the timer. Cmd-path acks (subscribe, order responses) DO count as server-pushed messages and reset the clock.

Default: 60 seconds

Source

pub fn backoff_reset_after( self, value: Duration, ) -> ManagedWsConfigBuilder<SetBackoffResetAfter<S>>
where S::BackoffResetAfter: IsUnset,

Optional (Some / Option setters). Default: Duration::from_secs(30).

How long a connection must stay up before the backoff state is considered “stable” and the next disconnect starts from initial_backoff again.

Without this, a zombie that accepts connections and immediately drops would be hammered at initial_backoff forever — the server never gets the exponential-backoff relief.

Default: 30 seconds

Source

pub fn maybe_backoff_reset_after( self, value: Option<Duration>, ) -> ManagedWsConfigBuilder<SetBackoffResetAfter<S>>
where S::BackoffResetAfter: IsUnset,

Optional (Some / Option setters). Default: Duration::from_secs(30).

How long a connection must stay up before the backoff state is considered “stable” and the next disconnect starts from initial_backoff again.

Without this, a zombie that accepts connections and immediately drops would be hammered at initial_backoff forever — the server never gets the exponential-backoff relief.

Default: 30 seconds

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more