| Package | Description |
|---|---|
| io.lettuce.core |
The Redis client package containing
RedisClient for Redis Standalone and Redis Sentinel operations. |
| io.lettuce.core.api |
Standalone Redis connection API.
|
| io.lettuce.core.cluster |
Client for Redis Cluster, see
RedisClusterClient. |
| io.lettuce.core.cluster.pubsub |
Redis Cluster Pub/Sub support.
|
| io.lettuce.core.failover.api | |
| io.lettuce.core.pubsub |
Pub/Sub connection classes.
|
| io.lettuce.core.pubsub.api.async |
Pub/Sub Redis API for asynchronous executed commands.
|
| io.lettuce.core.pubsub.api.reactive |
Pub/Sub Redis API for reactive command execution.
|
| io.lettuce.core.pubsub.api.sync |
Pub/Sub Redis API for synchronous executed commands.
|
| Modifier and Type | Method and Description |
|---|---|
StatefulRedisPubSubConnection<String,String> |
RedisClient.connectPubSub()
Open a new pub/sub connection to a Redis server that treats keys and values as UTF-8 strings.
|
<K,V> StatefulRedisPubSubConnection<K,V> |
RedisClient.connectPubSub(RedisCodec<K,V> codec)
|
<K,V> StatefulRedisPubSubConnection<K,V> |
RedisClient.connectPubSub(RedisCodec<K,V> codec,
RedisURI redisURI)
|
StatefulRedisPubSubConnection<String,String> |
RedisClient.connectPubSub(RedisURI redisURI)
Open a new pub/sub connection to a Redis server using the supplied
RedisURI that treats keys and values as UTF-8
strings. |
| Modifier and Type | Method and Description |
|---|---|
<K,V> ConnectionFuture<StatefulRedisPubSubConnection<K,V>> |
RedisClient.connectPubSubAsync(RedisCodec<K,V> codec,
RedisURI redisURI)
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
PubSubCommandsFactory<C extends StatefulRedisPubSubConnection<?,?>,T>
A
CommandsFactory that creates a command API bound to a Pub/Sub connection, for
use with commands(PubSubCommandsFactory). |
| Modifier and Type | Method and Description |
|---|---|
static <C extends StatefulRedisPubSubConnection<?,?>,T> |
PubSubCommandsFactory.of(Object key,
Function<C,T> builder)
Creates a
PubSubCommandsFactory from a cache key and a builder. |
| Constructor and Description |
|---|
RedisClusterPubSubAsyncCommandsImpl(StatefulRedisPubSubConnection<K,V> connection,
RedisCodec<K,V> codec)
Initialize a new connection.
|
RedisClusterPubSubReactiveCommandsImpl(StatefulRedisPubSubConnection<K,V> connection,
RedisCodec<K,V> codec)
Initialize a new connection.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
StatefulRedisClusterPubSubConnection<K,V>
A stateful Pub/Sub connection for Redis Cluster use.
|
| Modifier and Type | Method and Description |
|---|---|
StatefulRedisPubSubConnection<K,V> |
StatefulRedisClusterPubSubConnection.getConnection(String nodeId)
Retrieve a connection to the specified cluster node using the nodeId.
|
StatefulRedisPubSubConnection<K,V> |
StatefulRedisClusterPubSubConnection.getConnection(String host,
int port)
Retrieve a connection to the specified cluster node using host and port.
|
| Modifier and Type | Method and Description |
|---|---|
CompletableFuture<StatefulRedisPubSubConnection<K,V>> |
StatefulRedisClusterPubSubConnection.getConnectionAsync(String nodeId)
Retrieve asynchronously a connection to the specified cluster node using the nodeId.
|
CompletableFuture<StatefulRedisPubSubConnection<K,V>> |
StatefulRedisClusterPubSubConnection.getConnectionAsync(String host,
int port)
Retrieve a connection to the specified cluster node using host and port.
|
| Modifier and Type | Interface and Description |
|---|---|
interface |
StatefulRedisMultiDbPubSubConnection<K,V>
Stateful multi-database Redis PubSub connection that supports failover between multiple endpoints.
|
| Modifier and Type | Class and Description |
|---|---|
class |
StatefulRedisPubSubConnectionImpl<K,V>
An thread-safe pub/sub connection to a Redis server.
|
| Modifier and Type | Method and Description |
|---|---|
StatefulRedisPubSubConnection<K,V> |
RedisPubSubAsyncCommandsImpl.getStatefulConnection() |
StatefulRedisPubSubConnection<K,V> |
RedisPubSubReactiveCommandsImpl.getStatefulConnection() |
| Modifier and Type | Method and Description |
|---|---|
<T> T |
StatefulRedisPubSubConnectionImpl.commands(PubSubCommandsFactory<StatefulRedisPubSubConnection<K,V>,T> factory) |
default <T> T |
StatefulRedisPubSubConnection.commands(PubSubCommandsFactory<StatefulRedisPubSubConnection<K,V>,T> factory)
Returns the command API created by
factory, bound to this connection. |
| Constructor and Description |
|---|
RedisPubSubAsyncCommandsImpl(StatefulRedisPubSubConnection<K,V> connection,
RedisCodec<K,V> codec)
Initialize a new connection.
|
RedisPubSubReactiveCommandsImpl(StatefulRedisPubSubConnection<K,V> connection,
RedisCodec<K,V> codec)
Initialize a new connection.
|
| Modifier and Type | Method and Description |
|---|---|
StatefulRedisPubSubConnection<K,V> |
RedisPubSubAsyncCommands.getStatefulConnection() |
| Modifier and Type | Method and Description |
|---|---|
StatefulRedisPubSubConnection<K,V> |
RedisPubSubReactiveCommands.getStatefulConnection()
Deprecated.
since 6.2, there is no replacement — the underlying connection is not meant to be reached through the command
interfaces; scheduled for removal in a future major release.
|
| Modifier and Type | Method and Description |
|---|---|
static <K,V> PubSubCommandsFactory<StatefulRedisPubSubConnection<K,V>,RedisPubSubReactiveCommands<K,V>> |
RedisPubSubReactiveCommands.factory()
Returns the
PubSubCommandsFactory that creates RedisPubSubReactiveCommands, for use with
commands(PubSubCommandsFactory):
{
@code
RedisPubSubReactiveCommands |
| Modifier and Type | Method and Description |
|---|---|
StatefulRedisPubSubConnection<K,V> |
RedisPubSubCommands.getStatefulConnection() |
Copyright © 2026 lettuce.io. All rights reserved.