Struct awc::ws::WebsocketsRequest

pub struct WebsocketsRequest { /* fields omitted */ }

WebSocket connection

Methods

impl WebsocketsRequest

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<'c>(self, cookie: Cookie<'c>) -> Self

Set a cookie

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 server_mode(self) -> Self

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

pub fn no_default_headers(self) -> Self

Do not add default request headers. By default Date and User-Agent headers are set.

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

Append a header.

Header gets appended to existing header. To override header use set_header() method.

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

Insert a header, replaces existing header.

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

Insert a header only if it is not yet set.

pub fn basic_auth<U, P>(self, username: U, password: Option<P>) -> Self where
    U: Display,
    P: Display, 

Set HTTP basic authorization header

pub fn bearer_auth<T>(self, token: T) -> Self where
    T: Display, 

Set HTTP bearer authentication header

pub fn connect(
    self
) -> impl Future<Item = (ClientResponse, Framed<BoxedSocket, Codec>), Error = WsClientError>

Complete request construction and connect to a websockets server.