Package org.redisson

Class RedissonReliableTopic

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonReliableTopic

All Implemented Interfaces:

RExpirable, RExpirableAsync, RObject, RObjectAsync, RReliableTopic, RReliableTopicAsync

public class RedissonReliableTopic
extends RedissonObject
implements RReliableTopic

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor, name

Constructor Summary

Constructors

Constructor	Description
RedissonReliableTopic(Codec codec, CommandAsyncExecutor commandExecutor, String name)
RedissonReliableTopic(CommandAsyncExecutor commandExecutor, String name)

Method Summary

Modifier and Type	Method	Description
<M> String	addListener(Class<M> type, MessageListener<M> listener)	Subscribes to this topic.
<M> RFuture<String>	addListenerAsync(Class<M> type, MessageListener<M> listener)	Subscribes to this topic.
boolean	clearExpire()	Clear an expire timeout or expire date for object.
RFuture<Boolean>	clearExpireAsync()	Clear an expire timeout or expire date for object in async mode.
protected RFuture<Boolean>	clearExpireAsync(String... keys)
int	countListeners()	Returns amount of registered listeners to this topic instance
int	countSubscribers()	Returns amount of subscribers to this topic across all Redisson instances.
RFuture<Integer>	countSubscribersAsync()	Returns amount of subscribers to this topic across all Redisson instances.
RFuture<Boolean>	deleteAsync()	Delete object in async mode
boolean	expire(long timeToLive, TimeUnit timeUnit)	Set a timeout for object.
boolean	expire(Instant instant)	Set an expire date for object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit)	Set a timeout for object in async mode.
protected RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit, String... keys)
RFuture<Boolean>	expireAsync(Instant instant)	Set an expire date for object.
boolean	expireAt(long timestamp)	Use RExpirable.expire(Instant) instead
boolean	expireAt(Date timestamp)	Use RExpirable.expire(Instant) instead
RFuture<Boolean>	expireAtAsync(long timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
protected RFuture<Boolean>	expireAtAsync(long timestamp, String... keys)
RFuture<Boolean>	expireAtAsync(Date timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
protected String	generateId()
long	publish(Object message)	Publish the message to all subscribers of this topic asynchronously.
RFuture<Long>	publishAsync(Object message)	Publish the message to all subscribers of this topic asynchronously.
long	remainTimeToLive()	Remaining time to live of Redisson object that has a timeout
RFuture<Long>	remainTimeToLiveAsync()	Remaining time to live of Redisson object that has a timeout
void	removeAllListeners()	Removes all listeners attached to this topic instance
RFuture<Void>	removeAllListenersAsync()	Removes all listeners attached to this topic instance
void	removeListener(String... listenerIds)	Removes the listener by id attached to this topic instance
RFuture<Void>	removeListenerAsync(String... listenerIds)	Removes the listener by id attached to this topic instance
long	size()	Amount of messages stored in Redis Stream object.
RFuture<Long>	sizeAsync()	Amount of messages stored in Redis Stream object.
RFuture<Long>	sizeInMemoryAsync()	Returns bytes amount used by object in Redis memory.

Methods inherited from class org.redisson.RedissonObject

addListener, addListener, addListenerAsync, addListenerAsync, copy, copyAsync, delete, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListenerAsync, removeListenersAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

addListener, copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink

Methods inherited from interface org.redisson.api.RObjectAsync

addListenerAsync, copyAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, touchAsync, unlinkAsync

Constructor Detail

RedissonReliableTopic

public RedissonReliableTopic(Codec codec,
                             CommandAsyncExecutor commandExecutor,
                             String name)

RedissonReliableTopic

public RedissonReliableTopic(CommandAsyncExecutor commandExecutor,
                             String name)

Method Detail

publish

public long publish(Object message)

Description copied from interface: RReliableTopic

Publish the message to all subscribers of this topic asynchronously. Each subscriber may have multiple listeners.

Specified by:

publish in interface RReliableTopic

Parameters:

message - to send

Returns:

number of subscribers that received the message

addListener

public <M> String addListener(Class<M> type,
                              MessageListener<M> listener)

Description copied from interface: RReliableTopic

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

Though messages broadcasted across all topic instances, listener is attached to this topic instance.

Watchdog is started when listener was registered.

Specified by:

addListener in interface RReliableTopic

Type Parameters:

M - - type of message

Parameters:

type - - type of message

listener - for messages

Returns:

id of listener attached to this topic instance

See Also:

Config.setReliableTopicWatchdogTimeout(long), MessageListener

removeListener

public void removeListener(String... listenerIds)

Description copied from interface: RReliableTopic

Removes the listener by id attached to this topic instance

Specified by:

removeListener in interface RReliableTopic

Parameters:

listenerIds - - listener ids

removeAllListeners

public void removeAllListeners()

Description copied from interface: RReliableTopic

Removes all listeners attached to this topic instance

Specified by:

removeAllListeners in interface RReliableTopic

removeAllListenersAsync

public RFuture<Void> removeAllListenersAsync()

Description copied from interface: RReliableTopicAsync

Removes all listeners attached to this topic instance

Specified by:

removeAllListenersAsync in interface RReliableTopicAsync

size

public long size()

Description copied from interface: RReliableTopic

Amount of messages stored in Redis Stream object.

Specified by:

size in interface RReliableTopic

Returns:

amount of messages

sizeAsync

public RFuture<Long> sizeAsync()

Description copied from interface: RReliableTopicAsync

Amount of messages stored in Redis Stream object.

Specified by:

sizeAsync in interface RReliableTopicAsync

Returns:

amount of messages

countListeners

public int countListeners()

Description copied from interface: RReliableTopic

Returns amount of registered listeners to this topic instance

Specified by:

countListeners in interface RReliableTopic

Returns:

amount of listeners

publishAsync

public RFuture<Long> publishAsync(Object message)

Description copied from interface: RReliableTopicAsync

Publish the message to all subscribers of this topic asynchronously. Each subscriber may have multiple listeners.

Specified by:

publishAsync in interface RReliableTopicAsync

Parameters:

message - to send

Returns:

number of subscribers that received the message

generateId

protected String generateId()

addListenerAsync

public <M> RFuture<String> addListenerAsync(Class<M> type,
                                            MessageListener<M> listener)

Description copied from interface: RReliableTopicAsync

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

Though messages broadcasted across all topic instances, listener is attached to this topic instance.

Watchdog is started when listener was registered.

Specified by:

addListenerAsync in interface RReliableTopicAsync

Type Parameters:

M - - type of message

Parameters:

type - - type of message

listener - for messages

Returns:

id of listener attached to this topic instance

See Also:

Config.setReliableTopicWatchdogTimeout(long), MessageListener

deleteAsync

public RFuture<Boolean> deleteAsync()

Description copied from interface: RObjectAsync

Delete object in async mode

Specified by:

deleteAsync in interface RObjectAsync

Overrides:

deleteAsync in class RedissonObject

Returns:

true if object was deleted false if not

sizeInMemoryAsync

public RFuture<Long> sizeInMemoryAsync()

Description copied from interface: RObjectAsync

Returns bytes amount used by object in Redis memory.

Specified by:

sizeInMemoryAsync in interface RObjectAsync

Overrides:

sizeInMemoryAsync in class RedissonObject

Returns:

size in bytes

expireAsync

public RFuture<Boolean> expireAsync(long timeToLive,
                                    TimeUnit timeUnit)

Description copied from interface: RExpirableAsync

Set a timeout for object in async mode. After the timeout has expired, the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAtAsync

protected RFuture<Boolean> expireAtAsync(long timestamp,
                                         String... keys)

clearExpireAsync

public RFuture<Boolean> clearExpireAsync()

Description copied from interface: RExpirableAsync

Clear an expire timeout or expire date for object in async mode. Object will not be deleted.

Specified by:

clearExpireAsync in interface RExpirableAsync

Returns:

true if the timeout was cleared and false if not

removeListenerAsync

public RFuture<Void> removeListenerAsync(String... listenerIds)

Description copied from interface: RReliableTopicAsync

Removes the listener by id attached to this topic instance

Specified by:

removeListenerAsync in interface RReliableTopicAsync

Parameters:

listenerIds - - listener ids

Returns:

void

countSubscribers

public int countSubscribers()

Description copied from interface: RReliableTopic

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

Specified by:

countSubscribers in interface RReliableTopic

Returns:

amount of subscribers

countSubscribersAsync

public RFuture<Integer> countSubscribersAsync()

Description copied from interface: RReliableTopicAsync

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

Specified by:

countSubscribersAsync in interface RReliableTopicAsync

Returns:

amount of subscribers

expire

public boolean expire(long timeToLive,
                      TimeUnit timeUnit)

Description copied from interface: RExpirable

Set a timeout for object. After the timeout has expired, the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

timeToLive - - timeout before object will be deleted

timeUnit - - timeout time unit

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(long timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(long timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date in milliseconds (Unix timestamp)

Returns:

true if the timeout was set and false if not

expire

public boolean expire(Instant instant)

Description copied from interface: RExpirable

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expire in interface RExpirable

Parameters:

instant - - expire date

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(Instant instant)

Description copied from interface: RExpirableAsync

Set an expire date for object. When expire date comes the key will automatically be deleted.

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

instant - - expire date

Returns:

true if the timeout was set and false if not

expireAt

public boolean expireAt(Date timestamp)

Description copied from interface: RExpirable

Use RExpirable.expire(Instant) instead

Specified by:

expireAt in interface RExpirable

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

expireAtAsync

public RFuture<Boolean> expireAtAsync(Date timestamp)

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Instant) instead

Specified by:

expireAtAsync in interface RExpirableAsync

Parameters:

timestamp - - expire date

Returns:

true if the timeout was set and false if not

clearExpire

public boolean clearExpire()

Description copied from interface: RExpirable

Clear an expire timeout or expire date for object.

Specified by:

clearExpire in interface RExpirable

Returns:

true if timeout was removed false if object does not exist or does not have an associated timeout

remainTimeToLive

public long remainTimeToLive()

Description copied from interface: RExpirable

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLive in interface RExpirable

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

remainTimeToLiveAsync

public RFuture<Long> remainTimeToLiveAsync()

Description copied from interface: RExpirableAsync

Remaining time to live of Redisson object that has a timeout

Specified by:

remainTimeToLiveAsync in interface RExpirableAsync

Returns:

time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.

expireAsync

protected RFuture<Boolean> expireAsync(long timeToLive,
                                       TimeUnit timeUnit,
                                       String... keys)

clearExpireAsync

protected RFuture<Boolean> clearExpireAsync(String... keys)