Struct ws::WebSocketSettings [−] [src]

pub struct WebSocketSettings {
    pub max_connections: usize,
    pub panic_on_new_connection: bool,
    pub panic_on_shutdown: bool,
    pub protocols: Option<&'static str>,
    pub extensions: Option<&'static str>,
}

Settings that apply to multiple connections.

Fields

max_connections: usize

The maximum number of connections that this WebSocket will support. Default: 10,000

panic_on_new_connection: bool

Whether to panic when unable to establish a new TCP connection. Default: false

panic_on_shutdown: bool

Whether to panic when a shutdown of the WebSocket is requested. Default: false

protocols: Option<&'static str>

A protocol string representing the subprotocols that this WebSocket can support. This will be sent in Requests to server endpoints to help determine a subprotocol if any for the connection. Default: None

extensions: Option<&'static str>

A WebSocket extension string indicating the extensions that this WebSocket can support. Default: None

Trait Implementations

impl Default for Settings
[src]

fn default() -> Settings

Returns the "default value" for a type. Read more