com.lambdaworks.redis

Class RedisChannelHandler<K,V>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

com.lambdaworks.redis.RedisChannelHandler<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, Closeable, AutoCloseable

Direct Known Subclasses:

StatefulRedisClusterConnectionImpl, StatefulRedisConnectionImpl, StatefulRedisSentinelConnectionImpl

public abstract class RedisChannelHandler<K,V>
extends ChannelInboundHandlerAdapter
implements Closeable

Abstract base for every redis connection. Provides basic connection functionality and tracks open resources.

Since:

3.0

Author:

Mark Paluch

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
protected long	timeout
protected TimeUnit	unit

Constructor Summary

Constructors

Constructor and Description
RedisChannelHandler(RedisChannelWriter<K,V> writer, long timeout, TimeUnit unit)

Method Summary

Modifier and Type	Method and Description
void	activated() Notification when the connection becomes active (connected).
protected void	addListener(com.lambdaworks.redis.CloseEvents.CloseListener listener)
void	channelRead(ChannelHandlerContext ctx, Object msg)
void	channelRead(Object msg) Invoked on a channel read.
void	channelRegistered(ChannelHandlerContext ctx)
void	close() Close the connection.
void	deactivated() Notification when the connection becomes inactive (disconnected).
protected <T,C extends RedisCommand<K,V,T>> C	dispatch(C cmd)
void	flushCommands()
RedisChannelWriter<K,V>	getChannelWriter()
ClientOptions	getOptions()
long	getTimeout()
TimeUnit	getTimeoutUnit()
boolean	isClosed()
boolean	isOpen()
void	registerCloseables(Collection<Closeable> registry, Closeable... closeables) Register Closeable resources.
void	reset()
void	setAutoFlushCommands(boolean autoFlush)
void	setOptions(ClientOptions clientOptions)
void	setTimeout(long timeout, TimeUnit unit) Set the command timeout for this connection.
protected <T> T	syncHandler(Object asyncApi, Class<?>... interfaces)

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Field Detail

timeout

protected long timeout

unit

protected TimeUnit unit

Constructor Detail

RedisChannelHandler

public RedisChannelHandler(RedisChannelWriter<K,V> writer,
                           long timeout,
                           TimeUnit unit)

Parameters:

writer - the channel writer

timeout - timeout value

unit - unit of the timeout

Method Detail

channelRegistered

public void channelRegistered(ChannelHandlerContext ctx)
                       throws Exception

Specified by:

channelRegistered in interface ChannelInboundHandler

Overrides:

channelRegistered in class ChannelInboundHandlerAdapter

Throws:

Exception

setTimeout

public void setTimeout(long timeout,
                       TimeUnit unit)

Set the command timeout for this connection.

Parameters:

timeout - Command timeout.

unit - Unit of time for the timeout.

close

public void close()

Close the connection.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

channelRead

public void channelRead(ChannelHandlerContext ctx,
                        Object msg)
                 throws Exception

Specified by:

channelRead in interface ChannelInboundHandler

Overrides:

channelRead in class ChannelInboundHandlerAdapter

Throws:

Exception

channelRead

public void channelRead(Object msg)

Invoked on a channel read.

Parameters:

msg - channel message

dispatch

protected <T,C extends RedisCommand<K,V,T>> C dispatch(C cmd)

registerCloseables

public void registerCloseables(Collection<Closeable> registry,
                               Closeable... closeables)

Register Closeable resources. Internal access only.

Parameters:

registry - registry of closeables

closeables - closeables to register

addListener

protected void addListener(com.lambdaworks.redis.CloseEvents.CloseListener listener)

isClosed

public boolean isClosed()

Returns:

true if the connection is closed (final state in the connection lifecyle).

activated

public void activated()

Notification when the connection becomes active (connected).

deactivated

public void deactivated()

Notification when the connection becomes inactive (disconnected).

getChannelWriter

public RedisChannelWriter<K,V> getChannelWriter()

Returns:

the channel writer

isOpen

public boolean isOpen()

Returns:

true if the connection is active and not closed.

reset

public void reset()

getOptions

public ClientOptions getOptions()

setOptions

public void setOptions(ClientOptions clientOptions)

getTimeout

public long getTimeout()

getTimeoutUnit

public TimeUnit getTimeoutUnit()

syncHandler

protected <T> T syncHandler(Object asyncApi,
                            Class<?>... interfaces)

setAutoFlushCommands

public void setAutoFlushCommands(boolean autoFlush)

flushCommands

public void flushCommands()