io.lettuce.core.pubsub

Interface StatefulRedisPubSubConnection<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Superinterfaces:

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

All Known Subinterfaces:

StatefulRedisClusterPubSubConnection<K,V>, StatefulRedisMultiDbPubSubConnection<K,V>

All Known Implementing Classes:

StatefulRedisPubSubConnectionImpl

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

An asynchronous thread-safe pub/sub connection to a redis server. After one or more channels are subscribed to only pub/sub related commands or QUIT may be called. Incoming messages and results of the subscribe/unsubscribe calls will be passed to all registered RedisPubSubListeners. A ConnectionWatchdog monitors each connection and reconnects automatically until StatefulConnection.close() is called. Channel and pattern subscriptions are renewed after reconnecting.

Since:

4.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
void	addListener(RedisPubSubListener<K,V> listener) Add a new listener.
RedisPubSubAsyncCommands<K,V>	async() Returns the RedisPubSubAsyncCommands API for the current connection.
default <T> T	commands(PubSubCommandsFactory<StatefulRedisPubSubConnection<K,V>,T> factory) Returns the command API created by factory, bound to this connection.
RedisPubSubReactiveCommands<K,V>	reactive() Deprecated. since 7.8, use commands(PubSubCommandsFactory) with RedisPubSubReactiveCommands.factory() instead; scheduled for removal in a future major release.
void	removeListener(RedisPubSubListener<K,V> listener) Remove an existing listener.
RedisPubSubCommands<K,V>	sync() Returns the RedisPubSubCommands API for the current connection.

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

addListener, commands, isMulti, removeListener

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

sync

RedisPubSubCommands<K,V> sync()

Returns the RedisPubSubCommands 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.

Specified by:

sync in interface StatefulRedisConnection<K,V>

Returns:

the synchronous API for the underlying connection.

async

RedisPubSubAsyncCommands<K,V> async()

Returns the RedisPubSubAsyncCommands 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.

Specified by:

async in interface StatefulRedisConnection<K,V>

Returns:

the asynchronous API for the underlying connection.

reactive

@Deprecated
RedisPubSubReactiveCommands<K,V> reactive()

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

Returns the RedisPubSubReactiveCommands 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.

addListener

void addListener(RedisPubSubListener<K,V> listener)

Add a new listener.

Parameters:

listener - the listener, must not be null.

removeListener

void removeListener(RedisPubSubListener<K,V> listener)

Remove an existing listener.

Parameters:

listener - the listener, must not be null.

commands

default <T> T commands(PubSubCommandsFactory<StatefulRedisPubSubConnection<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