From 71739dbe0495b3aed4ce907fea88c122df9ac6a1 Mon Sep 17 00:00:00 2001 From: Matt Corallo Date: Wed, 9 Nov 2022 17:35:26 +0000 Subject: [PATCH] Correct async `lightning-background-processor` exit check docs The check to stop the background processor is true -> break, not false -> break. This simply updates the docs and leaves the code as-is. --- lightning-background-processor/src/lib.rs | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/lightning-background-processor/src/lib.rs b/lightning-background-processor/src/lib.rs index 27cd0663e..10bcc9bd6 100644 --- a/lightning-background-processor/src/lib.rs +++ b/lightning-background-processor/src/lib.rs @@ -358,8 +358,8 @@ macro_rules! define_run_body { /// Processes background events in a future. /// /// `sleeper` should return a future which completes in the given amount of time and returns a -/// boolean indicating whether the background processing should continue. Once `sleeper` returns a -/// future which outputs false, the loop will exit and this function's future will complete. +/// boolean indicating whether the background processing should exit. Once `sleeper` returns a +/// future which outputs true, the loop will exit and this function's future will complete. /// /// See [`BackgroundProcessor::start`] for information on which actions this handles. #[cfg(feature = "futures")] @@ -411,13 +411,13 @@ where UMH::Target: 'static + CustomMessageHandler, PS::Target: 'static + Persister<'a, Signer, CW, T, K, F, L, SC>, { - let mut should_continue = true; + let mut should_break = true; define_run_body!(persister, event_handler, chain_monitor, channel_manager, - gossip_sync, peer_manager, logger, scorer, should_continue, { + gossip_sync, peer_manager, logger, scorer, should_break, { select_biased! { _ = channel_manager.get_persistable_update_future().fuse() => true, - cont = sleeper(Duration::from_millis(100)).fuse() => { - should_continue = cont; + exit = sleeper(Duration::from_millis(100)).fuse() => { + should_break = exit; false } } -- 2.39.5