mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-24 15:02:20 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fix outdated ChannelMonitor docs

Browse source 
ChannelMonitor::get_and_clear_pending_events docs references a method
that had been refactored and is no longer accurate.
This commit is contained in:
Jeffrey Czyz 2022-11-09 11:11:08 -06:00
parent f1428fdf12
commit d4c3e16556
No known key found for this signature in database
GPG key ID: 912EF12EA67705F5
1 changed files with 5 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
lightning/src/chain/channelmonitor.rs
View file

@ -1305,9 +1305,11 @@ impl<Signer: Sign> ChannelMonitor<Signer> {
/// Gets the list of pending events which were generated by previous actions, clearing the list
/// in the process.
///
/// This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
/// EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
/// no internal locking in ChannelMonitors.
/// This is called by the [`EventsProvider::process_pending_events`] implementation for
/// [`ChainMonitor`].
///
/// [`EventsProvider::process_pending_events`]: crate::util::events::EventsProvider::process_pending_events
/// [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
pub fn get_and_clear_pending_events(&self) -> Vec<Event> {
self.inner.lock().unwrap().get_and_clear_pending_events()
}