Struct Config 

pub struct Config {
    pub max_message_size: usize,
    pub max_frame_size: usize,
    pub write_buffer_size: usize,
    pub compression: Compression,
    pub idle_timeout: u32,
    pub max_backpressure: usize,
    pub auto_ping: bool,
    pub ping_interval: u32,
    pub deflate: Option<DeflateConfig>,
}

Configuration for WebSocket connections

Mirrors uWebSockets configuration options for familiarity.

Example

use sockudo_ws::{Config, Compression};

let config = Config::builder()
    .compression(Compression::Shared)
    .max_payload_length(16 * 1024)
    .idle_timeout(10)
    .max_backpressure(1024 * 1024)
    .build();

Fields

max_message_size: usize

Maximum message size (default: 64MB) Equivalent to uWS maxPayloadLength

max_frame_size: usize

Maximum frame size (default: 16MB)

write_buffer_size: usize

Write buffer size for corking (default: 16KB)

compression: Compression

Compression mode (default: Disabled)

idle_timeout: u32

Idle timeout in seconds (default: 120, 0 = disabled) Connection is closed if no data received within this time

max_backpressure: usize

Maximum backpressure in bytes before dropping connection (default: 1MB) If write buffer exceeds this, connection is closed

auto_ping: bool

Send pings automatically to keep connection alive (default: true)

ping_interval: u32

Ping interval in seconds (default: 30)

deflate: Option<DeflateConfig>

Per-message deflate configuration (requires permessage-deflate feature)

Implementations

impl Config

pub fn builder() -> ConfigBuilder

Create a new config builder

pub fn uws_defaults() -> Self

Create config with uWebSockets-style defaults

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.