com.lambdaworks.redis.protocol

Class ConnectionWatchdog

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

com.lambdaworks.redis.protocol.ConnectionWatchdog

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, TimerTask

@ChannelHandler.Sharable
public class ConnectionWatchdog
extends ChannelInboundHandlerAdapter
implements TimerTask

A netty ChannelHandler responsible for monitoring the channel and reconnecting when the connection is lost.

Author:

Will Glozer

Nested Class Summary

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

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
static long	LOGGING_QUIET_TIME_MS
static int	RETRY_TIMEOUT_MAX

Constructor Summary

Constructors

Constructor and Description
ConnectionWatchdog(ClientOptions clientOptions, Bootstrap bootstrap, EventExecutorGroup reconnectWorkers, Timer timer) Create a new watchdog that adds to new connections to the supplied ChannelGroup and establishes a new Channel when disconnected, while reconnect is true.
ConnectionWatchdog(ClientOptions clientOptions, Bootstrap bootstrap, Timer timer, EventExecutorGroup reconnectWorkers, Supplier<SocketAddress> socketAddressSupplier) Create a new watchdog that adds to new connections to the supplied ChannelGroup and establishes a new Channel when disconnected, while reconnect is true.

Method Summary

Modifier and Type	Method and Description
void	channelActive(ChannelHandlerContext ctx)
void	channelInactive(ChannelHandlerContext ctx)
boolean	isListenOnChannelInactive()
boolean	isReconnectSuspended()
void	run(Timeout timeout) Reconnect to the remote address that the closed channel was connected to.
void	scheduleReconnect() Schedule reconnect if channel is not available/not active.
void	setListenOnChannelInactive(boolean listenOnChannelInactive)
void	setReconnect(boolean reconnect) Deprecated. use setListenOnChannelInactive(boolean)
void	setReconnectSuspended(boolean reconnectSuspended)
void	userEventTriggered(ChannelHandlerContext ctx, Object evt)

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

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

LOGGING_QUIET_TIME_MS

public static final long LOGGING_QUIET_TIME_MS

RETRY_TIMEOUT_MAX

public static final int RETRY_TIMEOUT_MAX

See Also:

Constant Field Values

Constructor Detail

ConnectionWatchdog

public ConnectionWatchdog(ClientOptions clientOptions,
                          Bootstrap bootstrap,
                          EventExecutorGroup reconnectWorkers,
                          Timer timer)

Create a new watchdog that adds to new connections to the supplied ChannelGroup and establishes a new Channel when disconnected, while reconnect is true.

Parameters:

clientOptions - client options for the current connection

bootstrap - Configuration for new channels.

reconnectWorkers - executor group for reconnect tasks.

timer - Timer used for delayed reconnect.

ConnectionWatchdog

public ConnectionWatchdog(ClientOptions clientOptions,
                          Bootstrap bootstrap,
                          Timer timer,
                          EventExecutorGroup reconnectWorkers,
                          Supplier<SocketAddress> socketAddressSupplier)

Create a new watchdog that adds to new connections to the supplied ChannelGroup and establishes a new Channel when disconnected, while reconnect is true. The socketAddressSupplier can supply the reconnect address.

Parameters:

clientOptions - client options for the current connection

bootstrap - Configuration for new channels.

timer - Timer used for delayed reconnect.

reconnectWorkers - executor group for reconnect tasks.

socketAddressSupplier - the socket address suplier for gaining an address to reconnect to

Method Detail

userEventTriggered

public void userEventTriggered(ChannelHandlerContext ctx,
                               Object evt)
                        throws Exception

Specified by:

userEventTriggered in interface ChannelInboundHandler

Overrides:

userEventTriggered in class ChannelInboundHandlerAdapter

Throws:

Exception

channelActive

public void channelActive(ChannelHandlerContext ctx)
                   throws Exception

Specified by:

channelActive in interface ChannelInboundHandler

Overrides:

channelActive in class ChannelInboundHandlerAdapter

Throws:

Exception

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

Specified by:

channelInactive in interface ChannelInboundHandler

Overrides:

channelInactive in class ChannelInboundHandlerAdapter

Throws:

Exception

scheduleReconnect

public void scheduleReconnect()

Schedule reconnect if channel is not available/not active.

run

public void run(Timeout timeout)
         throws Exception

Reconnect to the remote address that the closed channel was connected to. This creates a new ChannelPipeline with the same handler instances contained in the old channel's pipeline.

Specified by:

run in interface TimerTask

Parameters:

timeout - Timer task handle.

Throws:

Exception - when reconnection fails.

setReconnect

@Deprecated
public void setReconnect(boolean reconnect)

Deprecated. use setListenOnChannelInactive(boolean)

Parameters:

reconnect - true if reconnect is active

setListenOnChannelInactive

public void setListenOnChannelInactive(boolean listenOnChannelInactive)

isListenOnChannelInactive

public boolean isListenOnChannelInactive()

isReconnectSuspended

public boolean isReconnectSuspended()

setReconnectSuspended

public void setReconnectSuspended(boolean reconnectSuspended)