Struct WsConfig

pub struct WsConfig<T> { /* private fields */ }

A Websocket transport.

Implementations

impl<T> WsConfig<T>

pub fn new(transport: T) -> Self

Create a new websocket transport based on the given 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<T: Clone> Clone for WsConfig<T>

fn clone(&self) -> WsConfig<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for WsConfig<T>

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

Formats the value using the given formatter.

impl<T> From<WsConfig<T>> for WsConfig<T>

fn from(framed: WsConfig<T>) -> Self

Converts to this type from the input type.

impl<T> Transport for WsConfig<T>

where T: Transport + Send + Clone + 'static, T::Error: Send + 'static, T::Dial: Send + 'static, T::Listener: Send + 'static, T::ListenerUpgrade: Send + 'static, T::Output: AsyncRead + AsyncWrite + Unpin + Send + 'static,

type Output = RwStreamSink<BytesConnection<<T as Transport>::Output>>

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

type Error = Error<<T as Transport>::Error>

An error that occurred during connection setup.

type Listener = MapStream<Pin<Box<dyn Stream<Item = Result<ListenerEvent<Pin<Box<dyn Future<Output = Result<Connection<<T as Transport>::Output>, Error<<T as Transport>::Error>>> + Send>>, Error<<T as Transport>::Error>>, Error<<T as Transport>::Error>>> + Send>>, fn(Connection<<T as Transport>::Output>, ConnectedPoint) -> RwStreamSink<BytesConnection<<T as Transport>::Output>>>

A stream of Outputs for inbound connections.

type ListenerUpgrade = MapFuture<Pin<Box<dyn Future<Output = Result<Connection<<T as Transport>::Output>, Error<<T as Transport>::Error>>> + Send>>, fn(Connection<<T as Transport>::Output>, ConnectedPoint) -> RwStreamSink<BytesConnection<<T as Transport>::Output>>>

A pending Output for an inbound connection, obtained from the Listener stream.

type Dial = MapFuture<Pin<Box<dyn Future<Output = Result<Connection<<T as Transport>::Output>, Error<<T as Transport>::Error>>> + Send>>, fn(Connection<<T as Transport>::Output>, ConnectedPoint) -> RwStreamSink<BytesConnection<<T as Transport>::Output>>>

A pending Output for an outbound connection, obtained from dialing.

fn listen_on( self, addr: Multiaddr, ) -> Result<Self::Listener, TransportError<Self::Error>>

Listens on the given Multiaddr, producing a stream of pending, inbound connections and addresses this transport is listening on (cf. ListenerEvent).

fn dial( self, addr: Multiaddr, ) -> Result<Self::Dial, TransportError<Self::Error>>

Dials the given Multiaddr, returning a future for a pending outbound connection.

fn address_translation( &self, server: &Multiaddr, observed: &Multiaddr, ) -> Option<Multiaddr>

Performs a transport-specific mapping of an address observed by a remote onto a local listen address to yield an address for the local node that may be reachable for other peers.

fn boxed(self) -> Boxed<Self::Output>

where Self: Sized + Transport + Clone + Send + Sync + 'static, Self::Dial: Send + 'static, Self::Listener: Send + 'static, Self::ListenerUpgrade: Send + 'static, Self::Error: Send + Sync,

Boxes the transport, including custom transport errors.

fn map<F, O>(self, f: F) -> Map<Self, F>

where Self: Sized, F: FnOnce(Self::Output, ConnectedPoint) -> O + Clone,

Applies a function on the connections created by the transport.

fn map_err<F, E>(self, f: F) -> MapErr<Self, F>

where Self: Sized, F: FnOnce(Self::Error) -> E + Clone,

Applies a function on the errors generated by the futures of the transport.

fn or_transport<U>(self, other: U) -> OrTransport<Self, U>

where Self: Sized, U: Transport, <U as Transport>::Error: 'static,

Adds a fallback transport that is used when encountering errors while establishing inbound or outbound connections.

fn and_then<C, F, O>(self, f: C) -> AndThen<Self, C>

where Self: Sized, C: FnOnce(Self::Output, ConnectedPoint) -> F + Clone, F: TryFuture<Ok = O>, <F as TryFuture>::Error: Error + 'static,

Applies a function producing an asynchronous result to every connection created by this transport.

fn upgrade(self, version: Version) -> Builder<Self>

where Self: Sized, Self::Error: 'static,

Begins a series of protocol upgrades via an upgrade::Builder.