Struct libp2p_websocket::framed::WsConfig

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

A Websocket transport whose output type is a [Stream] and [Sink] of frame payloads which does not implement [AsyncRead] or [AsyncWrite]. See crate::WsConfig if you require the latter.

Implementations

impl<T> WsConfig<T>

pub fn new(transport: T) -> Self

Create a new websocket transport based on another 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: 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 + Send + Unpin + 'static,
    T::Error: Send + 'static,
    T::Dial: Send + 'static,
    T::ListenerUpgrade: Send + 'static,
    T::Output: AsyncRead + AsyncWrite + Unpin + Send + 'static,

type Output = Connection<<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 ListenerUpgrade = Pin<Box<dyn Future<Output = Result<<WsConfig<T> as Transport>::Output, <WsConfig<T> as Transport>::Error>> + Send + 'static, Global>>

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

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

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

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

Listens on the given [Multiaddr] for inbound connections.

fn remove_listener(&mut self, id: ListenerId) -> bool

Remove a listener.

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

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

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

As Transport::dial but has the local node act as a listener on the outgoing 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 poll(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<TransportEvent<Self::ListenerUpgrade, Self::Error>>

Poll for TransportEvents.

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

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,

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,
    F: TryFuture<Ok = O>,
    <F as TryFuture>::Error: 'static + Error,

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.