logos-messaging/logos-messaging-rust-bindings
1
0
Fork 0
mirror of https://github.com/logos-messaging/logos-messaging-rust-bindings.git synced 2026-01-03 14:33:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

WakuHandle docs

Browse Source
This commit is contained in:
Daniel Sanchez Quiros 2022-10-07 11:51:35 +02:00
parent fa56c3540b
commit 89ee331809
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
waku/src/node/mod.rs
View File

@ -36,6 +36,11 @@ pub struct Running;
impl WakuNodeState for Initialized {} impl WakuNodeState for Initialized {}
impl WakuNodeState for Running {} impl WakuNodeState for Running {}
/// Handle to the underliying waku node
/// Safe to sendt to/through threads.
/// Only a waku node can be running at a time.
/// Referenes (`&`) to the handle can call queries and perform operations in a thread safe way.
/// Only an owned version of the handle can `start` or `stop` the node.
pub struct WakuNodeHandle<State: WakuNodeState>(PhantomData<State>); pub struct WakuNodeHandle<State: WakuNodeState>(PhantomData<State>);
/// We do not have any inner state, so the handle should be safe to be send among threads. /// We do not have any inner state, so the handle should be safe to be send among threads.