Package org.redisson.api

Interface RTopic

All Superinterfaces:

RTopicAsync

All Known Subinterfaces:

RShardedTopic

All Known Implementing Classes:

RedissonShardedTopic, RedissonTopic

public interface RTopic
extends RTopicAsync

Distributed topic. Messages are delivered to all message listeners across Redis cluster.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
<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
int	countListeners()	Returns amount of registered listeners to this topic
long	countSubscribers()	Returns amount of subscribers to this topic across all Redisson instances.
List<String>	getChannelNames()	Get topic channel names
long	publish(Object message)	Publish the message to all subscribers of this topic
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

Methods inherited from interface org.redisson.api.RTopicAsync

addListenerAsync, addListenerAsync, countSubscribersAsync, publishAsync, removeAllListenersAsync, removeListenerAsync, removeListenerAsync

Method Details

getChannelNames

List<String> getChannelNames()

Get topic channel names

Returns:

channel names

publish

long publish(Object message)

Publish the message to all subscribers of this topic

Parameters:

message - to send

Returns:

the number of clients that received the message

addListener

<M> int addListener(Class<M> type,
 MessageListener<? extends M> listener)

Subscribes to this topic. MessageListener.onMessage is called when any message is published on this topic.

Type Parameters:

M - - type of message

Parameters:

type - - type of message

listener - for messages

Returns:

locally unique listener id

See Also:

• MessageListener

addListener

int addListener(StatusListener listener)

Subscribes to status changes of this topic

Parameters:

listener - for messages

Returns:

listener id

See Also:

• StatusListener

removeListener

void removeListener(MessageListener<?> listener)

Removes the listener by its instance

Parameters:

listener - - listener instance

removeListener

void removeListener(Integer... listenerIds)

Removes the listener by id for listening this topic

Parameters:

listenerIds - - listener ids

removeAllListeners

void removeAllListeners()

Removes all listeners from this topic

countListeners

int countListeners()

Returns amount of registered listeners to this topic

Returns:

amount of listeners

countSubscribers

long countSubscribers()

Returns amount of subscribers to this topic across all Redisson instances. Each subscriber may have multiple listeners.

Returns:

amount of subscribers