io.lettuce.core.pubsub.PubSubMessage Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of lettuce-core Show documentation

Advanced and thread-safe Java Redis client for synchronous, asynchronous, and reactive usage. Supports Cluster, Sentinel, Pipelining, Auto-Reconnect, Codecs and much more.

The newest version!

package io.lettuce.core.pubsub;

/**
 * Represents a Pub/Sub notification message.
 *
 * @author Mark Paluch
 * @since 6.0
 */
public interface PubSubMessage {

    /**
     * @return the {@link PubSubOutput.Type} message type.
     */
    PubSubOutput.Type type();

    /**
     * @return name of the channel to which this notification belongs to.
     */
    K channel();

    /**
     * @return pattern that applies if the message was received through a pattern subscription. Can be {@code null}.
     */
    K pattern();

    /**
     * @return the subscriber count if applicable.
     */
    long count();

    /**
     * @return the message body, if applicable. Can be {@code null}.
     */
    V body();

}