_ Git - ldk-java/blob - src/main/java/org/ldk/structs/LockableScore.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 scorer that is accessed under a lock.
  12  *
  13  * Needed so that calls to [`Score::channel_penalty_msat`] in [`find_route`] can be made while
  14  * having shared ownership of a scorer but without requiring internal locking in [`Score`]
  15  * implementations. Internal locking would be detrimental to route finding performance and could
  16  * result in [`Score::channel_penalty_msat`] returning a different value for the same channel.
  17  *
  18  * [`find_route`]: crate::routing::router::find_route
  19  */
  20 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  21 public class LockableScore extends CommonBase {
  22         final bindings.LDKLockableScore bindings_instance;
  23         LockableScore(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }
  24         private LockableScore(bindings.LDKLockableScore arg) {
  25                 super(bindings.LDKLockableScore_new(arg));
  26                 this.ptrs_to.add(arg);
  27                 this.bindings_instance = arg;
  28         }
  29         @Override @SuppressWarnings("deprecation")
  30         protected void finalize() throws Throwable {
  31                 if (ptr != 0) { bindings.LockableScore_free(ptr); } super.finalize();
  32         }
  33         /**
  34          * Destroys the object, freeing associated resources. After this call, any access
  35          * to this object may result in a SEGFAULT or worse.
  36          *
  37          * You should generally NEVER call this method. You should let the garbage collector
  38          * do this for you when it finalizes objects. However, it may be useful for types
  39          * which represent locks and should be closed immediately to avoid holding locks
  40          * until the GC runs.
  41          */
  42         public void destroy() {
  43                 if (ptr != 0) { bindings.LockableScore_free(ptr); }
  44                 ptr = 0;
  45         }
  46         public static interface LockableScoreInterface {
  47                 /**
  48                  * Returns the locked scorer.
  49                  */
  50                 Score lock();
  51         }
  52         private static class LDKLockableScoreHolder { LockableScore held; }
  53         public static LockableScore new_impl(LockableScoreInterface arg) {
  54                 final LDKLockableScoreHolder impl_holder = new LDKLockableScoreHolder();
  55                 impl_holder.held = new LockableScore(new bindings.LDKLockableScore() {
  56                         @Override public long lock() {
  57                                 Score ret = arg.lock();
  58                                 Reference.reachabilityFence(arg);
  59                                 long result = ret.ptr;
  60                                 if (impl_holder.held != null) { impl_holder.held.ptrs_to.add(ret); };
  61                                 return result;
  62                         }
  63                 });
  64                 return impl_holder.held;
  65         }
  66         /**
  67          * Returns the locked scorer.
  68          */
  69         public Score lock() {
  70                 long ret = bindings.LockableScore_lock(this.ptr);
  71                 Reference.reachabilityFence(this);
  72                 if (ret >= 0 && ret <= 4096) { return null; }
  73                 Score ret_hu_conv = new Score(null, ret);
  74                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
  75                 return ret_hu_conv;
  76         }
  77
  78 }