Struct disarray_network::WsConfig

pub struct WsConfig<T>where
    T: Transport,
    <T as Transport>::Output: 'static,
    <T as Transport>::Output: AsyncRead,
    <T as Transport>::Output: AsyncWrite,
    <T as Transport>::Output: Send,
    <T as Transport>::Output: Unpin,{ /* private fields */ }

A Websocket transport.

Implementations

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

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

Create a new websocket transport based on the given transport.

*Note: The given transport must be based on TCP/IP and should usually incorporate DNS resolution, though the latter is not strictly necessary if one wishes to only use the Ws protocol with known IP addresses and ports. See libp2p-tcp and libp2p-dns for constructing the inner 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> Debug for WsConfig<T>where
    T: Debug + Transport,
    <T as Transport>::Output: 'static,
    <T as Transport>::Output: AsyncRead,
    <T as Transport>::Output: AsyncWrite,
    <T as Transport>::Output: Send,
    <T as Transport>::Output: Unpin,
    <T as Transport>::Output: Debug,

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

Formats the value using the given formatter.

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

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 ListenerUpgrade = MapFuture<Pin<Box<dyn Future<Output = Result<Connection<<T as Transport>::Output>, Error<<T as Transport>::Error>>> + Send + 'static, Global>>, fn(Connection<<T as Transport>::Output>, ConnectedPoint) -> RwStreamSink<BytesConnection<<T as Transport>::Output>>>

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

type Dial = MapFuture<Pin<Box<dyn Future<Output = Result<Connection<<T as Transport>::Output>, Error<<T as Transport>::Error>>> + Send + 'static, Global>>, fn(Connection<<T as Transport>::Output>, ConnectedPoint) -> RwStreamSink<BytesConnection<<T as Transport>::Output>>>

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

fn listen_on(
    &mut self,
    addr: Multiaddr
) -> Result<ListenerId, TransportError<<WsConfig<T> as Transport>::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<<WsConfig<T> as Transport>::Dial, TransportError<<WsConfig<T> as Transport>::Error>>

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

fn dial_as_listener(
    &mut self,
    addr: Multiaddr
) -> Result<<WsConfig<T> as Transport>::Dial, TransportError<<WsConfig<T> as Transport>::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 WsConfig<T>>,
    cx: &mut Context<'_>
) -> Poll<TransportEvent<<WsConfig<T> as Transport>::ListenerUpgrade, <WsConfig<T> as Transport>::Error>>

Poll for [TransportEvent]s.

fn map<F, O>(self, f: F) -> Map<Self, F>where
    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
    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
    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
    C: FnOnce(Self::Output, ConnectedPoint) -> F,
    F: TryFuture<Ok = O>,
    <F as TryFuture>::Error: 'static,
    <F as TryFuture>::Error: Error,

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

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

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