_ Git - ldk-java/blob - src/main/java/org/ldk/structs/RouteParameters.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  * Parameters needed to find a [`Route`].
  13  *
  14  * Passed to [`find_route`] and [`build_route_from_hops`], but also provided in
  15  * [`Event::PaymentPathFailed`] for retrying a failed payment path.
  16  *
  17  * [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
  18  */
  19 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  20 public class RouteParameters extends CommonBase {
  21         RouteParameters(Object _dummy, long ptr) { super(ptr); }
  22         @Override @SuppressWarnings("deprecation")
  23         protected void finalize() throws Throwable {
  24                 super.finalize();
  25                 if (ptr != 0) { bindings.RouteParameters_free(ptr); }
  26         }
  27
  28         /**
  29          * The parameters of the failed payment path.
  30          */
  31         public PaymentParameters get_payment_params() {
  32                 long ret = bindings.RouteParameters_get_payment_params(this.ptr);
  33                 Reference.reachabilityFence(this);
  34                 if (ret >= 0 && ret <= 4096) { return null; }
  35                 org.ldk.structs.PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PaymentParameters(null, ret); }
  36                 ret_hu_conv.ptrs_to.add(this);
  37                 return ret_hu_conv;
  38         }
  39
  40         /**
  41          * The parameters of the failed payment path.
  42          */
  43         public void set_payment_params(PaymentParameters val) {
  44                 bindings.RouteParameters_set_payment_params(this.ptr, val == null ? 0 : val.ptr);
  45                 Reference.reachabilityFence(this);
  46                 Reference.reachabilityFence(val);
  47                 this.ptrs_to.add(val);
  48         }
  49
  50         /**
  51          * The amount in msats sent on the failed payment path.
  52          */
  53         public long get_final_value_msat() {
  54                 long ret = bindings.RouteParameters_get_final_value_msat(this.ptr);
  55                 Reference.reachabilityFence(this);
  56                 return ret;
  57         }
  58
  59         /**
  60          * The amount in msats sent on the failed payment path.
  61          */
  62         public void set_final_value_msat(long val) {
  63                 bindings.RouteParameters_set_final_value_msat(this.ptr, val);
  64                 Reference.reachabilityFence(this);
  65                 Reference.reachabilityFence(val);
  66         }
  67
  68         /**
  69          * The CLTV on the final hop of the failed payment path.
  70          */
  71         public int get_final_cltv_expiry_delta() {
  72                 int ret = bindings.RouteParameters_get_final_cltv_expiry_delta(this.ptr);
  73                 Reference.reachabilityFence(this);
  74                 return ret;
  75         }
  76
  77         /**
  78          * The CLTV on the final hop of the failed payment path.
  79          */
  80         public void set_final_cltv_expiry_delta(int val) {
  81                 bindings.RouteParameters_set_final_cltv_expiry_delta(this.ptr, val);
  82                 Reference.reachabilityFence(this);
  83                 Reference.reachabilityFence(val);
  84         }
  85
  86         /**
  87          * Constructs a new RouteParameters given each field
  88          */
  89         public static RouteParameters of(PaymentParameters payment_params_arg, long final_value_msat_arg, int final_cltv_expiry_delta_arg) {
  90                 long ret = bindings.RouteParameters_new(payment_params_arg == null ? 0 : payment_params_arg.ptr, final_value_msat_arg, final_cltv_expiry_delta_arg);
  91                 Reference.reachabilityFence(payment_params_arg);
  92                 Reference.reachabilityFence(final_value_msat_arg);
  93                 Reference.reachabilityFence(final_cltv_expiry_delta_arg);
  94                 if (ret >= 0 && ret <= 4096) { return null; }
  95                 org.ldk.structs.RouteParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.RouteParameters(null, ret); }
  96                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
  97                 ret_hu_conv.ptrs_to.add(payment_params_arg);
  98                 return ret_hu_conv;
  99         }
 100
 101         long clone_ptr() {
 102                 long ret = bindings.RouteParameters_clone_ptr(this.ptr);
 103                 Reference.reachabilityFence(this);
 104                 return ret;
 105         }
 106
 107         /**
 108          * Creates a copy of the RouteParameters
 109          */
 110         public RouteParameters clone() {
 111                 long ret = bindings.RouteParameters_clone(this.ptr);
 112                 Reference.reachabilityFence(this);
 113                 if (ret >= 0 && ret <= 4096) { return null; }
 114                 org.ldk.structs.RouteParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.RouteParameters(null, ret); }
 115                 ret_hu_conv.ptrs_to.add(this);
 116                 return ret_hu_conv;
 117         }
 118
 119         /**
 120          * Serialize the RouteParameters object into a byte array which can be read by RouteParameters_read
 121          */
 122         public byte[] write() {
 123                 byte[] ret = bindings.RouteParameters_write(this.ptr);
 124                 Reference.reachabilityFence(this);
 125                 return ret;
 126         }
 127
 128         /**
 129          * Read a RouteParameters from a byte array, created by RouteParameters_write
 130          */
 131         public static Result_RouteParametersDecodeErrorZ read(byte[] ser) {
 132                 long ret = bindings.RouteParameters_read(ser);
 133                 Reference.reachabilityFence(ser);
 134                 if (ret >= 0 && ret <= 4096) { return null; }
 135                 Result_RouteParametersDecodeErrorZ ret_hu_conv = Result_RouteParametersDecodeErrorZ.constr_from_ptr(ret);
 136                 return ret_hu_conv;
 137         }
 138
 139 }