Add Tokio example to process_events_async docs

Author: tnull

lightning-background-processor/src/lib.rs

@@ -466,7 +466,7 @@ use core::task;
 ///
 /// `sleeper` should return a future which completes in the given amount of time and returns a
 /// 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.
+/// 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.
 ///
@@ -479,6 +479,49 @@ use core::task;
 /// mobile device, where we may need to check for interruption of the application regularly. If you
 /// are unsure, you should set the flag, as the performance impact of it is minimal unless there
 /// are hundreds or thousands of simultaneous process calls running.
+///
+/// For example, in order to process background events in a [Tokio](https://tokio.rs/) task, you
+/// could setup `process_events_async` like this:
+/// ```ignore
+///		let background_persister = Arc::clone(&my_persister);
+///		let background_event_handler = Arc::clone(&my_event_handler);
+///		let background_chain_mon = Arc::clone(&my_chain_monitor);
+///		let background_chan_man = Arc::clone(&my_channel_manager);
+///		let background_gossip_sync = GossipSync::p2p(Arc::clone(&my_gossip_sync));
+///		let background_peer_man = Arc::clone(&my_peer_manager);
+///		let background_logger = Arc::clone(&my_logger);
+///		let background_scorer = Arc::clone(&my_scorer);
+///
+///		// Setup the sleeper.
+///		let should_stop = AtomicBool::new(false);
+///
+///		let sleeper = |d| async move {
+///			tokio::time::sleep(d).await;
+///			should_stop.load(Ordering::Relaxed)
+///		};
+///
+///		let mobile_interruptable_platform = false;
+///
+///		tokio::spawn(async move {
+///			process_events_async(
+///				background_persister,
+///				|e| background_event_handler.handle_event(e),
+///				background_chain_mon,
+///				background_chan_man,
+///				background_gossip_sync,
+///				background_peer_man,
+///				background_logger,
+///				Some(background_scorer),
+///				sleeper,
+///				mobile_interruptable_platform,
+///				)
+///				.await
+///				.expect("Failed to process events");
+///		});
+///
+///		// Stop the background processing.
+///		should_stop.store(true, Ordering::Relaxed);
+///```
 #[cfg(feature = "futures")]
 pub async fn process_events_async<
 	'a,