Struct libp2p::websocket::WsConfig

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

A Websocket transport.

Methods

impl<T> WsConfig<T>

pub fn new(transport: T) -> WsConfig<T>

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 WsConfig<T>

Set max. number of redirects to follow.

pub fn max_data_size(&self) -> u64

Get the max. frame data size we support.

pub fn set_max_data_size(&mut self, size: u64) -> &mut WsConfig<T>

Set the max. frame data size we support.

pub fn set_tls_config(&mut self, c: Config) -> &mut WsConfig<T>

Set the TLS configuration if TLS support is desired.

pub fn use_deflate(&mut self, flag: bool) -> &mut WsConfig<T>

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

Trait Implementations

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

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

Performs the conversion.

impl<T> Clone for WsConfig<T> where
    T: Clone, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T> Transport for WsConfig<T> where
    T: Transport + Send + Clone + 'static,
    <T as Transport>::Error: Send,
    <T as Transport>::Error: 'static,
    <T as Transport>::Dial: Send,
    <T as Transport>::Dial: 'static,
    <T as Transport>::Listener: Send,
    <T as Transport>::Listener: 'static,
    <T as Transport>::ListenerUpgrade: Send,
    <T as Transport>::ListenerUpgrade: 'static,
    <T as Transport>::Output: AsyncRead,
    <T as Transport>::Output: AsyncWrite,
    <T as Transport>::Output: Send,
    <T as Transport>::Output: '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<Box<dyn Stream<Item = ListenerEvent<Box<dyn Future<Item = BytesConnection<<T as Transport>::Output>, Error = Error<<T as Transport>::Error>> + 'static + Send>>, Error = Error<<T as Transport>::Error>> + 'static + Send>, fn(BytesConnection<<T as Transport>::Output>, ConnectedPoint) -> RwStreamSink<BytesConnection<<T as Transport>::Output>>>

A stream of Outputs for inbound connections.

type ListenerUpgrade = MapFuture<Box<dyn Future<Item = BytesConnection<<T as Transport>::Output>, Error = Error<<T as Transport>::Error>> + 'static + Send>, fn(BytesConnection<<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<Box<dyn Future<Item = BytesConnection<<T as Transport>::Output>, Error = Error<<T as Transport>::Error>> + 'static + Send>, fn(BytesConnection<<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<<WsConfig<T> as Transport>::Listener, TransportError<<WsConfig<T> as Transport>::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<<WsConfig<T> as Transport>::Dial, TransportError<<WsConfig<T> as Transport>::Error>>

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

fn boxed(self) -> Boxed<Self::Output, Self::Error> where
    Self: Clone + Send + Sync + 'static,
    Self::Dial: Send,
    Self::Dial: 'static,
    Self::Listener: Send,
    Self::Listener: 'static,
    Self::ListenerUpgrade: Send,
    Self::ListenerUpgrade: 'static, 

Turns this Transport into an abstract boxed transport.

fn map<F, O>(self, map: F) -> Map<Self, F> where
    F: FnOnce(Self::Output, ConnectedPoint) -> O + Clone, 

Applies a function on the connections created by the transport.

fn map_err<F, TNewErr>(self, map_err: F) -> MapErr<Self, F> where
    F: FnOnce(Self::Error) -> TNewErr + Clone, 

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

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

Builds a new transport that falls back to another transport when encountering errors on dialing or listening for connections.

fn with_upgrade<U, O, E>(self, upgrade: U) -> Upgrade<Self, U> where
    U: InboundUpgrade<Self::Output, Output = O, Error = E> + OutboundUpgrade<Self::Output, Output = O, Error = E>,
    Self::Output: AsyncRead,
    Self::Output: AsyncWrite, 

Wraps this transport inside an [Upgrade].

fn and_then<C, F, O>(self, upgrade: C) -> AndThen<Self, C> where
    C: FnOnce(Self::Output, ConnectedPoint) -> F + Clone,
    F: IntoFuture<Item = O>, 

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

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

Adds a timeout to the connection setup (including upgrades) for all inbound and outbound connection attempts.

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

Adds a timeout to the connection setup (including upgrades) for all outbound connection attempts.

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

Adds a timeout to the connection setup (including upgrades) for all inbound connection attempts.