Struct rocket_ws::Config

pub struct Config {
    pub max_send_queue: Option<usize>,
    pub write_buffer_size: usize,
    pub max_write_buffer_size: 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 message) 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>

👎Deprecated

Does nothing, instead use max_write_buffer_size.

write_buffer_size: usize

The target minimum size of the write buffer to reach before writing the data to the underlying stream. The default value is 128 KiB.

If set to 0 each message will be eagerly written to the underlying stream. It is often more optimal to allow them to buffer a little, hence the default value.

Note: flush will always fully write the buffer regardless.

max_write_buffer_size: usize

The max size of the write buffer in bytes. Setting this can provide backpressure in the case the write buffer is filling up due to write errors. The default value is unlimited.

Note: The write buffer only builds up past write_buffer_size when writes to the underlying stream are failing. So the write buffer can not fill up if you are not observing write errors even if not flushing.

Note: Should always be at least write_buffer_size + 1 message and probably a little more depending on error handling strategy.

max_message_size: Option<usize>

The maximum size of an incoming 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 incoming 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