com.lambdaworks.redis.pubsub

Class RedisPubSubConnection<K,V>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

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

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

public class RedisPubSubConnection<K,V>
extends RedisAsyncConnection<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 RedisAsyncConnection.quit() may be called. Incoming messages and results of the subscribe(java.lang.String...)/unsubscribe(java.lang.String...) calls will be passed to all registered RedisPubSubListeners. A ConnectionWatchdog monitors each connection and reconnects automatically until RedisAsyncConnection.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

io.netty.channel.ChannelHandler.Sharable

Field Summary

Fields inherited from class com.lambdaworks.redis.RedisAsyncConnection

channel, codec, multi, queue, timeout, unit

Constructor Summary

Constructors

Constructor and Description
RedisPubSubConnection(RedisClient client, BlockingQueue<Command<K,V,?>> queue, RedisCodec<K,V> codec, long timeout, TimeUnit unit, io.netty.channel.EventLoopGroup eventLoopGroup) Initialize a new connection.

Method Summary

Methods

Modifier and Type	Method and Description
void	addListener(RedisPubSubListener<V> listener) Add a new listener.
void	channelActive(io.netty.channel.ChannelHandlerContext ctx)
void	channelRead(io.netty.channel.ChannelHandlerContext ctx, Object msg)
void	psubscribe(String... patterns)
io.netty.util.concurrent.Future<V>	punsubscribe(String... patterns)
void	removeListener(RedisPubSubListener<V> listener) Remove an existing listener.
void	subscribe(String... channels)
io.netty.util.concurrent.Future<V>	unsubscribe(String... channels)

Methods inherited from class com.lambdaworks.redis.RedisAsyncConnection

append, auth, await, awaitAll, awaitAll, awaitInterruptibly, bgrewriteaof, bgsave, bitcount, bitcount, bitopAnd, bitopNot, bitopOr, bitopXor, blpop, brpop, brpoplpush, channelInactive, clientGetname, clientKill, clientList, clientSetname, close, clusterNodes, configGet, configResetstat, configSet, dbsize, debugObject, decr, decrby, del, digest, discard, dispatch, dispatch, dispatch, dispatch, dispatch, dump, echo, eval, eval, evalR, evalsha, evalsha, exec, exists, expire, expireat, expireat, flushall, flushdb, get, getbit, getMasterAddrByKey, getrange, getRedisClient, getset, hdel, hexists, hget, hgetall, hincrby, hincrbyfloat, hkeys, hlen, hmget, hmset, hscan, hset, hsetnx, hvals, incr, incrby, incrbyfloat, info, info, isMultiMode, isReconnect, keys, lastsave, lindex, linsert, llen, lpop, lpush, lpushx, lrange, lrem, lset, ltrim, mget, migrate, move, mset, msetnx, multi, newScriptOutput, objectEncoding, objectIdletime, objectRefcount, persist, pexpire, pexpireat, pexpireat, pfadd, pfcount, pfmerge, ping, psetex, pttl, publish, quit, randomkey, rename, renamenx, restore, rpop, rpoplpush, rpush, rpushx, sadd, save, scard, scriptExists, scriptFlush, scriptKill, scriptLoad, sdiff, sdiffstore, select, set, setbit, setex, setexnx, setnx, setrange, setReconnect, setTimeout, shutdown, shutdown, sinter, sinterstore, sismember, slaveof, slaveofNoOne, slaves, slowlogGet, slowlogGet, slowlogLen, slowlogReset, smembers, smove, sort, sort, sortStore, spop, srandmember, srandmember, srem, sscan, string, strlen, sunion, sunionstore, sync, time, ttl, type, unwatch, watch, zadd, zadd, zcard, zcount, zcount, zincrby, zinterstore, zinterstore, zrange, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangeWithScores, zrank, zrem, zremrangebyrank, zremrangebyscore, zremrangebyscore, zrevrange, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangeWithScores, zrevrank, zscan, zscore, zunionstore, zunionstore

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelReadComplete, channelRegistered, 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 io.netty.channel.ChannelHandler

handlerAdded, handlerRemoved

Constructor Detail

RedisPubSubConnection

public RedisPubSubConnection(RedisClient client,
                     BlockingQueue<Command<K,V,?>> queue,
                     RedisCodec<K,V> codec,
                     long timeout,
                     TimeUnit unit,
                     io.netty.channel.EventLoopGroup eventLoopGroup)

Initialize a new connection.

Parameters:

queue - Command queue.

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

timeout - Maximum time to wait for a responses.

unit - Unit of time for the timeout.

eventLoopGroup -

Method Detail

addListener

public void addListener(RedisPubSubListener<V> listener)

Add a new listener.

Parameters:

listener - Listener.

removeListener

public void removeListener(RedisPubSubListener<V> listener)

Remove an existing listener.

Parameters:

listener - Listener.

psubscribe

public void psubscribe(String... patterns)

subscribe

public void subscribe(String... channels)

unsubscribe

public io.netty.util.concurrent.Future<V> unsubscribe(String... channels)

punsubscribe

public io.netty.util.concurrent.Future<V> punsubscribe(String... patterns)

channelActive

public void channelActive(io.netty.channel.ChannelHandlerContext ctx)
                   throws Exception

Specified by:

channelActive in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelActive in class RedisAsyncConnection<K,V>

Throws:

Exception

channelRead

public void channelRead(io.netty.channel.ChannelHandlerContext ctx,
               Object msg)
                 throws Exception

Specified by:

channelRead in interface io.netty.channel.ChannelInboundHandler

Overrides:

channelRead in class io.netty.channel.ChannelInboundHandlerAdapter

Throws:

Exception