Module lettuce.core

Package io.lettuce.core.pubsub

Class StatefulRedisPubSubConnectionImpl<K,V>

java.lang.Object

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

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

io.lettuce.core.pubsub.StatefulRedisPubSubConnectionImpl<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Implemented Interfaces:

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

public class StatefulRedisPubSubConnectionImpl<K,V>
extends StatefulRedisConnectionImpl<K,V>
implements StatefulRedisPubSubConnection<K,V>

An thread-safe pub/sub connection to a Redis server. Multiple threads may share one StatefulRedisPubSubConnectionImpl 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 inherited from class io.lettuce.core.StatefulRedisConnectionImpl

async, codec, multi, reactive, sync

Constructor Summary

Constructors

Constructor	Description
StatefulRedisPubSubConnectionImpl(PubSubEndpoint<K,V> endpoint, RedisChannelWriter writer, RedisCodec<K,V> codec, Duration timeout)	Initialize a new connection.

Method Summary

Modifier and Type	Method	Description
void	activated()	Notification when the connection becomes active (connected).
void	addListener(RedisPubSubListener<K,V> listener)	Add a new listener.
RedisPubSubAsyncCommands<K,V>	async()	Returns the RedisAsyncCommands API for the current connection.
protected RedisPubSubAsyncCommandsImpl<K,V>	newRedisAsyncCommandsImpl()	Create a new instance of RedisAsyncCommandsImpl.
protected RedisPubSubReactiveCommandsImpl<K,V>	newRedisReactiveCommandsImpl()	Create a new instance of RedisReactiveCommandsImpl.
protected RedisPubSubCommands<K,V>	newRedisSyncCommandsImpl()	Create a new instance of RedisCommands.
RedisPubSubReactiveCommands<K,V>	reactive()	Returns the RedisReactiveCommands API for the current connection.
void	removeListener(RedisPubSubListener<K,V> listener)	Remove an existing listener.
protected List<RedisFuture<Void>>	resubscribe()	Re-subscribe to all previously subscribed channels and patterns.
RedisPubSubCommands<K,V>	sync()	Returns the RedisCommands API for the current connection.

Methods inherited from class io.lettuce.core.StatefulRedisConnectionImpl

addListener, dispatch, dispatch, getCodec, getConnectionState, isMulti, preProcessCommand, removeListener, setClientName

Methods inherited from class io.lettuce.core.RedisChannelHandler

addListener, close, closeAsync, deactivated, flushCommands, getChannelWriter, getOptions, getResources, getTimeout, isClosed, isOpen, registerCloseables, reset, 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

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

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

addListener, isMulti, removeListener

Constructor Details

StatefulRedisPubSubConnectionImpl

public StatefulRedisPubSubConnectionImpl(PubSubEndpoint<K,V> endpoint,
RedisChannelWriter writer,
RedisCodec<K,V> codec,
Duration timeout)

Initialize a new connection.

Parameters:

endpoint - the PubSubEndpoint

writer - the writer used to write commands

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

timeout - Maximum time to wait for a response.

Method Details

addListener

public void addListener(RedisPubSubListener<K,V> listener)

Add a new listener.

Specified by:

addListener in interface StatefulRedisPubSubConnection<K,V>

Parameters:

listener - Listener.

removeListener

public void removeListener(RedisPubSubListener<K,V> listener)

Remove an existing listener.

Specified by:

removeListener in interface StatefulRedisPubSubConnection<K,V>

Parameters:

listener - Listener.

async

public RedisPubSubAsyncCommands<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>

Specified by:

async in interface StatefulRedisPubSubConnection<K,V>

Overrides:

async in class StatefulRedisConnectionImpl<K,V>

Returns:

the asynchronous API for the underlying connection.

newRedisAsyncCommandsImpl

protected RedisPubSubAsyncCommandsImpl<K,V> newRedisAsyncCommandsImpl()

Description copied from class: StatefulRedisConnectionImpl

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

Overrides:

newRedisAsyncCommandsImpl in class StatefulRedisConnectionImpl<K,V>

Returns:

a new instance

sync

public RedisPubSubCommands<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>

Specified by:

sync in interface StatefulRedisPubSubConnection<K,V>

Overrides:

sync in class StatefulRedisConnectionImpl<K,V>

Returns:

the synchronous API for the underlying connection.

newRedisSyncCommandsImpl

protected RedisPubSubCommands<K,V> newRedisSyncCommandsImpl()

Description copied from class: StatefulRedisConnectionImpl

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

Overrides:

newRedisSyncCommandsImpl in class StatefulRedisConnectionImpl<K,V>

Returns:

a new instance

reactive

public RedisPubSubReactiveCommands<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>

Specified by:

reactive in interface StatefulRedisPubSubConnection<K,V>

Overrides:

reactive in class StatefulRedisConnectionImpl<K,V>

Returns:

the reactive API for the underlying connection.

newRedisReactiveCommandsImpl

protected RedisPubSubReactiveCommandsImpl<K,V> newRedisReactiveCommandsImpl()

Description copied from class: StatefulRedisConnectionImpl

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

Overrides:

newRedisReactiveCommandsImpl in class StatefulRedisConnectionImpl<K,V>

Returns:

a new instance

resubscribe

protected List<RedisFuture<Void>> resubscribe()

Re-subscribe to all previously subscribed channels and patterns.

Returns:

list of the futures of the subscribe and psubscribe commands.

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>