io.gravitee.node.api.cluster.messaging.Topic Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of gravitee-node-api Show documentation
There is a newer version: 7.0.2
/**
 * Copyright (C) 2015 The Gravitee team (http://gravitee.io)
 *
 * 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 io.gravitee.node.api.cluster.messaging;

import io.reactivex.rxjava3.core.Completable;
import io.reactivex.rxjava3.core.Single;
import io.reactivex.rxjava3.schedulers.Schedulers;
import org.checkerframework.checker.units.qual.C;

/**
 * @author Kamiel Ahmadpour (kamiel.ahmadpour at graviteesource.com)
 * @author GraviteeSource Team
 */
public interface Topic {
    /**
     * Publish a new event on the current topic
     * @param event the event to publish
     */
    void publish(T event);

    /**
     * Reactive version of {@link Topic#publish(T)}. By default, execution will be done on IO schedulers.
     *
     * @param event the event to publish
     * @return returns a {@code Completable} instance that completes in case of success
     */
    default Completable rxPublish(T event) {
        return Completable.fromRunnable(() -> this.publish(event)).subscribeOn(Schedulers.io());
    }

    /**
     * Add a new listener on this topic. The given listener will be notified on any new message on the topic.
     * @param messageListener the listener to notify
     * @return the subscription identifier. Could be used to remove this listener.
     */
    String addMessageListener(final MessageListener messageListener);

    /**
     * Reactive version of {@link Queue#addMessageListener(MessageListener)}. By default, execution will be done on IO schedulers.
     *
     * @param messageListener the listener to notify
     * @return a {@code Single} with the subscription identifier. Could be used to remove this listener.
     */
    default Single rxAddMessageListener(final MessageListener messageListener) {
        return Single.fromCallable(() -> this.addMessageListener(messageListener)).subscribeOn(Schedulers.io());
    }

    /**
     * Remove a listener on this topic from its subscription id.
     * @param subscriptionId the subscription id used to remove the listener
     * @return true if any listener has been removed, false otherwise.
     */
    boolean removeMessageListener(final String subscriptionId);

    /**
     * Reactive version of {@link Topic#removeMessageListener(String)}. By default, execution will be done on IO schedulers.
     *
     * @param subscriptionId the subscription id used to remove the listener
     * @return returns a {@code Completable} instance that completes in case of listener has been removed.
     */
    default Completable rxRemoveMessageListener(final String subscriptionId) {
        return Completable.fromRunnable(() -> this.removeMessageListener(subscriptionId)).subscribeOn(Schedulers.io());
    }
}