97d0f60b6e793f5daa46150fe7e611322b1a9974
[ldk-java] / src / main / java / org / ldk / structs / ChannelUpdate.java
1 package org.ldk.structs;
2
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
5 import org.ldk.util.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
9
10
11 /**
12  * A [`channel_update`] message to be sent to or received from a peer.
13  * 
14  * [`channel_update`]: https://github.com/lightning/bolts/blob/master/07-routing-gossip.md#the-channel_update-message
15  */
16 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
17 public class ChannelUpdate extends CommonBase {
18         ChannelUpdate(Object _dummy, long ptr) { super(ptr); }
19         @Override @SuppressWarnings("deprecation")
20         protected void finalize() throws Throwable {
21                 super.finalize();
22                 if (ptr != 0) { bindings.ChannelUpdate_free(ptr); }
23         }
24
25         /**
26          * A signature of the channel update
27          */
28         public byte[] get_signature() {
29                 byte[] ret = bindings.ChannelUpdate_get_signature(this.ptr);
30                 Reference.reachabilityFence(this);
31                 return ret;
32         }
33
34         /**
35          * A signature of the channel update
36          */
37         public void set_signature(byte[] val) {
38                 bindings.ChannelUpdate_set_signature(this.ptr, InternalUtils.check_arr_len(val, 64));
39                 Reference.reachabilityFence(this);
40                 Reference.reachabilityFence(val);
41         }
42
43         /**
44          * The actual channel update
45          */
46         public UnsignedChannelUpdate get_contents() {
47                 long ret = bindings.ChannelUpdate_get_contents(this.ptr);
48                 Reference.reachabilityFence(this);
49                 if (ret >= 0 && ret <= 4096) { return null; }
50                 org.ldk.structs.UnsignedChannelUpdate ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.UnsignedChannelUpdate(null, ret); }
51                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
52                 return ret_hu_conv;
53         }
54
55         /**
56          * The actual channel update
57          */
58         public void set_contents(org.ldk.structs.UnsignedChannelUpdate val) {
59                 bindings.ChannelUpdate_set_contents(this.ptr, val == null ? 0 : val.ptr);
60                 Reference.reachabilityFence(this);
61                 Reference.reachabilityFence(val);
62                 if (this != null) { this.ptrs_to.add(val); };
63         }
64
65         /**
66          * Constructs a new ChannelUpdate given each field
67          */
68         public static ChannelUpdate of(byte[] signature_arg, org.ldk.structs.UnsignedChannelUpdate contents_arg) {
69                 long ret = bindings.ChannelUpdate_new(InternalUtils.check_arr_len(signature_arg, 64), contents_arg == null ? 0 : contents_arg.ptr);
70                 Reference.reachabilityFence(signature_arg);
71                 Reference.reachabilityFence(contents_arg);
72                 if (ret >= 0 && ret <= 4096) { return null; }
73                 org.ldk.structs.ChannelUpdate ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelUpdate(null, ret); }
74                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
75                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(contents_arg); };
76                 return ret_hu_conv;
77         }
78
79         long clone_ptr() {
80                 long ret = bindings.ChannelUpdate_clone_ptr(this.ptr);
81                 Reference.reachabilityFence(this);
82                 return ret;
83         }
84
85         /**
86          * Creates a copy of the ChannelUpdate
87          */
88         public ChannelUpdate clone() {
89                 long ret = bindings.ChannelUpdate_clone(this.ptr);
90                 Reference.reachabilityFence(this);
91                 if (ret >= 0 && ret <= 4096) { return null; }
92                 org.ldk.structs.ChannelUpdate ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelUpdate(null, ret); }
93                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
94                 return ret_hu_conv;
95         }
96
97         /**
98          * Checks if two ChannelUpdates contain equal inner contents.
99          * This ignores pointers and is_owned flags and looks at the values in fields.
100          * Two objects with NULL inner values will be considered "equal" here.
101          */
102         public boolean eq(org.ldk.structs.ChannelUpdate b) {
103                 boolean ret = bindings.ChannelUpdate_eq(this.ptr, b == null ? 0 : b.ptr);
104                 Reference.reachabilityFence(this);
105                 Reference.reachabilityFence(b);
106                 if (this != null) { this.ptrs_to.add(b); };
107                 return ret;
108         }
109
110         @Override public boolean equals(Object o) {
111                 if (!(o instanceof ChannelUpdate)) return false;
112                 return this.eq((ChannelUpdate)o);
113         }
114         /**
115          * Serialize the ChannelUpdate object into a byte array which can be read by ChannelUpdate_read
116          */
117         public byte[] write() {
118                 byte[] ret = bindings.ChannelUpdate_write(this.ptr);
119                 Reference.reachabilityFence(this);
120                 return ret;
121         }
122
123         /**
124          * Read a ChannelUpdate from a byte array, created by ChannelUpdate_write
125          */
126         public static Result_ChannelUpdateDecodeErrorZ read(byte[] ser) {
127                 long ret = bindings.ChannelUpdate_read(ser);
128                 Reference.reachabilityFence(ser);
129                 if (ret >= 0 && ret <= 4096) { return null; }
130                 Result_ChannelUpdateDecodeErrorZ ret_hu_conv = Result_ChannelUpdateDecodeErrorZ.constr_from_ptr(ret);
131                 return ret_hu_conv;
132         }
133
134 }