com.lambdaworks.redis

Class RedisClient

java.lang.Object

com.lambdaworks.redis.AbstractRedisClient

com.lambdaworks.redis.RedisClient

public class RedisClient
extends AbstractRedisClient

A scalable thread-safe Redis client. Multiple threads may share one connection provided they avoid blocking and transactional operations such as BLPOP and MULTI/EXEC.

Author:

Will Glozer, Mark Paluch

Field Summary

Fields inherited from class com.lambdaworks.redis.AbstractRedisClient

channels, clientOptions, closeableResources, connectionEvents, eventLoopGroup, eventLoopGroups, logger, timeout, timer, unit

Constructor Summary

Constructors

Constructor and Description
RedisClient() Creates a uri-less RedisClient.
RedisClient(RedisURI redisURI) Create a new client that connects to the supplied host and port.
RedisClient(String host) Create a new client that connects to the supplied host on the default port.
RedisClient(String host, int port) Create a new client that connects to the supplied host and port.

Method Summary

Modifier and Type	Method and Description
RedisConnectionPool<RedisAsyncConnection<String,String>>	asyncPool() Creates a connection pool for asynchronous connections. 5 max idle connections and 20 max active connections.
RedisConnectionPool<RedisAsyncConnection<String,String>>	asyncPool(int maxIdle, int maxActive) Creates a connection pool for asynchronous connections.
<K,V> RedisConnectionPool<RedisAsyncConnection<K,V>>	asyncPool(RedisCodec<K,V> codec, int maxIdle, int maxActive) Creates a connection pool for asynchronous connections.
RedisConnection<String,String>	connect() Open a new synchronous connection to the redis server that treats keys and values as UTF-8 strings.
<K,V> RedisConnection<K,V>	connect(RedisCodec<K,V> codec) Open a new synchronous connection to the redis server.
RedisConnection<String,String>	connect(RedisURI redisURI) Open a new synchronous connection to the supplied RedisURI that treats keys and values as UTF-8 strings.
RedisAsyncConnection<String,String>	connectAsync() Open a new asynchronous connection to the redis server that treats keys and values as UTF-8 strings.
<K,V> RedisAsyncConnection<K,V>	connectAsync(RedisCodec<K,V> codec) Open a new asynchronous connection to the redis server.
RedisAsyncConnection<String,String>	connectAsync(RedisURI redisURI) Open a new asynchronous connection to the supplied RedisURI that treats keys and values as UTF-8 strings.
RedisPubSubConnection<String,String>	connectPubSub() Open a new pub/sub connection to the redis server that treats keys and values as UTF-8 strings.
<K,V> RedisPubSubConnection<K,V>	connectPubSub(RedisCodec<K,V> codec) Open a new pub/sub connection to the redis server.
protected <K,V> RedisPubSubConnection<K,V>	connectPubSub(RedisCodec<K,V> codec, RedisURI redisURI)
RedisPubSubConnection<String,String>	connectPubSub(RedisURI redisURI) Open a new pub/sub connection to the supplied RedisURI that treats keys and values as UTF-8 strings.
RedisSentinelAsyncConnection<String,String>	connectSentinelAsync() Creates an asynchronous connection to Sentinel.
<K,V> RedisSentinelAsyncConnection<K,V>	connectSentinelAsync(RedisCodec<K,V> codec) Creates an asynchronous connection to Sentinel.
RedisSentinelAsyncConnection<String,String>	connectSentinelAsync(RedisURI redisURI) Creates an asynchronous connection to Sentinel.
protected SocketAddress	getSocketAddress(RedisURI redisURI)
protected long	makeTimeout()
protected <K,V> RedisAsyncConnectionImpl<K,V>	newRedisAsyncConnectionImpl(RedisChannelWriter<K,V> channelWriter, RedisCodec<K,V> codec, long timeout, TimeUnit unit) Construct a new RedisAsyncConnectionImpl.
protected <K,V> RedisPubSubConnectionImpl<K,V>	newRedisPubSubConnectionImpl(RedisChannelWriter<K,V> channelWriter, RedisCodec<K,V> codec, long timeout, TimeUnit unit) Construct a new RedisPubSubConnectionImpl.
protected <K,V> com.lambdaworks.redis.RedisSentinelAsyncConnectionImpl<K,V>	newRedisSentinelAsyncConnectionImpl(RedisChannelWriter<K,V> channelWriter, RedisCodec<K,V> codec, long timeout, TimeUnit unit) Construct a new RedisSentinelAsyncConnectionImpl.
RedisConnectionPool<RedisConnection<String,String>>	pool() Creates a connection pool for synchronous connections. 5 max idle connections and 20 max active connections.
RedisConnectionPool<RedisConnection<String,String>>	pool(int maxIdle, int maxActive) Creates a connection pool for synchronous connections.
<K,V> RedisConnectionPool<RedisConnection<K,V>>	pool(RedisCodec<K,V> codec, int maxIdle, int maxActive) Creates a connection pool for synchronous connections.

