Skip to main content

WebSocketClientConfig

Struct WebSocketClientConfig 

Source
pub struct WebSocketClientConfig {
    pub default_send_retry_policy: WsSendRetryPolicy,
    pub default_request_retry_policy: WsRequestRetryPolicy,
    pub queues: QueueLimits,
    pub dispatch: DispatchLimits,
    pub requests: RequestLimits,
    pub frames: FrameConfig,
    pub tcp: TcpConfig,
    pub heartbeat: Option<HeartbeatConfig>,
    pub close_timeout: Duration,
}
Expand description

Shared resource limits, transport parameters, and heartbeat configuration for WebSocket clients.

Fields§

§default_send_retry_policy: WsSendRetryPolicy

Default replay policy for untracked message writes. Initially disabled.

§default_request_retry_policy: WsRequestRetryPolicy

Default policy for factory-backed logical requests. Initially disabled.

§queues: QueueLimits

Capacity of command, I/O event, and normal and emergency send queues.

§dispatch: DispatchLimits

Resource caps for receiving messages, subscribing to distribution, callback execution, and blocking handshake tasks.

§requests: RequestLimits

Number of pending requests and manual response handling grace configuration.

§frames: FrameConfig

WebSocket frame fragmentation, read and write buffers and sizes, timeout limits.

§tcp: TcpConfig

Low-level TCP socket options.

§heartbeat: Option<HeartbeatConfig>

Active Ping/Pong heartbeat configuration; None means disabling active heartbeat.

§close_timeout: Duration

Maximum time to wait for the closing handshake and I/O task to finish during shutdown; the default is 2 seconds.

Implementations§

Source§

impl WebSocketClientConfig

Source

pub fn with_default_send_retry_policy(self, policy: WsSendRetryPolicy) -> Self

Source

pub fn with_default_request_retry_policy( self, policy: WsRequestRetryPolicy, ) -> Self

Source

pub fn validate(&self) -> Result<()>

Validates all nested limits and transport settings before client creation.

Trait Implementations§

Source§

impl Clone for WebSocketClientConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WebSocketClientConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WebSocketClientConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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<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