Struct WsConfig 

pub struct WsConfig { /* private fields */ }

A Websocket transport.

Implementations

impl WsConfig

pub fn new() -> Self

Create a new websocket transport based on the tcp transport.

pub fn new_with_dns() -> Self

Create a new websocket transport based on the dns transport.

pub fn max_redirects(&self) -> u8

Return the configured maximum number of redirects.

pub fn set_max_redirects(&mut self, max: u8) -> &mut Self

Set max. number of redirects to follow.

pub fn max_data_size(&self) -> usize

Get the max. frame data size we support.

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

Set the max. frame data size we support.

pub fn set_tls_config(&mut self, c: Config) -> &mut Self

Set the TLS configuration if TLS support is desired.

pub fn use_deflate(&mut self, flag: bool) -> &mut Self

Should the deflate extension (RFC 7692) be used if supported?

Trait Implementations

impl Clone for WsConfig

fn clone(&self) -> WsConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for WsConfig

fn default() -> Self

Returns the “default value” for a type.

impl From<WsConfig> for WsConfig

fn from(framed: WsConfig) -> Self

Converts to this type from the input type.

impl Transport for WsConfig

type Output = Connection<EitherOutput<EitherOutput<TlsClientStream<TcpTransStream>, TlsServerStream<TcpTransStream>>, TcpTransStream>>

The result of a connection setup process, including protocol upgrades.

fn listen_on( &mut self, addr: Multiaddr, ) -> Result<IListener<Self::Output>, TransportError>

Listens on the given Multiaddr, producing a IListener which can be used to accept new inbound connections.

fn dial<'life0, 'async_trait>( &'life0 mut self, addr: Multiaddr, ) -> Pin<Box<dyn Future<Output = Result<Self::Output, TransportError>> + Send + 'async_trait>>

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

Dials the given Multiaddr, returning a outbound connection.

fn box_clone(&self) -> ITransport<Self::Output>

Clones the transport and returns the trait object.

fn protocols(&self) -> Vec<u32>

Returns the Multiaddr protocol supported by the transport.

fn timeout(self, timeout: Duration) -> TransportTimeout<Self>

where Self: Sized,

Adds a timeout to the connection setup (including upgrades) for all inbound and outbound connections established through the transport.

fn outbound_timeout(self, timeout: Duration) -> TransportTimeout<Self>

where Self: Sized,

Adds a timeout to the connection setup (including upgrades) for all outbound connections established through the transport.

fn inbound_timeout(self, timeout: Duration) -> TransportTimeout<Self>

where Self: Sized,

Adds a timeout to the connection setup (including upgrades) for all inbound connections established through the transport.