Struct actix_web::ws::Client

pub struct Client { /* fields omitted */ }

WebSocket client

Example of WebSocket client usage is available in websocket example

Methods

impl Client

pub fn new<S: AsRef<str>>(uri: S) -> Client

Create new websocket connection

pub fn with_connector<S: AsRef<str>>(
    uri: S,
    conn: Addr<ClientConnector>
) -> Client

Create new websocket connection with custom ClientConnector

pub fn protocols<U, V>(self, protos: U) -> Self where
    U: IntoIterator<Item = V> + 'static,
    V: AsRef<str>, 

Set supported websocket protocols

pub fn cookie(self, cookie: Cookie) -> Self

Set cookie for handshake request

pub fn origin<V>(self, origin: V) -> Self where
    HeaderValue: HttpTryFrom<V>, 

Set request Origin

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

Set max frame size

By default max size is set to 64kb

pub fn write_buffer_capacity(self, cap: usize) -> Self

Set write buffer capacity

Default buffer capacity is 32kb

pub fn no_masking(self) -> Self

Disable payload masking. By default ws client masks frame payload.

pub fn header<K, V>(self, key: K, value: V) -> Self where
    HeaderName: HttpTryFrom<K>,
    V: IntoHeaderValue, 

Set request header

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

Set websocket handshake timeout

Handshake timeout is a total time for successful handshake. Default value is 5 seconds.

pub fn connect(&mut self) -> ClientHandshake

Connect to websocket server and do ws handshake