Struct libp2p::websocket::framed::WsConfig

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

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

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

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

Performs the conversion.

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: Unpin,
    <T as Transport>::Output: Send,
    <T as Transport>::Output: '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 Listener = Pin<Box<dyn Stream<Item = Result<ListenerEvent<<WsConfig<T> as Transport>::ListenerUpgrade, <WsConfig<T> as Transport>::Error>, <WsConfig<T> as Transport>::Error>> + 'static + Send, Global>>

A stream of Outputs for inbound connections.

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

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

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

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

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

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

pub 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 the transport into an abstract boxed (i.e. heap-allocated) transport.

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

Applies a function on the connections created by the transport.

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

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

pub fn or_transport<U>(self, other: U) -> OrTransport<Self, U> where
    U: Transport,
    <U as Transport>::Error: 'static, 

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

pub fn and_then<C, F, O>(self, f: C) -> AndThen<Self, C> where
    C: FnOnce(Self::Output, ConnectedPoint) -> F + Clone,
    F: TryFuture<Ok = O>,
    <F as TryFuture>::Error: Error,
    <F as TryFuture>::Error: 'static, 

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

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

Adds a timeout to the connection setup (including upgrades) for all inbound and outbound connections established through the transport.

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

Adds a timeout to the connection setup (including upgrades) for all outbound connections established through the transport.

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

Adds a timeout to the connection setup (including upgrades) for all inbound connections established through the transport.

pub fn upgrade(self, version: Version) -> Builder<Self> where
    Self::Error: 'static, 

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