Struct libp2p_core::connection::Connection

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>>, 

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

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

pub fn handler(&self) -> &THandler

Returns a reference to the ConnectionHandler

pub fn handler_mut(&mut self) -> &mut THandler

Returns a mutable reference to the ConnectionHandler

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

Notifies the connection handler of an event.

pub fn close(self) -> (THandler, Close<TMuxer>)

Begins an orderly shutdown of the connection, returning the connection handler and 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>>>

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, 

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

Formats the value using the given formatter.

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