com.lambdaworks.redis

Class RedisClient

java.lang.Object

com.lambdaworks.redis.RedisClient

public class RedisClient
extends java.lang.Object

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.

Field Summary

Fields

Modifier and Type	Field and Description
private org.jboss.netty.bootstrap.ClientBootstrap	bootstrap
private org.jboss.netty.channel.group.ChannelGroup	channels
private long	timeout
private org.jboss.netty.util.Timer	timer
private java.util.concurrent.TimeUnit	unit

Constructor Summary

Constructors

Constructor and Description
RedisClient(java.lang.String host) Create a new client that connects to the supplied host on the default port.
RedisClient(java.lang.String host, int port) Create a new client that connects to the supplied host and port.

Method Summary

Modifier and Type	Method and Description
RedisConnection<java.lang.String,java.lang.String>	connect() Open a new synchronous connection to the redis server that treats keys and values as UTF-8 strings.
private <K,V,T extends RedisAsyncConnection<K,V>> T	connect(CommandHandler<K,V> handler, T connection)
<K,V> RedisConnection<K,V>	connect(RedisCodec<K,V> codec) Open a new synchronous connection to the redis server.
RedisAsyncConnection<java.lang.String,java.lang.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.
RedisPubSubConnection<java.lang.String,java.lang.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.
void	setDefaultTimeout(long timeout, java.util.concurrent.TimeUnit unit) Set the default timeout for connections created by this client.
void	shutdown() Shutdown this client and close all open connections.

Methods inherited from class java.lang.Object

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

Field Detail

bootstrap

private org.jboss.netty.bootstrap.ClientBootstrap bootstrap

timer

private org.jboss.netty.util.Timer timer

channels

private org.jboss.netty.channel.group.ChannelGroup channels

timeout

private long timeout

unit

private java.util.concurrent.TimeUnit unit

Constructor Detail

RedisClient

public RedisClient(java.lang.String host)

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

Parameters:

host - Server hostname.

RedisClient

public RedisClient(java.lang.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.

Method Detail

setDefaultTimeout

public void setDefaultTimeout(long timeout,
                              java.util.concurrent.TimeUnit unit)

Set the default timeout for connections created by this client. The timeout applies to connection attempts and non-blocking commands.

Parameters:

timeout - Default connection timeout.

unit - Unit of time for the timeout.

connect

public RedisConnection<java.lang.String,java.lang.String> connect()

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

Returns:

A new connection.

connectAsync

public RedisAsyncConnection<java.lang.String,java.lang.String> connectAsync()

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

Returns:

A new connection.

connectPubSub

public RedisPubSubConnection<java.lang.String,java.lang.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.

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.

Parameters:

codec - Use this codec to encode/decode keys and values.

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.

Parameters:

codec - Use this codec to encode/decode keys and values.

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.

Parameters:

codec - Use this codec to encode/decode keys and values.

Returns:

A new pub/sub connection.

connect

private <K,V,T extends RedisAsyncConnection<K,V>> T connect(CommandHandler<K,V> handler,
                                                            T connection)

shutdown

public void shutdown()

Shutdown this client and close all open connections. The client should be discarded after calling shutdown.