com.lambdaworks.redis.pubsub

Class StatefulRedisPubSubConnectionImpl<K,V>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

com.lambdaworks.redis.RedisChannelHandler<K,V>

com.lambdaworks.redis.StatefulRedisConnectionImpl<K,V>

com.lambdaworks.redis.pubsub.StatefulRedisPubSubConnectionImpl<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Implemented Interfaces:

StatefulConnection<K,V>, StatefulRedisConnection<K,V>, StatefulRedisPubSubConnection<K,V>, ChannelHandler, ChannelInboundHandler, Closeable, AutoCloseable

@ChannelHandler.Sharable
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

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
protected Set<K>	channels
protected List<RedisPubSubListener<K,V>>	listeners
protected Set<K>	patterns

Fields inherited from class com.lambdaworks.redis.StatefulRedisConnectionImpl

async, codec, multi, reactive, sync

Fields inherited from class com.lambdaworks.redis.RedisChannelHandler

timeout, unit

Constructor Summary

Constructors

Constructor and Description
StatefulRedisPubSubConnectionImpl(RedisChannelWriter<K,V> writer, RedisCodec<K,V> codec, long timeout, TimeUnit unit) Initialize a new connection.

Method Summary

Modifier and Type	Method and 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.
void	channelRead(Object msg) Invoked on a channel read.
<T,C extends RedisCommand<K,V,T>> C	dispatch(C command) Dispatch a command.
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.
protected void	notifyListeners(PubSubOutput<K,V,V> output)
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 com.lambdaworks.redis.StatefulRedisConnectionImpl

isMulti, setClientName

Methods inherited from class com.lambdaworks.redis.RedisChannelHandler

addListener, channelRead, channelRegistered, close, deactivated, flushCommands, getChannelWriter, getOptions, getTimeout, getTimeoutUnit, isClosed, isOpen, registerCloseables, reset, setAutoFlushCommands, setOptions, setTimeout, syncHandler

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelReadComplete, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.lambdaworks.redis.api.StatefulRedisConnection

isMulti

Methods inherited from interface com.lambdaworks.redis.api.StatefulConnection

close, flushCommands, getOptions, getTimeout, getTimeoutUnit, isOpen, reset, setAutoFlushCommands, setTimeout

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Field Detail

listeners

protected final List<RedisPubSubListener<K,V>> listeners

channels

protected final Set<K> channels

patterns

protected final Set<K> patterns

Constructor Detail

StatefulRedisPubSubConnectionImpl

public StatefulRedisPubSubConnectionImpl(RedisChannelWriter<K,V> writer,
                                         RedisCodec<K,V> codec,
                                         long timeout,
                                         TimeUnit unit)

Initialize a new connection.

Parameters:

writer - the channel writer

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

timeout - Maximum time to wait for a response.

unit - Unit of time for the timeout.

Method Detail

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

channelRead

public void channelRead(Object msg)

Description copied from class: RedisChannelHandler

Invoked on a channel read.

Overrides:

channelRead in class RedisChannelHandler<K,V>

Parameters:

msg - channel message

activated

public void activated()

Description copied from class: RedisChannelHandler

Notification when the connection becomes active (connected).

Overrides:

activated in class StatefulRedisConnectionImpl<K,V>

dispatch

public <T,C extends RedisCommand<K,V,T>> C dispatch(C command)

Description copied from interface: StatefulConnection

Dispatch a command. Write a command on the channel. The command may be changed/wrapped during write and the written instance is returned after the call. This command does not wait until the command completes and does not guarantee whether the command is executed successfully.

Specified by:

dispatch in interface StatefulConnection<K,V>

Overrides:

dispatch in class StatefulRedisConnectionImpl<K,V>

Type Parameters:

T - result type

C - command type

Parameters:

command - the Redis command

Returns:

the written redis command

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.

notifyListeners

protected void notifyListeners(PubSubOutput<K,V,V> output)