[Java] Update auto-generated bindings
[ldk-java] / src / main / java / org / ldk / structs / NetAddress.java
index 32e333f2fb7982adbb432421ebd32036bcfed1c7..73f5bc325d6491b63c0adc7853217fe9a9314afc 100644 (file)
@@ -4,16 +4,21 @@ 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;
 
+
+/**
+ * An address which can be used to connect to a remote peer
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class NetAddress extends CommonBase {
        private NetAddress(Object _dummy, long ptr) { super(ptr); }
        @Override @SuppressWarnings("deprecation")
        protected void finalize() throws Throwable {
                super.finalize();
-               bindings.NetAddress_free(ptr);
+               if (ptr != 0) { bindings.NetAddress_free(ptr); }
        }
-       long conv_to_c() { assert false; return 0; /* Should only be called on subclasses */ }
        static NetAddress constr_from_ptr(long ptr) {
                bindings.LDKNetAddress raw_val = bindings.LDKNetAddress_ref_from_ptr(ptr);
                if (raw_val.getClass() == bindings.LDKNetAddress.IPv4.class) {
@@ -31,41 +36,77 @@ public class NetAddress extends CommonBase {
                assert false; return null; // Unreachable without extending the (internal) bindings interface
        }
 
+       /**
+        * An IPv4 address/port on which the peer is listening.
+        */
        public final static class IPv4 extends NetAddress {
-               public byte[] addr;
-               public short port;
+               /**
+                * The 4-byte IPv4 address
+               */
+               public final byte[] addr;
+               /**
+                * The port on which the node is listening
+               */
+               public final short port;
                private IPv4(long ptr, bindings.LDKNetAddress.IPv4 obj) {
                        super(null, ptr);
                        this.addr = obj.addr;
                        this.port = obj.port;
                }
-               @Override long conv_to_c() { return 0; /*XXX*/ }
        }
+       /**
+        * An IPv6 address/port on which the peer is listening.
+        */
        public final static class IPv6 extends NetAddress {
-               public byte[] addr;
-               public short port;
+               /**
+                * The 16-byte IPv6 address
+               */
+               public final byte[] addr;
+               /**
+                * The port on which the node is listening
+               */
+               public final short port;
                private IPv6(long ptr, bindings.LDKNetAddress.IPv6 obj) {
                        super(null, ptr);
                        this.addr = obj.addr;
                        this.port = obj.port;
                }
-               @Override long conv_to_c() { return 0; /*XXX*/ }
        }
+       /**
+        * An old-style Tor onion address/port on which the peer is listening.
+        * 
+        * This field is deprecated and the Tor network generally no longer supports V2 Onion
+        * addresses. Thus, the details are not parsed here.
+        */
        public final static class OnionV2 extends NetAddress {
-               public byte[] addr;
-               public short port;
+               public final byte[] onion_v2;
                private OnionV2(long ptr, bindings.LDKNetAddress.OnionV2 obj) {
                        super(null, ptr);
-                       this.addr = obj.addr;
-                       this.port = obj.port;
+                       this.onion_v2 = obj.onion_v2;
                }
-               @Override long conv_to_c() { return 0; /*XXX*/ }
        }
+       /**
+        * A new-style Tor onion address/port on which the peer is listening.
+        * To create the human-readable \"hostname\", concatenate ed25519_pubkey, checksum, and version,
+        * wrap as base32 and append \".onion\".
+        */
        public final static class OnionV3 extends NetAddress {
-               public byte[] ed25519_pubkey;
-               public short checksum;
-               public byte version;
-               public short port;
+               /**
+                * The ed25519 long-term public key of the peer
+               */
+               public final byte[] ed25519_pubkey;
+               /**
+                * The checksum of the pubkey and version, as included in the onion address
+               */
+               public final short checksum;
+               /**
+                * The version byte, as defined by the Tor Onion v3 spec.
+               */
+               public final byte version;
+               /**
+                * The port on which the node is listening
+               */
+               public final short port;
                private OnionV3(long ptr, bindings.LDKNetAddress.OnionV3 obj) {
                        super(null, ptr);
                        this.ed25519_pubkey = obj.ed25519_pubkey;
@@ -73,6 +114,96 @@ public class NetAddress extends CommonBase {
                        this.version = obj.version;
                        this.port = obj.port;
                }
-               @Override long conv_to_c() { return 0; /*XXX*/ }
        }
+       long clone_ptr() {
+               long ret = bindings.NetAddress_clone_ptr(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       /**
+        * Creates a copy of the NetAddress
+        */
+       public NetAddress clone() {
+               long ret = bindings.NetAddress_clone(this.ptr);
+               Reference.reachabilityFence(this);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.NetAddress ret_hu_conv = org.ldk.structs.NetAddress.constr_from_ptr(ret);
+               ret_hu_conv.ptrs_to.add(this);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Utility method to constructs a new IPv4-variant NetAddress
+        */
+       public static NetAddress ipv4(byte[] addr, short port) {
+               long ret = bindings.NetAddress_ipv4(InternalUtils.check_arr_len(addr, 4), port);
+               Reference.reachabilityFence(addr);
+               Reference.reachabilityFence(port);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.NetAddress ret_hu_conv = org.ldk.structs.NetAddress.constr_from_ptr(ret);
+               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Utility method to constructs a new IPv6-variant NetAddress
+        */
+       public static NetAddress ipv6(byte[] addr, short port) {
+               long ret = bindings.NetAddress_ipv6(InternalUtils.check_arr_len(addr, 16), port);
+               Reference.reachabilityFence(addr);
+               Reference.reachabilityFence(port);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.NetAddress ret_hu_conv = org.ldk.structs.NetAddress.constr_from_ptr(ret);
+               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Utility method to constructs a new OnionV2-variant NetAddress
+        */
+       public static NetAddress onion_v2(byte[] a) {
+               long ret = bindings.NetAddress_onion_v2(InternalUtils.check_arr_len(a, 12));
+               Reference.reachabilityFence(a);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.NetAddress ret_hu_conv = org.ldk.structs.NetAddress.constr_from_ptr(ret);
+               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Utility method to constructs a new OnionV3-variant NetAddress
+        */
+       public static NetAddress onion_v3(byte[] ed25519_pubkey, short checksum, byte version, short port) {
+               long ret = bindings.NetAddress_onion_v3(InternalUtils.check_arr_len(ed25519_pubkey, 32), checksum, version, port);
+               Reference.reachabilityFence(ed25519_pubkey);
+               Reference.reachabilityFence(checksum);
+               Reference.reachabilityFence(version);
+               Reference.reachabilityFence(port);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               org.ldk.structs.NetAddress ret_hu_conv = org.ldk.structs.NetAddress.constr_from_ptr(ret);
+               ret_hu_conv.ptrs_to.add(ret_hu_conv);
+               return ret_hu_conv;
+       }
+
+       /**
+        * Serialize the NetAddress object into a byte array which can be read by NetAddress_read
+        */
+       public byte[] write() {
+               byte[] ret = bindings.NetAddress_write(this.ptr);
+               Reference.reachabilityFence(this);
+               return ret;
+       }
+
+       /**
+        * Read a NetAddress from a byte array, created by NetAddress_write
+        */
+       public static Result_NetAddressDecodeErrorZ read(byte[] ser) {
+               long ret = bindings.NetAddress_read(ser);
+               Reference.reachabilityFence(ser);
+               if (ret >= 0 && ret <= 4096) { return null; }
+               Result_NetAddressDecodeErrorZ ret_hu_conv = Result_NetAddressDecodeErrorZ.constr_from_ptr(ret);
+               return ret_hu_conv;
+       }
+
 }