Struct WsConfig

pub struct WsConfig { /* private fields */ }

config for WebSockets.

example:

use actix_web::{App, HttpServer};
use actix_send_websocket::WsConfig;

#[actix_web::main]
async fn main() -> std::io::Result<()> {
    HttpServer::new(||
        App::new().app_data(WsConfig::new().disable_heartbeat())
    )
    .bind("127.0.0.1:8080")?
    .run()
    .await
}

Implementations

impl WsConfig

pub fn new() -> Self

pub fn codec(self, codec: Codec) -> Self

Set WebSockets protocol codec.

pub fn protocols(self, protocols: Vec<String>) -> Self

Set specific protocol strings. protocols is a sequence of known protocols. On successful handshake, the returned response headers contain the first protocol in this list which the server also knows.

pub fn heartbeat(self, dur: Duration) -> Self

Set the heartbeat check interval.

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

Set the timeout duration for client does not send Ping for too long.

pub fn disable_heartbeat(self) -> Self

Disable heartbeat check.

pub fn enable_server_send_heartbeat(self) -> Self

Enable the heartbeat from Server side to Client.

Trait Implementations

impl Clone for WsConfig

fn clone(&self) -> WsConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for WsConfig

fn default() -> Self

Returns the “default value” for a type.