Struct libp2p_core::connection::EstablishedConnection

pub struct EstablishedConnection<'a, TInEvent> { /* fields omitted */ }

An established connection in a pool.

Implementations

impl<TInEvent> EstablishedConnection<'_, TInEvent>

pub fn endpoint(&self) -> &ConnectedPoint

Returns information about the connected endpoint.

pub fn peer_id(&self) -> PeerId

Returns the identity of the connected peer.

pub fn id(&self) -> ConnectionId

Returns the local connection ID.

pub fn notify_handler(&mut self, event: TInEvent) -> Result<(), TInEvent>

(Asynchronously) sends an event to the connection handler.

If the handler is not ready to receive the event, either because it is busy or the connection is about to close, the given event is returned with an Err.

If execution of this method is preceded by successful execution of poll_ready_notify_handler without another intervening execution of notify_handler, it only fails if the connection is now about to close.

pub fn poll_ready_notify_handler(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<Result<(), ()>>

Checks if notify_handler is ready to accept an event.

Returns Ok(()) if the handler is ready to receive an event via notify_handler.

Returns Err(()) if the background task associated with the connection is terminating and the connection is about to close.

pub fn start_close(self)

Initiates a graceful close of the connection.

Has no effect if the connection is already closing.

Trait Implementations

impl<TInEvent> Debug for EstablishedConnection<'_, TInEvent> where
    TInEvent: Debug, 

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

Formats the value using the given formatter.