X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=background-processor%2Fsrc%2Flib.rs;h=c3db4d55ade989e13fb8ac228ac77d6460d0502f;hb=836985a5e5e8036d5dea47797ef6fba498616e67;hp=286bfeddf155123668200e2d5971979bd558d714;hpb=2c7c1a6a7a7796d6cbef4a2549fc0a7338fc8fb9;p=rust-lightning diff --git a/background-processor/src/lib.rs b/background-processor/src/lib.rs index 286bfeddf..c3db4d55a 100644 --- a/background-processor/src/lib.rs +++ b/background-processor/src/lib.rs @@ -48,18 +48,21 @@ impl BackgroundProcessor { /// Start a background thread that takes care of responsibilities enumerated in the top-level /// documentation. /// - /// If `persist_manager` returns an error, then this thread will return said error (and `start()` - /// will need to be called again to restart the `BackgroundProcessor`). Users should wait on - /// [`thread_handle`]'s `join()` method to be able to tell if and when an error is returned, or - /// implement `persist_manager` such that an error is never returned to the `BackgroundProcessor` + /// If `persist_manager` returns an error, then this thread will return said error (and + /// `start()` will need to be called again to restart the `BackgroundProcessor`). Users should + /// wait on [`thread_handle`]'s `join()` method to be able to tell if and when an error is + /// returned, or implement `persist_manager` such that an error is never returned to the + /// `BackgroundProcessor` /// - /// `persist_manager` is responsible for writing out the `ChannelManager` to disk, and/or uploading - /// to one or more backup services. See [`ChannelManager::write`] for writing out a `ChannelManager`. - /// See [`FilesystemPersister::persist_manager`] for Rust-Lightning's provided implementation. + /// `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or + /// uploading to one or more backup services. See [`ChannelManager::write`] for writing out a + /// [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's + /// provided implementation. /// - /// [`thread_handle`]: struct.BackgroundProcessor.html#structfield.thread_handle - /// [`ChannelManager::write`]: ../lightning/ln/channelmanager/struct.ChannelManager.html#method.write - /// [`FilesystemPersister::persist_manager`]: ../lightning_persister/struct.FilesystemPersister.html#impl + /// [`thread_handle`]: BackgroundProcessor::thread_handle + /// [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager + /// [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable + /// [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager pub fn start(persist_manager: PM, manager: Arc, Arc, Arc, Arc, Arc>>, logger: Arc) -> Self where Signer: 'static + Sign, M: 'static + chain::Watch,