RedissonTopic (Redisson 3.15.4 API)

java.lang.Object
- org.redisson.RedissonTopic

All Implemented Interfaces:

RTopic, RTopicAsync
```
public class RedissonTopic
extends Object
implements RTopic
```
Distributed topic implementation. Messages are delivered to all message listeners across Redis cluster.

Author:

Nikita Koksharov

Constructor Summary

Constructors
Constructor and Description
`RedissonTopic(Codec codec, CommandAsyncExecutor commandExecutor, NameMapper nameMapper, String name)`
`RedissonTopic(Codec codec, CommandAsyncExecutor commandExecutor, String name)`
`RedissonTopic(CommandAsyncExecutor commandExecutor, String name)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`acquire(AsyncSemaphore semaphore)`
`<M> int`	`addListener(Class<M> type, MessageListener<? extends M> listener)` Subscribes to this topic.
`int`	`addListener(StatusListener listener)` Subscribes to status changes of this topic
`<M> RFuture<Integer>`	`addListenerAsync(Class<M> type, MessageListener<M> listener)` Subscribes to this topic.
`protected RFuture<Integer>`	`addListenerAsync(RedisPubSubListener<?> pubSubListener)`
`RFuture<Integer>`	`addListenerAsync(StatusListener listener)` Subscribes to status changes of this topic
`int`	`countListeners()` Returns amount of registered listeners to this topic
`long`	`countSubscribers()` Returns amount of subscribers to this topic across all Redisson instances.
`RFuture<Long>`	`countSubscribersAsync()` Returns amount of subscribers to this topic across all Redisson instances.
`static RedissonTopic`	`createRaw(Codec codec, CommandAsyncExecutor commandExecutor, String name)`
`static RedissonTopic`	`createRaw(CommandAsyncExecutor commandExecutor, String name)`
`List<String>`	`getChannelNames()` Get topic channel names
`protected String`	`getName()`
`protected String`	`getName(Object o)`
`long`	`publish(Object message)` Publish the message to all subscribers of this topic
`RFuture<Long>`	`publishAsync(Object message)` Publish the message to all subscribers of this topic asynchronously
`void`	`removeAllListeners()` Removes all listeners from this topic
`void`	`removeListener(Integer... listenerIds)` Removes the listener by `id` for listening this topic
`void`	`removeListener(MessageListener<?> listener)` Removes the listener by its instance
`RFuture<Void>`	`removeListenerAsync(Integer... listenerIds)` Removes the listener by `id` for listening this topic
`RFuture<Void>`	`removeListenerAsync(MessageListener<?> listener)` Removes the listener by its instance

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - RedissonTopic
```
public RedissonTopic(CommandAsyncExecutor commandExecutor,
                     String name)
```
  - RedissonTopic
```
public RedissonTopic(Codec codec,
                     CommandAsyncExecutor commandExecutor,
                     String name)
```
  - RedissonTopic
```
public RedissonTopic(Codec codec,
                     CommandAsyncExecutor commandExecutor,
                     NameMapper nameMapper,
                     String name)
```
- Method Detail
  - createRaw
```
public static RedissonTopic createRaw(CommandAsyncExecutor commandExecutor,
                                      String name)
```
  - createRaw
```
public static RedissonTopic createRaw(Codec codec,
                                      CommandAsyncExecutor commandExecutor,
                                      String name)
```
  - getChannelNames
```
public List<String> getChannelNames()
```
    Description copied from interface: RTopic
    
    Get topic channel names
    
    Specified by:
    
    getChannelNames in interface RTopic
    
    Returns:
    
    channel names
  - publish
```
public long publish(Object message)
```
    Description copied from interface: RTopic
    
    Publish the message to all subscribers of this topic
    
    Specified by:
    
    publish in interface RTopic
    
    Parameters:
    
    message - to send
    
    Returns:
    
    the number of clients that received the message
  - getName
```
protected String getName()
```
  - getName
```
protected String getName(Object o)
```
  - publishAsync
```
public RFuture<Long> publishAsync(Object message)
```
    Description copied from interface: RTopicAsync
    
    Publish the message to all subscribers of this topic asynchronously
    
    Specified by:
    
    publishAsync in interface RTopicAsync
    
    Parameters:
    
    message - to send
    
    Returns:
    
    number of clients that received the message
  - addListener
```
public int addListener(StatusListener listener)
```
    Description copied from interface: RTopic
    
    Subscribes to status changes of this topic
    
    Specified by:
    
    addListener in interface RTopic
    
    Parameters:
    
    listener - for messages
    
    Returns:
    
    listener id
    
    See Also:
    
    StatusListener
  - addListener
```
public <M> int addListener(Class<M> type,
                           MessageListener<? extends M> listener)
