Struct libp2p_core::nodes::handled_node_tasks::HandledNodesTasks

pub struct HandledNodesTasks<TInEvent, TOutEvent, TIntoHandler, TReachErr, THandlerErr, TUserData, TPeerId = PeerId> { /* fields omitted */ }

Implementation of Stream that handles a collection of nodes.

Methods

impl<TInEvent, TOutEvent, TIntoHandler, TReachErr, THandlerErr, TUserData, TPeerId> HandledNodesTasks<TInEvent, TOutEvent, TIntoHandler, TReachErr, THandlerErr, TUserData, TPeerId>

pub fn new() -> Self

Creates a new empty collection.

pub fn add_reach_attempt<TFut, TMuxer>(
    &mut self,
    future: TFut,
    user_data: TUserData,
    handler: TIntoHandler
) -> TaskId where
    TFut: Future<Item = (TPeerId, TMuxer), Error = TReachErr> + Send + 'static,
    TIntoHandler: IntoNodeHandler<TPeerId> + Send + 'static,
    TIntoHandler::Handler: NodeHandler<Substream = Substream<TMuxer>, InEvent = TInEvent, OutEvent = TOutEvent, Error = THandlerErr> + Send + 'static,
    TReachErr: Error + Send + 'static,
    THandlerErr: Error + Send + 'static,
    TInEvent: Send + 'static,
    TOutEvent: Send + 'static,
    <TIntoHandler::Handler as NodeHandler>::OutboundOpenInfo: Send + 'static,
    TMuxer: StreamMuxer + Send + Sync + 'static,
    TMuxer::OutboundSubstream: Send + 'static,
    TPeerId: Send + 'static, 

Adds to the collection a future that tries to reach a node.

This method spawns a task dedicated to resolving this future and processing the node's events.

pub fn broadcast_event(&mut self, event: &TInEvent) where
    TInEvent: Clone, 

Sends an event to all the tasks, including the pending ones.

pub fn task(&mut self, id: TaskId) -> Option<Task<TInEvent, TUserData>>

Grants access to an object that allows controlling a task of the collection.

Returns None if the task id is invalid.

pub fn tasks<'a>(&'a self) -> impl Iterator<Item = TaskId> + 'a

Returns a list of all the active tasks.

pub fn poll(
    &mut self
) -> Async<HandledNodesEvent<TInEvent, TOutEvent, TIntoHandler, TReachErr, THandlerErr, TUserData, TPeerId>>

Provides an API similar to Stream, except that it cannot produce an error.

Trait Implementations

impl<TInEvent, TOutEvent, TIntoHandler, TReachErr, THandlerErr, TUserData, TPeerId> Debug for HandledNodesTasks<TInEvent, TOutEvent, TIntoHandler, TReachErr, THandlerErr, TUserData, TPeerId> where
    TUserData: Debug, 

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

Formats the value using the given formatter.