Struct libp2prs_websocket::framed::WsConfig

pub struct WsConfig { /* 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 WsConfig

pub fn new(transport: ITransport<TcpTransStream>) -> Self

Create a new websocket transport based on another transport.

Trait Implementations

impl Clone for WsConfig

pub fn clone(&self) -> WsConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WsConfig

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

Formats the value using the given formatter.

impl From<WsConfig> for WsConfig

pub fn from(framed: WsConfig) -> Self

Performs the conversion.

impl Transport for WsConfig

type Output = Connection<TlsOrPlain<TcpTransStream>>

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

pub fn listen_on(
    &mut self,
    addr: Multiaddr
) -> Result<IListener<Self::Output>, TransportError>

Listens on the given [Multiaddr], producing a IListener which can be used to accept new inbound connections.

pub fn dial<'life0, 'async_trait>(
    &'life0 mut self,
    addr: Multiaddr
) -> Pin<Box<dyn Future<Output = Result<Self::Output, TransportError>> + Send + 'async_trait>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

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

pub fn box_clone(&self) -> ITransport<Self::Output>

Clones the transport and returns the trait object.

pub fn protocols(&self) -> Vec<u32>

Returns the [Multiaddr] protocol supported by the 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.