# actix_web::ws::Client - Rust
API documentation for the Rust `Client` struct in crate `actix_web`.
Keywords: rust, rustlang, rust-lang, Client

# Struct actix_web::ws::Client [−] [src]

    pub struct Client { /* fields omitted */ }

`WebSocket` client

Example of `WebSocket` client usage is available in websocket example

## Methods

###

`impl Client`

[src]

####

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

[src]

Create new websocket connection

####

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

[src]

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>,`

[src]

Set supported websocket protocols

####

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

[src]

Set cookie for handshake request

####

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

[src]

Set request Origin

####

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

[src]

Set max frame size

By default max size is set to 64kb

####

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

[src]

Set write buffer capacity

Default buffer capacity is 32kb

####

`pub fn no_masking(self) -> Self`

[src]

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,`

[src]

Set request header

####

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

[src]

Set websocket handshake timeout

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

####

`pub fn connect(&mut self) -> ClientHandshake`

[src]

Connect to websocket server and do ws handshake

## Auto Trait Implementations

###

`impl !Send for Client`

###

`impl !Sync for Client`

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g. `str,u8` or `String,struct:Vec,test`)