io.vertx.redis.client

Class RedisClusterConnectOptions

java.lang.Object

io.vertx.redis.client.RedisConnectOptions

io.vertx.redis.client.RedisClusterConnectOptions

public class RedisClusterConnectOptions
extends RedisConnectOptions

Constructor Summary

Constructors

Constructor and Description
RedisClusterConnectOptions()
RedisClusterConnectOptions(JsonObject json)
RedisClusterConnectOptions(RedisClusterConnectOptions other)
RedisClusterConnectOptions(RedisOptions options)

Method Summary

Modifier and Type	Method and Description
RedisClusterConnectOptions	addConnectionString(String connectionString) Adds a connection string (endpoint) to use while connecting to the redis server.
RedisClusterTransactions	getClusterTransactions() Get how Redis transactions are handled in cluster mode.
long	getHashSlotCacheTTL() Deprecated. use getTopologyCacheTTL()
long	getTopologyCacheTTL() Returns the TTL of the topology cache.
RedisReplicas	getUseReplicas() Get whether to use replica nodes for read only queries.
RedisClusterConnectOptions	setClusterTransactions(RedisClusterTransactions clusterTransactions) Set how Redis transactions are handled in cluster mode.
RedisClusterConnectOptions	setConnectionString(String connectionString) Sets a single connection string (endpoint) to use while connecting to the redis server.
RedisClusterConnectOptions	setEndpoints(List<String> endpoints) Set the endpoints to use while connecting to the redis server.
RedisClusterConnectOptions	setHashSlotCacheTTL(long hashSlotCacheTTL) Deprecated. use setTopologyCacheTTL(long)
RedisClusterConnectOptions	setMaxLineLength(int maxLineLength) Set the maximum length (in bytes) of a single RESP line (a simple string, an error, or a type header) that may be buffered before its \r\n terminator is found.
RedisClusterConnectOptions	setMaxMultiLength(int maxMultiLength) Set the maximum number of elements allowed in any single RESP multi-bulk response (array, map, set, push, attribute).
RedisClusterConnectOptions	setMaxNestedArrays(int maxNestedArrays) Tune how much nested arrays are allowed on a redis response.
RedisClusterConnectOptions	setMaxStringLength(long maxStringLength) Set the maximum length (in bytes) of a single RESP bulk (bulk string or verbatim string) payload.
RedisClusterConnectOptions	setMaxWaitingHandlers(int maxWaitingHandlers) The client will always work on pipeline mode, this means that messages can start queueing.
RedisClusterConnectOptions	setPassword(String password) Set the default password for cluster/sentinel connections.
RedisClusterConnectOptions	setPreferredProtocolVersion(ProtocolVersion preferredProtocolVersion) Sets the preferred protocol version to be used during protocol negotiation.
RedisClusterConnectOptions	setProtocolNegotiation(boolean protocolNegotiation) Should the client perform REST protocol negotiation during the connection acquire.
RedisClusterConnectOptions	setTopologyCacheTTL(long topologyCacheTTL) Sets the TTL of the hash slot cache.
RedisClusterConnectOptions	setUseReplicas(RedisReplicas useReplicas) Set whether to use replica nodes for read only queries.
JsonObject	toJson() Converts this object to JSON notation.

Methods inherited from class io.vertx.redis.client.RedisConnectOptions

getEndpoint, getEndpoints, getMaxLineLength, getMaxMultiLength, getMaxNestedArrays, getMaxStringLength, getMaxWaitingHandlers, getPassword, getPreferredProtocolVersion, isProtocolNegotiation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RedisClusterConnectOptions

public RedisClusterConnectOptions()

RedisClusterConnectOptions

public RedisClusterConnectOptions(RedisOptions options)

RedisClusterConnectOptions

public RedisClusterConnectOptions(RedisClusterConnectOptions other)

RedisClusterConnectOptions

public RedisClusterConnectOptions(JsonObject json)

Method Detail

getUseReplicas

public RedisReplicas getUseReplicas()

Get whether to use replica nodes for read only queries.

Returns:

the cluster replica node use mode.

setUseReplicas

public RedisClusterConnectOptions setUseReplicas(RedisReplicas useReplicas)

Set whether to use replica nodes for read only queries.

Parameters:

useReplicas - the cluster replica use mode.

Returns:

fluent self.

getHashSlotCacheTTL

@Deprecated
public long getHashSlotCacheTTL()

Deprecated. use getTopologyCacheTTL()

setHashSlotCacheTTL

@Deprecated
public RedisClusterConnectOptions setHashSlotCacheTTL(long hashSlotCacheTTL)

Deprecated. use setTopologyCacheTTL(long)

getTopologyCacheTTL

public long getTopologyCacheTTL()

Returns the TTL of the topology cache. The TTL is expressed in milliseconds. Defaults to 1000 millis (1 second).

Returns:

the TTL of the topology cache

setTopologyCacheTTL

public RedisClusterConnectOptions setTopologyCacheTTL(long topologyCacheTTL)

Sets the TTL of the hash slot cache. The TTL is expressed in milliseconds. Defaults to 1000 millis (1 second).

Parameters:

topologyCacheTTL - the TTL of the hash slot cache, in millis

getClusterTransactions

public RedisClusterTransactions getClusterTransactions()

Get how Redis transactions are handled in cluster mode.

Returns:

how transactions are handled

setClusterTransactions

public RedisClusterConnectOptions setClusterTransactions(RedisClusterTransactions clusterTransactions)

