File tree Expand file tree Collapse file tree 1 file changed +6
-2
lines changed Expand file tree Collapse file tree 1 file changed +6
-2
lines changed Original file line number Diff line number Diff line change @@ -468,8 +468,10 @@ pub struct Node {
468
468
469
469
impl Node {
470
470
/// Starts the necessary background tasks, such as handling events coming from user input,
471
- /// LDK/BDK, and the peer-to-peer network. After this returns, the [`Node`] instance can be
472
- /// controlled via the provided API methods in a thread-safe manner.
471
+ /// LDK/BDK, and the peer-to-peer network.
472
+ ///
473
+ /// After this returns, the [`Node`] instance can be controlled via the provided API methods in
474
+ /// a thread-safe manner.
473
475
pub fn start ( & self ) -> Result < ( ) , Error > {
474
476
// Acquire a run lock and hold it until we're setup.
475
477
let mut run_lock = self . running . write ( ) . unwrap ( ) ;
@@ -484,6 +486,8 @@ impl Node {
484
486
}
485
487
486
488
/// Disconnects all peers, stops all running background tasks, and shuts down [`Node`].
489
+ ///
490
+ /// After this returns most API methods will return [`Error::NotRunning`].
487
491
pub fn stop ( & self ) -> Result < ( ) , Error > {
488
492
let mut run_lock = self . running . write ( ) . unwrap ( ) ;
489
493
if run_lock. is_none ( ) {
You can’t perform that action at this time.
0 commit comments