com.lambdaworks.redis

Interface RedisChannelWriter<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

CommandHandler, PubSubCommandHandler

public interface RedisChannelWriter<K,V>
extends Closeable

Writer for a channel. Writers push commands on to the communication channel and maintain a state for the commands.

Since:

3.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
void	close()
void	flushCommands() Flush pending commands.
void	reset() Reset the writer state.
void	setAutoFlushCommands(boolean autoFlush) Disable or enable auto-flush behavior.
void	setRedisChannelHandler(RedisChannelHandler<K,V> redisChannelHandler) Set the corresponding connection instance in order to notify it about channel active/inactive state.
<T,C extends RedisCommand<K,V,T>> C	write(C command) Write a command on the channel.

Method Detail

write

<T,C extends RedisCommand<K,V,T>> C write(C command)

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

Type Parameters:

T - result type

C - command type

Parameters:

command - the Redis command.

Returns:

the written Redis command.

close

void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

reset

void reset()

Reset the writer 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.

setRedisChannelHandler

void setRedisChannelHandler(RedisChannelHandler<K,V> redisChannelHandler)

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

Parameters:

redisChannelHandler - the channel handler (external connection object)

setAutoFlushCommands

void setAutoFlushCommands(boolean autoFlush)

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 flushCommands() is issued. After calling flushCommands() commands are sent to the transport and executed by Redis.

Parameters:

autoFlush - state of autoFlush.

flushCommands

void flushCommands()

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.