Module lettuce.core

Package io.lettuce.core

Class CommandListenerWriter

java.lang.Object

io.lettuce.core.CommandListenerWriter

All Implemented Interfaces:

AsyncCloseable, RedisChannelWriter, Closeable, AutoCloseable

public class CommandListenerWriter
extends Object
implements RedisChannelWriter

Writer for command listeners.

Since:

6.1

Author:

Mikhael Sokolov, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommandListenerWriter.CommandListenerMulticaster	Wraps multiple command listeners into one multicaster.

Constructor Summary

Constructors

Constructor	Description
CommandListenerWriter(RedisChannelWriter delegate, List<CommandListener> listeners)

Method Summary

Modifier and Type	Method	Description
void	close()
CompletableFuture<Void>	closeAsync()	Asynchronously close the RedisChannelWriter.
void	flushCommands()	Flush pending commands.
ClientResources	getClientResources()
RedisChannelWriter	getDelegate()
static boolean	isSupported(List<CommandListener> commandListeners)	Check whether the list of CommandListener is not empty.
void	reset()	Reset the command state.
void	setAutoFlushCommands(boolean autoFlush)	Disable or enable auto-flush behavior.
void	setConnectionFacade(ConnectionFacade connection)	Set the corresponding connection facade in order to notify it about channel active/inactive state.
<K, V, T> RedisCommand<K,V,T>	write(RedisCommand<K,V,T> command)	Write a command on the channel.
<K, V> Collection<RedisCommand<K,V,?>>	write(Collection<? extends RedisCommand<K,V,?>> redisCommands)	Write multiple commands on the channel.

Methods inherited from class java.lang.Object

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

Constructor Details

CommandListenerWriter

public CommandListenerWriter(RedisChannelWriter delegate,
List<CommandListener> listeners)

Method Details

isSupported

public static boolean isSupported(List<CommandListener> commandListeners)

Check whether the list of CommandListener is not empty.

Parameters:

commandListeners - must not be null.

Returns:

true if the list of CommandListener is not empty.

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

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

Type Parameters:

K - key type

V - value type

Parameters:

redisCommands - the Redis commands.

Returns:

the written redis command

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface RedisChannelWriter

closeAsync

public CompletableFuture<Void> closeAsync()

Description copied from interface: RedisChannelWriter

Asynchronously close the RedisChannelWriter.

Specified by:

closeAsync in interface AsyncCloseable

Specified by:

closeAsync in interface RedisChannelWriter

Returns:

future for result synchronization.

reset

public void reset()

Description copied from interface: RedisChannelWriter

Reset the command state. Queued commands will be canceled and the internal state will be reset. This is useful when the internal state machine gets out of sync with the connection (e.g. errors during external SSL tunneling). Calling this method will reset the protocol state, therefore it is considered unsafe.

Specified by:

reset in interface RedisChannelWriter

setConnectionFacade

public void setConnectionFacade(ConnectionFacade connection)

Description copied from interface: RedisChannelWriter

Set the corresponding connection facade in order to notify it about channel active/inactive state.

Specified by:

setConnectionFacade in interface RedisChannelWriter

Parameters:

connection - the connection facade (external connection object)

setAutoFlushCommands

public void setAutoFlushCommands(boolean autoFlush)

Description copied from interface: RedisChannelWriter

Disable or enable auto-flush behavior. Default is true. If autoFlushCommands is disabled, multiple commands can be issued without writing them actually to the transport. Commands are buffered until a RedisChannelWriter.flushCommands() is issued. After calling RedisChannelWriter.flushCommands() commands are sent to the transport and executed by Redis.

Specified by:

setAutoFlushCommands in interface RedisChannelWriter

Parameters:

autoFlush - state of autoFlush.

flushCommands

public void flushCommands()

Description copied from interface: RedisChannelWriter

Flush pending commands. This commands forces a flush on the channel and can be used to buffer ("pipeline") commands to achieve batching. No-op if channel is not connected.

Specified by:

flushCommands in interface RedisChannelWriter

getClientResources

public ClientResources getClientResources()

Specified by:

getClientResources in interface RedisChannelWriter

Returns:

the ClientResources.

getDelegate

public RedisChannelWriter getDelegate()