Browse Source

update javadoc

Zhiru Zhu 5 years ago
parent
commit
514a82dc3f

+ 2 - 2
src/main/java/io/milvus/client/ConnectParam.java

@@ -202,8 +202,8 @@ public class ConnectParam {
     }
 
     /**
-     * Optional. Set the duration without ongoing RPCs before going to idle mode. Defaults to 24
-     * hour.
+     * Optional. Set the duration without ongoing RPCs before going to idle mode.
+     * A new RPC would take the channel out of idle mode. Defaults to 24 hour.
      *
      * @see <a
      *     href="https://grpc.github.io/grpc-java/javadoc/io/grpc/ManagedChannelBuilder.html#idleTimeout-long-java.util.concurrent.TimeUnit-">

+ 2 - 1
src/main/java/io/milvus/client/MilvusClient.java

@@ -56,7 +56,8 @@ public interface MilvusClient {
    */
   Response connect(ConnectParam connectParam) throws ConnectFailedException;
 
-  /** @return <code>true</code> if the client is connected to Milvus server */
+  /** @return <code>true</code> if the client is connected to Milvus server.
+   * The channel's connectivity state is READY.*/
   boolean isConnected();
 
   /**