Trait lightning::events::EventsProvider
source · pub trait EventsProvider {
// Required method
fn process_pending_events<H: Deref>(&self, handler: H)
where H::Target: EventHandler;
}Expand description
A trait indicating an object may generate events.
Events are processed by passing an EventHandler to process_pending_events.
Implementations of this trait may also feature an async version of event handling, as shown with
ChannelManager::process_pending_events_async and
ChainMonitor::process_pending_events_async.
§Requirements
When using this trait, process_pending_events will call handle_event for each pending
event since the last invocation.
In order to ensure no Events are lost, implementors of this trait will persist Events
and replay any unhandled events on startup. An Event is considered handled when
process_pending_events returns, thus handlers MUST fully handle Events and persist any
relevant changes to disk before returning.
Further, because an application may crash between an Event being handled and the
implementor of this trait being re-serialized, Event handling must be idempotent - in
effect, Events may be replayed.
Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
consult the provider’s documentation on the implication of processing events and how a handler
may safely use the provider (e.g., see ChannelManager::process_pending_events and
ChainMonitor::process_pending_events).
(C-not implementable) As there is likely no reason for a user to implement this trait on their own type(s).
Required Methods§
sourcefn process_pending_events<H: Deref>(&self, handler: H)where
H::Target: EventHandler,
fn process_pending_events<H: Deref>(&self, handler: H)where
H::Target: EventHandler,
Processes any events generated since the last call using the given event handler.
See the trait-level documentation for requirements.