io.lettuce.core.protocol

Class MaintenanceAwareExpiryWriter

java.lang.Object

io.lettuce.core.protocol.CommandExpiryWriter

io.lettuce.core.protocol.MaintenanceAwareExpiryWriter

All Implemented Interfaces:

AsyncCloseable, MaintenanceAwareComponent, RedisChannelWriter, Closeable, AutoCloseable

public class MaintenanceAwareExpiryWriter
extends CommandExpiryWriter
implements MaintenanceAwareComponent

Extension to RedisChannelWriter that expires commands. Command timeout starts at the time the command is written regardless to flushing mode (user-controlled batching).

This implementation, compared to the CommandExpiryWriter implementation, relaxes the timeouts when a re-bind is in progress. The relaxation is done by starting a new timer with the relaxed timeout value. The relaxed timeout is configured via TimeoutOptions.getRelaxedTimeout().

The logic is only applied when the ClientOptions.getMaintNotificationsConfig() is enabled.

Since:

7.0

Author:

Tihomir Mateev

See Also:

TimeoutOptions, MaintenanceAwareComponent, MaintenanceAwareConnectionWatchdog, ClientOptions.getMaintNotificationsConfig()

Constructor Summary

Constructors

Constructor and Description
MaintenanceAwareExpiryWriter(RedisChannelWriter delegate, ClientOptions clientOptions, ClientResources clientResources) Create a new MaintenanceAwareExpiryWriter.

Method Summary

Modifier and Type	Method and Description
void	onFailoverCompleted(String shards) Called whenever a failover is completed
void	onFailoverStarted(String shards) Called whenever a failover is initiated
void	onMigrateCompleted(String shards) Called whenever a shard migration is completed
void	onMigrateStarted(String shards) Called whenever a shard migration is initiated
void	onRebindCompleted() Called whenever the re-bind has been completed
void	onRebindStarted(Duration time, SocketAddress endpoint) Called whenever a re-bind has been initiated by the remote server A specific endpoint is going to move to another node within seconds
<K,V> Collection<RedisCommand<K,V,?>>	write(Collection<? extends RedisCommand<K,V,?>> redisCommands) Write multiple commands on the channel.
<K,V,T> RedisCommand<K,V,T>	write(RedisCommand<K,V,T> command) Write a command on the channel.

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

buildCommandExpiryWriter, close, closeAsync, flushCommands, getClientResources, getDelegate, isSupported, setAutoFlushCommands, setConnectionFacade, setTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

MaintenanceAwareExpiryWriter

public MaintenanceAwareExpiryWriter(RedisChannelWriter delegate,
                                    ClientOptions clientOptions,
                                    ClientResources clientResources)

Create a new MaintenanceAwareExpiryWriter.

Parameters:

delegate - must not be null.

clientOptions - must not be null.

clientResources - must not be null.

Method Detail

write

public <K,V,T> RedisCommand<K,V,T> write(RedisCommand<K,V,T> command)

Description copied from interface: RedisChannelWriter

Write a command on the channel. The command may be changed/wrapped during write and the written instance is returned after the call.

Specified by:

write in interface RedisChannelWriter

Overrides:

write in class CommandExpiryWriter

T - result type

Parameters:

command - the Redis command.

Returns:

the written Redis command.

write

public <K,V> Collection<RedisCommand<K,V,?>> write(Collection<? extends RedisCommand<K,V,?>> redisCommands)

Description copied from interface: RedisChannelWriter

Write multiple commands on the channel. The commands may be changed/wrapped during write and the written instance is returned after the call.

Specified by:

write in interface RedisChannelWriter

Overrides:

write in class CommandExpiryWriter

Type Parameters:

K - key type

V - value type

Parameters:

redisCommands - the Redis commands.

Returns:

the written redis command

onRebindStarted

public void onRebindStarted(Duration time,
                            SocketAddress endpoint)

Description copied from interface: MaintenanceAwareComponent

Called whenever a re-bind has been initiated by the remote server

A specific endpoint is going to move to another node within seconds

Specified by:

onRebindStarted in interface MaintenanceAwareComponent

Parameters:

time - estimated time for the re-bind to complete

endpoint - address of the target endpoint

onRebindCompleted

public void onRebindCompleted()

Description copied from interface: MaintenanceAwareComponent

Called whenever the re-bind has been completed

Specified by:

onRebindCompleted in interface MaintenanceAwareComponent

onMigrateStarted

public void onMigrateStarted(String shards)

Description copied from interface: MaintenanceAwareComponent

Called whenever a shard migration is initiated

Specified by:

onMigrateStarted in interface MaintenanceAwareComponent

onMigrateCompleted

public void onMigrateCompleted(String shards)

Description copied from interface: MaintenanceAwareComponent

Called whenever a shard migration is completed

Specified by:

onMigrateCompleted in interface MaintenanceAwareComponent

onFailoverStarted

public void onFailoverStarted(String shards)

Description copied from interface: MaintenanceAwareComponent

Called whenever a failover is initiated

Specified by:

onFailoverStarted in interface MaintenanceAwareComponent

onFailoverCompleted

public void onFailoverCompleted(String shards)

Description copied from interface: MaintenanceAwareComponent

Called whenever a failover is completed

Specified by:

onFailoverCompleted in interface MaintenanceAwareComponent