com.lambdaworks.redis.pubsub

Class RedisPubSubConnectionImpl<K,V>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

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

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

Type Parameters:

K - Key type.

V - Value type.

All Implemented Interfaces:

BaseRedisAsyncConnection<K,V>, RedisPubSubConnection<K,V>, RedisAsyncConnection<K,V>, RedisClusterAsyncConnection<K,V>, RedisGeoAsyncConnection<K,V>, RedisHashesAsyncConnection<K,V>, RedisHLLAsyncConnection<K,V>, RedisKeysAsyncConnection<K,V>, RedisListsAsyncConnection<K,V>, RedisScriptingAsyncConnection<K,V>, RedisServerAsyncConnection<K,V>, RedisSetsAsyncConnection<K,V>, RedisSortedSetsAsyncConnection<K,V>, RedisStringsAsyncConnection<K,V>, ChannelHandler, ChannelInboundHandler, Closeable, AutoCloseable

public class RedisPubSubConnectionImpl<K,V>
extends RedisAsyncConnectionImpl<K,V>
implements RedisPubSubConnection<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 RedisAsyncConnectionImpl.quit() may be called. Incoming messages and results of the subscribe(K...)/unsubscribe(K...) calls will be passed to all registered RedisPubSubListeners. A ConnectionWatchdog monitors each connection and reconnects automatically until RedisChannelHandler.close() is called. Channel and pattern subscriptions are renewed after reconnecting.

Author:

Will Glozer

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.RedisAsyncConnectionImpl

codec, commandBuilder, multi

Fields inherited from class com.lambdaworks.redis.RedisChannelHandler

timeout, unit

Constructor Summary

Constructors

