io.lettuce.core.protocol

Class MaintenanceAwareConnectionWatchdog

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.lettuce.core.protocol.ConnectionWatchdog

io.lettuce.core.protocol.MaintenanceAwareConnectionWatchdog

All Implemented Interfaces:

PushListener, io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

@ChannelHandler.Sharable
public class MaintenanceAwareConnectionWatchdog
extends ConnectionWatchdog
implements PushListener

An extension to ConnectionWatchdog that intercepts maintenance events.

Since:

7.0

Author:

Tihomir Mateev

See Also:

ClientOptions.getMaintNotificationsConfig()

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
static io.netty.util.AttributeKey<RebindState>	REBIND_ATTRIBUTE

Fields inherited from class io.lettuce.core.protocol.ConnectionWatchdog

reconnectionHandler

Constructor Summary

Constructors

Constructor and Description
MaintenanceAwareConnectionWatchdog(Delay reconnectDelay, ClientOptions clientOptions, io.netty.bootstrap.Bootstrap bootstrap, io.netty.util.Timer timer, io.netty.util.concurrent.EventExecutorGroup reconnectWorkers, Mono<SocketAddress> socketAddressSupplier, ReconnectionListener reconnectionListener, ConnectionFacade connectionFacade, EventBus eventBus, Endpoint endpoint)

Method Summary

Modifier and Type	Method and Description
void	channelActive(io.netty.channel.ChannelHandlerContext ctx)
void	channelReadComplete(io.netty.channel.ChannelHandlerContext ctx)
void	onPushMessage(PushMessage message) Handle a push message.
void	setMaintenanceEventListener(MaintenanceAwareComponent component) Register a component that is aware of re-bind events.
protected Mono<SocketAddress>	wrapSocketAddressSupplier(Mono<SocketAddress> socketAddressSupplier)

Methods inherited from class io.lettuce.core.protocol.ConnectionWatchdog

channelInactive, isListenOnChannelInactive, isReconnectSuspended, run, scheduleReconnect, setListenOnChannelInactive, setReconnectSuspended

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelRead, channelRegistered, 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

REBIND_ATTRIBUTE

public static final io.netty.util.AttributeKey<RebindState> REBIND_ATTRIBUTE

Constructor Detail

MaintenanceAwareConnectionWatchdog

public MaintenanceAwareConnectionWatchdog(Delay reconnectDelay,
                                          ClientOptions clientOptions,
                                          io.netty.bootstrap.Bootstrap bootstrap,
                                          io.netty.util.Timer timer,
                                          io.netty.util.concurrent.EventExecutorGroup reconnectWorkers,
                                          Mono<SocketAddress> socketAddressSupplier,
                                          ReconnectionListener reconnectionListener,
                                          ConnectionFacade connectionFacade,
                                          EventBus eventBus,
                                          Endpoint endpoint)

Method Detail

channelActive

public void channelActive(io.netty.channel.ChannelHandlerContext ctx)
                   throws Exception

Specified by:

channelActive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelActive in class ConnectionWatchdog

Throws:

Exception

channelReadComplete

public void channelReadComplete(io.netty.channel.ChannelHandlerContext ctx)
                         throws Exception

Specified by:

channelReadComplete in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelReadComplete in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception

wrapSocketAddressSupplier

protected Mono<SocketAddress> wrapSocketAddressSupplier(Mono<SocketAddress> socketAddressSupplier)

Overrides:

wrapSocketAddressSupplier in class ConnectionWatchdog

onPushMessage

public void onPushMessage(PushMessage message)

Description copied from interface: PushListener

Handle a push message.

Specified by:

onPushMessage in interface PushListener

Parameters:

message - message to respond to.

setMaintenanceEventListener

public void setMaintenanceEventListener(MaintenanceAwareComponent component)

Register a component that is aware of re-bind events. Such a component is going to be notified of re-bind events by calling their onRebindStarted and onRebindCompleted methods.

Parameters:

component - the component to register