Struct libp2p::core::connection::Connection

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

A multiplexed connection to a peer with an associated ConnectionHandler.

Implementations

impl<TMuxer, THandler> Connection<TMuxer, THandler> where
    THandler: ConnectionHandler<Substream = SubstreamRef<Arc<TMuxer>>>,
    TMuxer: StreamMuxer, 

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

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 as ConnectionHandler>::InEvent)

Notifies the connection handler of an event.

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

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

pub fn poll(
    self: Pin<&mut Connection<TMuxer, THandler>>,
    cx: &mut Context<'_>
) -> Poll<Result<Event<<THandler as ConnectionHandler>::OutEvent>, ConnectionError<<THandler as ConnectionHandler>::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
    THandler: ConnectionHandler<Substream = SubstreamRef<Arc<TMuxer>>> + Debug,
    TMuxer: StreamMuxer, 

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

Formats the value using the given formatter.

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