Add note about garbage collection of the chan man constructor

[ldk-java] / src / main / java / org / ldk / batteries / ChannelManagerConstructor.java

diff --git a/src/main/java/org/ldk/batteries/ChannelManagerConstructor.java b/src/main/java/org/ldk/batteries/ChannelManagerConstructor.java
index 122fcff8b45ba9e21f07ff6a7d9f07ed7a9234f3..6a9b9be69e48f8c49d369b3b07e077b3c8952db4 100644 (file)
--- a/src/main/java/org/ldk/batteries/ChannelManagerConstructor.java
+++ b/src/main/java/org/ldk/batteries/ChannelManagerConstructor.java
@@ -14,6 +14,10 @@ import java.util.HashSet;
  * more ChannelMonitors.
  *
  * Also constructs a PeerManager and spawns a background thread to monitor for and notify you of relevant Events.
+ *
+ * Note that you must ensure you hold a reference to any constructed ChannelManagerConstructor objects to ensure you
+ * continue to receive events generated by the background thread which will be stopped if this object is garbage
+ * collected.
  */
 public class ChannelManagerConstructor {
     /**