Package io.lettuce.core.pubsub.api.reactive

Interface RedisPubSubReactiveCommands<K,V>

Type Parameters:

K - Key type.

V - Value type.

All Superinterfaces:

BaseRedisReactiveCommands<K,V>, RedisAclReactiveCommands<K,V>, RedisClusterReactiveCommands<K,V>, RedisFunctionReactiveCommands<K,V>, RedisGeoReactiveCommands<K,V>, RedisHashReactiveCommands<K,V>, RedisHLLReactiveCommands<K,V>, RedisKeyReactiveCommands<K,V>, RedisListReactiveCommands<K,V>, RedisReactiveCommands<K,V>, RedisScriptingReactiveCommands<K,V>, RedisServerReactiveCommands<K,V>, RedisSetReactiveCommands<K,V>, RedisSortedSetReactiveCommands<K,V>, RedisStreamReactiveCommands<K,V>, RedisStringReactiveCommands<K,V>, RedisTransactionalReactiveCommands<K,V>

All Known Subinterfaces:

RedisClusterPubSubReactiveCommands<K,V>

All Known Implementing Classes:

RedisClusterPubSubReactiveCommandsImpl, RedisPubSubReactiveCommandsImpl

public interface RedisPubSubReactiveCommands<K,V>
extends RedisReactiveCommands<K,V>

Asynchronous and thread-safe Redis PubSub API.

Since:

5.0

Author:

Mark Paluch

Method Summary

Modifier and Type	Method	Description
StatefulRedisPubSubConnection<K,V>	getStatefulConnection()	Deprecated.
Flux<ChannelMessage<K,V>>	observeChannels()	Flux for messages (message) received though channel subscriptions.
Flux<ChannelMessage<K,V>>	observeChannels(FluxSink.OverflowStrategy overflowStrategy)	Flux for messages (message) received though channel subscriptions.
Flux<PatternMessage<K,V>>	observePatterns()	Flux for messages (pmessage) received though pattern subscriptions.
Flux<PatternMessage<K,V>>	observePatterns(FluxSink.OverflowStrategy overflowStrategy)	Flux for messages (pmessage) received though pattern subscriptions.
Mono<Void>	psubscribe(K... patterns)	Listen for messages published to channels matching the given patterns.
Mono<Void>	punsubscribe(K... patterns)	Stop listening for messages posted to channels matching the given patterns.
Mono<Void>	subscribe(K... channels)	Listen for messages published to the given channels.
Mono<Void>	unsubscribe(K... channels)	Stop listening for messages posted to the given channels.

Methods inherited from interface io.lettuce.core.api.reactive.BaseRedisReactiveCommands

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

Methods inherited from interface io.lettuce.core.api.reactive.RedisAclReactiveCommands

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

Methods inherited from interface io.lettuce.core.cluster.api.reactive.RedisClusterReactiveCommands

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

Methods inherited from interface io.lettuce.core.api.reactive.RedisFunctionReactiveCommands

fcall, fcall, fcallReadOnly, fcallReadOnly, functionDump, functionFlush, functionKill, functionList, functionList, functionLoad, functionLoad, functionRestore, functionRestore

Methods inherited from interface io.lettuce.core.api.reactive.RedisGeoReactiveCommands

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.reactive.RedisHashReactiveCommands

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.reactive.RedisHLLReactiveCommands

pfadd, pfcount, pfmerge

Methods inherited from interface io.lettuce.core.api.reactive.RedisKeyReactiveCommands

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

Methods inherited from interface io.lettuce.core.api.reactive.RedisListReactiveCommands

blmove, blmove, blmpop, blmpop, blpop, blpop, brpop, brpop, brpoplpush, brpoplpush, lindex, linsert, llen, lmove, lmpop, 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.reactive.RedisReactiveCommands

auth, auth, select, swapdb

Methods inherited from interface io.lettuce.core.api.reactive.RedisScriptingReactiveCommands

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

Methods inherited from interface io.lettuce.core.api.reactive.RedisServerReactiveCommands

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

Methods inherited from interface io.lettuce.core.api.reactive.RedisSetReactiveCommands

sadd, scard, sdiff, sdiff, sdiffstore, sinter, sinter, sintercard, sintercard, 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.reactive.RedisSortedSetReactiveCommands

