X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FErrorMessage.java;fp=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FErrorMessage.java;h=bf512b9a4924c42b1a3f5e47ec538e69fa44e1d9;hb=17113550a5fefab21f39f27fbfe02646b8db53ae;hp=8e1f30ddcb36824b2c8ebb90bcddc8b1baa3eac7;hpb=d69a40d071871d3c0e4160744202c6e85941a4cc;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..bf512b9a 100644
--- a/src/main/java/org/ldk/structs/ErrorMessage.java
+++ b/src/main/java/org/ldk/structs/ErrorMessage.java
@@ -5,6 +5,10 @@ import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
 
+
+/**
+ * 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,24 +18,45 @@ public class ErrorMessage extends CommonBase {
 		if (ptr != 0) { bindings.ErrorMessage_free(ptr); }
 	}
 
+	/**
+	 * The channel ID involved in the error
+	 */
 	public byte[] get_channel_id() {
 		byte[] ret = bindings.ErrorMessage_get_channel_id(this.ptr);
 		return ret;
 	}
 
+	/**
+	 * The channel ID involved in the error
+	 */
 	public void set_channel_id(byte[] val) {
 		bindings.ErrorMessage_set_channel_id(this.ptr, 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);
 		return ret;
 	}
 
+	/**
+	 * 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(byte[] val) {
 		bindings.ErrorMessage_set_data(this.ptr, val);
 	}
 
+	/**
+	 * Constructs a new ErrorMessage given each field
+	 */
 	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);
@@ -39,6 +64,9 @@ public class ErrorMessage extends CommonBase {
 		return ret_hu_conv;
 	}
 
+	/**
+	 * Creates a copy of the ErrorMessage
+	 */
 	public ErrorMessage clone() {
 		long ret = bindings.ErrorMessage_clone(this.ptr);
 		ErrorMessage ret_hu_conv = new ErrorMessage(null, ret);
@@ -46,11 +74,17 @@ public class ErrorMessage extends CommonBase {
 		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);
 		return ret;
 	}
 
+	/**
+	 * Read a ErrorMessage from a byte array, created by ErrorMessage_write
+	 */
 	public static Result_ErrorMessageDecodeErrorZ constructor_read(byte[] ser) {
 		long ret = bindings.ErrorMessage_read(ser);
 		Result_ErrorMessageDecodeErrorZ ret_hu_conv = Result_ErrorMessageDecodeErrorZ.constr_from_ptr(ret);