Constructor and Description
RedisPubSubConnectionImpl(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.
void	channelRead(Object msg) Invoked on a channel read.
RedisFuture<Void>	psubscribe(K... patterns) Listen for messages published to channels matching the given patterns.
RedisFuture<Void>	punsubscribe(K... patterns) Stop listening for messages posted to channels matching the given patterns.
void	removeListener(RedisPubSubListener<K,V> listener) Remove an existing listener.
protected List<RedisFuture<Void>>	resubscribe() Re-subscribe to all previously subscribed channels and patterns.
RedisFuture<Void>	subscribe(K... channels) Listen for messages published to the given channels.
RedisFuture<Void>	unsubscribe(K... channels) Stop listening for messages posted to the given channels.

Methods inherited from class com.lambdaworks.redis.RedisAsyncConnectionImpl

append, asking, auth, bgrewriteaof, bgsave, bitcount, bitcount, bitopAnd, bitopNot, bitopOr, bitopXor, bitpos, bitpos, blpop, brpop, brpoplpush, clientGetname, clientKill, clientKill, clientList, clientPause, clientSetname, clusterAddSlots, clusterCountFailureReports, clusterCountKeysInSlot, clusterDelSlots, clusterFailover, clusterFlushslots, clusterForget, clusterGetKeysInSlot, clusterInfo, clusterKeyslot, clusterMeet, clusterMyId, clusterNodes, clusterReplicate, clusterReset, clusterSaveconfig, clusterSetConfigEpoch, clusterSetSlotImporting, clusterSetSlotMigrating, clusterSetSlotNode, clusterSetSlotStable, clusterSlaves, clusterSlots, command, commandCount, commandInfo, commandInfo, configGet, configResetstat, configRewrite, configSet, dbsize, debugHtstats, debugObject, debugOom, debugSegfault, decr, decrby, del, digest, discard, dispatch, dispatch, dispatch, dump, echo, eval, eval, evalsha, evalsha, exec, exists, exists, expire, expireat, expireat, flushall, flushallAsync, flushdb, flushdbAsync, geoadd, geoadd, geodist, geopos, georadius, georadius, georadiusbymember, georadiusbymember, get, getbit, getrange, getset, hdel, hexists, hget, hgetall, hgetall, hincrby, hincrbyfloat, hkeys, hkeys, hlen, hmget, hmget, hmset, hscan, hscan, hscan, hscan, hscan, hscan, hscan, hscan, hset, hsetnx, hstrlen, hvals, hvals, incr, incrby, incrbyfloat, info, info, isMulti, keys, keys, lastsave, lindex, linsert, llen, lpop, lpush, lpushx, lrange, lrange, lrem, lset, ltrim, mget, mget, migrate, move, mset, msetnx, multi, objectEncoding, objectIdletime, objectRefcount, persist, pexpire, pexpireat, pexpireat, pfadd, pfcount, pfmerge, ping, psetex, pttl, publish, pubsubChannels, pubsubChannels, pubsubNumpat, pubsubNumsub, quit, randomkey, readOnly, readWrite, rename, renamenx, restore, role, rpop, rpoplpush, rpush, rpushx, sadd, save, scan, scan, scan, scan, scan, scan, scan, scan, scard, scriptExists, scriptFlush, scriptKill, scriptLoad, sdiff, sdiff, sdiffstore, select, set, set, setbit, setex, setnx, setrange, shutdown, shutdown, sinter, sinter, sinterstore, sismember, slaveof, slaveofNoOne, slowlogGet, slowlogGet, slowlogLen, slowlogReset, smembers, smembers, smove, sort, sort, sort, sort, sortStore, spop, srandmember, srandmember, srandmember, srem, sscan, sscan, sscan, sscan, sscan, sscan, sscan, sscan, string, strlen, sunion, sunion, sunionstore, sync, time, ttl, type, unlink, unwatch, waitForReplication, watch, zadd, zadd, zadd, zadd, zaddincr, zcard, zcount, zcount, zincrby, zinterstore, zinterstore, zlexcount, zrange, zrange, zrangebylex, zrangebylex, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangeWithScores, zrangeWithScores, zrank, zrem, zremrangebylex, zremrangebyrank, zremrangebyscore, zremrangebyscore, zrevrange, zrevrange, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangeWithScores, zrevrangeWithScores, zrevrank, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscore, zunionstore, zunionstore

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

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

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

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

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.RedisAsyncConnection

auth, select, setTimeout

Methods inherited from interface com.lambdaworks.redis.RedisClusterAsyncConnection

asking, close, clusterAddSlots, clusterCountFailureReports, clusterCountKeysInSlot, clusterDelSlots, clusterFailover, clusterFlushslots, clusterForget, clusterGetKeysInSlot, clusterInfo, clusterKeyslot, clusterMeet, clusterMyId, clusterNodes, clusterReplicate, clusterReset, clusterSaveconfig, clusterSetConfigEpoch, clusterSetSlotImporting, clusterSetSlotMigrating, clusterSetSlotNode, clusterSetSlotStable, clusterSlaves, clusterSlots, readOnly, readWrite

Methods inherited from interface com.lambdaworks.redis.RedisHashesAsyncConnection

hdel, hexists, hget, hgetall, hgetall, hincrby, hincrbyfloat, hkeys, hkeys, hlen, hmget, hmget, hmset, hscan, hscan, hscan, hscan, hscan, hscan, hscan, hscan, hset, hsetnx, hstrlen, hvals, hvals

Methods inherited from interface com.lambdaworks.redis.RedisKeysAsyncConnection

del, dump, exists, exists, expire, expireat, expireat, keys, keys, migrate, move, objectEncoding, objectIdletime, objectRefcount, persist, pexpire, pexpireat, pexpireat, pttl, randomkey, rename, renamenx, restore, scan, scan, scan, scan, scan, scan, scan, scan, sort, sort, sort, sort, sortStore, ttl, type, unlink

Methods inherited from interface com.lambdaworks.redis.RedisStringsAsyncConnection

append, bitcount, bitcount, bitopAnd, bitopNot, bitopOr, bitopXor, bitpos, bitpos, decr, decrby, get, getbit, getrange, getset, incr, incrby, incrbyfloat, mget, mget, mset, msetnx, psetex, set, set, setbit, setex, setnx, setrange, strlen

Methods inherited from interface com.lambdaworks.redis.RedisListsAsyncConnection

blpop, brpop, brpoplpush, lindex, linsert, llen, lpop, lpush, lpushx, lrange, lrange, lrem, lset, ltrim, rpop, rpoplpush, rpush, rpushx

Methods inherited from interface com.lambdaworks.redis.RedisSetsAsyncConnection

sadd, scard, sdiff, sdiff, sdiffstore, sinter, sinter, sinterstore, sismember, smembers, smembers, smove, spop, srandmember, srandmember, srandmember, srem, sscan, sscan, sscan, sscan, sscan, sscan, sscan, sscan, sunion, sunion, sunionstore

Methods inherited from interface com.lambdaworks.redis.RedisSortedSetsAsyncConnection

zadd, zadd, zadd, zadd, zaddincr, zcard, zcount, zcount, zincrby, zinterstore, zinterstore, zlexcount, zrange, zrange, zrangebylex, zrangebylex, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangeWithScores, zrangeWithScores, zrank, zrem, zremrangebylex, zremrangebyrank, zremrangebyscore, zremrangebyscore, zrevrange, zrevrange, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangeWithScores, zrevrangeWithScores, zrevrank, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscore, zunionstore, zunionstore

Methods inherited from interface com.lambdaworks.redis.RedisScriptingAsyncConnection

eval, eval, evalsha, evalsha, scriptExists, scriptFlush, scriptKill, scriptLoad

Methods inherited from interface com.lambdaworks.redis.RedisServerAsyncConnection

bgrewriteaof, bgsave, clientGetname, clientKill, clientKill, clientList, clientPause, clientSetname, command, commandCount, commandInfo, commandInfo, configGet, configResetstat, configRewrite, configSet, dbsize, debugHtstats, debugObject, debugOom, debugSegfault, flushall, flushallAsync, flushdb, flushdbAsync, info, info, lastsave, save, shutdown, slaveof, slaveofNoOne, slowlogGet, slowlogGet, slowlogLen, slowlogReset, sync, time

Methods inherited from interface com.lambdaworks.redis.RedisHLLAsyncConnection

pfadd, pfcount, pfmerge

Methods inherited from interface com.lambdaworks.redis.RedisGeoAsyncConnection

geoadd, geoadd, geodist, geopos, georadius, georadius, georadiusbymember, georadiusbymember

Methods inherited from interface com.lambdaworks.redis.BaseRedisAsyncConnection

digest, discard, echo, exec, flushCommands, isOpen, multi, ping, publish, pubsubChannels, pubsubChannels, pubsubNumpat, pubsubNumsub, quit, role, setAutoFlushCommands, unwatch, waitForReplication, watch

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

RedisPubSubConnectionImpl

public RedisPubSubConnectionImpl(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 responses.

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 RedisPubSubConnection<K,V>

Parameters:

listener - Listener.

removeListener

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

Remove an existing listener.

Specified by:

removeListener in interface RedisPubSubConnection<K,V>

Parameters:

listener - Listener.

psubscribe

public RedisFuture<Void> psubscribe(K... patterns)

Description copied from interface: RedisPubSubConnection

Listen for messages published to channels matching the given patterns.

Specified by:

psubscribe in interface RedisPubSubConnection<K,V>

Parameters:

patterns - the patterns

Returns:

RedisFuture<Void> Future to synchronize psubscribe completion

punsubscribe

public RedisFuture<Void> punsubscribe(K... patterns)

Description copied from interface: RedisPubSubConnection

Stop listening for messages posted to channels matching the given patterns.

Specified by:

punsubscribe in interface RedisPubSubConnection<K,V>

Parameters:

patterns - the patterns

Returns:

RedisFuture<Void> Future to synchronize punsubscribe completion

subscribe

public RedisFuture<Void> subscribe(K... channels)

Description copied from interface: RedisPubSubConnection

Listen for messages published to the given channels.

Specified by:

subscribe in interface RedisPubSubConnection<K,V>

Parameters:

channels - the channels

Returns:

RedisFuture<Void> Future to synchronize subscribe completion

unsubscribe

public RedisFuture<Void> unsubscribe(K... channels)

Description copied from interface: RedisPubSubConnection

Stop listening for messages posted to the given channels.

Specified by:

unsubscribe in interface RedisPubSubConnection<K,V>

Parameters:

channels - the channels

Returns:

RedisFuture<Void> Future to synchronize unsubscribe completion.

activated

public void activated()

Description copied from class: RedisChannelHandler

Notification when the connection becomes active (connected).

Overrides:

activated in class RedisAsyncConnectionImpl<K,V>

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.

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