org.redisson.api.RTopicAsync Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of redisson-all Show documentation
Show all versions of redisson-all Show documentation
Easy Redis Java client and Real-Time Data Platform. Valkey compatible. Sync/Async/RxJava3/Reactive API. Client side caching. Over 50 Redis based Java objects and services: JCache API, Apache Tomcat, Hibernate, Spring, Set, Multimap, SortedSet, Map, List, Queue, Deque, Semaphore, Lock, AtomicLong, Map Reduce, Bloom filter, Scheduler, RPC
/**
* Copyright (c) 2013-2024 Nikita Koksharov
*
* 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.api;
import org.redisson.api.listener.MessageListener;
import org.redisson.api.listener.StatusListener;
/**
* Distributed topic. Messages are delivered to all message listeners across Redis cluster.
*
* @author Nikita Koksharov
*
*/
public interface RTopicAsync {
/**
* Publish the message to all subscribers of this topic asynchronously
*
* @param message to send
* @return number of clients that received the message
*/
RFuture publishAsync(Object message);
/**
* Subscribes to status changes of this topic
*
* @param listener for messages
* @return listener id
* @see org.redisson.api.listener.StatusListener
*/
RFuture addListenerAsync(StatusListener listener);
/**
* Subscribes to this topic.
* MessageListener.onMessage
is called when any message
* is published on this topic.
*
* @param type of message
* @param type - type of message
* @param listener for messages
* @return locally unique listener id
* @see org.redisson.api.listener.MessageListener
*/
RFuture addListenerAsync(Class type, MessageListener extends M> listener);
/**
* Removes the listener by id
for listening this topic
*
* @param listenerIds - listener ids
* @return void
*/
RFuture removeListenerAsync(Integer... listenerIds);
/**
* Removes the listener by its instance
*
* @param listener - listener instance
* @return void
*/
RFuture removeListenerAsync(MessageListener> listener);
/**
* Returns amount of subscribers to this topic across all Redisson instances.
* Each subscriber may have multiple listeners.
*
* @return amount of subscribers
*/
RFuture countSubscribersAsync();
/**
* Removes all listeners from this topic
*
* @return void
*/
RFuture removeAllListenersAsync();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy