Package org.ldk.structs

Class EventsProvider

java.lang.Object

org.ldk.structs.EventsProvider

public class EventsProvider
extends Object

A trait indicating an object may generate events. Events are processed by passing an [`EventHandler`] to [`process_pending_events`]. # 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 [`Event`]s are lost, implementors of this trait will persist [`Event`]s and replay any unhandled events on startup. An [`Event`] is considered handled when [`process_pending_events`] returns, thus handlers MUST fully handle [`Event`]s 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, [`Event`]s 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). [`process_pending_events`]: Self::process_pending_events [`handle_event`]: EventHandler::handle_event [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EventsProvider.EventsProviderInterface

Method Summary

Modifier and Type	Method	Description
protected void	finalize()
static EventsProvider	new_impl(EventsProvider.EventsProviderInterface arg)
void	process_pending_events(EventHandler handler)	Processes any events generated since the last call using the given event handler.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

new_impl

public static EventsProvider new_impl(EventsProvider.EventsProviderInterface arg)

process_pending_events

public void process_pending_events(EventHandler handler)

Processes any events generated since the last call using the given event handler. See the trait-level documentation for requirements.