You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@rocketmq.apache.org by aa...@apache.org on 2022/06/25 15:13:43 UTC
[rocketmq-clients] 03/04: Fix typos
This is an automated email from the ASF dual-hosted git repository.
aaronai pushed a commit to branch temp
in repository https://gitbox.apache.org/repos/asf/rocketmq-clients.git
commit f76b7a61e44b5d0a4ba33bbf3ea8461f4a2a9407
Author: Aaron Ai <ya...@gmail.com>
AuthorDate: Thu Jun 23 19:00:34 2022 +0800
Fix typos
---
.../client/apis/ClientServiceProvider.java | 10 ++++++++
.../rocketmq/client/java/impl/ClientManager.java | 30 +++++++++++-----------
.../client/java/impl/ClientManagerImpl.java | 8 +++---
.../client/java/impl/ClientManagerRegistry.java | 6 ++---
.../java/impl/ClientServiceProviderImpl.java | 12 +++++++++
.../client/java/impl/TelemetrySession.java | 3 ++-
6 files changed, 46 insertions(+), 23 deletions(-)
diff --git a/java/client-apis/src/main/java/org/apache/rocketmq/client/apis/ClientServiceProvider.java b/java/client-apis/src/main/java/org/apache/rocketmq/client/apis/ClientServiceProvider.java
index ed9dc32..523f1f8 100644
--- a/java/client-apis/src/main/java/org/apache/rocketmq/client/apis/ClientServiceProvider.java
+++ b/java/client-apis/src/main/java/org/apache/rocketmq/client/apis/ClientServiceProvider.java
@@ -52,7 +52,17 @@ public interface ClientServiceProvider {
*/
MessageBuilder newMessageBuilder();
+ /**
+ * Get the push consumer builder by the current provider.
+ *
+ * @return the push consumer builder instance.
+ */
PushConsumerBuilder newPushConsumerBuilder();
+ /**
+ * Get the simple consumer builder by the current provider.
+ *
+ * @return the simple consumer builder instance.
+ */
SimpleConsumerBuilder newSimpleConsumerBuilder();
}
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 b9340af..9f40a6d 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,11 @@ import org.apache.rocketmq.client.apis.ClientException;
import org.apache.rocketmq.client.java.route.Endpoints;
/**
- * Client manager supplies a series of unified apis to execute remote procedure call for each {@link Client}.
+ * 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 shutdown, it must be unregistered from client manager. client manager hold the connections
- * and underlying threads, which are shared by all register client.
+ * 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.
*/
public interface ClientManager {
/**
@@ -77,7 +77,7 @@ public interface ClientManager {
boolean isEmpty();
/**
- * Provide for client to share the scheduler.
+ * Provide for the client to share the scheduler.
*
* @return shared scheduler.
*/
@@ -90,7 +90,7 @@ public interface ClientManager {
* @param metadata gRPC request header metadata.
* @param request query route request.
* @param duration request max duration.
- * @return response future of topic route.
+ * @return response future of the topic route.
*/
ListenableFuture<QueryRouteResponse> queryRoute(Endpoints endpoints, Metadata metadata, QueryRouteRequest request,
Duration duration);
@@ -100,9 +100,9 @@ public interface ClientManager {
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
- * @param request heart beat request.
+ * @param request heartbeat request.
* @param duration request max duration.
- * @return response future of heart beat.
+ * @return response future of heartbeat.
*/
ListenableFuture<HeartbeatResponse> heartbeat(Endpoints endpoints, Metadata metadata, HeartbeatRequest request,
Duration duration);
@@ -114,7 +114,7 @@ public interface ClientManager {
* @param metadata gRPC request header metadata.
* @param request send message request.
* @param duration request max duration.
- * @return response future of sending message.
+ * @return response future of the sending message.
*/
ListenableFuture<SendMessageResponse> sendMessage(Endpoints endpoints, Metadata metadata,
SendMessageRequest request, Duration duration);
@@ -132,7 +132,7 @@ public interface ClientManager {
QueryAssignmentRequest request, Duration duration);
/**
- * Receiving message asynchronously from server, the method ensures no throwable.
+ * Receiving messages asynchronously from the server, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
@@ -141,7 +141,7 @@ public interface ClientManager {
ReceiveMessageRequest request, Duration duration);
/**
- * Ack message asynchronously after success of consumption, the method ensures no throwable.
+ * Ack message asynchronously after the success of consumption, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
@@ -153,7 +153,7 @@ public interface ClientManager {
Duration duration);
/**
- * Nack message asynchronously after failure of consumption, the method ensures no throwable.
+ * Nack message asynchronously after the failure of consumption, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
@@ -165,13 +165,13 @@ public interface ClientManager {
ChangeInvisibleDurationRequest request, Duration duration);
/**
- * Send message to dead letter queue asynchronously, the method ensures no throwable.
+ * Send a message to the dead letter queue asynchronously, the method ensures no throwable.
*
* @param endpoints requested endpoints.
* @param metadata gRPC request header metadata.
- * @param request request of sending message to DLQ.
+ * @param request request of sending a message to DLQ.
* @param duration request max duration.
- * @return response future of sending message to DLQ.
+ * @return response future of sending a message to DLQ.
*/
ListenableFuture<ForwardMessageToDeadLetterQueueResponse> forwardMessageToDeadLetterQueue(
Endpoints endpoints, Metadata metadata, ForwardMessageToDeadLetterQueueRequest request, Duration duration);
@@ -189,7 +189,7 @@ public interface ClientManager {
EndTransactionRequest request, Duration duration);
/**
- * Asynchronously notify server that client is terminated, the method ensures no throwable.
+ * Asynchronously notify the server that client is terminated, the method ensures no throwable.
*
* @param endpoints request endpoints.
* @param metadata gRPC request header metadata.
diff --git a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientManagerImpl.java b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientManagerImpl.java
index ddbbbf9..b13b7e1 100644
--- a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientManagerImpl.java
+++ b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientManagerImpl.java
@@ -100,12 +100,12 @@ public class ClientManagerImpl extends AbstractIdleService implements ClientMana
private final ConcurrentMap<String, Client> clientTable;
/**
- * In charge of all scheduled task.
+ * In charge of all scheduled tasks.
*/
private final ScheduledExecutorService scheduler;
/**
- * Public executor for all async rpc, <strong>should never submit heavy task.</strong>
+ * Public executor for all async RPCs, <strong>should never submit a heavy task.</strong>
*/
private final ExecutorService asyncWorker;
@@ -147,7 +147,7 @@ public class ClientManagerImpl extends AbstractIdleService implements ClientMana
* It is well-founded that a {@link RpcClient} is deprecated if it is idle for a long time, so it is essential to
* clear it.
*
- * @throws InterruptedException if thread has been interrupted
+ * @throws InterruptedException if the thread has been interrupted
*/
private void clearIdleRpcClients() throws InterruptedException {
rpcClientTableLock.writeLock().lock();
@@ -423,7 +423,7 @@ public class ClientManagerImpl extends AbstractIdleService implements ClientMana
try {
announceSettings();
} catch (Throwable t) {
- LOGGER.error("Exception raised during setting announcement.", t);
+ LOGGER.error("Exception raised during the setting announcement.", t);
}
},
ANNOUNCE_SETTINGS_DELAY.toNanos(),
diff --git a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientManagerRegistry.java b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientManagerRegistry.java
index 2d57dc1..42dc30d 100644
--- a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientManagerRegistry.java
+++ b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientManagerRegistry.java
@@ -44,9 +44,9 @@ public class ClientManagerRegistry {
/**
* Register {@link Client} to the appointed manager by manager id, start the manager if it is created newly.
*
- * <p>Different client would share the same {@link ClientManager} if they have the same manager id.
+ * <p>Different clients would share the same {@link ClientManager} if they have the same manager id.
*
- * @param client client to register.
+ * @param client the client to register.
* @return the client manager which is started.
*/
public ClientManager registerClient(Client client) {
@@ -66,7 +66,7 @@ public class ClientManagerRegistry {
}
/**
- * Unregister {@link Client} to the appointed manager by message id, shutdown the manager if no client
+ * Unregister {@link Client} to the appointed manager by message-id, shutdown the manager if no client
* registered in it.
*
* @param client client to unregister.
diff --git a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientServiceProviderImpl.java b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientServiceProviderImpl.java
index c7576e2..f502b8f 100644
--- a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientServiceProviderImpl.java
+++ b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/ClientServiceProviderImpl.java
@@ -28,21 +28,33 @@ import org.apache.rocketmq.client.java.impl.producer.ProducerBuilderImpl;
import org.apache.rocketmq.client.java.message.MessageBuilderImpl;
public class ClientServiceProviderImpl implements ClientServiceProvider {
+ /**
+ * @see ClientServiceProvider#newProducerBuilder()
+ */
@Override
public ProducerBuilder newProducerBuilder() {
return new ProducerBuilderImpl();
}
+ /**
+ * @see ClientServiceProvider#newMessageBuilder()
+ */
@Override
public PushConsumerBuilder newPushConsumerBuilder() {
return new PushConsumerBuilderImpl();
}
+ /**
+ * @see ClientServiceProvider#newMessageBuilder()
+ */
@Override
public SimpleConsumerBuilder newSimpleConsumerBuilder() {
return new SimpleConsumerBuilderImpl();
}
+ /**
+ * @see ClientServiceProvider#newMessageBuilder()
+ */
@Override
public MessageBuilder newMessageBuilder() {
return new MessageBuilderImpl();
diff --git a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/TelemetrySession.java b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/TelemetrySession.java
index bb51870..7d87340 100644
--- a/java/client/src/main/java/org/apache/rocketmq/client/java/impl/TelemetrySession.java
+++ b/java/client/src/main/java/org/apache/rocketmq/client/java/impl/TelemetrySession.java
@@ -61,6 +61,7 @@ public class TelemetrySession implements StreamObserver<TelemetryCommand> {
return new TelemetrySession(client, clientManager, endpoints).register();
}
+ @SuppressWarnings("UnstableApiUsage")
private ListenableFuture<TelemetrySession> register() {
ListenableFuture<TelemetrySession> future;
try {
@@ -161,7 +162,7 @@ public class TelemetrySession implements StreamObserver<TelemetryCommand> {
case VERIFY_MESSAGE_COMMAND: {
final VerifyMessageCommand verifyMessageCommand = command.getVerifyMessageCommand();
LOGGER.info("Receive message verification command from remote, endpoints={}, clientId={}",
- client.getClientId());
+ endpoints, client.getClientId());
client.onVerifyMessageCommand(endpoints, verifyMessageCommand);
break;
}