_ Git - ldk-java/blob - src/main/java/org/ldk/structs/EventsProvider.java

   1 package org.ldk.structs;
   2
   3 import org.ldk.impl.bindings;
   4 import org.ldk.enums.*;
   5 import org.ldk.util.*;
   6 import java.util.Arrays;
   7 import java.lang.ref.Reference;
   8 import javax.annotation.Nullable;
   9
  10 /**
  11  * A trait indicating an object may generate events.
  12  *
  13  * Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
  14  *
  15  * # Requirements
  16  *
  17  * See [`process_pending_events`] for requirements around event processing.
  18  *
  19  * When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
  20  * event since the last invocation. The handler must either act upon the event immediately
  21  * or preserve it for later handling.
  22  *
  23  * Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
  24  * consult the provider's documentation on the implication of processing events and how a handler
  25  * may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
  26  * [`ChainMonitor::process_pending_events`]).
  27  *
  28  * (C-not implementable) As there is likely no reason for a user to implement this trait on their
  29  * own type(s).
  30  *
  31  * [`process_pending_events`]: Self::process_pending_events
  32  * [`handle_event`]: EventHandler::handle_event
  33  * [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
  34  * [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
  35  */
  36 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  37 public class EventsProvider extends CommonBase {
  38         final bindings.LDKEventsProvider bindings_instance;
  39         EventsProvider(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }
  40         private EventsProvider(bindings.LDKEventsProvider arg) {
  41                 super(bindings.LDKEventsProvider_new(arg));
  42                 this.ptrs_to.add(arg);
  43                 this.bindings_instance = arg;
  44         }
  45         @Override @SuppressWarnings("deprecation")
  46         protected void finalize() throws Throwable {
  47                 if (ptr != 0) { bindings.EventsProvider_free(ptr); } super.finalize();
  48         }
  49
  50         public static interface EventsProviderInterface {
  51                 /**
  52                  * Processes any events generated since the last call using the given event handler.
  53                  *
  54                  * Subsequent calls must only process new events. However, handlers must be capable of handling
  55                  * duplicate events across process restarts. This may occur if the provider was recovered from
  56                  * an old state (i.e., it hadn't been successfully persisted after processing pending events).
  57                  */
  58                 void process_pending_events(EventHandler handler);
  59         }
  60         private static class LDKEventsProviderHolder { EventsProvider held; }
  61         public static EventsProvider new_impl(EventsProviderInterface arg) {
  62                 final LDKEventsProviderHolder impl_holder = new LDKEventsProviderHolder();
  63                 impl_holder.held = new EventsProvider(new bindings.LDKEventsProvider() {
  64                         @Override public void process_pending_events(long handler) {
  65                                 EventHandler ret_hu_conv = new EventHandler(null, handler);
  66                                 ret_hu_conv.ptrs_to.add(this);
  67                                 arg.process_pending_events(ret_hu_conv);
  68                         }
  69                 });
  70                 return impl_holder.held;
  71         }
  72         /**
  73          * Processes any events generated since the last call using the given event handler.
  74          *
  75          * Subsequent calls must only process new events. However, handlers must be capable of handling
  76          * duplicate events across process restarts. This may occur if the provider was recovered from
  77          * an old state (i.e., it hadn't been successfully persisted after processing pending events).
  78          */
  79         public void process_pending_events(EventHandler handler) {
  80                 bindings.EventsProvider_process_pending_events(this.ptr, handler == null ? 0 : handler.ptr);
  81                 Reference.reachabilityFence(this);
  82                 Reference.reachabilityFence(handler);
  83                 this.ptrs_to.add(handler);
  84         }
  85
  86 }