Struct rocket_ws::Config

pub struct Config {
    pub max_send_queue: Option<usize>,
    pub max_message_size: Option<usize>,
    pub max_frame_size: Option<usize>,
    pub accept_unmasked_frames: bool,
}

WebSocket connection configuration.

The default configuration for a WebSocket can be changed by calling WebSocket::config() with a value of this type. The defaults are obtained via Default::default(). You don’t generally need to reconfigure a WebSocket unless you’re certain you need different values. In other words, this structure should rarely be used.

Example

use rocket::data::ToByteUnit;

#[get("/echo")]
fn echo_stream(ws: ws::WebSocket) -> ws::Stream!['static] {
    let ws = ws.config(ws::Config {
        // Enable backpressure with a max send queue size of `5`.
        max_send_queue: Some(5),
        // Decrease the maximum (complete) message size to 4MiB.
        max_message_size: Some(4.mebibytes().as_u64() as usize),
        // Decrease the maximum size of _one_ frame (not messag) to 1MiB.
        max_frame_size: Some(1.mebibytes().as_u64() as usize),
        // Use the default values for the rest.
        ..Default::default()
    });

    ws::Stream! { ws =>
        for await message in ws {
            yield message?;
        }
    }
}

Original tungstenite Documentation Follows

The configuration for WebSocket connection.

Fields

max_send_queue: Option<usize>

The size of the send queue. You can use it to turn on/off the backpressure features. None means here that the size of the queue is unlimited. The default value is the unlimited queue.

max_message_size: Option<usize>

The maximum size of a message. None means no size limit. The default value is 64 MiB which should be reasonably big for all normal use-cases but small enough to prevent memory eating by a malicious user.

max_frame_size: Option<usize>

The maximum size of a single message frame. None means no size limit. The limit is for frame payload NOT including the frame header. The default value is 16 MiB which should be reasonably big for all normal use-cases but small enough to prevent memory eating by a malicious user.

accept_unmasked_frames: bool

When set to true, the server will accept and handle unmasked frames from the client. According to the RFC 6455, the server must close the connection to the client in such cases, however it seems like there are some popular libraries that are sending unmasked frames, ignoring the RFC. By default this option is set to false, i.e. according to RFC 6455.

Trait Implementations

impl Clone for WebSocketConfig

fn clone(&self) -> WebSocketConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketConfig

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

Formats the value using the given formatter.

impl Default for WebSocketConfig

fn default() -> WebSocketConfig

Returns the “default value” for a type.

impl Copy for WebSocketConfig