Struct libp2p::websocket::WsConfig

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

Represents the configuration for a websocket transport capability for libp2p. Must be put on top of another Transport.

This implementation of Transport accepts any address that ends with /ws or /wss, and will try to pass the underlying multiaddress to the underlying Transport.

Note that the underlying multiaddr is /dns4/... or /dns6/..., then this library will pass the domain name in the headers of the request. This is important is the listener is behind an HTTP proxy.

Note: /wss is only supported for dialing and not listening.

Methods

impl<T> WsConfig<T>

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

Creates a new configuration object for websocket.

The websockets will run on top of the Transport you pass as parameter.

Trait Implementations

impl<T> Transport for WsConfig<T> where
    T: Transport + 'static,
    <T as Transport>::Error: Send,
    <T as Transport>::Dial: Send,
    <T as Transport>::Listener: Send,
    <T as Transport>::ListenerUpgrade: Send,
    <T as Transport>::Output: AsyncRead,
    <T as Transport>::Output: AsyncWrite,
    <T as Transport>::Output: Send, 

type Output = Box<dyn Stream + 'static + Send>

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

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

An error that occurred during connection setup.

type Listener = Box<dyn Stream<Item = ListenerEvent<<WsConfig<T> as Transport>::ListenerUpgrade>, Error = <WsConfig<T> as Transport>::Error> + 'static + Send>

A stream of Outputs for inbound connections.

type ListenerUpgrade = Box<dyn Future<Error = <WsConfig<T> as Transport>::Error, Item = <WsConfig<T> as Transport>::Output> + 'static + Send>

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

type Dial = Box<dyn Future<Error = <WsConfig<T> as Transport>::Error, Item = <WsConfig<T> as Transport>::Output> + 'static + Send>

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

fn listen_on(
    self,
    original_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,
    original_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.

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> 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.