io.lettuce.core

Class StatefulRedisConnectionImpl<K,V>

java.lang.Object

io.lettuce.core.RedisChannelHandler<K,V>

io.lettuce.core.StatefulRedisConnectionImpl<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Implemented Interfaces:

StatefulConnection<K,V>, StatefulRedisConnection<K,V>, AsyncCloseable, ConnectionFacade, Closeable, AutoCloseable

Direct Known Subclasses:

StatefulRedisPubSubConnectionImpl

public class StatefulRedisConnectionImpl<K,V>
extends RedisChannelHandler<K,V>
implements StatefulRedisConnection<K,V>

A thread-safe connection to a Redis server. Multiple threads may share one StatefulRedisConnectionImpl A ConnectionWatchdog monitors each connection and reconnects automatically until RedisChannelHandler.close() is called. All pending commands will be (re)sent after successful reconnection.

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
protected RedisAsyncCommandsImpl<K,V>	async
protected RedisCodec<K,V>	codec
protected MultiOutput<K,V>	multi
protected RedisReactiveCommandsImpl<K,V>	reactive
protected RedisCommands<K,V>	sync

Constructor Summary

Constructors

Constructor and Description
StatefulRedisConnectionImpl(RedisChannelWriter writer, PushHandler pushHandler, RedisCodec<K,V> codec, Duration timeout) Initialize a new connection.
StatefulRedisConnectionImpl(RedisChannelWriter writer, PushHandler pushHandler, RedisCodec<K,V> codec, Duration timeout, Supplier<JsonParser> parser) Initialize a new connection.

Method Summary

Modifier and Type	Method and Description
void	activated() Notification when the connection becomes active (connected).
void	addListener(PushListener listener) Add a new listener.
RedisAsyncCommands<K,V>	async() Returns the RedisAsyncCommands API for the current connection.
void	deactivated() Notification when the connection becomes inactive (disconnected).
Collection<RedisCommand<K,V,?>>	dispatch(Collection<? extends RedisCommand<K,V,?>> commands) Dispatch multiple command in a single write on the channel.
<T> RedisCommand<K,V,T>	dispatch(RedisCommand<K,V,T> command) Dispatch a command.
RedisCodec<K,V>	getCodec()
ConnectionState	getConnectionState()
boolean	isMulti()
protected RedisAsyncCommandsImpl<K,V>	newRedisAsyncCommandsImpl() Create a new instance of RedisAsyncCommandsImpl.
protected RedisReactiveCommandsImpl<K,V>	newRedisReactiveCommandsImpl() Create a new instance of RedisReactiveCommandsImpl.
protected RedisCommands<K,V>	newRedisSyncCommandsImpl() Create a new instance of RedisCommands.
protected <T> RedisCommand<K,V,T>	postProcessCommand(RedisCommand<K,V,T> command)
protected Collection<RedisCommand<K,V,?>>	postProcessCommands(Collection<RedisCommand<K,V,?>> commands)
protected <T> RedisCommand<K,V,T>	preProcessCommand(RedisCommand<K,V,T> command)
protected Collection<RedisCommand<K,V,?>>	preProcessCommands(Collection<? extends RedisCommand<K,V,?>> commands)
RedisReactiveCommands<K,V>	reactive() Returns the RedisReactiveCommands API for the current connection.
void	removeListener(PushListener listener) Remove an existing listener.
void	setAuthenticationHandler(RedisAuthenticationHandler<K,V> handler)
void	setClientName(String clientName) Deprecated. since 6.0, use RedisServerAsyncCommands.clientSetname(Object).
RedisCommands<K,V>	sync() Returns the RedisCommands API for the current connection.

Methods inherited from class io.lettuce.core.RedisChannelHandler

addListener, addListener, close, closeAsync, flushCommands, getChannelWriter, getConnectionEvents, getOptions, getResources, getTimeout, isClosed, isOpen, registerCloseables, removeListener, setAutoFlushCommands, setOptions, setTimeout, syncHandler

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.lettuce.core.api.StatefulConnection

addListener, close, closeAsync, flushCommands, getOptions, getResources, getTimeout, isOpen, removeListener, setAutoFlushCommands, setTimeout

Field Detail

codec

protected final RedisCodec<K,V> codec

sync

protected final RedisCommands<K,V> sync

async

protected final RedisAsyncCommandsImpl<K,V> async

reactive

protected final RedisReactiveCommandsImpl<K,V> reactive

multi

protected MultiOutput<K,V> multi

Constructor Detail

StatefulRedisConnectionImpl

public StatefulRedisConnectionImpl(RedisChannelWriter writer,
                                   PushHandler pushHandler,
                                   RedisCodec<K,V> codec,
                                   Duration timeout)

Initialize a new connection.

Parameters:

writer - the channel writer.

pushHandler - the handler for push notifications.

codec - Codec used to encode/decode keys and values.

timeout - Maximum time to wait for a response.

StatefulRedisConnectionImpl

