Module lettuce.core

Package 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>

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	Description
void	addListener(RedisPubSubListener<K,V> listener)	Add a new listener.
RedisPubSubAsyncCommands<K,V>	async()	Returns the RedisPubSubAsyncCommands API for the current connection.
RedisPubSubReactiveCommands<K,V>	reactive()	Returns the RedisPubSubReactiveCommands API for the current connection.
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.StatefulConnection

close, closeAsync, dispatch, dispatch, flushCommands, getOptions, getResources, getTimeout, isOpen, reset, setAutoFlushCommands, setTimeout

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

addListener, isMulti, removeListener

Method Details

sync

RedisPubSubCommands<K,V> sync()

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

async

RedisPubSubAsyncCommands<K,V> async()

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

reactive

RedisPubSubReactiveCommands<K,V> reactive()

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.