Methods inherited from class com.lambdaworks.redis.AbstractRedisClient

addListener, channelType, connectAsyncImpl, connectionBuilder, getChannelCount, getOptions, getResourceCount, initializeChannel, removeListener, setDefaultTimeout, setOptions, shutdown, shutdown, syncHandler

Methods inherited from class java.lang.Object

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

Constructor Detail

RedisClient

public RedisClient()

Creates a uri-less RedisClient. You can connect to different redis servers but you must supply a RedisURI on connecting. Methods without having a RedisURI will fail with a IllegalStateException.

RedisClient

public RedisClient(String host)

Create a new client that connects to the supplied host on the default port.

Parameters:

host - Server hostname.

RedisClient

public RedisClient(String host,
                   int port)

Create a new client that connects to the supplied host and port. Connection attempts and non-blocking commands will timeout after 60 seconds.

Parameters:

host - Server hostname.

port - Server port.

RedisClient

public RedisClient(RedisURI redisURI)

Create a new client that connects to the supplied host and port. Connection attempts and non-blocking commands will timeout after 60 seconds.

Parameters:

redisURI - Redis URI.

Method Detail

pool

public RedisConnectionPool<RedisConnection<String,String>> pool()

Creates a connection pool for synchronous connections. 5 max idle connections and 20 max active connections. Please keep in mind to free all collections and close the pool once you do not need it anymore.

Returns:

a new RedisConnectionPool instance

pool

public RedisConnectionPool<RedisConnection<String,String>> pool(int maxIdle,
                                                                int maxActive)

Creates a connection pool for synchronous connections. Please keep in mind to free all collections and close the pool once you do not need it anymore.

Parameters:

maxIdle - max idle connections in pool

maxActive - max active connections in pool

Returns:

a new RedisConnectionPool instance

pool

public <K,V> RedisConnectionPool<RedisConnection<K,V>> pool(RedisCodec<K,V> codec,
                                                            int maxIdle,
                                                            int maxActive)

Creates a connection pool for synchronous connections. Please keep in mind to free all collections and close the pool once you do not need it anymore.

Type Parameters:

K - Key type.

V - Value type.

Parameters:

codec - the codec to use

maxIdle - max idle connections in pool

maxActive - max active connections in pool

Returns:

a new RedisConnectionPool instance

makeTimeout

protected long makeTimeout()

asyncPool

public RedisConnectionPool<RedisAsyncConnection<String,String>> asyncPool()

Creates a connection pool for asynchronous connections. 5 max idle connections and 20 max active connections. Please keep in mind to free all collections and close the pool once you do not need it anymore.

Returns:

a new RedisConnectionPool instance

asyncPool

public RedisConnectionPool<RedisAsyncConnection<String,String>> asyncPool(int maxIdle,
                                                                          int maxActive)

Creates a connection pool for asynchronous connections. Please keep in mind to free all collections and close the pool once you do not need it anymore.

Parameters:

maxIdle - max idle connections in pool

maxActive - max active connections in pool

Returns:

a new RedisConnectionPool instance

asyncPool

public <K,V> RedisConnectionPool<RedisAsyncConnection<K,V>> asyncPool(RedisCodec<K,V> codec,
                                                                      int maxIdle,
                                                                      int maxActive)

Creates a connection pool for asynchronous connections. Please keep in mind to free all collections and close the pool once you do not need it anymore.

Type Parameters:

K - Key type.

V - Value type.

Parameters:

codec - the codec to use

maxIdle - max idle connections in pool

maxActive - max active connections in pool

Returns:

a new RedisConnectionPool instance

connect

public RedisConnection<String,String> connect()

Open a new synchronous connection to the redis server that treats keys and values as UTF-8 strings.

Returns:

A new connection.

connect

public <K,V> RedisConnection<K,V> connect(RedisCodec<K,V> codec)

Open a new synchronous connection to the redis server. Use the supplied codec to encode/decode keys and values.

Type Parameters:

K - Key type.

V - Value type.

Parameters:

codec - Use this codec to encode/decode keys and values, must note be null

Returns:

A new connection.

connect

public RedisConnection<String,String> connect(RedisURI redisURI)

Open a new synchronous connection to the supplied RedisURI that treats keys and values as UTF-8 strings.

Parameters:

redisURI - the redis server to connect to, must not be null

Returns:

A new connection.

connectAsync

public RedisAsyncConnection<String,String> connectAsync()

Open a new asynchronous connection to the redis server that treats keys and values as UTF-8 strings.

Returns:

A new connection.

connectAsync

public <K,V> RedisAsyncConnection<K,V> connectAsync(RedisCodec<K,V> codec)

Open a new asynchronous connection to the redis server. Use the supplied codec to encode/decode keys and values.