public StatefulRedisConnectionImpl(RedisChannelWriter writer,
                                   PushHandler pushHandler,
                                   RedisCodec<K,V> codec,
                                   Duration timeout,
                                   Supplier<JsonParser> parser)

Initialize a new connection.

Parameters:

writer - the channel writer.

pushHandler - the handler for push notifications.

codec - Codec used to encode/decode keys and values.

timeout - Maximum time to wait for a response.

parser - the parser to use for JSON commands.

Method Detail

getCodec

public RedisCodec<K,V> getCodec()

Specified by:

getCodec in interface StatefulConnection<K,V>

Returns:

the RedisCodec used by this connection.

async

public RedisAsyncCommands<K,V> async()

Description copied from interface: StatefulRedisConnection

Returns the RedisAsyncCommands API for the current connection. Does not create a new connection.

Specified by:

async in interface StatefulRedisConnection<K,V>

Returns:

the asynchronous API for the underlying connection.

newRedisSyncCommandsImpl

protected RedisCommands<K,V> newRedisSyncCommandsImpl()

Create a new instance of RedisCommands. Can be overriden to extend.

Returns:

a new instance

newRedisAsyncCommandsImpl

protected RedisAsyncCommandsImpl<K,V> newRedisAsyncCommandsImpl()

Create a new instance of RedisAsyncCommandsImpl. Can be overriden to extend.

Returns:

a new instance

reactive

public RedisReactiveCommands<K,V> reactive()

Description copied from interface: StatefulRedisConnection

Returns the RedisReactiveCommands API for the current connection. Does not create a new connection.

Specified by:

reactive in interface StatefulRedisConnection<K,V>

Returns:

the reactive API for the underlying connection.

newRedisReactiveCommandsImpl

protected RedisReactiveCommandsImpl<K,V> newRedisReactiveCommandsImpl()

Create a new instance of RedisReactiveCommandsImpl. Can be overriden to extend.

Returns:

a new instance

sync

public RedisCommands<K,V> sync()

Description copied from interface: StatefulRedisConnection

Returns the RedisCommands API for the current connection. Does not create a new connection.

Specified by:

sync in interface StatefulRedisConnection<K,V>

Returns:

the synchronous API for the underlying connection.

addListener

public void addListener(PushListener listener)

Add a new listener.

Specified by:

addListener in interface StatefulRedisConnection<K,V>

Parameters:

listener - Listener.

removeListener

public void removeListener(PushListener listener)

Remove an existing listener.

Specified by:

removeListener in interface StatefulRedisConnection<K,V>

Parameters:

listener - Listener.

isMulti

public boolean isMulti()

Specified by:

isMulti in interface StatefulRedisConnection<K,V>

Returns:

true, if the connection is within a transaction.

dispatch

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

Description copied from interface: StatefulConnection

Dispatch a command. Write a command on the channel. The command may be changed/wrapped during write and the written instance is returned after the call. This command does not wait until the command completes and does not guarantee whether the command is executed successfully.

Specified by:

dispatch in interface StatefulConnection<K,V>

Overrides:

dispatch in class RedisChannelHandler<K,V>

Type Parameters:

T - result type

Parameters:

command - the Redis command.

Returns:

the written Redis command.

dispatch

public Collection<RedisCommand<K,V,?>> dispatch(Collection<? extends RedisCommand<K,V,?>> commands)

Description copied from interface: StatefulConnection

Dispatch multiple command in a single write on the channel. The commands may be changed/wrapped during write and the written instance is returned after the call. This command does not wait until the command completes and does not guarantee whether the command is executed successfully.

Specified by:

dispatch in interface StatefulConnection<K,V>

Overrides:

dispatch in class RedisChannelHandler<K,V>

Parameters:

commands - the Redis commands.

Returns:

the written Redis commands.

postProcessCommands

protected Collection<RedisCommand<K,V,?>> postProcessCommands(Collection<RedisCommand<K,V,?>> commands)

postProcessCommand

protected <T> RedisCommand<K,V,T> postProcessCommand(RedisCommand<K,V,T> command)

preProcessCommands

protected Collection<RedisCommand<K,V,?>> preProcessCommands(Collection<? extends RedisCommand<K,V,?>> commands)

preProcessCommand

protected <T> RedisCommand<K,V,T> preProcessCommand(RedisCommand<K,V,T> command)

setClientName

@Deprecated
public void setClientName(String clientName)

Deprecated. since 6.0, use RedisServerAsyncCommands.clientSetname(Object).

Parameters:

clientName -

getConnectionState

public ConnectionState getConnectionState()

activated

public void activated()

Description copied from class: RedisChannelHandler

Notification when the connection becomes active (connected).

Specified by:

activated in interface ConnectionFacade

Overrides:

activated in class RedisChannelHandler<K,V>

deactivated

public void deactivated()

Description copied from class: RedisChannelHandler

Notification when the connection becomes inactive (disconnected).

Specified by:

deactivated in interface ConnectionFacade

Overrides:

deactivated in class RedisChannelHandler<K,V>

setAuthenticationHandler

public void setAuthenticationHandler(RedisAuthenticationHandler<K,V> handler)