You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@curator.apache.org by ti...@apache.org on 2023/04/12 11:22:45 UTC
[curator] branch master updated: CURATOR-668. Modify blockUntilConnected method annotation (#457)
This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/curator.git
The following commit(s) were added to refs/heads/master by this push:
new 0095a273 CURATOR-668. Modify blockUntilConnected method annotation (#457)
0095a273 is described below
commit 0095a273c157a74b133c5d9cc6ee9b61ecb43fd4
Author: Adam's <43...@users.noreply.github.com>
AuthorDate: Wed Apr 12 19:22:36 2023 +0800
CURATOR-668. Modify blockUntilConnected method annotation (#457)
Co-authored-by: tison <wa...@gmail.com>
---
.../main/java/org/apache/curator/framework/CuratorFramework.java | 7 +++++--
1 file changed, 5 insertions(+), 2 deletions(-)
diff --git a/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java b/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java
index 1527500e..bbcd3cfc 100644
--- a/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java
+++ b/curator-framework/src/main/java/org/apache/curator/framework/CuratorFramework.java
@@ -290,7 +290,10 @@ public interface CuratorFramework extends Closeable
/**
* Block until a connection to ZooKeeper is available or the maxWaitTime has been exceeded
- * @param maxWaitTime The maximum wait time. Specify a value <= 0 to return immediately
+ * @param maxWaitTime The maximum wait time.
+ * 1. {@code value <= 0} and {@code units != null} to return immediately;
+ * 2. {@code value <= 0} and {@code units == null} to wait indefinitely,
+ * which is same as {@link #blockUntilConnected()}.
* @param units The time units for the maximum wait time.
* @return True if connection has been established, false otherwise.
* @throws InterruptedException If interrupted while waiting
@@ -299,7 +302,7 @@ public interface CuratorFramework extends Closeable
/**
* Block until a connection to ZooKeeper is available. This method will not return until a
- * connection is available or it is interrupted, in which case an InterruptedException will
+ * connection is available, or it is interrupted, in which case an InterruptedException will
* be thrown
* @throws InterruptedException If interrupted while waiting
*/