org.redisson.api.RPatternTopic 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
The newest version!
/**
* 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 java.util.List;
import org.redisson.api.listener.PatternMessageListener;
import org.redisson.api.listener.PatternStatusListener;
/**
* Pattern based observer for Publish Subscribe object.
*
* @author Nikita Koksharov
*
*/
public interface RPatternTopic {
/**
* Get topic channel patterns
*
* @return list of topic names
*/
List getPatternNames();
/**
* 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 - message listener
* @return local JVM unique listener id
* @see org.redisson.api.listener.MessageListener
*/
int addListener(Class type, PatternMessageListener listener);
/**
* Subscribes to status changes of this topic
*
* @param listener - message listener
* @return local JVM unique listener id
* @see org.redisson.api.listener.StatusListener
*/
int addListener(PatternStatusListener listener);
/**
* Removes the listeners by ids
for listening this topic
*
* @param ids listener ids
*/
void removeListener(Integer... ids);
/**
* Removes the listener by its instance
*
* @param listener - listener instance
*/
void removeListener(PatternMessageListener> listener);
/**
* Removes all listeners from this topic
*/
void removeAllListeners();
/**
* Removes all listeners from this topic
*
* @return void
*/
RFuture removeAllListenersAsync();
RFuture addListenerAsync(PatternStatusListener listener);
RFuture addListenerAsync(Class type, PatternMessageListener listener);
/**
* Removes the listeners by ids
for listening this topic
*
* @param ids listener ids
* @return void
*/
RFuture removeListenerAsync(Integer... ids);
/**
* Returns active topic list of this pattern
* @return all actives channel of this pattern
*/
RFuture> getActiveTopicsAsync();
/**
* Returns active topic list of this pattern
* @return all actives topic of this pattern
*/
List getActiveTopics();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy