io.lettuce.core.api

Interface StatefulRedisConnection<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Superinterfaces:

AsyncCloseable, AutoCloseable, StatefulConnection<K,V>

All Known Subinterfaces:

StatefulRedisClusterPubSubConnection<K,V>, StatefulRedisMasterReplicaConnection<K,V>, StatefulRedisMasterSlaveConnection<K,V>, StatefulRedisMultiDbConnection<K,V>, StatefulRedisMultiDbPubSubConnection<K,V>, StatefulRedisPubSubConnection<K,V>

All Known Implementing Classes:

StatefulRedisConnectionImpl, StatefulRedisPubSubConnectionImpl

public interface StatefulRedisConnection<K,V>
extends StatefulConnection<K,V>

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

Since:

4.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
void	addListener(PushListener listener) Add a new listener to consume push messages.
RedisAsyncCommands<K,V>	async() Returns the RedisAsyncCommands API for the current connection.
default <T> T	commands(CommandsFactory<StatefulRedisConnection<K,V>,T> factory) Returns the command API created by factory, bound to this connection.
boolean	isMulti()
RedisReactiveCommands<K,V>	reactive() Deprecated. since 7.8, use commands(CommandsFactory) with RedisReactiveCommands.factory() instead; scheduled for removal in a future major release.
void	removeListener(PushListener listener) Remove an existing listener.
RedisCommands<K,V>	sync() Returns the RedisCommands API for the current connection.

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

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

Method Detail

isMulti

boolean isMulti()

Returns:

true, if the connection is within a transaction.

sync

RedisCommands<K,V> sync()

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

Note: this accessor is scheduled for removal in a future major release; a commands(...)-based replacement is planned.

Returns:

the synchronous API for the underlying connection.

async

RedisAsyncCommands<K,V> async()

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

Note: this accessor is scheduled for removal in a future major release; a commands(...)-based replacement is planned.

Returns:

the asynchronous API for the underlying connection.

reactive

@Deprecated
RedisReactiveCommands<K,V> reactive()

Deprecated. since 7.8, use commands(CommandsFactory) with RedisReactiveCommands.factory() instead; scheduled for removal in a future major release.

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

Returns:

the reactive API for the underlying connection.

addListener

void addListener(PushListener listener)

Add a new listener to consume push messages.

Parameters:

listener - the listener, must not be null.

Since:

6.0

removeListener

void removeListener(PushListener listener)

Remove an existing listener.

Parameters:

listener - the listener, must not be null.

Since:

6.0

commands

default <T> T commands(CommandsFactory<StatefulRedisConnection<K,V>,T> factory)

Returns the command API created by factory, bound to this connection. Does not create a new connection.

The command API is created once per connection and cached; calling this method again with the same factory returns the same instance.

Type Parameters:

T - the command API type

Parameters:

factory - the command API factory, must not be null

Returns:

the command API bound to this connection

Throws:

UnsupportedOperationException - if the connection implementation does not override this method. The default is provided only for source compatibility in Lettuce 7.x and becomes an abstract method in Lettuce 8.0.

Since:

7.8