[rocketmq-clients] branch master updated: Add comments on RpcClient#telemetry (#212)

[aaronai]

This is an automated email from the ASF dual-hosted git repository.

aaronai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-clients.git


The following commit(s) were added to refs/heads/master by this push:
     new 12fc770  Add comments on RpcClient#telemetry (#212)
12fc770 is described below

commit 12fc7700491b0184371c6777ed73c8af513bcbb9
Author: Aaron Ai <yangkun....@gmail.com>
AuthorDate: Wed Aug 31 16:03:43 2022 +0800

    Add comments on RpcClient#telemetry (#212)
---
 .../java/org/apache/rocketmq/client/java/impl/ClientManager.java | 6 +-----
 .../main/java/org/apache/rocketmq/client/java/rpc/RpcClient.java | 9 +++++++++
 2 files changed, 10 insertions(+), 5 deletions(-)

diff --git 
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientManager.java
 
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientManager.java
index ebc6f78..ce7d2e1 100644
--- 
a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientManager.java
+++ 
b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientManager.java
@@ -48,11 +48,7 @@ import org.apache.rocketmq.client.java.route.Endpoints;
 import org.apache.rocketmq.client.java.rpc.RpcFuture;
 
 /**
- * Client manager supplies a series of unified APIs to execute remote 
procedure calls for each {@link Client}.
- *
- * <p>To manage lifecycle for client manager, {@link Client} must be 
registered before using client manager,
- * once {@link Client} is shut down, it must be unregistered by the client 
manager. The client manager holds the
- * connections and underlying threads, which are shared by all registered 
clients.
+ * Client manager supplies a series of unified APIs to execute remote 
procedure calls for {@link Client}.
  */
 public abstract class ClientManager extends AbstractIdleService {
     /**
diff --git 
a/java/client/src/main/java/org/apache/rocketmq/client/java/rpc/RpcClient.java 
b/java/client/src/main/java/org/apache/rocketmq/client/java/rpc/RpcClient.java
index 10f7fa1..4c5e8b7 100644
--- 
a/java/client/src/main/java/org/apache/rocketmq/client/java/rpc/RpcClient.java
+++ 
b/java/client/src/main/java/org/apache/rocketmq/client/java/rpc/RpcClient.java
@@ -186,6 +186,15 @@ public interface RpcClient {
     ListenableFuture<NotifyClientTerminationResponse> 
notifyClientTermination(Metadata metadata,
         NotifyClientTerminationRequest request, Executor executor, Duration 
duration);
 
+    /**
+     * Start a streaming request and get the request observer.
+     *
+     * @param metadata         gRPC request header metadata.
+     * @param executor         gRPC asynchronous executor.
+     * @param duration         streaming max duration.
+     * @param responseObserver stream response observer.
+     * @return request observer.
+     */
     StreamObserver<TelemetryCommand> telemetry(Metadata metadata, Executor 
executor, Duration duration,
         StreamObserver<TelemetryCommand> responseObserver);
 }