Type Parameters:

K - Key type.

V - Value type.

Parameters:

codec - Use this codec to encode/decode keys and values, must not be null

Returns:

A new connection.

connectAsync

public RedisAsyncConnection<String,String> connectAsync(RedisURI redisURI)

Open a new asynchronous connection to the supplied RedisURI that treats keys and values as UTF-8 strings.

Parameters:

redisURI - the redis server to connect to, must not be null

Returns:

A new connection.

connectPubSub

public RedisPubSubConnection<String,String> connectPubSub()

Open a new pub/sub connection to the redis server that treats keys and values as UTF-8 strings.

Returns:

A new connection.

connectPubSub

public RedisPubSubConnection<String,String> connectPubSub(RedisURI redisURI)

Open a new pub/sub connection to the supplied RedisURI that treats keys and values as UTF-8 strings.

Parameters:

redisURI - the redis server to connect to, must not be null

Returns:

A new connection.

connectPubSub

public <K,V> RedisPubSubConnection<K,V> connectPubSub(RedisCodec<K,V> codec)

Open a new pub/sub connection to the redis server. Use the supplied codec to encode/decode keys and values.

Type Parameters:

K - Key type.

V - Value type.

Parameters:

codec - Use this codec to encode/decode keys and values, must not be null

Returns:

A new pub/sub connection.

connectPubSub

protected <K,V> RedisPubSubConnection<K,V> connectPubSub(RedisCodec<K,V> codec,
                                                         RedisURI redisURI)

connectSentinelAsync

public RedisSentinelAsyncConnection<String,String> connectSentinelAsync()

Creates an asynchronous connection to Sentinel. You must supply a valid RedisURI containing one or more sentinels.

Returns:

a new connection.

connectSentinelAsync

public <K,V> RedisSentinelAsyncConnection<K,V> connectSentinelAsync(RedisCodec<K,V> codec)

Creates an asynchronous connection to Sentinel. You must supply a valid RedisURI containing one or more sentinels.

Type Parameters:

K - Key type.

V - Value type.

Parameters:

codec - Use this codec to encode/decode keys and values, must not be null

Returns:

a new connection.

connectSentinelAsync

public RedisSentinelAsyncConnection<String,String> connectSentinelAsync(RedisURI redisURI)

Creates an asynchronous connection to Sentinel. You must supply a valid RedisURI containing a redis host or one or more sentinels.

Parameters:

redisURI - the redis server to connect to, must not be null

Returns:

A new connection.

newRedisAsyncConnectionImpl

protected <K,V> RedisAsyncConnectionImpl<K,V> newRedisAsyncConnectionImpl(RedisChannelWriter<K,V> channelWriter,
                                                                          RedisCodec<K,V> codec,
                                                                          long timeout,
                                                                          TimeUnit unit)

Construct a new RedisAsyncConnectionImpl. Can be overridden in order to construct a subclass of RedisAsyncConnectionImpl

Type Parameters:

K - Key type.

V - Value type.

Parameters:

channelWriter - the channel writer

codec - the codec to use

timeout - Timeout value

unit - Timeout unit

Returns:

RedisAsyncConnectionImpl<K, V> instance

newRedisSentinelAsyncConnectionImpl

protected <K,V> com.lambdaworks.redis.RedisSentinelAsyncConnectionImpl<K,V> newRedisSentinelAsyncConnectionImpl(RedisChannelWriter<K,V> channelWriter,
                                                                                                                RedisCodec<K,V> codec,
                                                                                                                long timeout,
                                                                                                                TimeUnit unit)

Construct a new RedisSentinelAsyncConnectionImpl. Can be overridden in order to construct a subclass of RedisSentinelAsyncConnectionImpl

Type Parameters:

K - Key type.

V - Value type.

Parameters:

channelWriter - the channel writer

codec - the codec to use

timeout - Timeout value

unit - Timeout unit

Returns:

RedisSentinelAsyncConnectionImpl<K, V> instance

newRedisPubSubConnectionImpl

protected <K,V> RedisPubSubConnectionImpl<K,V> newRedisPubSubConnectionImpl(RedisChannelWriter<K,V> channelWriter,
                                                                            RedisCodec<K,V> codec,
                                                                            long timeout,
                                                                            TimeUnit unit)

Construct a new RedisPubSubConnectionImpl. Can be overridden in order to construct a subclass of RedisPubSubConnectionImpl

Type Parameters:

K - Key type.

V - Value type.

Parameters:

channelWriter - the channel writer

codec - the codec to use

timeout - Timeout value

unit - Timeout unit

Returns:

RedisPubSubConnectionImpl<K, V> instance

getSocketAddress

protected SocketAddress getSocketAddress(RedisURI redisURI)
                                  throws InterruptedException,
                                         TimeoutException,
                                         ExecutionException

Throws:

InterruptedException

TimeoutException

ExecutionException