Struct libp2p::core::nodes::handled_node::HandledNode

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

A node combined with an implementation of NodeHandler.

Methods

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

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

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 as NodeHandler>::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<(), Error>;

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 HandledNode<TMuxer, THandler>>,
    cx: &mut Context
) -> Poll<Result<<THandler as NodeHandler>::OutEvent, HandledNodeError<<THandler as NodeHandler>::Error>>>

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

Trait Implementations

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

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

Formats the value using the given formatter.

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