Struct libp2p_core::nodes::handled_node::HandledNode

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

A node combined with an implementation of NodeHandler.

Methods

impl<TMuxer, THandler> HandledNode<TMuxer, THandler> where
    TMuxer: StreamMuxer,
    THandler: NodeHandler<Substream = Substream<TMuxer>>, 

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

Builds a new HandledNode.

pub fn handler(&self) -> &THandler

Returns a reference to the NodeHandler

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

Returns a mutable reference to the NodeHandler

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

Injects an event to the handler. Has no effect if the handler is closing.

pub fn is_remote_acknowledged(&self) -> bool

Returns true if the remote has shown any sign of activity after the muxer has been open.

See StreamMuxer::is_remote_acknowledged.

Important traits for Close<TMuxer>

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

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

Indicates to the handled node that it should shut down. After calling this method, the Stream will end in the not-so-distant future.

pub fn poll(
    self: Pin<&mut Self>,
    cx: &mut Context
) -> Poll<Result<THandler::OutEvent, HandledNodeError<THandler::Error>>>

API similar to Future::poll that polls the node for events.

Trait Implementations

impl<TMuxer, THandler> Debug for HandledNode<TMuxer, THandler> where
    TMuxer: StreamMuxer,
    THandler: NodeHandler<Substream = Substream<TMuxer>> + Debug, 

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

Formats the value using the given formatter.

impl<TMuxer, THandler> Unpin for HandledNode<TMuxer, THandler> where
    TMuxer: StreamMuxer,
    THandler: NodeHandler<Substream = Substream<TMuxer>>,