```
    Description copied from interface: RTopic
    
    Subscribes to this topic. MessageListener.onMessage is called when any message is published on this topic.
    
    Specified by:
    
    addListener in interface RTopic
    
    Type Parameters:
    
    M - - type of message
    
    Parameters:
    
    type - - type of message
    
    listener - for messages
    
    Returns:
    
    locally unique listener id
    
    See Also:
    
    MessageListener
  - addListenerAsync
```
public RFuture<Integer> addListenerAsync(StatusListener listener)
```
    Description copied from interface: RTopicAsync
    
    Subscribes to status changes of this topic
    
    Specified by:
    
    addListenerAsync in interface RTopicAsync
    
    Parameters:
    
    listener - for messages
    
    Returns:
    
    listener id
    
    See Also:
    
    StatusListener
  - addListenerAsync
```
public <M> RFuture<Integer> addListenerAsync(Class<M> type,
                                             MessageListener<M> listener)
```
    Description copied from interface: RTopicAsync
    
    Subscribes to this topic. MessageListener.onMessage is called when any message is published on this topic.
    
    Specified by:
    
    addListenerAsync in interface RTopicAsync
    
    Type Parameters:
    
    M - type of message
    
    Parameters:
    
    type - - type of message
    
    listener - for messages
    
    Returns:
    
    locally unique listener id
    
    See Also:
    
    MessageListener
  - addListenerAsync
```
protected RFuture<Integer> addListenerAsync(RedisPubSubListener<?> pubSubListener)
```
  - removeAllListeners
```
public void removeAllListeners()
```
    Description copied from interface: RTopic
    
    Removes all listeners from this topic
    
    Specified by:
    
    removeAllListeners in interface RTopic
  - acquire
```
protected void acquire(AsyncSemaphore semaphore)
```
  - removeListener
```
public void removeListener(MessageListener<?> listener)
```
    Description copied from interface: RTopic
    
    Removes the listener by its instance
    
    Specified by:
    
    removeListener in interface RTopic
    
    Parameters:
    
    listener - - listener instance
  - removeListenerAsync
```
public RFuture<Void> removeListenerAsync(MessageListener<?> listener)
```
    Description copied from interface: RTopicAsync
    
    Removes the listener by its instance
    
    Specified by:
    
    removeListenerAsync in interface RTopicAsync
    
    Parameters:
    
    listener - - listener instance
    
    Returns:
    
    void
  - removeListenerAsync
```
public RFuture<Void> removeListenerAsync(Integer... listenerIds)
```
    Description copied from interface: RTopicAsync
    
    Removes the listener by id for listening this topic
    
    Specified by:
    
    removeListenerAsync in interface RTopicAsync
    
    Parameters:
    
    listenerIds - - listener ids
    
    Returns:
    
    void
  - removeListener
```
public void removeListener(Integer... listenerIds)
```
    Description copied from interface: RTopic
    
    Removes the listener by id for listening this topic
    
    Specified by:
    
    removeListener in interface RTopic
    
    Parameters:
    
    listenerIds - - listener ids
  - countListeners
```
public int countListeners()
```
    Description copied from interface: RTopic
    
    Returns amount of registered listeners to this topic
    
    Specified by:
    
    countListeners in interface RTopic
    
    Returns:
    
    amount of listeners
  - countSubscribersAsync
```
public RFuture<Long> countSubscribersAsync()
```
    Description copied from interface: RTopicAsync
    
    Returns amount of subscribers to this topic across all Redisson instances. Each subscriber may have multiple listeners.
    
    Specified by:
    
    countSubscribersAsync in interface RTopicAsync
    
    Returns:
    
    amount of subscribers
  - countSubscribers
```
public long countSubscribers()
```
    Description copied from interface: RTopic
    
    Returns amount of subscribers to this topic across all Redisson instances. Each subscriber may have multiple listeners.
    
    Specified by:
    
    countSubscribers in interface RTopic
    
    Returns:
    
    amount of subscribers

Class RedissonTopic

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RedissonTopic

RedissonTopic

RedissonTopic

Method Detail

createRaw

createRaw

getChannelNames

publish

getName

getName

publishAsync

addListener

addListener

addListenerAsync

addListenerAsync

addListenerAsync

removeAllListeners

acquire

removeListener

removeListenerAsync

removeListenerAsync

removeListener

countListeners

countSubscribersAsync

countSubscribers