_ Git - ldk-java/blob - src/main/java/org/ldk/structs/BackgroundProcessor.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 /**
  12  * `BackgroundProcessor` takes care of tasks that (1) need to happen periodically to keep
  13  * Rust-Lightning running properly, and (2) either can or should be run in the background. Its
  14  * responsibilities are:
  15  * Processing [`Event`]s with a user-provided [`EventHandler`].
  16  * Monitoring whether the [`ChannelManager`] needs to be re-persisted to disk, and if so,
  17  * writing it to disk/backups by invoking the callback given to it at startup.
  18  * [`ChannelManager`] persistence should be done in the background.
  19  * Calling [`ChannelManager::timer_tick_occurred`], [`ChainMonitor::rebroadcast_pending_claims`]
  20  * and [`PeerManager::timer_tick_occurred`] at the appropriate intervals.
  21  * Calling [`NetworkGraph::remove_stale_channels_and_tracking`] (if a [`GossipSync`] with a
  22  * [`NetworkGraph`] is provided to [`BackgroundProcessor::start`]).
  23  *
  24  * It will also call [`PeerManager::process_events`] periodically though this shouldn't be relied
  25  * upon as doing so may result in high latency.
  26  *
  27  * # Note
  28  *
  29  * If [`ChannelManager`] persistence fails and the persisted manager becomes out-of-date, then
  30  * there is a risk of channels force-closing on startup when the manager realizes it's outdated.
  31  * However, as long as [`ChannelMonitor`] backups are sound, no funds besides those used for
  32  * unilateral chain closure fees are at risk.
  33  *
  34  * [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
  35  * [`Event`]: lightning::events::Event
  36  * [`PeerManager::timer_tick_occurred`]: lightning::ln::peer_handler::PeerManager::timer_tick_occurred
  37  * [`PeerManager::process_events`]: lightning::ln::peer_handler::PeerManager::process_events
  38  * BackgroundProcessor will immediately stop on drop. It should be stored until shutdown.
  39  */
  40 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  41 public class BackgroundProcessor extends CommonBase {
  42         BackgroundProcessor(Object _dummy, long ptr) { super(ptr); }
  43         @Override @SuppressWarnings("deprecation")
  44         protected void finalize() throws Throwable {
  45                 super.finalize();
  46                 if (ptr != 0) { bindings.BackgroundProcessor_free(ptr); }
  47         }
  48
  49         /**
  50          * Start a background thread that takes care of responsibilities enumerated in the [top-level
  51          * documentation].
  52          *
  53          * The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
  54          * [`Persister::persist_manager`] returns an error. In case of an error, the error is retrieved by calling
  55          * either [`join`] or [`stop`].
  56          *
  57          * # Data Persistence
  58          *
  59          * [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
  60          * uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
  61          * [`ChannelManager`]. See the `lightning-persister` crate for LDK's
  62          * provided implementation.
  63          *
  64          * [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk, if
  65          * [`GossipSync`] is supplied. See [`NetworkGraph::write`] for writing out a [`NetworkGraph`].
  66          * See the `lightning-persister` crate for LDK's provided implementation.
  67          *
  68          * Typically, users should either implement [`Persister::persist_manager`] to never return an
  69          * error or call [`join`] and handle any error that may arise. For the latter case,
  70          * `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
  71          *
  72          * # Event Handling
  73          *
  74          * `event_handler` is responsible for handling events that users should be notified of (e.g.,
  75          * payment failed). [`BackgroundProcessor`] may decorate the given [`EventHandler`] with common
  76          * functionality implemented by other handlers.
  77          * [`P2PGossipSync`] if given will update the [`NetworkGraph`] based on payment failures.
  78          *
  79          * # Rapid Gossip Sync
  80          *
  81          * If rapid gossip sync is meant to run at startup, pass [`RapidGossipSync`] via `gossip_sync`
  82          * to indicate that the [`BackgroundProcessor`] should not prune the [`NetworkGraph`] instance
  83          * until the [`RapidGossipSync`] instance completes its first sync.
  84          *
  85          * [top-level documentation]: BackgroundProcessor
  86          * [`join`]: Self::join
  87          * [`stop`]: Self::stop
  88          * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
  89          * [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
  90          * [`Persister::persist_manager`]: lightning::util::persist::Persister::persist_manager
  91          * [`Persister::persist_graph`]: lightning::util::persist::Persister::persist_graph
  92          * [`NetworkGraph`]: lightning::routing::gossip::NetworkGraph
  93          * [`NetworkGraph::write`]: lightning::routing::gossip::NetworkGraph#impl-Writeable
  94          */
  95         public static BackgroundProcessor start(org.ldk.structs.Persister persister, org.ldk.structs.EventHandler event_handler, org.ldk.structs.ChainMonitor chain_monitor, org.ldk.structs.ChannelManager channel_manager, org.ldk.structs.GossipSync gossip_sync, org.ldk.structs.PeerManager peer_manager, org.ldk.structs.Logger logger, org.ldk.structs.Option_WriteableScoreZ scorer) {
  96                 long ret = bindings.BackgroundProcessor_start(persister.ptr, event_handler.ptr, chain_monitor == null ? 0 : chain_monitor.ptr, channel_manager == null ? 0 : channel_manager.ptr, gossip_sync.ptr, peer_manager == null ? 0 : peer_manager.ptr, logger.ptr, scorer.ptr);
  97                 Reference.reachabilityFence(persister);
  98                 Reference.reachabilityFence(event_handler);
  99                 Reference.reachabilityFence(chain_monitor);
 100                 Reference.reachabilityFence(channel_manager);
 101                 Reference.reachabilityFence(gossip_sync);
 102                 Reference.reachabilityFence(peer_manager);
 103                 Reference.reachabilityFence(logger);
 104                 Reference.reachabilityFence(scorer);
 105                 if (ret >= 0 && ret <= 4096) { return null; }
 106                 org.ldk.structs.BackgroundProcessor ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.BackgroundProcessor(null, ret); }
 107                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
 108                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(persister); };
 109                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(event_handler); };
 110                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(chain_monitor); };
 111                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(channel_manager); };
 112                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(gossip_sync); };
 113                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(peer_manager); };
 114                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(logger); };
 115                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(scorer); };
 116                 return ret_hu_conv;
 117         }
 118
 119         /**
 120          * Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
 121          * [`ChannelManager`].
 122          *
 123          * # Panics
 124          *
 125          * This function panics if the background thread has panicked such as while persisting or
 126          * handling events.
 127          *
 128          * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 129          */
 130         public Result_NoneIOErrorZ join() {
 131                 long ret = bindings.BackgroundProcessor_join(this.ptr);
 132                 Reference.reachabilityFence(this);
 133                 if (ret >= 0 && ret <= 4096) { return null; }
 134                 Result_NoneIOErrorZ ret_hu_conv = Result_NoneIOErrorZ.constr_from_ptr(ret);
 135                 if (this != null) { this.ptrs_to.add(this); };
 136                 // Due to rust's strict-ownership memory model, in some cases we need to "move"
 137                 // an object to pass exclusive ownership to the function being called.
 138                 // In most cases, we avoid this being visible in GC'd languages by cloning the object
 139                 // at the FFI layer, creating a new object which Rust can claim ownership of
 140                 // However, in some cases (eg here), there is no way to clone an object, and thus
 141                 // we actually have to pass full ownership to Rust.
 142                 // Thus, after this call, this is reset to null and is now a dummy object.
 143                 this.ptr = 0;;
 144                 return ret_hu_conv;
 145         }
 146
 147         /**
 148          * Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
 149          * [`ChannelManager`].
 150          *
 151          * # Panics
 152          *
 153          * This function panics if the background thread has panicked such as while persisting or
 154          * handling events.
 155          *
 156          * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
 157          */
 158         public Result_NoneIOErrorZ stop() {
 159                 long ret = bindings.BackgroundProcessor_stop(this.ptr);
 160                 Reference.reachabilityFence(this);
 161                 if (ret >= 0 && ret <= 4096) { return null; }
 162                 Result_NoneIOErrorZ ret_hu_conv = Result_NoneIOErrorZ.constr_from_ptr(ret);
 163                 if (this != null) { this.ptrs_to.add(this); };
 164                 // Due to rust's strict-ownership memory model, in some cases we need to "move"
 165                 // an object to pass exclusive ownership to the function being called.
 166                 // In most cases, we avoid this being visible in GC'd languages by cloning the object
 167                 // at the FFI layer, creating a new object which Rust can claim ownership of
 168                 // However, in some cases (eg here), there is no way to clone an object, and thus
 169                 // we actually have to pass full ownership to Rust.
 170                 // Thus, after this call, this is reset to null and is now a dummy object.
 171                 this.ptr = 0;;
 172                 return ret_hu_conv;
 173         }
 174
 175 }