Set how Redis transactions are handled in cluster mode.

Parameters:

clusterTransactions - transaction handling mode

Returns:

fluent self

setMaxNestedArrays

public RedisClusterConnectOptions setMaxNestedArrays(int maxNestedArrays)

Description copied from class: RedisConnectOptions

Tune how much nested arrays are allowed on a redis response. This affects the parser performance.

Overrides:

setMaxNestedArrays in class RedisConnectOptions

Parameters:

maxNestedArrays - the configured max nested arrays allowance.

Returns:

fluent self.

setMaxMultiLength

public RedisClusterConnectOptions setMaxMultiLength(int maxMultiLength)

Description copied from class: RedisConnectOptions

Set the maximum number of elements allowed in any single RESP multi-bulk response (array, map, set, push, attribute). Responses exceeding this limit cause the connection to be closed with an error. The default value is 65535.

Users with legitimate large responses (e.g. large LRANGE) can increase this value.

Overrides:

setMaxMultiLength in class RedisConnectOptions

Parameters:

maxMultiLength - the maximum multi-bulk length.

Returns:

fluent self.

setMaxLineLength

public RedisClusterConnectOptions setMaxLineLength(int maxLineLength)

Description copied from class: RedisConnectOptions

Set the maximum length (in bytes) of a single RESP line (a simple string, an error, or a type header) that may be buffered before its \r\n terminator is found. Lines exceeding this limit cause the connection to be closed with an error. The default value is 128 KB.

Overrides:

setMaxLineLength in class RedisConnectOptions

Parameters:

maxLineLength - the maximum line length, in bytes.

Returns:

fluent self.

setMaxStringLength

public RedisClusterConnectOptions setMaxStringLength(long maxStringLength)

Description copied from class: RedisConnectOptions

Set the maximum length (in bytes) of a single RESP bulk (bulk string or verbatim string) payload. Responses exceeding this limit cause the connection to be closed with an error. The default value is 512 MB.

Overrides:

setMaxStringLength in class RedisConnectOptions

Parameters:

maxStringLength - the maximum string length, in bytes.

Returns:

fluent self.

setProtocolNegotiation

public RedisClusterConnectOptions setProtocolNegotiation(boolean protocolNegotiation)

Description copied from class: RedisConnectOptions

Should the client perform REST protocol negotiation during the connection acquire. By default this is true, but there are situations when using broken servers it may be useful to skip this and always fallback to RESP2 without using the HELLO command.

Overrides:

setProtocolNegotiation in class RedisConnectOptions

Parameters:

protocolNegotiation - false to disable HELLO (not recommended) unless reasons...

Returns:

fluent self

setPreferredProtocolVersion

public RedisClusterConnectOptions setPreferredProtocolVersion(ProtocolVersion preferredProtocolVersion)

Description copied from class: RedisConnectOptions

Sets the preferred protocol version to be used during protocol negotiation. When not set, defaults to RESP 3. When protocol negotiation is disabled, this setting has no effect.

Overrides:

setPreferredProtocolVersion in class RedisConnectOptions

Parameters:

preferredProtocolVersion - preferred protocol version

Returns:

fluent self

setPassword

public RedisClusterConnectOptions setPassword(String password)

Description copied from class: RedisConnectOptions

Set the default password for cluster/sentinel connections.

Overrides:

setPassword in class RedisConnectOptions

Parameters:

password - the default password

Returns:

fluent self

setEndpoints

public RedisClusterConnectOptions setEndpoints(List<String> endpoints)

Description copied from class: RedisConnectOptions

Set the endpoints to use while connecting to the redis server. Only the cluster mode will consider more than 1 element. If more are provided, they are not considered by the client when in single server mode.

Overrides:

setEndpoints in class RedisConnectOptions

Parameters:

endpoints - list of socket addresses.

Returns:

fluent self.

addConnectionString

public RedisClusterConnectOptions addConnectionString(String connectionString)

Description copied from class: RedisConnectOptions

Adds a connection string (endpoint) to use while connecting to the redis server. Only the cluster mode will consider more than 1 element. If more are provided, they are not considered by the client when in single server mode.

Overrides:

addConnectionString in class RedisConnectOptions

Parameters:

connectionString - a string URI following the scheme: redis://[username:password@][host][:port][/database]

Returns:

fluent self.

See Also:

Redis scheme on iana.org

setConnectionString

public RedisClusterConnectOptions setConnectionString(String connectionString)

Description copied from class: RedisConnectOptions

Sets a single connection string (endpoint) to use while connecting to the redis server. Will replace the previously configured connection strings.

Overrides:

setConnectionString in class RedisConnectOptions

Parameters:

connectionString - a string following the scheme: redis://[username:password@][host][:port][/[database].

Returns:

fluent self.

See Also:

Redis scheme on iana.org

setMaxWaitingHandlers

public RedisClusterConnectOptions setMaxWaitingHandlers(int maxWaitingHandlers)

Description copied from class: RedisConnectOptions

The client will always work on pipeline mode, this means that messages can start queueing. You can control how much backlog you're willing to accept. This methods sets how much handlers is the client willing to queue.

Overrides:

setMaxWaitingHandlers in class RedisConnectOptions

Parameters:

maxWaitingHandlers - max allowed queued waiting handlers.

Returns:

fluent self.

toJson

public JsonObject toJson()

Converts this object to JSON notation.

Overrides:

toJson in class RedisConnectOptions

Returns:

JSON