Interface PubSubCommands<V>
-
- Type Parameters:
V
- the class of the exchanged messages.
- All Superinterfaces:
RedisCommands
- All Known Implementing Classes:
BlockingPubSubCommandsImpl
public interface PubSubCommands<V> extends RedisCommands
Allows executing Pub/Sub commands. See the pub/sub documentation.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
PubSubCommands.RedisSubscriber
A redis subscriber
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
publish(String channel, V message)
Publishes a message to a given channelPubSubCommands.RedisSubscriber
subscribe(String channel, Consumer<V> onMessage)
Subscribes to a given channel.PubSubCommands.RedisSubscriber
subscribe(String channel, Consumer<V> onMessage, Runnable onEnd, Consumer<Throwable> onException)
Subscribes to a given channel.PubSubCommands.RedisSubscriber
subscribe(List<String> channels, Consumer<V> onMessage)
Subscribes to the given channels.PubSubCommands.RedisSubscriber
subscribe(List<String> channels, Consumer<V> onMessage, Runnable onEnd, Consumer<Throwable> onException)
Subscribes to the given channels.PubSubCommands.RedisSubscriber
subscribeToPattern(String pattern, Consumer<V> onMessage)
Subscribes to a given pattern likechan*l
.PubSubCommands.RedisSubscriber
subscribeToPattern(String pattern, Consumer<V> onMessage, Runnable onEnd, Consumer<Throwable> onException)
Subscribes to a given pattern likechan*l
.PubSubCommands.RedisSubscriber
subscribeToPatterns(List<String> patterns, Consumer<V> onMessage)
Subscribes to the given patterns likechan*l
.PubSubCommands.RedisSubscriber
subscribeToPatterns(List<String> patterns, Consumer<V> onMessage, Runnable onEnd, Consumer<Throwable> onException)
Subscribes to the given patterns likechan*l
.-
Methods inherited from interface io.quarkus.redis.datasource.RedisCommands
getDataSource
-
-
-
-
Method Detail
-
publish
void publish(String channel, V message)
Publishes a message to a given channel- Parameters:
channel
- the channelmessage
- the message
-
subscribe
PubSubCommands.RedisSubscriber subscribe(String channel, Consumer<V> onMessage)
Subscribes to a given channel.- Parameters:
channel
- the channelonMessage
- the message consumer. Be aware that this callback is invoked for each message sent to the given channel, and is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.- Returns:
- the subscriber object that lets you unsubscribe
-
subscribeToPattern
PubSubCommands.RedisSubscriber subscribeToPattern(String pattern, Consumer<V> onMessage)
Subscribes to a given pattern likechan*l
.- Parameters:
pattern
- the patternonMessage
- the message consumer. Be aware that this callback is invoked for each message sent to the channels matching the pattern, and is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.- Returns:
- the subscriber object that lets you unsubscribe
-
subscribeToPatterns
PubSubCommands.RedisSubscriber subscribeToPatterns(List<String> patterns, Consumer<V> onMessage)
Subscribes to the given patterns likechan*l
.- Parameters:
patterns
- the patternsonMessage
- the message consumer. Be aware that this callback is invoked for each message sent to the channels matching the pattern, and is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.- Returns:
- the subscriber object that lets you unsubscribe
-
subscribe
PubSubCommands.RedisSubscriber subscribe(List<String> channels, Consumer<V> onMessage)
Subscribes to the given channels.- Parameters:
channels
- the channelsonMessage
- the message consumer. Be aware that this callback is invoked for each message sent to the given channels, and is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.- Returns:
- the subscriber object that lets you unsubscribe
-
subscribe
PubSubCommands.RedisSubscriber subscribe(String channel, Consumer<V> onMessage, Runnable onEnd, Consumer<Throwable> onException)
Subscribes to a given channel.- Parameters:
channel
- the channelonMessage
- the message consumer. Be aware that this callback is invoked for each message sent to the given channel, and is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.onEnd
- the end handler. Be aware that this callback is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.onException
- the exception handler. Be aware that this callback is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.- Returns:
- the subscriber object that lets you unsubscribe
-
subscribeToPattern
PubSubCommands.RedisSubscriber subscribeToPattern(String pattern, Consumer<V> onMessage, Runnable onEnd, Consumer<Throwable> onException)
Subscribes to a given pattern likechan*l
.- Parameters:
pattern
- the patternonMessage
- the message consumer. Be aware that this callback is invoked for each message sent to the channels matching the pattern, and is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.onEnd
- the end handler. Be aware that this callback is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.onException
- the exception handler. Be aware that this callback is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.- Returns:
- the subscriber object that lets you unsubscribe
-
subscribeToPatterns
PubSubCommands.RedisSubscriber subscribeToPatterns(List<String> patterns, Consumer<V> onMessage, Runnable onEnd, Consumer<Throwable> onException)
Subscribes to the given patterns likechan*l
.- Parameters:
patterns
- the patternsonMessage
- the message consumer. Be aware that this callback is invoked for each message sent to the channels matching the pattern, and is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.onEnd
- the end handler. Be aware that this callback is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.onException
- the exception handler. Be aware that this callback is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.- Returns:
- the subscriber object that lets you unsubscribe
-
subscribe
PubSubCommands.RedisSubscriber subscribe(List<String> channels, Consumer<V> onMessage, Runnable onEnd, Consumer<Throwable> onException)
Subscribes to the given channels.- Parameters:
channels
- the channelsonMessage
- the message consumer. Be aware that this callback is invoked for each message sent to the given channels, and is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.onEnd
- the end handler. Be aware that this callback is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.onException
- the exception handler. Be aware that this callback is invoked on the I/O thread. So, you must not block. Offload to a separate thread if needed.- Returns:
- the subscriber object that lets you unsubscribe
-
-