X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=src%2Fmain%2Fjava%2Forg%2Fldk%2Fstructs%2FListen.java;h=2e6b835de1b8536c6b232ae79b4fab8d800c91fb;hb=b9716bc7ee492882e4643c9365971fef3761989f;hp=075137cbc3d63db05d038cf817e4625ddf0f9cb8;hpb=246459dcbc3be28c38b4951140a5933f4b3aa024;p=ldk-java

diff --git a/src/main/java/org/ldk/structs/Listen.java b/src/main/java/org/ldk/structs/Listen.java
index 075137cb..2e6b835d 100644
--- a/src/main/java/org/ldk/structs/Listen.java
+++ b/src/main/java/org/ldk/structs/Listen.java
@@ -4,7 +4,17 @@ import org.ldk.impl.bindings;
 import org.ldk.enums.*;
 import org.ldk.util.*;
 import java.util.Arrays;
+import javax.annotation.Nullable;
 
+/**
+ * The `Listen` trait is used to notify when blocks have been connected or disconnected from the
+ * chain.
+ * 
+ * Useful when needing to replay chain data upon startup or as new chain events occur. Clients
+ * sourcing chain data using a block-oriented API should prefer this interface over [`Confirm`].
+ * Such clients fetch the entire header chain whereas clients using [`Confirm`] only fetch headers
+ * when needed.
+ */
 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
 public class Listen extends CommonBase {
 	final bindings.LDKListen bindings_instance;
@@ -20,7 +30,13 @@ public class Listen extends CommonBase {
 	}
 
 	public static interface ListenInterface {
+		/**
+		 * Notifies the listener that a block was added at the given height.
+		 */
 		void block_connected(byte[] block, int height);
+		/**
+		 * Notifies the listener that a block was removed at the given height.
+		 */
 		void block_disconnected(byte[] header, int height);
 	}
 	private static class LDKListenHolder { Listen held; }
@@ -36,10 +52,16 @@ public class Listen extends CommonBase {
 		});
 		return impl_holder.held;
 	}
+	/**
+	 * Notifies the listener that a block was added at the given height.
+	 */
 	public void block_connected(byte[] block, int height) {
 		bindings.Listen_block_connected(this.ptr, block, height);
 	}
 
+	/**
+	 * Notifies the listener that a block was removed at the given height.
+	 */
 	public void block_disconnected(byte[] header, int height) {
 		bindings.Listen_block_disconnected(this.ptr, header, height);
 	}