1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
12 * Parameters needed to find a [`Route`].
14 * Passed to [`find_route`] and also provided in [`Event::PaymentPathFailed`] for retrying a failed
17 * [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
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 {
25 if (ptr != 0) { bindings.RouteParameters_free(ptr); }
29 * The parameters of the failed payment path.
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 PaymentParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new PaymentParameters(null, ret); }
36 ret_hu_conv.ptrs_to.add(this);
41 * The parameters of the failed payment path.
43 public void set_payment_params(PaymentParameters val) {
44 bindings.RouteParameters_set_payment_params(this.ptr, val == null ? 0 : val.ptr & ~1);
45 Reference.reachabilityFence(this);
46 Reference.reachabilityFence(val);
50 * The amount in msats sent on the failed payment path.
52 public long get_final_value_msat() {
53 long ret = bindings.RouteParameters_get_final_value_msat(this.ptr);
54 Reference.reachabilityFence(this);
59 * The amount in msats sent on the failed payment path.
61 public void set_final_value_msat(long val) {
62 bindings.RouteParameters_set_final_value_msat(this.ptr, val);
63 Reference.reachabilityFence(this);
64 Reference.reachabilityFence(val);
68 * The CLTV on the final hop of the failed payment path.
70 public int get_final_cltv_expiry_delta() {
71 int ret = bindings.RouteParameters_get_final_cltv_expiry_delta(this.ptr);
72 Reference.reachabilityFence(this);
77 * The CLTV on the final hop of the failed payment path.
79 public void set_final_cltv_expiry_delta(int val) {
80 bindings.RouteParameters_set_final_cltv_expiry_delta(this.ptr, val);
81 Reference.reachabilityFence(this);
82 Reference.reachabilityFence(val);
86 * Constructs a new RouteParameters given each field
88 public static RouteParameters of(PaymentParameters payment_params_arg, long final_value_msat_arg, int final_cltv_expiry_delta_arg) {
89 long ret = bindings.RouteParameters_new(payment_params_arg == null ? 0 : payment_params_arg.ptr & ~1, final_value_msat_arg, final_cltv_expiry_delta_arg);
90 Reference.reachabilityFence(payment_params_arg);
91 Reference.reachabilityFence(final_value_msat_arg);
92 Reference.reachabilityFence(final_cltv_expiry_delta_arg);
93 if (ret >= 0 && ret <= 4096) { return null; }
94 RouteParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new RouteParameters(null, ret); }
95 ret_hu_conv.ptrs_to.add(ret_hu_conv);
100 long ret = bindings.RouteParameters_clone_ptr(this.ptr);
101 Reference.reachabilityFence(this);
106 * Creates a copy of the RouteParameters
108 public RouteParameters clone() {
109 long ret = bindings.RouteParameters_clone(this.ptr);
110 Reference.reachabilityFence(this);
111 if (ret >= 0 && ret <= 4096) { return null; }
112 RouteParameters ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new RouteParameters(null, ret); }
113 ret_hu_conv.ptrs_to.add(this);
118 * Serialize the RouteParameters object into a byte array which can be read by RouteParameters_read
120 public byte[] write() {
121 byte[] ret = bindings.RouteParameters_write(this.ptr);
122 Reference.reachabilityFence(this);
127 * Read a RouteParameters from a byte array, created by RouteParameters_write
129 public static Result_RouteParametersDecodeErrorZ read(byte[] ser) {
130 long ret = bindings.RouteParameters_read(ser);
131 Reference.reachabilityFence(ser);
132 if (ret >= 0 && ret <= 4096) { return null; }
133 Result_RouteParametersDecodeErrorZ ret_hu_conv = Result_RouteParametersDecodeErrorZ.constr_from_ptr(ret);