Update auto-generated bindings
[ldk-java] / src / main / java / org / ldk / structs / ChannelMonitorUpdate.java
index 7aabae2fe7f9176eabc38dbda60cda2e3631ee5b..fec769a5ee731b6158b326cf56f3116b1ea89655 100644 (file)
@@ -2,34 +2,83 @@ package org.ldk.structs;
 
 import org.ldk.impl.bindings;
 import org.ldk.enums.*;
+import org.ldk.util.*;
+import java.util.Arrays;
 
+
+/**
+ * An update generated by the underlying Channel itself which contains some new information the
+ * ChannelMonitor should be made aware of.
+ */
+@SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class ChannelMonitorUpdate extends CommonBase {
        ChannelMonitorUpdate(Object _dummy, long ptr) { super(ptr); }
        @Override @SuppressWarnings("deprecation")
        protected void finalize() throws Throwable {
                super.finalize();
-               bindings.ChannelMonitorUpdate_free(ptr);
+               if (ptr != 0) { bindings.ChannelMonitorUpdate_free(ptr); }
        }
 
-       public ChannelMonitorUpdate(ChannelMonitorUpdate orig) {
-               super(bindings.ChannelMonitorUpdate_clone(orig == null ? 0 : orig.ptr & ~1));
-               this.ptrs_to.add(orig);
+       /**
+        * The sequence number of this update. Updates *must* be replayed in-order according to this
+        * sequence number (and updates may panic if they are not). The update_id values are strictly
+        * increasing and increase by one for each new update, with one exception specified below.
+        * 
+        * This sequence number is also used to track up to which points updates which returned
+        * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
+        * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
+        * 
+        * The only instance where update_id values are not strictly increasing is the case where we
+        * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
+        * its docs for more details.
+        */
+       public long get_update_id() {
+               long ret = bindings.ChannelMonitorUpdate_get_update_id(this.ptr);
+               return ret;
        }
 
-       public long get_update_id(ChannelMonitorUpdate this_ptr) {
-               long ret = bindings.ChannelMonitorUpdate_get_update_id(this_ptr == null ? 0 : this_ptr.ptr & ~1);
-               this.ptrs_to.add(this_ptr);
-               return ret;
+       /**
+        * The sequence number of this update. Updates *must* be replayed in-order according to this
+        * sequence number (and updates may panic if they are not). The update_id values are strictly
+        * increasing and increase by one for each new update, with one exception specified below.
+        * 
+        * This sequence number is also used to track up to which points updates which returned
+        * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
+        * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
+        * 
+        * The only instance where update_id values are not strictly increasing is the case where we
+        * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
+        * its docs for more details.
+        */
+       public void set_update_id(long val) {
+               bindings.ChannelMonitorUpdate_set_update_id(this.ptr, val);
        }
 
-       public void set_update_id(ChannelMonitorUpdate this_ptr, long val) {
-               bindings.ChannelMonitorUpdate_set_update_id(this_ptr == null ? 0 : this_ptr.ptr & ~1, val);
-               this.ptrs_to.add(this_ptr);
+       /**
+        * Creates a copy of the ChannelMonitorUpdate
+        */
+       public ChannelMonitorUpdate clone() {
+               long ret = bindings.ChannelMonitorUpdate_clone(this.ptr);
+               ChannelMonitorUpdate ret_hu_conv = new ChannelMonitorUpdate(null, ret);
+               ret_hu_conv.ptrs_to.add(this);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
+        */
+       public byte[] write() {
+               byte[] ret = bindings.ChannelMonitorUpdate_write(this.ptr);
+               return ret;
        }
 
-       // Skipped ChannelMonitorUpdate_write
-       public ChannelMonitorUpdate(byte[] ser) {
-               super(bindings.ChannelMonitorUpdate_read(ser));
+       /**
+        * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
+        */
+       public static Result_ChannelMonitorUpdateDecodeErrorZ read(byte[] ser) {
+               long ret = bindings.ChannelMonitorUpdate_read(ser);
+               Result_ChannelMonitorUpdateDecodeErrorZ ret_hu_conv = Result_ChannelMonitorUpdateDecodeErrorZ.constr_from_ptr(ret);
+               return ret_hu_conv;
        }
 
 }