Skip to content

Commit e1f797d

Browse files
committed
f - Document lock reentrancy
1 parent 09cc4b7 commit e1f797d

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

lightning/src/util/events.rs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -381,7 +381,12 @@ pub trait MessageSendEventsProvider {
381381
fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
382382
}
383383

384-
/// A trait indicating an object may generate events
384+
/// A trait indicating an object may generate events.
385+
///
386+
/// Events are processed by a handler given to [`process_pending_events`]. Therefore, implementors
387+
/// should be mindful to avoid lock reentrancy if a handler may call back into the provider.
388+
///
389+
/// [`process_pending_events`]: Self::process_pending_events
385390
pub trait EventsProvider {
386391
/// Processes any generated events with the given event handler.
387392
fn process_pending_events<H: Deref>(&self, handler: H) where H::Target: EventHandler;

0 commit comments

Comments
 (0)