7ee1f980a466874f49ddaf97f50cd589d17b172a
[ldk-java] / src / main / java / org / ldk / structs / Ping.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 [`ping`] message to be sent to or received from a peer.
13  * 
14  * [`ping`]: https://github.com/lightning/bolts/blob/master/01-messaging.md#the-ping-and-pong-messages
15  */
16 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
17 public class Ping extends CommonBase {
18         Ping(Object _dummy, long ptr) { super(ptr); }
19         @Override @SuppressWarnings("deprecation")
20         protected void finalize() throws Throwable {
21                 super.finalize();
22                 if (ptr != 0) { bindings.Ping_free(ptr); }
23         }
24
25         /**
26          * The desired response length.
27          */
28         public short get_ponglen() {
29                 short ret = bindings.Ping_get_ponglen(this.ptr);
30                 Reference.reachabilityFence(this);
31                 return ret;
32         }
33
34         /**
35          * The desired response length.
36          */
37         public void set_ponglen(short val) {
38                 bindings.Ping_set_ponglen(this.ptr, val);
39                 Reference.reachabilityFence(this);
40                 Reference.reachabilityFence(val);
41         }
42
43         /**
44          * The ping packet size.
45          * 
46          * This field is not sent on the wire. byteslen zeros are sent.
47          */
48         public short get_byteslen() {
49                 short ret = bindings.Ping_get_byteslen(this.ptr);
50                 Reference.reachabilityFence(this);
51                 return ret;
52         }
53
54         /**
55          * The ping packet size.
56          * 
57          * This field is not sent on the wire. byteslen zeros are sent.
58          */
59         public void set_byteslen(short val) {
60                 bindings.Ping_set_byteslen(this.ptr, val);
61                 Reference.reachabilityFence(this);
62                 Reference.reachabilityFence(val);
63         }
64
65         /**
66          * Constructs a new Ping given each field
67          */
68         public static Ping of(short ponglen_arg, short byteslen_arg) {
69                 long ret = bindings.Ping_new(ponglen_arg, byteslen_arg);
70                 Reference.reachabilityFence(ponglen_arg);
71                 Reference.reachabilityFence(byteslen_arg);
72                 if (ret >= 0 && ret <= 4096) { return null; }
73                 org.ldk.structs.Ping ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Ping(null, ret); }
74                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(ret_hu_conv); };
75                 return ret_hu_conv;
76         }
77
78         long clone_ptr() {
79                 long ret = bindings.Ping_clone_ptr(this.ptr);
80                 Reference.reachabilityFence(this);
81                 return ret;
82         }
83
84         /**
85          * Creates a copy of the Ping
86          */
87         public Ping clone() {
88                 long ret = bindings.Ping_clone(this.ptr);
89                 Reference.reachabilityFence(this);
90                 if (ret >= 0 && ret <= 4096) { return null; }
91                 org.ldk.structs.Ping ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.Ping(null, ret); }
92                 if (ret_hu_conv != null) { ret_hu_conv.ptrs_to.add(this); };
93                 return ret_hu_conv;
94         }
95
96         /**
97          * Checks if two Pings contain equal inner contents.
98          * This ignores pointers and is_owned flags and looks at the values in fields.
99          * Two objects with NULL inner values will be considered "equal" here.
100          */
101         public boolean eq(org.ldk.structs.Ping b) {
102                 boolean ret = bindings.Ping_eq(this.ptr, b == null ? 0 : b.ptr);
103                 Reference.reachabilityFence(this);
104                 Reference.reachabilityFence(b);
105                 if (this != null) { this.ptrs_to.add(b); };
106                 return ret;
107         }
108
109         @Override public boolean equals(Object o) {
110                 if (!(o instanceof Ping)) return false;
111                 return this.eq((Ping)o);
112         }
113         /**
114          * Serialize the Ping object into a byte array which can be read by Ping_read
115          */
116         public byte[] write() {
117                 byte[] ret = bindings.Ping_write(this.ptr);
118                 Reference.reachabilityFence(this);
119                 return ret;
120         }
121
122         /**
123          * Read a Ping from a byte array, created by Ping_write
124          */
125         public static Result_PingDecodeErrorZ read(byte[] ser) {
126                 long ret = bindings.Ping_read(ser);
127                 Reference.reachabilityFence(ser);
128                 if (ret >= 0 && ret <= 4096) { return null; }
129                 Result_PingDecodeErrorZ ret_hu_conv = Result_PingDecodeErrorZ.constr_from_ptr(ret);
130                 return ret_hu_conv;
131         }
132
133 }