Struct libp2p_core::connection::Connection[−][src]

pub struct Connection<TMuxer, THandler> where
    TMuxer: StreamMuxer,
    THandler: ConnectionHandler<Substream = Substream<TMuxer>>,  { /* fields omitted */ }

A multiplexed connection to a peer with an associated ConnectionHandler.

Implementations

impl<TMuxer, THandler> Connection<TMuxer, THandler> where
    TMuxer: StreamMuxer,
    THandler: ConnectionHandler<Substream = Substream<TMuxer>>, [src]

pub fn new(muxer: TMuxer, handler: THandler) -> Self[src]

Builds a new Connection from the given substream multiplexer and connection handler.

pub fn handler(&self) -> &THandler[src]

Returns a reference to the ConnectionHandler

pub fn handler_mut(&mut self) -> &mut THandler[src]

Returns a mutable reference to the ConnectionHandler

pub fn inject_event(&mut self, event: THandler::InEvent)[src]

Notifies the connection handler of an event.

pub fn close(self) -> Close<TMuxer>ⓘ

Notable traits for Close<TMuxer>

impl<TMuxer> Future for Close<TMuxer> where
    TMuxer: StreamMuxer,  type Output = Result<(), IoError>;
[src]

Begins an orderly shutdown of the connection, returning a Future that resolves when connection shutdown is complete.

pub fn poll(
    self: Pin<&mut Self>,
    cx: &mut Context<'_>
) -> Poll<Result<Event<THandler::OutEvent>, ConnectionError<THandler::Error>>>[src]

Polls the connection for events produced by the associated handler as a result of I/O activity on the substream multiplexer.

Trait Implementations

impl<TMuxer, THandler> Debug for Connection<TMuxer, THandler> where
    TMuxer: StreamMuxer,
    THandler: ConnectionHandler<Substream = Substream<TMuxer>> + Debug, [src]

impl<TMuxer, THandler> Unpin for Connection<TMuxer, THandler> where
    TMuxer: StreamMuxer,
    THandler: ConnectionHandler<Substream = Substream<TMuxer>>, [src]

Auto Trait Implementations

impl<TMuxer, THandler> RefUnwindSafe for Connection<TMuxer, THandler> where
    THandler: RefUnwindSafe,
    TMuxer: RefUnwindSafe,
    <THandler as ConnectionHandler>::OutboundOpenInfo: RefUnwindSafe,
    <TMuxer as StreamMuxer>::OutboundSubstream: RefUnwindSafe, [src]

impl<TMuxer, THandler> Send for Connection<TMuxer, THandler> where
    THandler: Send,
    TMuxer: Send + Sync,
    <THandler as ConnectionHandler>::OutboundOpenInfo: Send,
    <TMuxer as StreamMuxer>::OutboundSubstream: Send, [src]

impl<TMuxer, THandler> Sync for Connection<TMuxer, THandler> where
    THandler: Sync,
    TMuxer: Send + Sync,
    <THandler as ConnectionHandler>::OutboundOpenInfo: Sync,
    <TMuxer as StreamMuxer>::OutboundSubstream: Sync, [src]

impl<TMuxer, THandler> UnwindSafe for Connection<TMuxer, THandler> where
    THandler: UnwindSafe,
    TMuxer: RefUnwindSafe,
    <THandler as ConnectionHandler>::OutboundOpenInfo: RefUnwindSafe + UnwindSafe,
    <TMuxer as StreamMuxer>::OutboundSubstream: RefUnwindSafe + UnwindSafe, [src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,