Skip to content

Commit 5b63507

Browse files
committed
Update javadoc
1 parent 48089fb commit 5b63507

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

server/src/main/java/org/elasticsearch/index/shard/GlobalCheckpointListeners.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,8 @@ public interface GlobalCheckpointListener {
8383
* Add a global checkpoint listener. If the global checkpoint is above the current global checkpoint known to the listener then the
8484
* listener will be asynchronously notified on the executor used to construct this collection of global checkpoint listeners. If the
8585
* shard is closed then the listener will be asynchronously notified on the executor used to construct this collection of global
86-
* checkpoint listeners.
86+
* checkpoint listeners. The listener will only be notified of at most one event, either the global checkpoint is updated or the shard
87+
* is closed. A listener must re-register after one of these events to receive subsequent events.
8788
*
8889
* @param currentGlobalCheckpoint the current global checkpoint known to the listener
8990
* @param listener the listener

0 commit comments

Comments
 (0)