Update java bindings with new generator and new upstream code
[ldk-java] / src / main / java / org / ldk / structs / ChannelMessageHandler.java
index 2b9aebe4680264b50744ed174afee298448ee6a4..5eaedc1652e4e16ed601ee33e25a5e8c177c1d45 100644 (file)
@@ -5,6 +5,12 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+/**
+ * A trait to describe an object which can receive channel messages.
+ * 
+ * Messages MAY be called in parallel when they originate from different their_node_ids, however
+ * they MUST NOT be called in parallel when the two calls have the same their_node_id.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class ChannelMessageHandler extends CommonBase {
        final bindings.LDKChannelMessageHandler bindings_instance;
@@ -21,24 +27,84 @@ public class ChannelMessageHandler extends CommonBase {
        }
 
        public static interface ChannelMessageHandlerInterface {
+               /**
+                * Handle an incoming open_channel message from the given peer.
+                */
                void handle_open_channel(byte[] their_node_id, InitFeatures their_features, OpenChannel msg);
+               /**
+                * Handle an incoming accept_channel message from the given peer.
+                */
                void handle_accept_channel(byte[] their_node_id, InitFeatures their_features, AcceptChannel msg);
+               /**
+                * Handle an incoming funding_created message from the given peer.
+                */
                void handle_funding_created(byte[] their_node_id, FundingCreated msg);
+               /**
+                * Handle an incoming funding_signed message from the given peer.
+                */
                void handle_funding_signed(byte[] their_node_id, FundingSigned msg);
+               /**
+                * Handle an incoming funding_locked message from the given peer.
+                */
                void handle_funding_locked(byte[] their_node_id, FundingLocked msg);
+               /**
+                * Handle an incoming shutdown message from the given peer.
+                */
                void handle_shutdown(byte[] their_node_id, InitFeatures their_features, Shutdown msg);
+               /**
+                * Handle an incoming closing_signed message from the given peer.
+                */
                void handle_closing_signed(byte[] their_node_id, ClosingSigned msg);
+               /**
+                * Handle an incoming update_add_htlc message from the given peer.
+                */
                void handle_update_add_htlc(byte[] their_node_id, UpdateAddHTLC msg);
+               /**
+                * Handle an incoming update_fulfill_htlc message from the given peer.
+                */
                void handle_update_fulfill_htlc(byte[] their_node_id, UpdateFulfillHTLC msg);
+               /**
+                * Handle an incoming update_fail_htlc message from the given peer.
+                */
                void handle_update_fail_htlc(byte[] their_node_id, UpdateFailHTLC msg);
+               /**
+                * Handle an incoming update_fail_malformed_htlc message from the given peer.
+                */
                void handle_update_fail_malformed_htlc(byte[] their_node_id, UpdateFailMalformedHTLC msg);
+               /**
+                * Handle an incoming commitment_signed message from the given peer.
+                */
                void handle_commitment_signed(byte[] their_node_id, CommitmentSigned msg);
+               /**
+                * Handle an incoming revoke_and_ack message from the given peer.
+                */
                void handle_revoke_and_ack(byte[] their_node_id, RevokeAndACK msg);
+               /**
+                * Handle an incoming update_fee message from the given peer.
+                */
                void handle_update_fee(byte[] their_node_id, UpdateFee msg);
+               /**
+                * Handle an incoming announcement_signatures message from the given peer.
+                */
                void handle_announcement_signatures(byte[] their_node_id, AnnouncementSignatures msg);
+               /**
+                * Indicates a connection to the peer failed/an existing connection was lost. If no connection
+                * is believed to be possible in the future (eg they're sending us messages we don't
+                * understand or indicate they require unknown feature bits), no_connection_possible is set
+                * and any outstanding channels should be failed.
+                */
                void peer_disconnected(byte[] their_node_id, boolean no_connection_possible);
+               /**
+                * Handle a peer reconnecting, possibly generating channel_reestablish message(s).
+                */
                void peer_connected(byte[] their_node_id, Init msg);
+               /**
+                * Handle an incoming channel_reestablish message from the given peer.
+                */
                void handle_channel_reestablish(byte[] their_node_id, ChannelReestablish msg);
+               /**
+                * Handle an incoming error message from the given peer.
+                */
                void handle_error(byte[] their_node_id, ErrorMessage msg);
        }
        private static class LDKChannelMessageHandlerHolder { ChannelMessageHandler held; }
@@ -128,98 +194,158 @@ public class ChannelMessageHandler extends CommonBase {
                }, MessageSendEventsProvider.new_impl(MessageSendEventsProvider_impl).bindings_instance);
                return impl_holder.held;
        }
