com.lambdaworks.redis.pubsub.api.sync

Interface RedisPubSubCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Superinterfaces:

AutoCloseable, BaseRedisCommands<K,V>, BaseRedisConnection<K,V>, Closeable, RedisClusterCommands<K,V>, RedisClusterConnection<K,V>, RedisCommands<K,V>, RedisConnection<K,V>, RedisGeoCommands<K,V>, RedisGeoConnection<K,V>, RedisHashCommands<K,V>, RedisHashesConnection<K,V>, RedisHLLCommands<K,V>, RedisHLLConnection<K,V>, RedisKeyCommands<K,V>, RedisKeysConnection<K,V>, RedisListCommands<K,V>, RedisListsConnection<K,V>, RedisScriptingCommands<K,V>, RedisScriptingConnection<K,V>, RedisServerCommands<K,V>, RedisServerConnection<K,V>, RedisSetCommands<K,V>, RedisSetsConnection<K,V>, RedisSortedSetCommands<K,V>, RedisSortedSetsConnection<K,V>, RedisStringCommands<K,V>, RedisStringsConnection<K,V>, RedisTransactionalCommands<K,V>

All Known Subinterfaces:

RedisClusterPubSubCommands<K,V>

public interface RedisPubSubCommands<K,V>
extends RedisCommands<K,V>

Synchronous and thread-safe Redis PubSub API.

Since:

4.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
void	addListener(RedisPubSubListener<K,V> listener) Deprecated. Use getStatefulConnection() and StatefulRedisPubSubConnection.addListener(RedisPubSubListener).
StatefulRedisPubSubConnection<K,V>	getStatefulConnection()
void	psubscribe(K... patterns) Listen for messages published to channels matching the given patterns.
void	punsubscribe(K... patterns) Stop listening for messages posted to channels matching the given patterns.
void	removeListener(RedisPubSubListener<K,V> listener) Deprecated. Use getStatefulConnection() and StatefulRedisPubSubConnection.removeListener(RedisPubSubListener).
void	subscribe(K... channels) Listen for messages published to the given channels.
void	unsubscribe(K... channels) Stop listening for messages posted to the given channels.

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisCommands

auth, select, setTimeout, swapdb

Methods inherited from interface com.lambdaworks.redis.cluster.api.sync.RedisClusterCommands

asking, close, clusterAddSlots, clusterBumpepoch, 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.api.sync.RedisHashCommands

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.api.sync.RedisKeyCommands

del, dump, exists, expire, expireat, expireat, keys, keys, migrate, 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, touch, ttl, type, unlink

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisStringCommands

append, bitcount, bitcount, bitfield, bitopAnd, bitopNot, bitopOr, bitopXor, bitpos, 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.api.sync.RedisListCommands

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

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisSetCommands

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

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisSortedSetCommands

zadd, zadd, zadd, zadd, zadd, zadd, zaddincr, zaddincr, zcard, zcount, zcount, zcount, zincrby, zinterstore, zinterstore, zlexcount, zlexcount, zrange, zrange, zrangebylex, zrangebylex, zrangebylex, zrangebylex, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscore, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangebyscoreWithScores, zrangeWithScores, zrangeWithScores, zrank, zrem, zremrangebylex, zremrangebylex, zremrangebyrank, zremrangebyscore, zremrangebyscore, zremrangebyscore, zrevrange, zrevrange, zrevrangebylex, zrevrangebylex, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscore, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, zrevrangebyscoreWithScores, 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.api.sync.RedisScriptingCommands

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

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisHLLCommands

pfadd, pfcount, pfmerge

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisGeoCommands

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

Methods inherited from interface com.lambdaworks.redis.api.sync.BaseRedisCommands

dispatch, dispatch, echo, isOpen, ping, publish, pubsubChannels, pubsubChannels, pubsubNumpat, pubsubNumsub, quit, reset, role, waitForReplication

Methods inherited from interface com.lambdaworks.redis.api.sync.RedisTransactionalCommands

discard, exec, multi, unwatch, watch

Method Detail

addListener

@Deprecated
void addListener(RedisPubSubListener<K,V> listener)

Deprecated. Use getStatefulConnection() and StatefulRedisPubSubConnection.addListener(RedisPubSubListener).

Add a new listener.

Parameters:

listener - Listener.

removeListener

@Deprecated
void removeListener(RedisPubSubListener<K,V> listener)

Deprecated. Use getStatefulConnection() and StatefulRedisPubSubConnection.removeListener(RedisPubSubListener).

Remove an existing listener.

Parameters:

listener - Listener.

psubscribe

void psubscribe(K... patterns)

Listen for messages published to channels matching the given patterns.

Parameters:

patterns - the patterns

punsubscribe

void punsubscribe(K... patterns)

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

Parameters:

patterns - the patterns

subscribe

void subscribe(K... channels)

Listen for messages published to the given channels.

Parameters:

channels - the channels

unsubscribe

void unsubscribe(K... channels)

Stop listening for messages posted to the given channels.

Parameters:

channels - the channels

getStatefulConnection

StatefulRedisPubSubConnection<K,V> getStatefulConnection()

Specified by:

getStatefulConnection in interface RedisCommands<K,V>

Specified by:

getStatefulConnection in interface RedisConnection<K,V>

Returns:

the underlying connection.