Document io.factorhouse.kpow.StreamsRegistry

factorhouse · Dec 19, 2024 · 53adbe1 · 53adbe1
1 parent a4f8f96
commit 53adbe1
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/src/java/io/factorhouse/kpow/StreamsRegistry.java b/src/java/io/factorhouse/kpow/StreamsRegistry.java
@@ -91,6 +91,11 @@ public StreamsRegistry(Properties props) {
         this(props, MetricFilter.defaultMetricFilter());
     }
 
+    /**
+     * Registers a Kafka Streams application with Kpow's StreamsRegistry.
+     *
+     * @return a StreamsAgent instance for the registered application (used to unregister).
+     */
     public StreamsAgent register(KafkaStreams streams, Topology topology, KeyStrategy keyStrategy) {
         IFn require = Clojure.var("clojure.core", "require");
         require.invoke(Clojure.read("io.factorhouse.kpow.agent"));
@@ -103,6 +108,10 @@ public StreamsAgent register(KafkaStreams streams, Topology topology, KeyStrateg
         }
     }
 
+    /**
+     * Unregisters a Kafka Streams application with Kpow's StreamsRegistry. Use the StreamsAgent instance returned from
+     * the register method.
+     */
     public void unregister(StreamsAgent streamsAgent) {
         if (streamsAgent != null) {
             IFn require = Clojure.var("clojure.core", "require");