Struct message_io::node::NodeHandler

pub struct NodeHandler<S>(_);

A shareable and clonable entity that allows to deal with the network, send signals and stop the node.

Implementations

impl<S> NodeHandler<S>

pub fn network(&self) -> &NetworkController

Returns a reference to the NetworkController to deal with the network. See NetworkController

pub fn signals(&self) -> &EventSender<S>

Returns a reference to the EventSender to send signals to the node. Signals are events that the node send to itself useful in situation where you need to “wake up” the NodeListener to perform some action. See EventSender.

pub fn stop(&self)

Finalizes the NodeListener. After this call, no more events will be processed by NodeListener::for_each().

pub fn is_running(&self) -> bool

Check if the node is running. Note that the node is running and listening events from its creation, not only once you call to NodeListener::for_each(). Calling this function only will offer the event to the user to be processed.

Trait Implementations

impl<S: Send + 'static> Clone for NodeHandler<S>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.