Struct libp2p::websocket_websys::Transport

pub struct Transport { /* private fields */ }

Available on crate feature websocket-websys only.

A Websocket transport that can be used in a wasm environment.

Example

To create an authenticated transport instance with Noise protocol and Yamux:

let local_key = Keypair::generate_ed25519();
let transport = libp2p_websocket_websys::Transport::default()
    .upgrade(Version::V1)
    .authenticate(noise::Config::new(&local_key).unwrap())
    .multiplex(yamux::Config::default())
    .boxed();

Trait Implementations

impl Default for Transport

fn default() -> Transport

Returns the “default value” for a type.

impl Transport for Transport

type Output = Connection

The result of a connection setup process, including protocol upgrades.

type Error = Error

An error that occurred during connection setup.

type ListenerUpgrade = Ready<Result<<Transport as Transport>::Output, <Transport as Transport>::Error>>

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

type Dial = Pin<Box<dyn Future<Output = Result<<Transport as Transport>::Output, <Transport as Transport>::Error>> + Send>>

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

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

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

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

As Transport::dial but has the local node act as a listener on the outgoing connection.

fn poll( self: Pin<&mut Transport>, _cx: &mut Context<'_> ) -> Poll<TransportEvent<<Transport as Transport>::ListenerUpgrade, <Transport as Transport>::Error>>

Poll for TransportEvents.

fn address_translation( &self, _listen: &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 boxed(self) -> Boxed<Self::Output>

where Self: Sized + Send + Unpin + 'static, Self::Dial: Send + 'static, Self::ListenerUpgrade: Send + 'static, Self::Error: Send + Sync,

Boxes the transport, including custom transport errors.

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.