X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FNodeInfo.java;h=803f8e692c944dd1b672a60f982ab4ddee9cce5f;hb=1854b5cebef22ace9e9e4dd191f609818df9ce08;hp=8b9837398d36a2f49bbfb685bf011357ebe09321;hpb=9e8763c71cd61d55be7c869d973524f75209a3f3;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/NodeInfo.java b/src/main/java/org/ldk/structs/NodeInfo.java
index 8b983739..803f8e69 100644
--- a/src/main/java/org/ldk/structs/NodeInfo.java
+++ b/src/main/java/org/ldk/structs/NodeInfo.java
@@ -4,7 +4,13 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import java.lang.ref.Reference;
+import javax.annotation.Nullable;
 
+
+/**
+ * Details about a node in the network, known from the network announcement.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class NodeInfo extends CommonBase {
 	NodeInfo(Object _dummy, long ptr) { super(ptr); }
@@ -14,57 +20,123 @@ public class NodeInfo extends CommonBase {
 		if (ptr != 0) { bindings.NodeInfo_free(ptr); }
 	}
 
+	/**
+	 * All valid channels a node has announced
+	 */
 	public void set_channels(long[] val) {
 		bindings.NodeInfo_set_channels(this.ptr, val);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(val);
 	}
 
+	/**
+	 * Lowest fees enabling routing via any of the enabled, known channels to a node.
+	 * The two fields (flat and proportional fee) are independent,
+	 * meaning they don't have to refer to the same channel.
+	 * 
+	 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+	 */
+	@Nullable
 	public RoutingFees get_lowest_inbound_channel_fees() {
 		long ret = bindings.NodeInfo_get_lowest_inbound_channel_fees(this.ptr);
-		RoutingFees ret_hu_conv = new RoutingFees(null, ret);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		RoutingFees ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new RoutingFees(null, ret); }
 		ret_hu_conv.ptrs_to.add(this);
 		return ret_hu_conv;
 	}
 
-	public void set_lowest_inbound_channel_fees(RoutingFees val) {
+	/**
+	 * Lowest fees enabling routing via any of the enabled, known channels to a node.
+	 * The two fields (flat and proportional fee) are independent,
+	 * meaning they don't have to refer to the same channel.
+	 * 
+	 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
+	 */
+	public void set_lowest_inbound_channel_fees(@Nullable RoutingFees val) {
 		bindings.NodeInfo_set_lowest_inbound_channel_fees(this.ptr, val == null ? 0 : val.ptr & ~1);
-		this.ptrs_to.add(val);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(val);
 	}
 
+	/**
+	 * More information about a node from node_announcement.
+	 * Optional because we store a Node entry after learning about it from
+	 * a channel announcement, but before receiving a node announcement.
+	 * 
+	 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
+	 */
+	@Nullable
 	public NodeAnnouncementInfo get_announcement_info() {
 		long ret = bindings.NodeInfo_get_announcement_info(this.ptr);
-		NodeAnnouncementInfo ret_hu_conv = new NodeAnnouncementInfo(null, ret);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		NodeAnnouncementInfo ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new NodeAnnouncementInfo(null, ret); }
 		ret_hu_conv.ptrs_to.add(this);
 		return ret_hu_conv;
 	}
 
-	public void set_announcement_info(NodeAnnouncementInfo val) {
+	/**
+	 * More information about a node from node_announcement.
+	 * Optional because we store a Node entry after learning about it from
+	 * a channel announcement, but before receiving a node announcement.
+	 * 
+	 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
+	 */
+	public void set_announcement_info(@Nullable NodeAnnouncementInfo val) {
 		bindings.NodeInfo_set_announcement_info(this.ptr, val == null ? 0 : val.ptr & ~1);
-		this.ptrs_to.add(val);
+		Reference.reachabilityFence(this);
+		Reference.reachabilityFence(val);
 	}
 
-	public static NodeInfo constructor_new(long[] channels_arg, RoutingFees lowest_inbound_channel_fees_arg, NodeAnnouncementInfo announcement_info_arg) {
+	/**
+	 * Constructs a new NodeInfo given each field
+	 */
+	public static NodeInfo of(long[] channels_arg, RoutingFees lowest_inbound_channel_fees_arg, NodeAnnouncementInfo announcement_info_arg) {
 		long ret = bindings.NodeInfo_new(channels_arg, lowest_inbound_channel_fees_arg == null ? 0 : lowest_inbound_channel_fees_arg.ptr & ~1, announcement_info_arg == null ? 0 : announcement_info_arg.ptr & ~1);
-		NodeInfo ret_hu_conv = new NodeInfo(null, ret);
+		Reference.reachabilityFence(channels_arg);
+		Reference.reachabilityFence(lowest_inbound_channel_fees_arg);
+		Reference.reachabilityFence(announcement_info_arg);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		NodeInfo ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new NodeInfo(null, ret); }
 		ret_hu_conv.ptrs_to.add(ret_hu_conv);
-		ret_hu_conv.ptrs_to.add(lowest_inbound_channel_fees_arg);
-		ret_hu_conv.ptrs_to.add(announcement_info_arg);
 		return ret_hu_conv;
 	}
 
+	long clone_ptr() {
+		long ret = bindings.NodeInfo_clone_ptr(this.ptr);
+		Reference.reachabilityFence(this);
+		return ret;
+	}
+
+	/**
+	 * Creates a copy of the NodeInfo
+	 */
 	public NodeInfo clone() {
 		long ret = bindings.NodeInfo_clone(this.ptr);
-		NodeInfo ret_hu_conv = new NodeInfo(null, ret);
+		Reference.reachabilityFence(this);
+		if (ret >= 0 && ret <= 4096) { return null; }
+		NodeInfo ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new NodeInfo(null, ret); }
 		ret_hu_conv.ptrs_to.add(this);
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Serialize the NodeInfo object into a byte array which can be read by NodeInfo_read
+	 */
 	public byte[] write() {
 		byte[] ret = bindings.NodeInfo_write(this.ptr);
+		Reference.reachabilityFence(this);
 		return ret;
 	}
 
-	public static Result_NodeInfoDecodeErrorZ constructor_read(byte[] ser) {
+	/**
+	 * Read a NodeInfo from a byte array, created by NodeInfo_write
+	 */
+	public static Result_NodeInfoDecodeErrorZ read(byte[] ser) {
 		long ret = bindings.NodeInfo_read(ser);
+		Reference.reachabilityFence(ser);
+		if (ret >= 0 && ret <= 4096) { return null; }
 		Result_NodeInfoDecodeErrorZ ret_hu_conv = Result_NodeInfoDecodeErrorZ.constr_from_ptr(ret);
 		return ret_hu_conv;
 	}