Struct WebSocketTransport 

pub struct WebSocketTransport { /* private fields */ }

The built-in transport: tokio-tungstenite over rustls, trusting the platform’s root certificates. It handles the upgrade handshake, answers pings, and reassembles fragmented messages. The request carries User-Agent: actioncable/<version> unless the caller set one, and never negotiates extensions.

Implementations

impl WebSocketTransport

pub fn new() -> WebSocketTransport

The transport with its defaults: a ten second handshake, a ten second write, and messages up to 8 MiB.

pub fn handshake_timeout(self, timeout: Duration) -> WebSocketTransport

Bounds the TCP connect, the TLS handshake and the upgrade together. Ten seconds by default.

pub fn write_timeout(self, timeout: Duration) -> WebSocketTransport

Bounds one write. A peer that has stopped reading would otherwise hold a perform forever; past the timeout the write fails and the connection is dropped and redialed, the same as a failed read. Ten seconds by default.

pub fn max_message_size(self, bytes: usize) -> WebSocketTransport

The largest message accepted, in bytes. 8 MiB by default.

Trait Implementations

impl Clone for WebSocketTransport

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSocketTransport

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

Formats the value using the given formatter.

impl Default for WebSocketTransport

fn default() -> WebSocketTransport

Returns the “default value” for a type.

impl Transport for WebSocketTransport

fn dial<'life0, 'life1, 'async_trait>( &'life0 self, url: &'life1 str, options: DialOptions, ) -> Pin<Box<dyn Future<Output = Result<Box<dyn Conn>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Opens one connection. options carries the subprotocols the client’s protocols negotiate under and the headers that authorize the request.