Struct libp2p_quic::GenTransport

pub struct GenTransport<P: Provider> { /* private fields */ }

Implementation of the Transport trait for QUIC.

By default only QUIC Version 1 (RFC 9000) is supported. In the [Multiaddr] this maps to [libp2p_core::multiaddr::Protocol::QuicV1]. The [libp2p_core::multiaddr::Protocol::Quic] codepoint is interpreted as QUIC version draft-29 and only supported if Config::support_draft_29 is set to true. Note that in that case servers support both version an all QUIC listening addresses.

Version draft-29 should only be used to connect to nodes from other libp2p implementations that do not support QuicV1 yet. Support for it will be removed long-term. See https://github.com/multiformats/multiaddr/issues/145.

Implementations

impl<P: Provider> GenTransport<P>

pub fn new(config: Config) -> Self

Create a new GenTransport with the given Config.

Trait Implementations

impl<P: Debug + Provider> Debug for GenTransport<P>

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

Formats the value using the given formatter.

impl<P: Provider> Transport for GenTransport<P>

type Output = (PeerId, Connection)

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

type Error = Error

An error that occurred during connection setup.

type ListenerUpgrade = Connecting

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

type Dial = Pin<Box<dyn Future<Output = Result<<GenTransport<P> as Transport>::Output, <GenTransport<P> 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 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 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 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: 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.