| Package | Description | 
|---|---|
| io.vertx.reactivex.redis.client | |
| io.vertx.redis.client | |
| io.vertx.rxjava.redis.client | 
| Modifier and Type | Method and Description | 
|---|---|
static Redis | 
Redis.createClient(Vertx vertx,
            RedisOptions options)
Create a new redis client using the given client options. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
RedisOptions | 
RedisOptions.addConnectionString(String connectionString)
Adds a connection string (endpoint) to use while connecting to the redis server. 
 | 
RedisOptions | 
RedisOptions.addEndpoint(String connectionString)
Deprecated. 
 
see  
setConnectionString(String connectionString) for a better naming | 
RedisOptions | 
RedisOptions.setConnectionString(String connectionString)
Sets a single connection string (endpoint) to use while connecting to the redis server. 
 | 
RedisOptions | 
RedisOptions.setEndpoint(String connectionString)
Deprecated. 
 
see  
setConnectionString(String connectionString) for a better naming | 
RedisOptions | 
RedisOptions.setEndpoints(List<String> endpoints)
Set the endpoints to use while connecting to the redis server. 
 | 
RedisOptions | 
RedisOptions.setMasterName(String masterName)
Set the master name (only considered in HA mode). 
 | 
RedisOptions | 
RedisOptions.setMaxNestedArrays(int maxNestedArrays)
Tune how much nested arrays are allowed on a redis response. 
 | 
RedisOptions | 
RedisOptions.setMaxPoolSize(int maxPoolSize)
Tune the maximum size of the connection pool. 
 | 
RedisOptions | 
RedisOptions.setMaxPoolWaiting(int maxPoolWaiting)
Tune the maximum waiting requests for a connection from the pool. 
 | 
RedisOptions | 
RedisOptions.setMaxWaitingHandlers(int maxWaitingHandlers)
The client will always work on pipeline mode, this means that messages can start queueing. 
 | 
RedisOptions | 
RedisOptions.setNetClientOptions(NetClientOptions netClientOptions)
Set the net client options to be used while connecting to the redis server. 
 | 
RedisOptions | 
RedisOptions.setPassword(String password)
Set the default password for cluster/sentinel connections. 
 | 
RedisOptions | 
RedisOptions.setPoolCleanerInterval(int poolCleanerInterval)
Tune how often in milliseconds should the connection pool cleaner execute. 
 | 
RedisOptions | 
RedisOptions.setPoolRecycleTimeout(int poolRecycleTimeout)
Tune when a connection should be recycled in milliseconds. 
 | 
RedisOptions | 
RedisOptions.setRole(RedisRole role)
Set the role name (only considered in HA mode). 
 | 
RedisOptions | 
RedisOptions.setType(RedisClientType type)
Set the desired client type to be created. 
 | 
RedisOptions | 
RedisOptions.setUseReplicas(RedisReplicas useReplicas)
Set whether or not to use replica nodes (only considered in Cluster mode). 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static Redis | 
Redis.createClient(Vertx vertx,
            RedisOptions options)
Create a new redis client using the given client options. 
 | 
static void | 
RedisOptionsConverter.fromJson(Iterable<Map.Entry<String,Object>> json,
        RedisOptions obj)  | 
static void | 
RedisOptionsConverter.toJson(RedisOptions obj,
      JsonObject json)  | 
static void | 
RedisOptionsConverter.toJson(RedisOptions obj,
      Map<String,Object> json)  | 
| Constructor and Description | 
|---|
RedisOptions(RedisOptions other)
Copy constructor. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
static Redis | 
Redis.createClient(Vertx vertx,
            RedisOptions options)
Create a new redis client using the given client options. 
 | 
Copyright © 2020 Eclipse. All rights reserved.