Struct ntex::ws::WsClientBuilder

pub struct WsClientBuilder<F, T> { /* fields omitted */ }

WebSocket client builder

Implementations

impl<F, T> WsClientBuilder<F, T> where
    T: Service<Connect<Uri>, Response = Io<F>, Error = ConnectError>, 

pub fn address(&mut self, addr: SocketAddr) -> &mut Self

Set socket address of the server.

This address is used for connection. If address is not provided url’s host name get resolved.

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

Set supported websocket protocols

pub fn cookie(&mut self, cookie: Cookie<'_>) -> &mut Self

Set a cookie

pub fn origin<V, E>(&mut self, origin: V) -> &mut Self where
    HeaderValue: TryFrom<V, Error = E>,
    HttpError: From<E>, 

Set request Origin

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

Set max frame size

By default max size is set to 64kb

pub fn server_mode(&mut self) -> &mut Self

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

pub fn header<K, V>(&mut self, key: K, value: V) -> &mut Self where
    HeaderName: TryFrom<K>,
    HeaderValue: TryFrom<V>,
    <HeaderName as TryFrom<K>>::Error: Into<HttpError>,
    <HeaderValue as TryFrom<V>>::Error: Into<HttpError>, 

Append a header.

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

pub fn set_header<K, V>(&mut self, key: K, value: V) -> &mut Self where
    HeaderName: TryFrom<K>,
    HeaderValue: TryFrom<V>,
    <HeaderName as TryFrom<K>>::Error: Into<HttpError>,
    <HeaderValue as TryFrom<V>>::Error: Into<HttpError>, 

Insert a header, replaces existing header.

pub fn set_header_if_none<K, V>(&mut self, key: K, value: V) -> &mut Self where
    HeaderName: TryFrom<K>,
    HeaderValue: TryFrom<V>,
    <HeaderName as TryFrom<K>>::Error: Into<HttpError>,
    <HeaderValue as TryFrom<V>>::Error: Into<HttpError>, 

Insert a header only if it is not yet set.

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

Set HTTP basic authorization header

pub fn bearer_auth<U>(&mut self, token: U) -> &mut Self where
    U: Display, 

Set HTTP bearer authentication header

pub fn timeout<U: Into<Millis>>(&mut self, timeout: U) -> &mut Self

Set request timeout.

Request timeout is the total time before a response must be received. Default value is 5 seconds.

pub fn connector<F1, T1>(&mut self, connector: T1) -> WsClientBuilder<F1, T1> where
    F1: Filter,
    T1: Service<Connect<Uri>, Response = Io<F1>, Error = ConnectError>, 

Use custom connector

pub fn openssl(
    &mut self,
    connector: SslConnector
) -> WsClientBuilder<SslFilter, Connector<Uri>>

Use openssl connector.

pub fn rustls(
    &mut self,
    config: Arc<ClientConfig>
) -> WsClientBuilder<TlsFilter, Connector<Uri>>

Use rustls connector.

pub fn take(&mut self) -> WsClientBuilder<F, T>

This method construct new WsClientBuilder

pub fn finish(&mut self) -> Result<WsClient<F, T>, WsClientBuilderError>

Complete building process and construct websockets client.

Trait Implementations

impl<F, T> Debug for WsClientBuilder<F, T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.