Struct salvo_extra::ws::WsHandler

pub struct WsHandler { /* fields omitted */ }

Creates a Websocket Handler. Request:

• Method must be GET
• Header connection must be upgrade
• Header upgrade must be websocket
• Header sec-websocket-version must be 13
• Header sec-websocket-key must be set.

Response:

• Status of 101 Switching Protocols
• Header connection: upgrade
• Header upgrade: websocket
• Header sec-websocket-accept with the hash value of the received key.

Implementations

impl WsHandler

pub fn new() -> Self

Create new WsHandler.

pub fn with_config(config: WebSocketConfig) -> Self

Create new WsHandler with config.

pub fn max_send_queue(self, max: usize) -> Self

Set the size of the internal message send queue.

pub fn max_message_size(self, max: usize) -> Self

Set the maximum message size (defaults to 64 megabytes)

pub fn max_frame_size(self, max: usize) -> Self

Set the maximum frame size (defaults to 16 megabytes)

pub fn handle(
    &self,
    req: &mut Request,
    res: &mut Response
) -> Result<impl Future<Output = Option<WebSocket>>, HttpError>

Handle websocket request.

Trait Implementations

impl Default for WsHandler

fn default() -> Self

Returns the “default value” for a type.