Skip to main content

ClientConfig

Struct ClientConfig 

Source
pub struct ClientConfig {
    pub timeout: Duration,
    pub reconnector: Option<Box<dyn Reconnector>>,
    pub reconnect_policy: ReconnectPolicy,
    pub keepalive: KeepaliveBehavior,
}
Expand description

Everything Client::from_transport_with_config needs beyond the transport halves and the runtime. Introduced because the option set had outgrown positional parameters - from_transport_with_reconnect already took seven arguments, and keepalive would have made it eight or forced a third constructor.

Defaults are deliberately inert: no reconnector, no keepalive. ConnectOptions (the WebSocket convenience path) opts into both, but a caller assembling a client from raw transport halves gets exactly the behavior they asked for and nothing more.

Fields§

§timeout: Duration

How long to wait for a CALLRESULT/CALLERROR, and the default pong deadline.

§reconnector: Option<Box<dyn Reconnector>>

Redials when the transport closes. None means the read loop exits on disconnect.

§reconnect_policy: ReconnectPolicy

Backoff between failed reconnect attempts. Ignored when reconnector is None.

§keepalive: KeepaliveBehavior

Whether to ping the peer on a schedule, and what to do when it stops answering.

Implementations§

Source§

impl ClientConfig

Source

pub fn new(timeout: Duration) -> Self

A config with timeout and nothing else enabled.

Source

pub fn with_reconnect( self, reconnector: Box<dyn Reconnector>, policy: ReconnectPolicy, ) -> Self

Redial through reconnector, backing off per policy, when the transport closes.

Source

pub fn with_keepalive(self, keepalive: KeepaliveBehavior) -> Self

Ping the peer per keepalive.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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