Merge pull request #29 from TheBlueMatt/main

[ldk-java] / src / main / java / org / ldk / structs / MessageHandler.java

diff --git a/src/main/java/org/ldk/structs/MessageHandler.java b/src/main/java/org/ldk/structs/MessageHandler.java
index 389e2a88e1ed032bc3cae30e9bb27adca23724ec..7077b4a2460e59432ce0cb59aa7f97bd0c5b6a34 100644 (file)
--- a/src/main/java/org/ldk/structs/MessageHandler.java
+++ b/src/main/java/org/ldk/structs/MessageHandler.java
@@ -5,6 +5,10 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * Provides references to trait impls which handle different types of messages.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class MessageHandler extends CommonBase {
        MessageHandler(Object _dummy, long ptr) { super(ptr); }
@@ -14,6 +18,12 @@ public class MessageHandler extends CommonBase {
                if (ptr != 0) { bindings.MessageHandler_free(ptr); }
        }
 
+       /**
+        * A message handler which handles messages specific to channels. Usually this is just a
+        * [`ChannelManager`] object or an [`ErroringMessageHandler`].
+        * 
+        * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
+        */
        public ChannelMessageHandler get_chan_handler() {
                long ret = bindings.MessageHandler_get_chan_handler(this.ptr);
                ChannelMessageHandler ret_hu_conv = new ChannelMessageHandler(null, ret);
@@ -21,11 +31,24 @@ public class MessageHandler extends CommonBase {
                return ret_hu_conv;
        }
 
+       /**
+        * A message handler which handles messages specific to channels. Usually this is just a
+        * [`ChannelManager`] object or an [`ErroringMessageHandler`].
+        * 
+        * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
+        */
        public void set_chan_handler(ChannelMessageHandler val) {
                bindings.MessageHandler_set_chan_handler(this.ptr, val == null ? 0 : val.ptr);
                this.ptrs_to.add(val);
        }
 
+       /**
+        * A message handler which handles messages updating our knowledge of the network channel
+        * graph. Usually this is just a [`NetGraphMsgHandler`] object or an
+        * [`IgnoringMessageHandler`].
+        * 
+        * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
+        */
        public RoutingMessageHandler get_route_handler() {
                long ret = bindings.MessageHandler_get_route_handler(this.ptr);
                RoutingMessageHandler ret_hu_conv = new RoutingMessageHandler(null, ret);
@@ -33,12 +56,22 @@ public class MessageHandler extends CommonBase {
                return ret_hu_conv;
        }
 
+       /**
+        * A message handler which handles messages updating our knowledge of the network channel
+        * graph. Usually this is just a [`NetGraphMsgHandler`] object or an
+        * [`IgnoringMessageHandler`].
+        * 
+        * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
+        */
        public void set_route_handler(RoutingMessageHandler val) {
                bindings.MessageHandler_set_route_handler(this.ptr, val == null ? 0 : val.ptr);
                this.ptrs_to.add(val);
        }
 
-       public static MessageHandler constructor_new(ChannelMessageHandler chan_handler_arg, RoutingMessageHandler route_handler_arg) {
+       /**
+        * Constructs a new MessageHandler given each field
+        */
+       public static MessageHandler of(ChannelMessageHandler chan_handler_arg, RoutingMessageHandler route_handler_arg) {
                long ret = bindings.MessageHandler_new(chan_handler_arg == null ? 0 : chan_handler_arg.ptr, route_handler_arg == null ? 0 : route_handler_arg.ptr);
                MessageHandler ret_hu_conv = new MessageHandler(null, ret);
                ret_hu_conv.ptrs_to.add(ret_hu_conv);