Struct WebsocketServerConfig 

pub struct WebsocketServerConfig { /* private fields */ }

A set of configuration options for the websocket server.

Implementations

impl WebsocketServerConfig

pub fn new(address: SocketAddr) -> Self

Constructs a new WebsocketServerConfig with the given address to listen on.

Examples found in repository

examples/server.rs (line 56)

    async fn start(&self) -> Result<Pid, ExitReason> {
        let address: SocketAddr = "127.0.0.1:1337".parse().unwrap();
        let config = WebsocketServerConfig::new(address);

        WebsocketServer::<MyWebsocketHandler>::new(config)
            .start_link(GenServerOptions::new())
            .await
    }

pub const fn handshake_timeout(self, timeout: Duration) -> Self

Sets the timeout for websocket handshakes.

When tls is enabled, this time includes the tls handshake as well.

pub const fn max_message_size(self, size: Option<usize>) -> Self

Sets 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.

pub const fn max_frame_size(self, size: Option<usize>) -> Self

Sets 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.

Trait Implementations

impl Clone for WebsocketServerConfig

fn clone(&self) -> WebsocketServerConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebsocketServerConfig

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

Formats the value using the given formatter.