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: Clone> Clone for WsConfig<T>

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

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

Formats the value using the given formatter.

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

type Output = Box<dyn AsyncStream + Send>

The raw connection to a peer.

type Error = WsError<T::Error>

Error that can happen when dialing or listening.

type Listener = Box<dyn Stream<Item = (Self::ListenerUpgrade, Multiaddr), Error = Self::Error> + Send>

The listener produces incoming connections.

type ListenerUpgrade = Box<dyn Future<Item = Self::Output, Error = Self::Error> + Send>

After a connection has been received, we may need to do some asynchronous pre-processing on it (e.g. an intermediary protocol negotiation). While this pre-processing takes place, we want to be able to continue polling on the listener.

type Dial = Box<dyn Future<Item = Self::Output, Error = Self::Error> + Send>

A future which indicates that we are currently dialing to a peer.

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

Listen on the given multiaddr. Returns a stream of incoming connections, plus a modified version of the Multiaddr. This new Multiaddr is the one that that should be advertised to other nodes, instead of the one passed as parameter.

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

Dial the given multi-addr.

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

Takes a multiaddress we're listening on (server), and tries to convert it to an externally-visible multiaddress. In order to do so, we pass an observed address which a remote node observes for one of our dialers.

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 output of 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 struct that implements Transport that contains both self and other.

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. Whenever a connection that uses this transport is established, it is wrapped inside the 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>, 

Wraps this transport inside an upgrade. Whenever a connection that uses this transport is established, it is wrapped inside the upgrade.

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

Adds a timeout to the connection and upgrade steps for all the sockets created by the transport.

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

Adds a timeout to the connection and upgrade steps for all the outgoing sockets created by the transport.

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

Adds a timeout to the connection and upgrade steps for all the incoming sockets created by the transport.