Struct libp2p::core::nodes::node::NodeStream

pub struct NodeStream<TMuxer, TUserData> where
    TMuxer: StreamMuxer,  { /* fields omitted */ }

Implementation of Stream that handles a node.

The stream will receive substreams and can be used to open new outgoing substreams. Destroying the NodeStream will not close the existing substreams.

The stream will close once both the inbound and outbound channels are closed, and no more outbound substream attempt is pending.

Methods

impl<TMuxer, TUserData> NodeStream<TMuxer, TUserData> where
    TMuxer: StreamMuxer, 

pub fn new(muxer: TMuxer) -> NodeStream<TMuxer, TUserData>

Creates a new node events stream.

pub fn open_substream(&mut self, user_data: TUserData)

Starts the process of opening a new outbound substream.

After calling this method, polling the stream should eventually produce either an OutboundSubstream event or an OutboundClosed event containing the user data that has been passed to this method.

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.

#[must_use] pub fn close(self) -> (Close<TMuxer>, Vec<TUserData>)

Destroys the node stream and returns all the pending outbound substreams, plus an object that signals the remote that we shut down the connection.

pub fn cancel_outgoing(&mut self) -> Vec<TUserData>

Destroys all outbound streams and returns the corresponding user data.

pub fn poll(
    &mut self,
    cx: &mut Context
) -> Poll<Result<NodeEvent<TMuxer, TUserData>, Error>>

Provides an API similar to Future.

Trait Implementations

impl<TMuxer, TUserData> Debug for NodeStream<TMuxer, TUserData> where
    TMuxer: StreamMuxer, 

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

Formats the value using the given formatter.

impl<TMuxer, TUserData> Drop for NodeStream<TMuxer, TUserData> where
    TMuxer: StreamMuxer, 

fn drop(&mut self)

Executes the destructor for this type.