Struct salvo::prelude::WebSocketUpgrade

pub struct WebSocketUpgrade { /* private fields */ }

Available on crate feature ws only.

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 WebSocketUpgrade

pub fn new() -> WebSocketUpgrade

Create new WebSocketUpgrade.

pub fn with_config(config: WebSocketConfig) -> WebSocketUpgrade

Create new WebSocketUpgrade with config.

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

Sets the size of the internal message send queue.

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

Sets the maximum message size (defaults to 64 megabytes)

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

Sets the maximum frame size (defaults to 16 megabytes)

pub async fn upgrade<F, Fut>(
    &self,
    req: &mut Request,
    res: &mut Response,
    callback: F
) -> impl Future<Output = Result<(), StatusError>>where
    F: 'static + FnOnce(WebSocket) -> Fut + Send,
    Fut: 'static + Future<Output = ()> + Send,

Upgrade websocket request.

Trait Implementations

impl Default for WebSocketUpgrade

fn default() -> WebSocketUpgrade

Returns the “default value” for a type.