_ Git - ldk-java/blob - src/main/java/org/ldk/structs/ChannelUpdateInfo.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  * Details about one direction of a channel as received within a [`ChannelUpdate`].
  13  */
  14 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
  15 public class ChannelUpdateInfo extends CommonBase {
  16         ChannelUpdateInfo(Object _dummy, long ptr) { super(ptr); }
  17         @Override @SuppressWarnings("deprecation")
  18         protected void finalize() throws Throwable {
  19                 super.finalize();
  20                 if (ptr != 0) { bindings.ChannelUpdateInfo_free(ptr); }
  21         }
  22
  23         /**
  24          * When the last update to the channel direction was issued.
  25          * Value is opaque, as set in the announcement.
  26          */
  27         public int get_last_update() {
  28                 int ret = bindings.ChannelUpdateInfo_get_last_update(this.ptr);
  29                 Reference.reachabilityFence(this);
  30                 return ret;
  31         }
  32
  33         /**
  34          * When the last update to the channel direction was issued.
  35          * Value is opaque, as set in the announcement.
  36          */
  37         public void set_last_update(int val) {
  38                 bindings.ChannelUpdateInfo_set_last_update(this.ptr, val);
  39                 Reference.reachabilityFence(this);
  40                 Reference.reachabilityFence(val);
  41         }
  42
  43         /**
  44          * Whether the channel can be currently used for payments (in this one direction).
  45          */
  46         public boolean get_enabled() {
  47                 boolean ret = bindings.ChannelUpdateInfo_get_enabled(this.ptr);
  48                 Reference.reachabilityFence(this);
  49                 return ret;
  50         }
  51
  52         /**
  53          * Whether the channel can be currently used for payments (in this one direction).
  54          */
  55         public void set_enabled(boolean val) {
  56                 bindings.ChannelUpdateInfo_set_enabled(this.ptr, val);
  57                 Reference.reachabilityFence(this);
  58                 Reference.reachabilityFence(val);
  59         }
  60
  61         /**
  62          * The difference in CLTV values that you must have when routing through this channel.
  63          */
  64         public short get_cltv_expiry_delta() {
  65                 short ret = bindings.ChannelUpdateInfo_get_cltv_expiry_delta(this.ptr);
  66                 Reference.reachabilityFence(this);
  67                 return ret;
  68         }
  69
  70         /**
  71          * The difference in CLTV values that you must have when routing through this channel.
  72          */
  73         public void set_cltv_expiry_delta(short val) {
  74                 bindings.ChannelUpdateInfo_set_cltv_expiry_delta(this.ptr, val);
  75                 Reference.reachabilityFence(this);
  76                 Reference.reachabilityFence(val);
  77         }
  78
  79         /**
  80          * The minimum value, which must be relayed to the next hop via the channel
  81          */
  82         public long get_htlc_minimum_msat() {
  83                 long ret = bindings.ChannelUpdateInfo_get_htlc_minimum_msat(this.ptr);
  84                 Reference.reachabilityFence(this);
  85                 return ret;
  86         }
  87
  88         /**
  89          * The minimum value, which must be relayed to the next hop via the channel
  90          */
  91         public void set_htlc_minimum_msat(long val) {
  92                 bindings.ChannelUpdateInfo_set_htlc_minimum_msat(this.ptr, val);
  93                 Reference.reachabilityFence(this);
  94                 Reference.reachabilityFence(val);
  95         }
  96
  97         /**
  98          * The maximum value which may be relayed to the next hop via the channel.
  99          */
 100         public long get_htlc_maximum_msat() {
 101                 long ret = bindings.ChannelUpdateInfo_get_htlc_maximum_msat(this.ptr);
 102                 Reference.reachabilityFence(this);
 103                 return ret;
 104         }
 105
 106         /**
 107          * The maximum value which may be relayed to the next hop via the channel.
 108          */
 109         public void set_htlc_maximum_msat(long val) {
 110                 bindings.ChannelUpdateInfo_set_htlc_maximum_msat(this.ptr, val);
 111                 Reference.reachabilityFence(this);
 112                 Reference.reachabilityFence(val);
 113         }
 114
 115         /**
 116          * Fees charged when the channel is used for routing
 117          */
 118         public RoutingFees get_fees() {
 119                 long ret = bindings.ChannelUpdateInfo_get_fees(this.ptr);
 120                 Reference.reachabilityFence(this);
 121                 if (ret >= 0 && ret <= 4096) { return null; }
 122                 org.ldk.structs.RoutingFees ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.RoutingFees(null, ret); }
 123                 ret_hu_conv.ptrs_to.add(this);
 124                 return ret_hu_conv;
 125         }
 126
 127         /**
 128          * Fees charged when the channel is used for routing
 129          */
 130         public void set_fees(RoutingFees val) {
 131                 bindings.ChannelUpdateInfo_set_fees(this.ptr, val == null ? 0 : val.ptr & ~1);
 132                 Reference.reachabilityFence(this);
 133                 Reference.reachabilityFence(val);
 134         }
 135
 136         /**
 137          * Most recent update for the channel received from the network
 138          * Mostly redundant with the data we store in fields explicitly.
 139          * Everything else is useful only for sending out for initial routing sync.
 140          * Not stored if contains excess data to prevent DoS.
 141          *
 142          * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
 143          */
 144         @Nullable
 145         public ChannelUpdate get_last_update_message() {
 146                 long ret = bindings.ChannelUpdateInfo_get_last_update_message(this.ptr);
 147                 Reference.reachabilityFence(this);
 148                 if (ret >= 0 && ret <= 4096) { return null; }
 149                 org.ldk.structs.ChannelUpdate ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelUpdate(null, ret); }
 150                 ret_hu_conv.ptrs_to.add(this);
 151                 return ret_hu_conv;
 152         }
 153
 154         /**
 155          * Most recent update for the channel received from the network
 156          * Mostly redundant with the data we store in fields explicitly.
 157          * Everything else is useful only for sending out for initial routing sync.
 158          * Not stored if contains excess data to prevent DoS.
 159          *
 160          * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
 161          */
 162         public void set_last_update_message(@Nullable ChannelUpdate val) {
 163                 bindings.ChannelUpdateInfo_set_last_update_message(this.ptr, val == null ? 0 : val.ptr & ~1);
 164                 Reference.reachabilityFence(this);
 165                 Reference.reachabilityFence(val);
 166         }
 167
 168         /**
 169          * Constructs a new ChannelUpdateInfo given each field
 170          */
 171         public static ChannelUpdateInfo of(int last_update_arg, boolean enabled_arg, short cltv_expiry_delta_arg, long htlc_minimum_msat_arg, long htlc_maximum_msat_arg, RoutingFees fees_arg, ChannelUpdate last_update_message_arg) {
 172                 long ret = bindings.ChannelUpdateInfo_new(last_update_arg, enabled_arg, cltv_expiry_delta_arg, htlc_minimum_msat_arg, htlc_maximum_msat_arg, fees_arg == null ? 0 : fees_arg.ptr & ~1, last_update_message_arg == null ? 0 : last_update_message_arg.ptr & ~1);
 173                 Reference.reachabilityFence(last_update_arg);
 174                 Reference.reachabilityFence(enabled_arg);
 175                 Reference.reachabilityFence(cltv_expiry_delta_arg);
 176                 Reference.reachabilityFence(htlc_minimum_msat_arg);
 177                 Reference.reachabilityFence(htlc_maximum_msat_arg);
 178                 Reference.reachabilityFence(fees_arg);
 179                 Reference.reachabilityFence(last_update_message_arg);
 180                 if (ret >= 0 && ret <= 4096) { return null; }
 181                 org.ldk.structs.ChannelUpdateInfo ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelUpdateInfo(null, ret); }
 182                 ret_hu_conv.ptrs_to.add(ret_hu_conv);
 183                 return ret_hu_conv;
 184         }
 185
 186         long clone_ptr() {
 187                 long ret = bindings.ChannelUpdateInfo_clone_ptr(this.ptr);
 188                 Reference.reachabilityFence(this);
 189                 return ret;
 190         }
 191
 192         /**
 193          * Creates a copy of the ChannelUpdateInfo
 194          */
 195         public ChannelUpdateInfo clone() {
 196                 long ret = bindings.ChannelUpdateInfo_clone(this.ptr);
 197                 Reference.reachabilityFence(this);
 198                 if (ret >= 0 && ret <= 4096) { return null; }
 199                 org.ldk.structs.ChannelUpdateInfo ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelUpdateInfo(null, ret); }
 200                 ret_hu_conv.ptrs_to.add(this);
 201                 return ret_hu_conv;
 202         }
 203
 204         /**
 205          * Serialize the ChannelUpdateInfo object into a byte array which can be read by ChannelUpdateInfo_read
 206          */
 207         public byte[] write() {
 208                 byte[] ret = bindings.ChannelUpdateInfo_write(this.ptr);
 209                 Reference.reachabilityFence(this);
 210                 return ret;
 211         }
 212
 213         /**
 214          * Read a ChannelUpdateInfo from a byte array, created by ChannelUpdateInfo_write
 215          */
 216         public static Result_ChannelUpdateInfoDecodeErrorZ read(byte[] ser) {
 217                 long ret = bindings.ChannelUpdateInfo_read(ser);
 218                 Reference.reachabilityFence(ser);
 219                 if (ret >= 0 && ret <= 4096) { return null; }
 220                 Result_ChannelUpdateInfoDecodeErrorZ ret_hu_conv = Result_ChannelUpdateInfoDecodeErrorZ.constr_from_ptr(ret);
 221                 return ret_hu_conv;
 222         }
 223
 224 }