bzmpop, bzmpop, bzmpop, bzmpop, bzpopmax, bzpopmax, bzpopmin, bzpopmin, zadd, zadd, zadd, zadd, zadd, zadd, zaddincr, zaddincr, zcard, zcount, zcount, zcount, zdiff, zdiffstore, zdiffWithScores, zincrby, zinter, zinter, zintercard, zintercard, zinterstore, zinterstore, zinterWithScores, zinterWithScores, zlexcount, zlexcount, zmpop, zmpop, 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, zrangestore, zrangestorebylex, zrangestorebyscore, zrangeWithScores, zrangeWithScores, zrank, zrankWithScore, 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, zrevrangestore, zrevrangestorebylex, zrevrangestorebyscore, zrevrangeWithScores, zrevrangeWithScores, zrevrank, zrevrankWithScore, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscan, zscore, zunion, zunion, zunionstore, zunionstore, zunionWithScores, zunionWithScores

Methods inherited from interface io.lettuce.core.api.reactive.RedisStreamReactiveCommands

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.reactive.RedisStringReactiveCommands

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

Methods inherited from interface io.lettuce.core.api.reactive.RedisTransactionalReactiveCommands

discard, exec, multi, unwatch, watch

Method Detail

observePatterns

Flux<PatternMessage<K,V>> observePatterns()

Flux for messages (pmessage) received though pattern subscriptions. The connection needs to be subscribed to one or more patterns using psubscribe(Object[]).

Warning! This method uses FluxSink.OverflowStrategy.BUFFER This does unbounded buffering and may lead to OutOfMemoryError. Use observePatterns(FluxSink.OverflowStrategy) to specify a different strategy.

Returns:

hot Flux for subscriptions to pmessage's.

observePatterns

Flux<PatternMessage<K,V>> observePatterns(FluxSink.OverflowStrategy overflowStrategy)

Flux for messages (pmessage) received though pattern subscriptions. The connection needs to be subscribed to one or more patterns using psubscribe(Object[]).

Parameters:

overflowStrategy - the overflow strategy to use.

Returns:

hot Flux for subscriptions to pmessage's.

observeChannels

Flux<ChannelMessage<K,V>> observeChannels()

Flux for messages (message) received though channel subscriptions. The connection needs to be subscribed to one or more channels using subscribe(Object[]).

Warning! This method uses FluxSink.OverflowStrategy.BUFFER This does unbounded buffering and may lead to OutOfMemoryError. Use observeChannels(FluxSink.OverflowStrategy) to specify a different strategy.

Returns:

hot Flux for subscriptions to message's.

observeChannels

Flux<ChannelMessage<K,V>> observeChannels(FluxSink.OverflowStrategy overflowStrategy)

Flux for messages (message) received though channel subscriptions. The connection needs to be subscribed to one or more channels using subscribe(Object[]).

Parameters:

overflowStrategy - the overflow strategy to use.

Returns:

hot Flux for subscriptions to message's.

psubscribe

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

Listen for messages published to channels matching the given patterns. The Mono completes without a result as soon as the pattern subscription is registered.

Parameters:

patterns - the patterns.

Returns:

Mono<Void> Mono for psubscribe command.

punsubscribe

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

Stop listening for messages posted to channels matching the given patterns. The Mono completes without a result as soon as the pattern subscription is unregistered.

Parameters:

patterns - the patterns.

Returns:

Mono<Void> Mono for punsubscribe command.

subscribe

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

Listen for messages published to the given channels. The Mono completes without a result as soon as the * subscription is registered.

Parameters:

channels - the channels.

Returns:

Mono<Void> Mono for subscribe command.

unsubscribe

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

Stop listening for messages posted to the given channels. The Mono completes without a result as soon as the subscription is unregistered.

Parameters:

channels - the channels.

Returns:

Mono<Void> Mono for unsubscribe command.

getStatefulConnection

@Deprecated
StatefulRedisPubSubConnection<K,V> getStatefulConnection()

Deprecated.

Specified by:

getStatefulConnection in interface RedisReactiveCommands<K,V>

Returns:

the underlying connection.

Since:

6.2, will be removed with Lettuce 7 to avoid exposing the underlying connection.