From d23001fe89e79a792171440ff0fc064ee3d3dc4f Mon Sep 17 00:00:00 2001 From: Andrew Carbonetto Date: Tue, 2 Jan 2024 15:25:34 -0800 Subject: [PATCH] Update JavaDocs and comments Signed-off-by: Andrew Carbonetto --- java/client/src/main/java/glide/api/BaseClient.java | 2 +- java/client/src/main/java/glide/api/RedisClient.java | 7 +++---- .../api/models/configuration/BaseClientConfiguration.java | 2 +- .../java/glide/connectors/handlers/CallbackDispatcher.java | 2 +- .../java/glide/connectors/handlers/ChannelHandler.java | 2 +- .../src/main/java/glide/connectors/resources/Platform.java | 4 ++-- .../src/main/java/glide/managers/CallbackManager.java | 2 +- .../src/main/java/glide/managers/ConnectionManager.java | 5 +---- 8 files changed, 11 insertions(+), 15 deletions(-) diff --git a/java/client/src/main/java/glide/api/BaseClient.java b/java/client/src/main/java/glide/api/BaseClient.java index 07b004ac6a..88a42c1551 100644 --- a/java/client/src/main/java/glide/api/BaseClient.java +++ b/java/client/src/main/java/glide/api/BaseClient.java @@ -4,7 +4,7 @@ import glide.managers.ConnectionManager; import lombok.AllArgsConstructor; -/** Base Client class for connecting to Redis */ +/** Base Client class for Redis */ @AllArgsConstructor public abstract class BaseClient implements AutoCloseable { diff --git a/java/client/src/main/java/glide/api/RedisClient.java b/java/client/src/main/java/glide/api/RedisClient.java index ee49b7803c..a8b0f65424 100644 --- a/java/client/src/main/java/glide/api/RedisClient.java +++ b/java/client/src/main/java/glide/api/RedisClient.java @@ -12,7 +12,8 @@ import java.util.concurrent.ExecutionException; import java.util.concurrent.atomic.AtomicBoolean; -/** Factory class for creating Glide/Redis-client connections */ +/** Async (non-blocking) client for Redis in Standalone mode. Use {@link #CreateClient()} to + * request a client to Redis. */ public class RedisClient extends BaseClient { public static CompletableFuture CreateClient() { @@ -29,14 +30,12 @@ public static CompletableFuture CreateClient(String host, Integer p } /** - * Async (non-blocking) connection to Redis. + * Request an async (non-blocking) Redis client in Standalone mode. * * @param config - Redis Client Configuration * @return a promise to connect and return a RedisClient */ public static CompletableFuture CreateClient(RedisClientConfiguration config) { - AtomicBoolean connectionStatus = new AtomicBoolean(false); - CallbackDispatcher callbackDispatcher = new CallbackDispatcher(); ChannelHandler channelHandler = new ChannelHandler(callbackDispatcher, getSocket()); var connectionManager = new ConnectionManager(channelHandler); diff --git a/java/client/src/main/java/glide/api/models/configuration/BaseClientConfiguration.java b/java/client/src/main/java/glide/api/models/configuration/BaseClientConfiguration.java index 41d6321ba0..7835867f09 100644 --- a/java/client/src/main/java/glide/api/models/configuration/BaseClientConfiguration.java +++ b/java/client/src/main/java/glide/api/models/configuration/BaseClientConfiguration.java @@ -7,7 +7,7 @@ import lombok.Singular; import lombok.experimental.SuperBuilder; -/** Represents the configuration settings for a Redis client. */ +/** Configuration settings class for creating a Redis Client. Shared settings for both a standalone and cluster clients. */ @Getter @SuperBuilder public abstract class BaseClientConfiguration { diff --git a/java/client/src/main/java/glide/connectors/handlers/CallbackDispatcher.java b/java/client/src/main/java/glide/connectors/handlers/CallbackDispatcher.java index b356cb218a..de2cf39541 100644 --- a/java/client/src/main/java/glide/connectors/handlers/CallbackDispatcher.java +++ b/java/client/src/main/java/glide/connectors/handlers/CallbackDispatcher.java @@ -13,7 +13,7 @@ public class CallbackDispatcher { private final AtomicInteger requestId = new AtomicInteger(0); /** - * Storage of Futures to handle responses. Map key is callback id, which starts from 1.
+ * Storage of Futures to handle responses. Map key is callback id, which starts from 0. * Each future is a promise for every submitted by user request. */ private final Map> responses = new ConcurrentHashMap<>(); diff --git a/java/client/src/main/java/glide/connectors/handlers/ChannelHandler.java b/java/client/src/main/java/glide/connectors/handlers/ChannelHandler.java index 068ea3dd79..7607973da4 100644 --- a/java/client/src/main/java/glide/connectors/handlers/ChannelHandler.java +++ b/java/client/src/main/java/glide/connectors/handlers/ChannelHandler.java @@ -12,7 +12,7 @@ import response.ResponseOuterClass.Response; /** - * Class responsible for handling calls to/from a netty.io {@link Channel}.
+ * Class responsible for handling calls to/from a netty.io {@link Channel}. * Uses a {@link CallbackDispatcher} to record callbacks of every request sent. */ public class ChannelHandler { diff --git a/java/client/src/main/java/glide/connectors/resources/Platform.java b/java/client/src/main/java/glide/connectors/resources/Platform.java index 7f9b95d9c2..2445ab1b88 100644 --- a/java/client/src/main/java/glide/connectors/resources/Platform.java +++ b/java/client/src/main/java/glide/connectors/resources/Platform.java @@ -45,7 +45,7 @@ private static class Capabilities { new Capabilities(isKQueueAvailable(), isEPollAvailable(), false, false); /** - * Thread pools supplied to Netty to perform all async IO.
+ * Thread pools supplied to Netty to perform all async IO. * Map key is supposed to be pool name + thread count as a string concat product. */ private static final Map groups = new ConcurrentHashMap<>(); @@ -123,7 +123,7 @@ public static Class getClientUdsNettyChannelType( /** * A JVM shutdown hook to be registered. It is responsible for closing connection and freeing - * resources. It is recommended to use a class instead of lambda to ensure that it is called.
+ * resources. It is recommended to use a class instead of lambda to ensure that it is called. * See {@link Runtime#addShutdownHook}. */ private static class ShutdownHook implements Runnable { diff --git a/java/client/src/main/java/glide/managers/CallbackManager.java b/java/client/src/main/java/glide/managers/CallbackManager.java index 720b84f36f..54e3a19078 100644 --- a/java/client/src/main/java/glide/managers/CallbackManager.java +++ b/java/client/src/main/java/glide/managers/CallbackManager.java @@ -14,7 +14,7 @@ public class CallbackManager { private final AtomicInteger requestId = new AtomicInteger(0); /** - * Storage of Futures to handle responses. Map key is callback id, which starts from 1.
+ * Storage of Futures to handle responses. Map key is callback id, which starts from 0. * Each future is a promise for every submitted by user request. */ private final Map> responses = new ConcurrentHashMap<>(); diff --git a/java/client/src/main/java/glide/managers/ConnectionManager.java b/java/client/src/main/java/glide/managers/ConnectionManager.java index bb0528194b..128a9d4519 100644 --- a/java/client/src/main/java/glide/managers/ConnectionManager.java +++ b/java/client/src/main/java/glide/managers/ConnectionManager.java @@ -157,9 +157,8 @@ private ConnectionRequestOuterClass.ReadFrom mapReadFromEnum(ReadFrom readFrom) /** Check a response received from Glide. */ private Void checkGlideRsResponse(Response response) { - // TODO do we need to check callback value? It could be -1 or 0 if (response.hasRequestError()) { - // TODO do we need to support different types of exceptions and distinguish them by type? + // TODO support different types of exceptions and distinguish them by type: throw new RuntimeException( String.format( "%s: %s", @@ -171,8 +170,6 @@ private Void checkGlideRsResponse(Response response) { } else if (response.hasRespPointer()) { throw new RuntimeException("Unexpected data in response"); } - // TODO commented out due to #710 https://github.com/aws/babushka/issues/710 - // empty response means a successful connection // throw new IllegalStateException("A malformed response received: " + response.toString()); return null; }