Introduce configuration options in the cluster API #137
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These flags will be replaced by options and can be set using these new APIs instead: - valkeyClusterConnectWithOptions - valkeyClusterAsyncConnectWithOptions Signed-off-by: Björn Svensson <[email protected]>
Signed-off-by: Björn Svensson <[email protected]>
Signed-off-by: Björn Svensson <[email protected]>
Signed-off-by: Björn Svensson <[email protected]>
Signed-off-by: Björn Svensson <[email protected]>
zuiderkwast
reviewed
Dec 6, 2024
Comment on lines
+196
to
+202
| /* Helper macro to initialize options. */ | ||
| #define VALKEY_CLUSTER_OPTIONS_SET_ADAPTER_LIBEVENT(opts, event_base) \ | ||
| do { \ | ||
| (opts)->attach_fn = valkeyLibeventAttachAdapter; \ | ||
| (opts)->attach_data = event_base; \ | ||
| } while (0) | ||
|
|
There was a problem hiding this comment.
Why are these not static functions, like valkeyClusterLibeventAttach and others?
Comment on lines
+46
to
+52
| /* Helper macro to initialize options. */ | ||
| #define VALKEY_CLUSTER_OPTIONS_SET_SSL(opts, tls_) \ | ||
| do { \ | ||
| (opts)->tls = tls_; \ | ||
| (opts)->tls_init_fn = &valkeyInitiateTLSWithContext; \ | ||
| } while (0) | ||
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The standalone API uses the options struct
valkeyOptionsto allow users to configure howlibvalkeyset up the context.This struct is used when calling
valkeyConnectWithOptions(valkeyOptions *opt), which returns a connected context with prepared command timeout values and so on.The current cluster API, which in inherited from the project
hiredis-vipandhiredis-cluster, has some similarities to the standalone API, but it does not provide a options struct and does not have the same "look and feel" as the standalone API.This PR introduces a
valkeyClusterOptionthat allows a user to set all options before connecting to the cluster using:valkeyClusterContext *cc = valkeyClusterConnectWithOptions(&options)or
valkeyClusterAsyncContext *acc = valkeyClusterAsyncConnectWithOptions(&options)when using the async API.This options struct enables users to set the initial nodes, callbacks, timeouts, options, TLS- and event-adapters,
instead of using a wide range of
valkeyClusterSetOptionXxxfunctions on avalkeyClusterContext(even when they use async contextsvalkeyClusterAsyncContext...).There are still options that are allowed to be configured during runtime like
valkeyClusterSetOptionTimeout, but most other options requires a reconnect.The async cluster API will no longer require that users calls the blocking cluster API using
valkeyClusterConnect2(acc->cc).We now provide a new option
VALKEY_OPT_BLOCKING_INITIAL_UPDATEto enable a blocking slotmap update after an initial connect using thevalkeyClusterAsyncConnectWithOptionsAPI. This will allow us to avoidacc->ccusages and we should be able to hide theccin theaccstruct.All testcases are updated to use the new API and this should give a feeling how it works,
alternatively look at changes in
include/valkey/cluster.h.The migration guide and docs are not yet updated since its a draft PR.