Struct message_io::node::NodeHandler
source · pub struct NodeHandler<S>(/* private fields */);
Expand description
A shareable and clonable entity that allows to deal with the network, send signals and stop the node.
Implementations§
source§impl<S> NodeHandler<S>
impl<S> NodeHandler<S>
sourcepub fn network(&self) -> &NetworkController
pub fn network(&self) -> &NetworkController
Returns a reference to the NetworkController to deal with the network.
See NetworkController
sourcepub fn signals(&self) -> &EventSender<S>
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
.
sourcepub fn stop(&self)
pub fn stop(&self)
Finalizes the NodeListener
.
After this call, no more events will be processed by NodeListener::for_each()
.
sourcepub fn is_running(&self) -> bool
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()
.
Trait Implementations§
Auto Trait Implementations§
impl<S> Freeze for NodeHandler<S>
impl<S> !RefUnwindSafe for NodeHandler<S>
impl<S> Send for NodeHandler<S>where
S: Send,
impl<S> Sync for NodeHandler<S>where
S: Send,
impl<S> Unpin for NodeHandler<S>
impl<S> !UnwindSafe for NodeHandler<S>
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)