+       /**
+        * Handle an incoming open_channel message from the given peer.
+        */
        public void handle_open_channel(byte[] their_node_id, InitFeatures their_features, OpenChannel msg) {
                bindings.ChannelMessageHandler_handle_open_channel(this.ptr, their_node_id, their_features == null ? 0 : their_features.ptr & ~1, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(their_features);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming accept_channel message from the given peer.
+        */
        public void handle_accept_channel(byte[] their_node_id, InitFeatures their_features, AcceptChannel msg) {
                bindings.ChannelMessageHandler_handle_accept_channel(this.ptr, their_node_id, their_features == null ? 0 : their_features.ptr & ~1, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(their_features);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming funding_created message from the given peer.
+        */
        public void handle_funding_created(byte[] their_node_id, FundingCreated msg) {
                bindings.ChannelMessageHandler_handle_funding_created(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming funding_signed message from the given peer.
+        */
        public void handle_funding_signed(byte[] their_node_id, FundingSigned msg) {
                bindings.ChannelMessageHandler_handle_funding_signed(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming funding_locked message from the given peer.
+        */
        public void handle_funding_locked(byte[] their_node_id, FundingLocked msg) {
                bindings.ChannelMessageHandler_handle_funding_locked(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming shutdown message from the given peer.
+        */
        public void handle_shutdown(byte[] their_node_id, InitFeatures their_features, Shutdown msg) {
                bindings.ChannelMessageHandler_handle_shutdown(this.ptr, their_node_id, their_features == null ? 0 : their_features.ptr & ~1, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(their_features);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming closing_signed message from the given peer.
+        */
        public void handle_closing_signed(byte[] their_node_id, ClosingSigned msg) {
                bindings.ChannelMessageHandler_handle_closing_signed(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming update_add_htlc message from the given peer.
+        */
        public void handle_update_add_htlc(byte[] their_node_id, UpdateAddHTLC msg) {
                bindings.ChannelMessageHandler_handle_update_add_htlc(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming update_fulfill_htlc message from the given peer.
+        */
        public void handle_update_fulfill_htlc(byte[] their_node_id, UpdateFulfillHTLC msg) {
                bindings.ChannelMessageHandler_handle_update_fulfill_htlc(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming update_fail_htlc message from the given peer.
+        */
        public void handle_update_fail_htlc(byte[] their_node_id, UpdateFailHTLC msg) {
                bindings.ChannelMessageHandler_handle_update_fail_htlc(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming update_fail_malformed_htlc message from the given peer.
+        */
        public void handle_update_fail_malformed_htlc(byte[] their_node_id, UpdateFailMalformedHTLC msg) {
                bindings.ChannelMessageHandler_handle_update_fail_malformed_htlc(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming commitment_signed message from the given peer.
+        */
        public void handle_commitment_signed(byte[] their_node_id, CommitmentSigned msg) {
                bindings.ChannelMessageHandler_handle_commitment_signed(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming revoke_and_ack message from the given peer.
+        */
        public void handle_revoke_and_ack(byte[] their_node_id, RevokeAndACK msg) {
                bindings.ChannelMessageHandler_handle_revoke_and_ack(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming update_fee message from the given peer.
+        */
        public void handle_update_fee(byte[] their_node_id, UpdateFee msg) {
                bindings.ChannelMessageHandler_handle_update_fee(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming announcement_signatures message from the given peer.
+        */
        public void handle_announcement_signatures(byte[] their_node_id, AnnouncementSignatures msg) {
                bindings.ChannelMessageHandler_handle_announcement_signatures(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Indicates a connection to the peer failed/an existing connection was lost. If no connection
+        * is believed to be possible in the future (eg they're sending us messages we don't
+        * understand or indicate they require unknown feature bits), no_connection_possible is set
+        * and any outstanding channels should be failed.
+        */
        public void peer_disconnected(byte[] their_node_id, boolean no_connection_possible) {
                bindings.ChannelMessageHandler_peer_disconnected(this.ptr, their_node_id, no_connection_possible);
        }
 
+       /**
+        * Handle a peer reconnecting, possibly generating channel_reestablish message(s).
+        */
        public void peer_connected(byte[] their_node_id, Init msg) {
                bindings.ChannelMessageHandler_peer_connected(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming channel_reestablish message from the given peer.
+        */
        public void handle_channel_reestablish(byte[] their_node_id, ChannelReestablish msg) {
                bindings.ChannelMessageHandler_handle_channel_reestablish(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);
        }
 
+       /**
+        * Handle an incoming error message from the given peer.
+        */
        public void handle_error(byte[] their_node_id, ErrorMessage msg) {
                bindings.ChannelMessageHandler_handle_error(this.ptr, their_node_id, msg == null ? 0 : msg.ptr & ~1);
                this.ptrs_to.add(msg);