Struct libp2p::websocket::WsConfig

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

A Websocket transport.

DO NOT wrap this transport with a DNS transport if you want Secure Websockets to work.

A Secure Websocket transport needs to wrap DNS transport to resolve domain names after they are checked against the remote certificates. Use a combination of DNS and TCP transports to build a Secure Websocket transport.

If you don’t need Secure Websocket’s support, use a plain TCP transport as an inner transport.

Dependencies

This transport requires the zlib shared library to be installed on the system.

Future releases might lift this requirement, see https://github.com/paritytech/soketto/issues/72.

Examples

Secure Websocket transport:

let mut transport = websocket::WsConfig::new(dns::async_std::Transport::system(
    tcp::async_io::Transport::new(tcp::Config::default()),
).await.unwrap());

let rcgen_cert = generate_simple_self_signed(vec!["localhost".to_string()]).unwrap();
let priv_key = websocket::tls::PrivateKey::new(rcgen_cert.serialize_private_key_der());
let cert = websocket::tls::Certificate::new(rcgen_cert.serialize_der().unwrap());
transport.set_tls_config(websocket::tls::Config::new(priv_key, vec![cert]).unwrap());

let id = transport.listen_on(ListenerId::next(), "/ip4/127.0.0.1/tcp/0/wss".parse().unwrap()).unwrap();

let addr = future::poll_fn(|cx| Pin::new(&mut transport).poll(cx)).await.into_new_address().unwrap();
println!("Listening on {addr}");

Plain Websocket transport:

let mut transport = websocket::WsConfig::new(
    tcp::async_io::Transport::new(tcp::Config::default()),
);

let id = transport.listen_on(ListenerId::next(), "/ip4/127.0.0.1/tcp/0/ws".parse().unwrap()).unwrap();

let addr = future::poll_fn(|cx| Pin::new(&mut transport).poll(cx)).await.into_new_address().unwrap();
println!("Listening on {addr}");

Implementations

impl<T> WsConfig<T>

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

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.

Trait Implementations

impl<T> Debug for WsConfig<T>

where T: Debug + Transport, <T as Transport>::Output: AsyncRead + AsyncWrite + Send + Unpin + 'static + Debug,

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

Formats the value using the given formatter.

impl<T> Transport for WsConfig<T>

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

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>>, 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>>, 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, id: ListenerId, addr: Multiaddr, ) -> Result<(), TransportError<<WsConfig<T> as Transport>::Error>>

Listens on the given Multiaddr for inbound connections with a provided ListenerId.

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 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: Error + 'static,

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.