_ Git - ldk-java/blob - c_sharp/src/org/ldk/structs/ChannelMonitorUpdate.cs

   1 using org.ldk.impl;
   2 using org.ldk.enums;
   3 using org.ldk.util;
   4 using System;
   5
   6 namespace org { namespace ldk { namespace structs {
   7
   8
   9 /**
  10  * An update generated by the underlying channel itself which contains some new information the
  11  * [`ChannelMonitor`] should be made aware of.
  12  *
  13  * Because this represents only a small number of updates to the underlying state, it is generally
  14  * much smaller than a full [`ChannelMonitor`]. However, for large single commitment transaction
  15  * updates (e.g. ones during which there are hundreds of HTLCs pending on the commitment
  16  * transaction), a single update may reach upwards of 1 MiB in serialized size.
  17  */
  18 public class ChannelMonitorUpdate : CommonBase {
  19         internal ChannelMonitorUpdate(object _dummy, long ptr) : base(ptr) { }
  20         ~ChannelMonitorUpdate() {
  21                 if (ptr != 0) { bindings.ChannelMonitorUpdate_free(ptr); }
  22         }
  23
  24         /**
  25          * The sequence number of this update. Updates *must* be replayed in-order according to this
  26          * sequence number (and updates may panic if they are not). The update_id values are strictly
  27          * increasing and increase by one for each new update, with one exception specified below.
  28          *
  29          * This sequence number is also used to track up to which points updates which returned
  30          * [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
  31          * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
  32          *
  33          * The only instance where update_id values are not strictly increasing is the case where we
  34          * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
  35          * its docs for more details.
  36          *
  37          * [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
  38          */
  39         public long get_update_id() {
  40                 long ret = bindings.ChannelMonitorUpdate_get_update_id(this.ptr);
  41                 GC.KeepAlive(this);
  42                 return ret;
  43         }
  44
  45         /**
  46          * The sequence number of this update. Updates *must* be replayed in-order according to this
  47          * sequence number (and updates may panic if they are not). The update_id values are strictly
  48          * increasing and increase by one for each new update, with one exception specified below.
  49          *
  50          * This sequence number is also used to track up to which points updates which returned
  51          * [`ChannelMonitorUpdateStatus::InProgress`] have been applied to all copies of a given
  52          * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
  53          *
  54          * The only instance where update_id values are not strictly increasing is the case where we
  55          * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
  56          * its docs for more details.
  57          *
  58          * [`ChannelMonitorUpdateStatus::InProgress`]: super::ChannelMonitorUpdateStatus::InProgress
  59          */
  60         public void set_update_id(long val) {
  61                 bindings.ChannelMonitorUpdate_set_update_id(this.ptr, val);
  62                 GC.KeepAlive(this);
  63                 GC.KeepAlive(val);
  64         }
  65
  66         internal long clone_ptr() {
  67                 long ret = bindings.ChannelMonitorUpdate_clone_ptr(this.ptr);
  68                 GC.KeepAlive(this);
  69                 return ret;
  70         }
  71
  72         /**
  73          * Creates a copy of the ChannelMonitorUpdate
  74          */
  75         public ChannelMonitorUpdate clone() {
  76                 long ret = bindings.ChannelMonitorUpdate_clone(this.ptr);
  77                 GC.KeepAlive(this);
  78                 if (ret >= 0 && ret <= 4096) { return null; }
  79                 org.ldk.structs.ChannelMonitorUpdate ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelMonitorUpdate(null, ret); }
  80                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.AddLast(this); };
  81                 return ret_hu_conv;
  82         }
  83
  84         /**
  85          * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
  86          */
  87         public byte[] write() {
  88                 byte[] ret = bindings.ChannelMonitorUpdate_write(this.ptr);
  89                 GC.KeepAlive(this);
  90                 return ret;
  91         }
  92
  93         /**
  94          * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
  95          */
  96         public static Result_ChannelMonitorUpdateDecodeErrorZ read(byte[] ser) {
  97                 long ret = bindings.ChannelMonitorUpdate_read(ser);
  98                 GC.KeepAlive(ser);
  99                 if (ret >= 0 && ret <= 4096) { return null; }
 100                 Result_ChannelMonitorUpdateDecodeErrorZ ret_hu_conv = Result_ChannelMonitorUpdateDecodeErrorZ.constr_from_ptr(ret);
 101                 return ret_hu_conv;
 102         }
 103
 104 }
 105 } } }