Add javadoc to explain the purpose of "cancelPendingRead"

apache · Jan 16, 2025 · 41ad1ff · 41ad1ff
1 parent cd14e7b
commit 41ad1ff
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/...r/src/main/java/org/apache/pulsar/broker/service/AbstractDispatcherMultipleConsumers.java b/...r/src/main/java/org/apache/pulsar/broker/service/AbstractDispatcherMultipleConsumers.java
@@ -68,6 +68,10 @@ public SubType getType() {
 
     public abstract boolean isConsumerAvailable(Consumer consumer);
 
+    /**
+     * Cancel a possible pending read that is a Managed Cursor waiting to be notified for more entries.
+     * This won't cancel any other pending reads that are currently in progress.
+     */
     protected void cancelPendingRead() {}
 
     /**