javadocs fixed

pull/3917/head
Nikita Koksharov 3 years ago
parent 6bb3332996
commit c5f9894aec

@ -52,6 +52,8 @@ public interface RReliableTopic extends RExpirable, RReliableTopicAsync {
* <code>MessageListener.onMessage</code> method is called when any message * <code>MessageListener.onMessage</code> method is called when any message
* is published on this topic. * is published on this topic.
* <p> * <p>
* Though messages broadcasted across all topic instances, listener is attached to this topic instance.
* <p>
* Watchdog is started when listener was registered. * Watchdog is started when listener was registered.
* *
* @see org.redisson.config.Config#setReliableTopicWatchdogTimeout(long) * @see org.redisson.config.Config#setReliableTopicWatchdogTimeout(long)
@ -59,25 +61,25 @@ public interface RReliableTopic extends RExpirable, RReliableTopicAsync {
* @param <M> - type of message * @param <M> - type of message
* @param type - type of message * @param type - type of message
* @param listener for messages * @param listener for messages
* @return locally unique listener id * @return id of listener attached to this topic instance
* @see MessageListener * @see MessageListener
*/ */
<M> String addListener(Class<M> type, MessageListener<M> listener); <M> String addListener(Class<M> type, MessageListener<M> listener);
/** /**
* Removes the listener by <code>id</code> for listening this topic * Removes the listener by <code>id</code> attached to this topic instance
* *
* @param listenerIds - listener ids * @param listenerIds - listener ids
*/ */
void removeListener(String... listenerIds); void removeListener(String... listenerIds);
/** /**
* Removes all listeners from this topic * Removes all listeners attached to this topic instance
*/ */
void removeAllListeners(); void removeAllListeners();
/** /**
* Returns amount of registered listeners to this topic * Returns amount of registered listeners to this topic instance
* *
* @return amount of listeners * @return amount of listeners
*/ */

@ -52,6 +52,8 @@ public interface RReliableTopicAsync extends RExpirableAsync {
* <code>MessageListener.onMessage</code> method is called when any message * <code>MessageListener.onMessage</code> method is called when any message
* is published on this topic. * is published on this topic.
* <p> * <p>
* Though messages broadcasted across all topic instances, listener is attached to this topic instance.
* <p>
* Watchdog is started when listener was registered. * Watchdog is started when listener was registered.
* *
* @see org.redisson.config.Config#setReliableTopicWatchdogTimeout(long) * @see org.redisson.config.Config#setReliableTopicWatchdogTimeout(long)
@ -59,13 +61,13 @@ public interface RReliableTopicAsync extends RExpirableAsync {
* @param <M> - type of message * @param <M> - type of message
* @param type - type of message * @param type - type of message
* @param listener for messages * @param listener for messages
* @return locally unique listener id * @return id of listener attached to this topic instance
* @see MessageListener * @see MessageListener
*/ */
<M> RFuture<String> addListenerAsync(Class<M> type, MessageListener<M> listener); <M> RFuture<String> addListenerAsync(Class<M> type, MessageListener<M> listener);
/** /**
* Removes the listener by <code>id</code> for listening this topic * Removes the listener by <code>id</code> attached to this topic instance
* *
* @param listenerIds - listener ids * @param listenerIds - listener ids
* @return void * @return void
@ -73,7 +75,7 @@ public interface RReliableTopicAsync extends RExpirableAsync {
RFuture<Void> removeListenerAsync(String... listenerIds); RFuture<Void> removeListenerAsync(String... listenerIds);
/** /**
* Removes all listeners from this topic * Removes all listeners attached to this topic instance
*/ */
RFuture<Void> removeAllListenersAsync(); RFuture<Void> removeAllListenersAsync();

@ -54,6 +54,8 @@ public interface RReliableTopicReactive extends RExpirableReactive {
* <code>MessageListener.onMessage</code> method is called when any message * <code>MessageListener.onMessage</code> method is called when any message
* is published on this topic. * is published on this topic.
* <p> * <p>
* Though messages broadcasted across all topic instances, listener is attached to this topic instance.
* <p>
* Watchdog is started when listener was registered. * Watchdog is started when listener was registered.
* *
* @see org.redisson.config.Config#setReliableTopicWatchdogTimeout(long) * @see org.redisson.config.Config#setReliableTopicWatchdogTimeout(long)
@ -61,13 +63,13 @@ public interface RReliableTopicReactive extends RExpirableReactive {
* @param <M> - type of message * @param <M> - type of message
* @param type - type of message * @param type - type of message
* @param listener for messages * @param listener for messages
* @return locally unique listener id * @return id of listener attached to this topic instance
* @see MessageListener * @see MessageListener
*/ */
<M> Mono<String> addListener(Class<M> type, MessageListener<M> listener); <M> Mono<String> addListener(Class<M> type, MessageListener<M> listener);
/** /**
* Removes the listener by <code>id</code> for listening this topic * Removes the listener by <code>id</code> attached to this topic instance
* *
* @param listenerIds - listener ids * @param listenerIds - listener ids
* @return void * @return void
@ -75,7 +77,7 @@ public interface RReliableTopicReactive extends RExpirableReactive {
Mono<Void> removeListener(String... listenerIds); Mono<Void> removeListener(String... listenerIds);
/** /**
* Removes all listeners from this topic * Removes all listeners attached to this topic instance
*/ */
Mono<Void> removeAllListeners(); Mono<Void> removeAllListeners();

@ -55,6 +55,8 @@ public interface RReliableTopicRx extends RExpirableRx {
* <code>MessageListener.onMessage</code> method is called when any message * <code>MessageListener.onMessage</code> method is called when any message
* is published on this topic. * is published on this topic.
* <p> * <p>
* Though messages broadcasted across all topic instances, listener is attached to this topic instance.
* <p>
* Watchdog is started when listener was registered. * Watchdog is started when listener was registered.
* *
* @see org.redisson.config.Config#setReliableTopicWatchdogTimeout(long) * @see org.redisson.config.Config#setReliableTopicWatchdogTimeout(long)
@ -62,13 +64,13 @@ public interface RReliableTopicRx extends RExpirableRx {
* @param <M> - type of message * @param <M> - type of message
* @param type - type of message * @param type - type of message
* @param listener for messages * @param listener for messages
* @return locally unique listener id * @return id of listener attached to this topic instance
* @see MessageListener * @see MessageListener
*/ */
<M> Single<String> addListener(Class<M> type, MessageListener<M> listener); <M> Single<String> addListener(Class<M> type, MessageListener<M> listener);
/** /**
* Removes the listener by <code>id</code> for listening this topic * Removes the listener by <code>id</code> attached to this topic instance
* *
* @param listenerIds - listener ids * @param listenerIds - listener ids
* @return void * @return void
@ -76,7 +78,7 @@ public interface RReliableTopicRx extends RExpirableRx {
Completable removeListener(String... listenerIds); Completable removeListener(String... listenerIds);
/** /**
* Removes all listeners from this topic * Removes all listeners attached to this topic instance
*/ */
Completable removeAllListeners(); Completable removeAllListeners();

Loading…
Cancel
Save