org.redisson.core.RTopic Maven / Gradle / Ivy

Go to download
/**
 * Copyright 2014 Nikita Koksharov, Nickolay Borbit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.redisson.core;


/**
 * Distributed topic. Messages are delivered to all message listeners across Redis cluster.
 *
 * @author Nikita Koksharov
 *
 * @param  the type of message object
 */
public interface RTopic extends RObject {

    /**
     * Publish the message to all subscribers of this topic
     *
     * @param message
     */
    void publish(M message);

    /**
     * Subscribes to this topic.
     * MessageListener.onMessage is called when any message
     * is published on this topic.
     *
     * @param listener
     * @return locally unique listener id
     * @see org.redisson.core.MessageListener
     */
    int addListener(MessageListener listener);

    /**
     * Removes the listener by id for listening this topic
     *
     * @param listenerId
     */
    void removeListener(int listenerId);

}