io.lettuce.core.pubsub.api.async

Interface RedisPubSubAsyncCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Superinterfaces:

BaseRedisAsyncCommands<K,V>, RedisAclAsyncCommands<K,V>, RedisAsyncCommands<K,V>, RedisClusterAsyncCommands<K,V>, RedisGeoAsyncCommands<K,V>, RedisHashAsyncCommands<K,V>, RedisHLLAsyncCommands<K,V>, RedisKeyAsyncCommands<K,V>, RedisListAsyncCommands<K,V>, RedisScriptingAsyncCommands<K,V>, RedisServerAsyncCommands<K,V>, RedisSetAsyncCommands<K,V>, RedisSortedSetAsyncCommands<K,V>, RedisStreamAsyncCommands<K,V>, RedisStringAsyncCommands<K,V>, RedisTransactionalAsyncCommands<K,V>

All Known Subinterfaces:

RedisClusterPubSubAsyncCommands<K,V>

All Known Implementing Classes:

RedisClusterPubSubAsyncCommandsImpl, RedisPubSubAsyncCommandsImpl

public interface RedisPubSubAsyncCommands<K,V>
extends RedisAsyncCommands<K,V>

Asynchronous and thread-safe Redis PubSub API.

Since:

3.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
StatefulRedisPubSubConnection<K,V>	getStatefulConnection()
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.
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 interface io.lettuce.core.api.async.RedisAsyncCommands

auth, auth, select, swapdb

Methods inherited from interface io.lettuce.core.cluster.api.async.RedisClusterAsyncCommands

asking, clusterAddSlots, clusterBumpepoch, clusterCountFailureReports, clusterCountKeysInSlot, clusterDelSlots, clusterFailover, clusterFlushslots, clusterForget, clusterGetKeysInSlot, clusterInfo, clusterKeyslot, clusterMeet, clusterMyId, clusterNodes, clusterReplicas, clusterReplicate, clusterReset, clusterSaveconfig, clusterSetConfigEpoch, clusterSetSlotImporting, clusterSetSlotMigrating, clusterSetSlotNode, clusterSetSlotStable, clusterSlaves, clusterSlots, del, mget, mset, msetnx, readOnly, readWrite, setTimeout

Methods inherited from interface io.lettuce.core.api.async.BaseRedisAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisAclAsyncCommands

aclCat, aclCat, aclDeluser, aclGenpass, aclGenpass, aclGetuser, aclList, aclLoad, aclLog, aclLog, aclLogReset, aclSave, aclSetuser, aclUsers, aclWhoami

Methods inherited from interface io.lettuce.core.api.async.RedisGeoAsyncCommands

geoadd, geoadd, geoadd, geoadd, geoadd, geoadd, geodist, geohash, geopos, georadius, georadius, georadius, georadiusbymember, georadiusbymember, georadiusbymember, geosearch, geosearch, geosearchstore

Methods inherited from interface io.lettuce.core.api.async.RedisHashAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisHLLAsyncCommands

pfadd, pfcount, pfmerge

Methods inherited from interface io.lettuce.core.api.async.RedisKeyAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisListAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisScriptingAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisServerAsyncCommands

bgrewriteaof, bgsave, clientCaching, clientGetname, clientGetredir, clientId, clientKill, clientKill, clientList, clientPause, clientSetname, clientTracking, clientUnblock, command, commandCount, commandInfo, commandInfo, configGet, configResetstat, configRewrite, configSet, dbsize, debugCrashAndRecover, debugHtstats, debugObject, debugOom, debugReload, debugRestart, debugSdslen, debugSegfault, flushall, flushall, flushallAsync, flushdb, flushdb, flushdbAsync, info, info, lastsave, memoryUsage, replicaof, replicaofNoOne, save, shutdown, slaveof, slaveofNoOne, slowlogGet, slowlogGet, slowlogLen, slowlogReset, time

Methods inherited from interface io.lettuce.core.api.async.RedisSetAsyncCommands

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

Methods inherited from interface io.lettuce.core.api.async.RedisSortedSetAsyncCommands

bzpopmax, bzpopmax, bzpopmin, bzpopmin, zadd, zadd, zadd, zadd, zadd, zadd, zaddincr, zaddincr, zcard, zcount, zcount, zcount, zdiff, zdiffstore, zdiffWithScores, zincrby, zinter, zinter, zinterstore, zinterstore, zinterWithScores, zinterWithScores, zlexcount, zlexcount, zmscore, zpopmax, zpopmax, zpopmin, zpopmin, zrandmember, zrandmember, zrandmemberWithScores, zrandmemberWithScores, 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, zrangestorebylex, zrangestorebyscore, 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, zrevrangestorebylex, zrevrangestorebyscore, zrevrangeWithScores, zrevrangeWithScores, zrevrank, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscore, zunion, zunion, zunionstore, zunionstore, zunionWithScores, zunionWithScores

Methods inherited from interface io.lettuce.core.api.async.RedisStreamAsyncCommands

xack, xadd, xadd, xadd, xadd, xautoclaim, xclaim, xclaim, xdel, xgroupCreate, xgroupCreate, xgroupCreateconsumer, xgroupDelconsumer, xgroupDestroy, xgroupSetid, xinfoConsumers, xinfoGroups, xinfoStream, xlen, xpending, xpending, xpending, xpending, xrange, xrange, xread, xread, xreadgroup, xreadgroup, xrevrange, xrevrange, xtrim, xtrim, xtrim

Methods inherited from interface io.lettuce.core.api.async.RedisStringAsyncCommands

append, bitcount, bitcount, bitfield, bitopAnd, bitopNot, bitopOr, bitopXor, bitpos, bitpos, bitpos, decr, decrby, get, getbit, getdel, getex, getrange, getset, incr, incrby, incrbyfloat, mget, psetex, set, set, setbit, setex, setGet, setGet, setnx, setrange, stralgoLcs, strlen

Methods inherited from interface io.lettuce.core.api.async.RedisTransactionalAsyncCommands

discard, exec, multi, unwatch, watch

Method Detail

psubscribe

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

Listen for messages published to channels matching the given patterns.

Parameters:

patterns - the patterns

Returns:

RedisFuture<Void> Future to synchronize psubscribe completion

punsubscribe

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

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

Parameters:

patterns - the patterns

Returns:

RedisFuture<Void> Future to synchronize punsubscribe completion

subscribe

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

Listen for messages published to the given channels.

Parameters:

channels - the channels

Returns:

RedisFuture<Void> Future to synchronize subscribe completion

unsubscribe

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

Stop listening for messages posted to the given channels.

Parameters:

channels - the channels

Returns:

RedisFuture<Void> Future to synchronize unsubscribe completion.

getStatefulConnection

StatefulRedisPubSubConnection<K,V> getStatefulConnection()

Specified by:

getStatefulConnection in interface RedisAsyncCommands<K,V>

Returns:

the underlying connection.