X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FErrorMessage.java;h=22bbb8c46539df13754b26f0fc4a40247a335c6a;hb=6fe917116a65d7b62123226c4240d77ea2719783;hp=8e1f30ddcb36824b2c8ebb90bcddc8b1baa3eac7;hpb=246459dcbc3be28c38b4951140a5933f4b3aa024;p=ldk-java diff --git a/src/main/java/org/ldk/structs/ErrorMessage.java b/src/main/java/org/ldk/structs/ErrorMessage.java index 8e1f30dd..22bbb8c4 100644 --- a/src/main/java/org/ldk/structs/ErrorMessage.java +++ b/src/main/java/org/ldk/structs/ErrorMessage.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; + +/** + * An error message to be sent or received from a peer + */ @SuppressWarnings("unchecked") // We correctly assign various generic arrays public class ErrorMessage extends CommonBase { ErrorMessage(Object _dummy, long ptr) { super(ptr); } @@ -14,45 +20,101 @@ public class ErrorMessage extends CommonBase { if (ptr != 0) { bindings.ErrorMessage_free(ptr); } } + /** + * The channel ID involved in the error. + * + * All-0s indicates a general error unrelated to a specific channel, after which all channels + * with the sending peer should be closed. + */ public byte[] get_channel_id() { byte[] ret = bindings.ErrorMessage_get_channel_id(this.ptr); + Reference.reachabilityFence(this); return ret; } + /** + * The channel ID involved in the error. + * + * All-0s indicates a general error unrelated to a specific channel, after which all channels + * with the sending peer should be closed. + */ public void set_channel_id(byte[] val) { - bindings.ErrorMessage_set_channel_id(this.ptr, val); + bindings.ErrorMessage_set_channel_id(this.ptr, InternalUtils.check_arr_len(val, 32)); + Reference.reachabilityFence(this); + Reference.reachabilityFence(val); } + /** + * A possibly human-readable error description. + * The string should be sanitized before it is used (e.g. emitted to logs or printed to + * stdout). Otherwise, a well crafted error message may trigger a security vulnerability in + * the terminal emulator or the logging subsystem. + */ public String get_data() { String ret = bindings.ErrorMessage_get_data(this.ptr); + Reference.reachabilityFence(this); return ret; } - public void set_data(byte[] val) { + /** + * A possibly human-readable error description. + * The string should be sanitized before it is used (e.g. emitted to logs or printed to + * stdout). Otherwise, a well crafted error message may trigger a security vulnerability in + * the terminal emulator or the logging subsystem. + */ + public void set_data(java.lang.String val) { bindings.ErrorMessage_set_data(this.ptr, val); + Reference.reachabilityFence(this); + Reference.reachabilityFence(val); } - public static ErrorMessage constructor_new(byte[] channel_id_arg, byte[] data_arg) { - long ret = bindings.ErrorMessage_new(channel_id_arg, data_arg); - ErrorMessage ret_hu_conv = new ErrorMessage(null, ret); + /** + * Constructs a new ErrorMessage given each field + */ + public static ErrorMessage of(byte[] channel_id_arg, java.lang.String data_arg) { + long ret = bindings.ErrorMessage_new(InternalUtils.check_arr_len(channel_id_arg, 32), data_arg); + Reference.reachabilityFence(channel_id_arg); + Reference.reachabilityFence(data_arg); + if (ret >= 0 && ret <= 4096) { return null; } + ErrorMessage ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ErrorMessage(null, ret); } ret_hu_conv.ptrs_to.add(ret_hu_conv); return ret_hu_conv; } + long clone_ptr() { + long ret = bindings.ErrorMessage_clone_ptr(this.ptr); + Reference.reachabilityFence(this); + return ret; + } + + /** + * Creates a copy of the ErrorMessage + */ public ErrorMessage clone() { long ret = bindings.ErrorMessage_clone(this.ptr); - ErrorMessage ret_hu_conv = new ErrorMessage(null, ret); + Reference.reachabilityFence(this); + if (ret >= 0 && ret <= 4096) { return null; } + ErrorMessage ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new ErrorMessage(null, ret); } ret_hu_conv.ptrs_to.add(this); return ret_hu_conv; } + /** + * Serialize the ErrorMessage object into a byte array which can be read by ErrorMessage_read + */ public byte[] write() { byte[] ret = bindings.ErrorMessage_write(this.ptr); + Reference.reachabilityFence(this); return ret; } - public static Result_ErrorMessageDecodeErrorZ constructor_read(byte[] ser) { + /** + * Read a ErrorMessage from a byte array, created by ErrorMessage_write + */ + public static Result_ErrorMessageDecodeErrorZ read(byte[] ser) { long ret = bindings.ErrorMessage_read(ser); + Reference.reachabilityFence(ser); + if (ret >= 0 && ret <= 4096) { return null; } Result_ErrorMessageDecodeErrorZ ret_hu_conv = Result_ErrorMessageDecodeErrorZ.constr_from_ptr(ret); return ret_hu_conv; }