Interface RedisChannel<T>

Type Parameters:
T - the payload message type
public interface RedisChannel<T>
Strongly typed Redis Pub/Sub message channel.

  • Method Details

    • id

      ChannelId id()
      Returns the channel identifier.
      Returns:
      channel identifier

    • codec

      RedisCodec<T> codec()
      Returns the codec used to serialize and deserialize messages on this channel.
      Returns:
      message codec

    • publishAsync

      CompletionStage<Long> publishAsync(T message)
      Asynchronously publishes a message to this channel.
      Parameters:
      message - message payload to encode and broadcast
      Returns:
      stage completing with the number of Redis clients that received the message

    • subscribe

      ChannelSubscription subscribe(Consumer<T> listener)
      Subscribes a listener to receive messages from this channel on default virtual/async thread.
      Parameters:
      listener - message receiver callback
      Returns:
      active subscription handle

    • subscribe

      ChannelSubscription subscribe(Consumer<T> listener, Executor executor)
      Subscribes a listener to receive messages from this channel dispatched via an explicit executor.
      Parameters:
      listener - message receiver callback
      executor - executor to dispatch incoming message callbacks
      Returns:
      active subscription handle