Struct WebSocketOptions 

pub struct WebSocketOptions {
    pub ping_interval: Duration,
    pub idle_timeout: Duration,
    pub close_handshake_timeout: Duration,
    pub incoming_queue_length: NonZeroUsize,
}

Configuration for WebSocket connections.

Fields

ping_interval: Duration

Interval at which to send Ping frames.

We use pings for connection keep-alive. Value must be smaller than idle_timeout.

Default: 15s

idle_timeout: Duration

Amount of time after which an idle connection is closed.

A connection is considered idle if no data is received nor sent. This includes Ping/Pong frames used for keep-alive.

Value must be greater than ping_interval.

Default: 30s

close_handshake_timeout: Duration

For how long to keep draining the incoming messages until a client close is received.

Default: 250ms

incoming_queue_length: NonZeroUsize

Maximum number of messages to queue for processing.

If this number is exceeded, the client is disconnected.

Default: 2048

Trait Implementations

impl Clone for WebSocketOptions

fn clone(&self) -> WebSocketOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketOptions

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

Formats the value using the given formatter.

impl Default for WebSocketOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebSocketOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WebSocketOptions

fn eq(&self, other: &WebSocketOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WebSocketOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for WebSocketOptions

impl StructuralPartialEq for WebSocketOptions