Package org.redisson

Class RedissonStream<K,V>

java.lang.Object

org.redisson.RedissonObject

org.redisson.RedissonStream<K,V>

Type Parameters:

K - key type

V - value type

All Implemented Interfaces:

RExpirable, RExpirableAsync, RObject, RObjectAsync, RStream<K,V>, RStreamAsync<K,V>

public class RedissonStream<K,V>
extends RedissonObject
implements RStream<K,V>

Author:

Nikita Koksharov

Field Summary

Fields inherited from class org.redisson.RedissonObject

codec, commandExecutor, name

Constructor Summary

Constructors

Constructor	Description
RedissonStream(Codec codec, CommandAsyncExecutor connectionManager, String name)
RedissonStream(CommandAsyncExecutor connectionManager, String name)

Method Summary

Modifier and Type	Method	Description
long	ack(String groupName, StreamMessageId... id)	Marks pending messages by group name and stream ids as correctly processed.
RFuture<Long>	ackAsync(String groupName, StreamMessageId... ids)	Marks pending messages by group name and stream ids as correctly processed.
StreamMessageId	add(StreamAddArgs<K,V> args)	Appends a new entry/entries and returns generated Stream Message ID
void	add(StreamMessageId id, StreamAddArgs<K,V> args)	Appends a new entry/entries by specified Stream Message ID
RFuture<StreamMessageId>	addAsync(StreamAddArgs<K,V> args)	Appends a new entry/entries and returns generated Stream Message ID
RFuture<Void>	addAsync(StreamMessageId id, StreamAddArgs<K,V> args)	Appends a new entry/entries by specified Stream Message ID
<R> RFuture<R>	addCustomAsync(StreamMessageId id, StreamAddArgs<K,V> args)
int	addListener(ObjectListener listener)	Adds object event listener
RFuture<Integer>	addListenerAsync(ObjectListener listener)	Adds object event listener
AutoClaimResult<K,V>	autoClaim(String groupName, String consumerName, long idleTime, TimeUnit idleTimeUnit, StreamMessageId startId, int count)	Transfers ownership of pending messages by id to a new consumer by name if idle time of messages and startId are greater than defined value.
RFuture<AutoClaimResult<K,V>>	autoClaimAsync(String groupName, String consumerName, long idleTime, TimeUnit idleTimeUnit, StreamMessageId startId, int count)	Transfers ownership of pending messages by id to a new consumer by name if idle time of messages and startId are greater than defined value.
protected void	checkKey(Object key)
protected void	checkValue(Object value)
Map<StreamMessageId,Map<K,V>>	claim(String groupName, String consumerName, long idleTime, TimeUnit idleTimeUnit, StreamMessageId... ids)	Transfers ownership of pending messages by id to a new consumer by name if idle time of messages is greater than defined value.
RFuture<Map<StreamMessageId,Map<K,V>>>	claimAsync(String groupName, String consumerName, long idleTime, TimeUnit idleTimeUnit, StreamMessageId... ids)	Transfers ownership of pending messages by id to a new consumer by name if idle time of messages is greater than defined value.
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)
void	createConsumer(String groupName, String consumerName)	Creates consumer of the group by name.
RFuture<Void>	createConsumerAsync(String groupName, String consumerName)	Creates consumer of the group by name.
void	createGroup(StreamCreateGroupArgs args)	Creates consumer group.
RFuture<Void>	createGroupAsync(StreamCreateGroupArgs args)	Creates consumer group.
boolean	expire(long timeToLive, TimeUnit timeUnit)	Use RExpirable.expire(Duration) instead
boolean	expire(Duration duration)	Sets a timeout for this object.
boolean	expire(Instant instant)	Sets an expiration date for this object.
RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit)	Use RExpirableAsync.expireAsync(Duration) instead
protected RFuture<Boolean>	expireAsync(long timeToLive, TimeUnit timeUnit, String param, String... keys)
RFuture<Boolean>	expireAsync(Duration duration)	Set a timeout for object.
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 param, String... keys)
RFuture<Boolean>	expireAtAsync(Date timestamp)	Use RExpirableAsync.expireAsync(Instant) instead
boolean	expireIfGreater(Duration duration)	Sets a timeout for this object only if it's greater than timeout set before.
boolean	expireIfGreater(Instant time)	Sets an expiration date for this object only if it's greater than expiration date set before.
RFuture<Boolean>	expireIfGreaterAsync(Duration duration)	Sets a timeout for this object only if it's greater than timeout set before.
RFuture<Boolean>	expireIfGreaterAsync(Instant time)	Sets an expiration date for this object only if it's greater than expiration date set before.
boolean	expireIfLess(Duration duration)	Sets a timeout for this object only if it's less than timeout set before.
boolean	expireIfLess(Instant time)	Sets an expiration date for this object only if it's less than expiration date set before.
RFuture<Boolean>	expireIfLessAsync(Duration duration)	Sets a timeout for this object only if it's less than timeout set before.
RFuture<Boolean>	expireIfLessAsync(Instant time)	Sets an expiration date for this object only if it's less than expiration date set before.
boolean	expireIfNotSet(Duration duration)	Sets a timeout for this object only if it hasn't been set before.
boolean	expireIfNotSet(Instant time)	Sets an expiration date for this object only if it hasn't been set before.
RFuture<Boolean>	expireIfNotSetAsync(Duration duration)	Sets a timeout for this object only if it hasn't been set before.
RFuture<Boolean>	expireIfNotSetAsync(Instant time)	Sets an expiration date for this object only if it hasn't been set before.
boolean	expireIfSet(Duration duration)	Sets a timeout for this object only if it has been already set.
boolean	expireIfSet(Instant time)	Sets an expiration date for this object only if it has been already set.
RFuture<Boolean>	expireIfSetAsync(Duration duration)	Sets a timeout for this object only if it has been already set.
RFuture<Boolean>	expireIfSetAsync(Instant time)	Sets an expiration date for this object only if it has been already set.
FastAutoClaimResult	fastAutoClaim(String groupName, String consumerName, long idleTime, TimeUnit idleTimeUnit, StreamMessageId startId, int count)	Transfers ownership of pending messages by id to a new consumer by name if idle time of messages and startId are greater than defined value.
RFuture<FastAutoClaimResult>	fastAutoClaimAsync(String groupName, String consumerName, long idleTime, TimeUnit idleTimeUnit, StreamMessageId startId, int count)	Transfers ownership of pending messages by id to a new consumer by name if idle time of messages and startId are greater than defined value.
List<StreamMessageId>	fastClaim(String groupName, String consumerName, long idleTime, TimeUnit idleTimeUnit, StreamMessageId... ids)	Transfers ownership of pending messages by id to a new consumer by name if idle time of messages is greater than defined value.
RFuture<List<StreamMessageId>>	fastClaimAsync(String groupName, String consumerName, long idleTime, TimeUnit idleTimeUnit, StreamMessageId... ids)	Transfers ownership of pending messages by id to a new consumer by name if idle time of messages is greater than defined value.
long	getExpireTime()	Expiration time of Redisson object that has a timeout
RFuture<Long>	getExpireTimeAsync()	Expiration time of Redisson object that has a timeout
StreamInfo<K,V>	getInfo()	Returns information about this stream.
RFuture<StreamInfo<K,V>>	getInfoAsync()	Returns information about this stream.
PendingResult	getPendingInfo(String groupName)	Returns common info about pending messages by group name.
RFuture<PendingResult>	getPendingInfoAsync(String groupName)	Returns common info about pending messages by group name.
List<StreamConsumer>	listConsumers(String groupName)	Returns list of common info about group customers for specified groupName.
RFuture<List<StreamConsumer>>	listConsumersAsync(String groupName)	Returns list of objects with information about group customers for specified groupName.
List<StreamGroup>	listGroups()	Returns list of common info about groups belonging to this stream.
RFuture<List<StreamGroup>>	listGroupsAsync()	Returns list of objects with information about groups belonging to this stream.
List<PendingEntry>	listPending(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, int count)	Returns list of common info about pending messages by group and consumer name.
List<PendingEntry>	listPending(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, long idleTime, TimeUnit idleTimeUnit, int count)	Returns stream data of pending messages by group and customer name.
List<PendingEntry>	listPending(String groupName, StreamMessageId startId, StreamMessageId endId, int count)	Returns list of common info about pending messages by group name.
List<PendingEntry>	listPending(String groupName, StreamMessageId startId, StreamMessageId endId, long idleTime, TimeUnit idleTimeUnit, int count)	Returns stream data of pending messages by group name.
RFuture<List<PendingEntry>>	listPendingAsync(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, int count)	Returns list of common info about pending messages by group and consumer name.
RFuture<List<PendingEntry>>	listPendingAsync(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, long idleTime, TimeUnit idleTimeUnit, int count)	Returns list of common info about pending messages by group and consumer name.
RFuture<List<PendingEntry>>	listPendingAsync(String groupName, StreamMessageId startId, StreamMessageId endId, int count)	Returns list of common info about pending messages by group name.
RFuture<List<PendingEntry>>	listPendingAsync(String groupName, StreamMessageId startId, StreamMessageId endId, long idleTime, TimeUnit idleTimeUnit, int count)	Returns list of common info about pending messages by group name.
Map<StreamMessageId,Map<K,V>>	pendingRange(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, int count)	Returns stream data of pending messages by group and customer name.
Map<StreamMessageId,Map<K,V>>	pendingRange(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, long idleTime, TimeUnit idleTimeUnit, int count)	Returns stream data of pending messages by group and customer name.
Map<StreamMessageId,Map<K,V>>	pendingRange(String groupName, StreamMessageId startId, StreamMessageId endId, int count)	Returns stream data of pending messages by group name.
Map<StreamMessageId,Map<K,V>>	pendingRange(String groupName, StreamMessageId startId, StreamMessageId endId, long idleTime, TimeUnit idleTimeUnit, int count)	Returns stream data of pending messages by group name.
RFuture<Map<StreamMessageId,Map<K,V>>>	pendingRangeAsync(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, int count)	Returns stream data of pending messages by group and customer name.
RFuture<Map<StreamMessageId,Map<K,V>>>	pendingRangeAsync(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, long idleTime, TimeUnit idleTimeUnit, int count)	Returns stream data of pending messages by group and customer name.
RFuture<Map<StreamMessageId,Map<K,V>>>	pendingRangeAsync(String groupName, StreamMessageId startId, StreamMessageId endId, int count)	Returns stream data of pending messages by group name.
RFuture<Map<StreamMessageId,Map<K,V>>>	pendingRangeAsync(String groupName, StreamMessageId startId, StreamMessageId endId, long idleTime, TimeUnit idleTimeUnit, int count)	Returns stream data of pending messages by group name.
Map<StreamMessageId,Map<K,V>>	range(int count, StreamMessageId startId, StreamMessageId endId)	Returns stream data in range by specified start Stream Message ID (included) and end Stream Message ID (included).
Map<StreamMessageId,Map<K,V>>	range(StreamMessageId startId, StreamMessageId endId)	Returns stream data in range by specified start Stream Message ID (included) and end Stream Message ID (included).
RFuture<Map<StreamMessageId,Map<K,V>>>	rangeAsync(int count, StreamMessageId startId, StreamMessageId endId)	Returns stream data in range by specified start Stream ID (included) and end Stream ID (included).
RFuture<Map<StreamMessageId,Map<K,V>>>	rangeAsync(StreamMessageId startId, StreamMessageId endId)	Returns stream data in range by specified start Stream ID (included) and end Stream ID (included).
Map<StreamMessageId,Map<K,V>>	rangeReversed(int count, StreamMessageId startId, StreamMessageId endId)	Returns stream data in reverse order in range by specified start Stream Message ID (included) and end Stream Message ID (included).
Map<StreamMessageId,Map<K,V>>	rangeReversed(StreamMessageId startId, StreamMessageId endId)	Returns stream data in reverse order in range by specified start Stream Message ID (included) and end Stream Message ID (included).
RFuture<Map<StreamMessageId,Map<K,V>>>	rangeReversedAsync(int count, StreamMessageId startId, StreamMessageId endId)	Returns stream data in reverse order in range by specified start Stream ID (included) and end Stream ID (included).
RFuture<Map<StreamMessageId,Map<K,V>>>	rangeReversedAsync(StreamMessageId startId, StreamMessageId endId)	Returns stream data in reverse order in range by specified start Stream ID (included) and end Stream ID (included).
Map<String,Map<StreamMessageId,Map<K,V>>>	read(StreamMultiReadArgs args)	Read stream data from multiple streams including current.
Map<StreamMessageId,Map<K,V>>	read(StreamReadArgs args)	Read stream data from current stream only.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(StreamMultiReadArgs args)	Read stream data from multiple streams including current.
RFuture<Map<StreamMessageId,Map<K,V>>>	readAsync(StreamReadArgs args)	Read stream data from current stream only.
Map<String,Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, StreamMultiReadGroupArgs args)	Read stream data from consumer group and multiple streams including current.
Map<StreamMessageId,Map<K,V>>	readGroup(String groupName, String consumerName, StreamReadGroupArgs args)	Read stream data from consumer group and current stream only.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroupAsync(String groupName, String consumerName, StreamMultiReadGroupArgs args)	Read stream data from consumer group and multiple streams including current.
RFuture<Map<StreamMessageId,Map<K,V>>>	readGroupAsync(String groupName, String consumerName, StreamReadGroupArgs args)	Read stream data from consumer group and current stream only.
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
long	remove(StreamMessageId... ids)	Removes messages by id.
RFuture<Long>	removeAsync(StreamMessageId... ids)	Removes messages by id.
long	removeConsumer(String groupName, String consumerName)	Removes consumer of the group by name.
RFuture<Long>	removeConsumerAsync(String groupName, String consumerName)	Removes consumer of the group by name.
void	removeGroup(String groupName)	Removes group by name.
RFuture<Void>	removeGroupAsync(String groupName)	Removes group by name.
void	removeListener(int listenerId)	Removes object event listener
RFuture<Void>	removeListenerAsync(int listenerId)	Removes object event listener
long	size()	Returns number of entries in stream
RFuture<Long>	sizeAsync()	Returns number of entries in stream
long	trim(StreamTrimArgs args)	Trims stream using strict trimming.
RFuture<Long>	trimAsync(StreamTrimArgs args)
long	trimNonStrict(StreamTrimArgs args)	Trims stream using non-strict trimming.
RFuture<Long>	trimNonStrictAsync(StreamTrimArgs args)
void	updateGroupMessageId(String groupName, StreamMessageId id)	Updates next message id delivered to consumers.
RFuture<Void>	updateGroupMessageIdAsync(String groupName, StreamMessageId id)	Updates next message id delivered to consumers.

Methods inherited from class org.redisson.RedissonObject

addListener, addListenerAsync, addTrackingListener, addTrackingListenerAsync, copy, copyAsync, delete, deleteAsync, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, getServiceManager, getSubscribeService, isExists, isExistsAsync, map, migrate, migrateAsync, move, moveAsync, prefixName, removeListener, removeListenerAsync, removeListenerAsync, removeTrackingListener, removeTrackingListenerAsync, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, 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, expire, expireAt, expireAt, expireIfGreater, expireIfGreater, expireIfLess, expireIfLess, expireIfNotSet, expireIfNotSet, expireIfSet, expireIfSet, getExpireTime, remainTimeToLive

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, expireIfGreaterAsync, expireIfGreaterAsync, expireIfLessAsync, expireIfLessAsync, expireIfNotSetAsync, expireIfNotSetAsync, expireIfSetAsync, expireIfSetAsync, getExpireTimeAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObject

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

Methods inherited from interface org.redisson.api.RObjectAsync

copyAsync, deleteAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync

Constructor Details

RedissonStream

public RedissonStream(Codec codec,
 CommandAsyncExecutor connectionManager,
 String name)

RedissonStream

public RedissonStream(CommandAsyncExecutor connectionManager,
 String name)

Method Details

checkKey

protected void checkKey(Object key)

checkValue

protected void checkValue(Object value)

createGroup

public void createGroup(StreamCreateGroupArgs args)

Description copied from interface: RStream

Creates consumer group.

Usage examples:

 StreamMessageId id = stream.createGroup(StreamCreateGroupArgs.name("test").id(id).makeStream());
 

Specified by:

createGroup in interface RStream<K,V>

Parameters:

args - method arguments object

createGroupAsync

public RFuture<Void> createGroupAsync(StreamCreateGroupArgs args)

Description copied from interface: RStreamAsync

Creates consumer group.

Usage examples:

 StreamMessageId id = stream.createGroup(StreamCreateGroupArgs.name("test").id(id).makeStream());
 

Specified by:

createGroupAsync in interface RStreamAsync<K,V>

Parameters:

args - method arguments object

ackAsync

public RFuture<Long> ackAsync(String groupName,
 StreamMessageId... ids)

Description copied from interface: RStreamAsync

Marks pending messages by group name and stream ids as correctly processed.

Specified by:

ackAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

ids - - stream ids

Returns:

marked messages amount

ack

public long ack(String groupName,
 StreamMessageId... id)

Description copied from interface: RStream

Marks pending messages by group name and stream ids as correctly processed.

Specified by:

ack in interface RStream<K,V>

Parameters:

groupName - - name of group

id - - Stream Message IDs

Returns:

marked messages amount

getPendingInfoAsync

public RFuture<PendingResult> getPendingInfoAsync(String groupName)

Description copied from interface: RStreamAsync

Returns common info about pending messages by group name.

Specified by:

getPendingInfoAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

Returns:

result object

getPendingInfo

public PendingResult getPendingInfo(String groupName)

Description copied from interface: RStream

Returns common info about pending messages by group name.

Specified by:

getPendingInfo in interface RStream<K,V>

Parameters:

groupName - - name of group

Returns:

result object

listPendingAsync

public RFuture<List<PendingEntry>> listPendingAsync(String groupName,
 String consumerName,
 StreamMessageId startId,
 StreamMessageId endId,
 int count)

Description copied from interface: RStreamAsync

Returns list of common info about pending messages by group and consumer name. Limited by start Stream Message ID and end Stream Message ID and count.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Specified by:

listPendingAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

list

See Also:

• RStreamAsync.pendingRangeAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, int)

listPendingAsync

public RFuture<List<PendingEntry>> listPendingAsync(String groupName,
 StreamMessageId startId,
 StreamMessageId endId,
 int count)

Description copied from interface: RStreamAsync

Returns list of common info about pending messages by group name. Limited by start Stream Message ID and end Stream Message ID and count.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Specified by:

listPendingAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

list

See Also:

• RStreamAsync.pendingRangeAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, int)

listPendingAsync

public RFuture<List<PendingEntry>> listPendingAsync(String groupName,
 StreamMessageId startId,
 StreamMessageId endId,
 long idleTime,
 TimeUnit idleTimeUnit,
 int count)

Description copied from interface: RStreamAsync

Returns list of common info about pending messages by group name. Limited by minimum idle time, messages count, start and end Stream Message IDs.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Requires Redis 6.2.0 and higher.

Specified by:

listPendingAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

count - - amount of messages

Returns:

list

See Also:

• RStreamAsync.pendingRangeAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, int)

listPendingAsync

public RFuture<List<PendingEntry>> listPendingAsync(String groupName,
 String consumerName,
 StreamMessageId startId,
 StreamMessageId endId,
 long idleTime,
 TimeUnit idleTimeUnit,
 int count)

Description copied from interface: RStreamAsync

Returns list of common info about pending messages by group and consumer name. Limited by minimum idle time, messages count, start and end Stream Message IDs.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Requires Redis 6.2.0 and higher.

Specified by:

listPendingAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

startId - - start Stream Message ID

endId - - end Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

count - - amount of messages

Returns:

list

See Also:

• RStreamAsync.pendingRangeAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, int)

listPending

public List<PendingEntry> listPending(String groupName,
 StreamMessageId startId,
 StreamMessageId endId,
 int count)

Description copied from interface: RStream

Returns list of common info about pending messages by group name. Limited by start Stream Message ID and end Stream Message ID and count.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Specified by:

listPending in interface RStream<K,V>

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

list

See Also:

• RStreamAsync.pendingRangeAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, int)

listPending

public List<PendingEntry> listPending(String groupName,
 String consumerName,
 StreamMessageId startId,
 StreamMessageId endId,
 int count)

Description copied from interface: RStream

Returns list of common info about pending messages by group and consumer name. Limited by start Stream Message ID and end Stream Message ID and count.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Specified by:

listPending in interface RStream<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

list

See Also:

• RStreamAsync.pendingRangeAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, int)

listPending

public List<PendingEntry> listPending(String groupName,
 StreamMessageId startId,
 StreamMessageId endId,
 long idleTime,
 TimeUnit idleTimeUnit,
 int count)

Description copied from interface: RStream

Returns stream data of pending messages by group name. Limited by minimum idle time, messages count, start and end Stream Message IDs.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Requires Redis 6.2.0 and higher.

Specified by:

listPending in interface RStream<K,V>

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

count - - amount of messages

Returns:

map

See Also:

• RStreamAsync.listPendingAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, long, java.util.concurrent.TimeUnit, int)

listPending

public List<PendingEntry> listPending(String groupName,
 String consumerName,
 StreamMessageId startId,
 StreamMessageId endId,
 long idleTime,
 TimeUnit idleTimeUnit,
 int count)

Description copied from interface: RStream

Returns stream data of pending messages by group and customer name. Limited by minimum idle time, messages count, start and end Stream Message IDs.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Requires Redis 6.2.0 and higher.

Specified by:

listPending in interface RStream<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

startId - - start Stream Message ID

endId - - end Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

count - - amount of messages

Returns:

map

See Also:

• RStreamAsync.listPendingAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, long, java.util.concurrent.TimeUnit, int)

fastClaim

public List<StreamMessageId> fastClaim(String groupName,
 String consumerName,
 long idleTime,
 TimeUnit idleTimeUnit,
 StreamMessageId... ids)

Description copied from interface: RStream

Transfers ownership of pending messages by id to a new consumer by name if idle time of messages is greater than defined value.

Specified by:

fastClaim in interface RStream<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

ids - - Stream Message IDs

Returns:

list of Stream Message IDs

fastClaimAsync

public RFuture<List<StreamMessageId>> fastClaimAsync(String groupName,
 String consumerName,
 long idleTime,
 TimeUnit idleTimeUnit,
 StreamMessageId... ids)

Description copied from interface: RStreamAsync

Transfers ownership of pending messages by id to a new consumer by name if idle time of messages is greater than defined value.

Specified by:

fastClaimAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

ids - - Stream Message IDs

Returns:

list of Stream Message IDs

autoClaim

public AutoClaimResult<K,V> autoClaim(String groupName,
 String consumerName,
 long idleTime,
 TimeUnit idleTimeUnit,
 StreamMessageId startId,
 int count)

Description copied from interface: RStream

Transfers ownership of pending messages by id to a new consumer by name if idle time of messages and startId are greater than defined value.

Specified by:

autoClaim in interface RStream<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

startId - - start Stream Message ID

Returns:

stream data mapped by Stream ID

autoClaimAsync

public RFuture<AutoClaimResult<K,V>> autoClaimAsync(String groupName,
 String consumerName,
 long idleTime,
 TimeUnit idleTimeUnit,
 StreamMessageId startId,
 int count)

Description copied from interface: RStreamAsync

Transfers ownership of pending messages by id to a new consumer by name if idle time of messages and startId are greater than defined value.

Specified by:

autoClaimAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

startId - - start Stream Message ID

Returns:

stream data mapped by Stream ID

fastAutoClaim

public FastAutoClaimResult fastAutoClaim(String groupName,
 String consumerName,
 long idleTime,
 TimeUnit idleTimeUnit,
 StreamMessageId startId,
 int count)

Description copied from interface: RStream

Transfers ownership of pending messages by id to a new consumer by name if idle time of messages and startId are greater than defined value.

Specified by:

fastAutoClaim in interface RStream<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

startId - - start Stream Message ID

Returns:

list of Stream Message IDs

readGroup

public Map<String,Map<StreamMessageId,Map<K,V>>> readGroup(String groupName,
 String consumerName,
 StreamMultiReadGroupArgs args)

Description copied from interface: RStream

Read stream data from consumer group and multiple streams including current.

Usage examples:

 Map result = stream.read("group1", "consumer1",  StreamMultiReadGroupArgs.greaterThan(id, "stream2", id2));
 

 Map result = stream.read("group1", "consumer1", StreamMultiReadGroupArgs.greaterThan(id, "stream2", id2)
                                                                          .count(100)
                                                                          .timeout(Duration.ofSeconds(5))));
 

Specified by:

readGroup in interface RStream<K,V>

Parameters:

args - - method arguments object

Returns:

stream data mapped by stream name and Stream Message ID

readGroup

public Map<StreamMessageId,Map<K,V>> readGroup(String groupName,
 String consumerName,
 StreamReadGroupArgs args)

Description copied from interface: RStream

Read stream data from consumer group and current stream only.

Usage examples:

 Map result = stream.read("group1", "consumer1",  StreamReadGroupArgs.greaterThan(id));
 

 Map result = stream.read("group1", "consumer1", StreamReadGroupArgs.greaterThan(id)
                                                                          .count(100)
                                                                          .timeout(Duration.ofSeconds(5))));
 

Specified by:

readGroup in interface RStream<K,V>

Parameters:

args - - method arguments object

Returns:

stream data mapped by Stream Message ID

readGroupAsync

public RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroupAsync(String groupName,
 String consumerName,
 StreamMultiReadGroupArgs args)

Description copied from interface: RStreamAsync

Read stream data from consumer group and multiple streams including current.

Specified by:

readGroupAsync in interface RStreamAsync<K,V>

Parameters:

args - - method arguments object

Returns:

stream data mapped by stream name and Stream Message ID

readGroupAsync

public RFuture<Map<StreamMessageId,Map<K,V>>> readGroupAsync(String groupName,
 String consumerName,
 StreamReadGroupArgs args)

Description copied from interface: RStreamAsync

Read stream data from consumer group and current stream only.

Specified by:

readGroupAsync in interface RStreamAsync<K,V>

Parameters:

args - - method arguments object

Returns:

stream data mapped by Stream Message ID

fastAutoClaimAsync

public RFuture<FastAutoClaimResult> fastAutoClaimAsync(String groupName,
 String consumerName,
 long idleTime,
 TimeUnit idleTimeUnit,
 StreamMessageId startId,
 int count)

Description copied from interface: RStreamAsync

Transfers ownership of pending messages by id to a new consumer by name if idle time of messages and startId are greater than defined value.

Specified by:

fastAutoClaimAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

startId - - start Stream Message ID

Returns:

list of Stream Message IDs

claimAsync

public RFuture<Map<StreamMessageId,Map<K,V>>> claimAsync(String groupName,
 String consumerName,
 long idleTime,
 TimeUnit idleTimeUnit,
 StreamMessageId... ids)

Description copied from interface: RStreamAsync

Transfers ownership of pending messages by id to a new consumer by name if idle time of messages is greater than defined value.

Specified by:

claimAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

ids - - Stream Message IDs

Returns:

stream data mapped by Stream ID

claim

public Map<StreamMessageId,Map<K,V>> claim(String groupName,
 String consumerName,
 long idleTime,
 TimeUnit idleTimeUnit,
 StreamMessageId... ids)

Description copied from interface: RStream

Transfers ownership of pending messages by id to a new consumer by name if idle time of messages is greater than defined value.

Specified by:

claim in interface RStream<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

ids - - Stream Message IDs

Returns:

stream data mapped by Stream Message ID

size

public long size()

Description copied from interface: RStream

Returns number of entries in stream

Specified by:

size in interface RStream<K,V>

Returns:

size of stream

sizeAsync

public RFuture<Long> sizeAsync()

Description copied from interface: RStreamAsync

Returns number of entries in stream

Specified by:

sizeAsync in interface RStreamAsync<K,V>

Returns:

size of stream

read

public Map<String,Map<StreamMessageId,Map<K,V>>> read(StreamMultiReadArgs args)

Description copied from interface: RStream

Read stream data from multiple streams including current.

Usage examples:

 Map result = stream.read(StreamMultiReadArgs.greaterThan(id, "stream2", id2));
 

 Map result = stream.read(StreamMultiReadArgs.greaterThan(id, "stream2", id2)
                                 .count(100)
                                 .timeout(Duration.ofSeconds(5))));
 

Specified by:

read in interface RStream<K,V>

Parameters:

args - - method arguments object

Returns:

stream data mapped by stream name and Stream Message ID

readAsync

public RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(StreamMultiReadArgs args)

Description copied from interface: RStreamAsync

Read stream data from multiple streams including current.

Specified by:

readAsync in interface RStreamAsync<K,V>

Parameters:

args - - method arguments object

Returns:

stream data mapped by stream name and Stream Message ID

read

public Map<StreamMessageId,Map<K,V>> read(StreamReadArgs args)

Description copied from interface: RStream

Read stream data from current stream only.

Usage examples:

 Map result = stream.read(StreamReadArgs.greaterThan(id));
 

 Map result = stream.read(StreamReadArgs.greaterThan(id)
                                 .count(100)
                                 .timeout(Duration.ofSeconds(5))));
 

Specified by:

read in interface RStream<K,V>

Parameters:

args - - method arguments object

Returns:

stream data mapped by Stream Message ID

readAsync

public RFuture<Map<StreamMessageId,Map<K,V>>> readAsync(StreamReadArgs args)

Description copied from interface: RStreamAsync

Read stream data from current stream only.

Specified by:

readAsync in interface RStreamAsync<K,V>

Parameters:

args - - method arguments object

Returns:

stream data mapped by Stream Message ID

add

public StreamMessageId add(StreamAddArgs<K,V> args)

Description copied from interface: RStream

Appends a new entry/entries and returns generated Stream Message ID

Usage examples:

 StreamMessageId id = stream.add(StreamAddArgs.entry(15, 37));
 

 StreamMessageId id = stream.add(StreamAddArgs.entries(15, 37, 23, 43)
                                 .trim(TrimStrategy.MAXLEN, 100)));
 

Specified by:

add in interface RStream<K,V>

Parameters:

args - - method arguments object

Returns:

Stream Message ID

add

public void add(StreamMessageId id,
 StreamAddArgs<K,V> args)

Description copied from interface: RStream

Appends a new entry/entries by specified Stream Message ID

Usage examples:

 stream.add(id, StreamAddArgs.entry(15, 37));
 

 stream.add(id, StreamAddArgs.entries(15, 37, 23, 43)
                                 .trim(TrimStrategy.MAXLEN, 100)));
 

Specified by:

add in interface RStream<K,V>

Parameters:

id - - Stream Message ID

args - - method arguments object

addAsync

public RFuture<StreamMessageId> addAsync(StreamAddArgs<K,V> args)

Description copied from interface: RStreamAsync

Appends a new entry/entries and returns generated Stream Message ID

Specified by:

addAsync in interface RStreamAsync<K,V>

Parameters:

args - - method arguments object

Returns:

Stream Message ID

addAsync

public RFuture<Void> addAsync(StreamMessageId id,
 StreamAddArgs<K,V> args)

Description copied from interface: RStreamAsync

Appends a new entry/entries by specified Stream Message ID

Specified by:

addAsync in interface RStreamAsync<K,V>

Parameters:

id - - Stream Message ID

args - - method arguments object

addCustomAsync

public <R> RFuture<R> addCustomAsync(StreamMessageId id,
 StreamAddArgs<K,V> args)

rangeAsync

public RFuture<Map<StreamMessageId,Map<K,V>>> rangeAsync(int count,
 StreamMessageId startId,
 StreamMessageId endId)

Description copied from interface: RStreamAsync

Returns stream data in range by specified start Stream ID (included) and end Stream ID (included).

Specified by:

rangeAsync in interface RStreamAsync<K,V>

Parameters:

count - - stream data size limit

startId - - start Stream ID

endId - - end Stream ID

Returns:

stream data mapped by Stream ID

range

public Map<StreamMessageId,Map<K,V>> range(int count,
 StreamMessageId startId,
 StreamMessageId endId)

Description copied from interface: RStream

Returns stream data in range by specified start Stream Message ID (included) and end Stream Message ID (included).

Specified by:

range in interface RStream<K,V>

Parameters:

count - - stream data size limit

startId - - start Stream Message ID

endId - - end Stream Message ID

Returns:

stream data mapped by Stream Message ID

rangeReversedAsync

public RFuture<Map<StreamMessageId,Map<K,V>>> rangeReversedAsync(int count,
 StreamMessageId startId,
 StreamMessageId endId)

Description copied from interface: RStreamAsync

Returns stream data in reverse order in range by specified start Stream ID (included) and end Stream ID (included).

Specified by:

rangeReversedAsync in interface RStreamAsync<K,V>

Parameters:

count - - stream data size limit

startId - - start Stream ID

endId - - end Stream ID

Returns:

stream data mapped by Stream ID

rangeReversed

public Map<StreamMessageId,Map<K,V>> rangeReversed(int count,
 StreamMessageId startId,
 StreamMessageId endId)

Description copied from interface: RStream

Returns stream data in reverse order in range by specified start Stream Message ID (included) and end Stream Message ID (included).

Specified by:

rangeReversed in interface RStream<K,V>

Parameters:

count - - stream data size limit

startId - - start Stream Message ID

endId - - end Stream Message ID

Returns:

stream data mapped by Stream Message ID

rangeAsync

public RFuture<Map<StreamMessageId,Map<K,V>>> rangeAsync(StreamMessageId startId,
 StreamMessageId endId)

Description copied from interface: RStreamAsync

Returns stream data in range by specified start Stream ID (included) and end Stream ID (included).

Specified by:

rangeAsync in interface RStreamAsync<K,V>

Parameters:

startId - - start Stream ID

endId - - end Stream ID

Returns:

stream data mapped by Stream ID

rangeReversedAsync

public RFuture<Map<StreamMessageId,Map<K,V>>> rangeReversedAsync(StreamMessageId startId,
 StreamMessageId endId)

Description copied from interface: RStreamAsync

Returns stream data in reverse order in range by specified start Stream ID (included) and end Stream ID (included).

Specified by:

rangeReversedAsync in interface RStreamAsync<K,V>

Parameters:

startId - - start Stream ID

endId - - end Stream ID

Returns:

stream data mapped by Stream ID

range

public Map<StreamMessageId,Map<K,V>> range(StreamMessageId startId,
 StreamMessageId endId)

Description copied from interface: RStream

Returns stream data in range by specified start Stream Message ID (included) and end Stream Message ID (included).

Specified by:

range in interface RStream<K,V>

Parameters:

startId - - start Stream Message ID

endId - - end Stream Message ID

Returns:

stream data mapped by Stream Message ID

rangeReversed

public Map<StreamMessageId,Map<K,V>> rangeReversed(StreamMessageId startId,
 StreamMessageId endId)

Description copied from interface: RStream

Returns stream data in reverse order in range by specified start Stream Message ID (included) and end Stream Message ID (included).

Specified by:

rangeReversed in interface RStream<K,V>

Parameters:

startId - - start Stream Message ID

endId - - end Stream Message ID

Returns:

stream data mapped by Stream Message ID

removeAsync

public RFuture<Long> removeAsync(StreamMessageId... ids)

Description copied from interface: RStreamAsync

Removes messages by id.

Specified by:

removeAsync in interface RStreamAsync<K,V>

Parameters:

ids - - id of messages to remove

Returns:

deleted messages amount

remove

public long remove(StreamMessageId... ids)

Description copied from interface: RStream

Removes messages by id.

Specified by:

remove in interface RStream<K,V>

Parameters:

ids - - id of messages to remove

Returns:

deleted messages amount

removeGroupAsync

public RFuture<Void> removeGroupAsync(String groupName)

Description copied from interface: RStreamAsync

Removes group by name.

Specified by:

removeGroupAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

Returns:

void

removeGroup

public void removeGroup(String groupName)

Description copied from interface: RStream

Removes group by name.

Specified by:

removeGroup in interface RStream<K,V>

Parameters:

groupName - - name of group

createConsumer

public void createConsumer(String groupName,
 String consumerName)

Description copied from interface: RStream

Creates consumer of the group by name.

Requires Redis 6.2.0 and higher.

Specified by:

createConsumer in interface RStream<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

createConsumerAsync

public RFuture<Void> createConsumerAsync(String groupName,
 String consumerName)

Description copied from interface: RStreamAsync

Creates consumer of the group by name.

Requires Redis 6.2.0 and higher.

Specified by:

createConsumerAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

removeConsumerAsync

public RFuture<Long> removeConsumerAsync(String groupName,
 String consumerName)

Description copied from interface: RStreamAsync

Removes consumer of the group by name.

Specified by:

removeConsumerAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

Returns:

number of pending messages owned by consumer

removeConsumer

public long removeConsumer(String groupName,
 String consumerName)

Description copied from interface: RStream

Removes consumer of the group by name.

Specified by:

removeConsumer in interface RStream<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

Returns:

number of pending messages owned by consumer

updateGroupMessageIdAsync

public RFuture<Void> updateGroupMessageIdAsync(String groupName,
 StreamMessageId id)

Description copied from interface: RStreamAsync

Updates next message id delivered to consumers.

Specified by:

updateGroupMessageIdAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

id - - Stream Message ID

Returns:

void

updateGroupMessageId

public void updateGroupMessageId(String groupName,
 StreamMessageId id)

Description copied from interface: RStream

Updates next message id delivered to consumers.

Specified by:

updateGroupMessageId in interface RStream<K,V>

Parameters:

groupName - - name of group

id - - Stream Message ID

getInfo

public StreamInfo<K,V> getInfo()

Description copied from interface: RStream

Returns information about this stream.

Specified by:

getInfo in interface RStream<K,V>

Returns:

info object

getInfoAsync

public RFuture<StreamInfo<K,V>> getInfoAsync()

Description copied from interface: RStreamAsync

Returns information about this stream.

Specified by:

getInfoAsync in interface RStreamAsync<K,V>

Returns:

info object

listGroups

public List<StreamGroup> listGroups()

Description copied from interface: RStream

Returns list of common info about groups belonging to this stream.

Specified by:

listGroups in interface RStream<K,V>

Returns:

list of info objects

listGroupsAsync

public RFuture<List<StreamGroup>> listGroupsAsync()

Description copied from interface: RStreamAsync

Returns list of objects with information about groups belonging to this stream.

Specified by:

listGroupsAsync in interface RStreamAsync<K,V>

Returns:

list of info objects

listConsumers

public List<StreamConsumer> listConsumers(String groupName)

Description copied from interface: RStream

Returns list of common info about group customers for specified groupName.

Specified by:

listConsumers in interface RStream<K,V>

Parameters:

groupName - - name of group

Returns:

list of info objects

listConsumersAsync

public RFuture<List<StreamConsumer>> listConsumersAsync(String groupName)

Description copied from interface: RStreamAsync

Returns list of objects with information about group customers for specified groupName.

Specified by:

listConsumersAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

Returns:

list of info objects

pendingRangeAsync

public RFuture<Map<StreamMessageId,Map<K,V>>> pendingRangeAsync(String groupName,
 StreamMessageId startId,
 StreamMessageId endId,
 int count)

Description copied from interface: RStreamAsync

Returns stream data of pending messages by group name. Limited by start Stream Message ID and end Stream Message ID and count.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Specified by:

pendingRangeAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

map

See Also:

• RStreamAsync.listPendingAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, long, java.util.concurrent.TimeUnit, int)

pendingRangeAsync

public RFuture<Map<StreamMessageId,Map<K,V>>> pendingRangeAsync(String groupName,
 String consumerName,
 StreamMessageId startId,
 StreamMessageId endId,
 int count)

Description copied from interface: RStreamAsync

Returns stream data of pending messages by group and customer name. Limited by start Stream Message ID and end Stream Message ID and count.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Specified by:

pendingRangeAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

map

See Also:

• RStreamAsync.listPendingAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, long, java.util.concurrent.TimeUnit, int)

pendingRangeAsync

public RFuture<Map<StreamMessageId,Map<K,V>>> pendingRangeAsync(String groupName,
 StreamMessageId startId,
 StreamMessageId endId,
 long idleTime,
 TimeUnit idleTimeUnit,
 int count)

Description copied from interface: RStreamAsync

Returns stream data of pending messages by group name. Limited by minimum idle time, messages count, start and end Stream Message IDs.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Requires Redis 6.2.0 and higher.

Specified by:

pendingRangeAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

count - - amount of messages

Returns:

map

See Also:

• RStreamAsync.listPendingAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, long, java.util.concurrent.TimeUnit, int)

pendingRangeAsync

public RFuture<Map<StreamMessageId,Map<K,V>>> pendingRangeAsync(String groupName,
 String consumerName,
 StreamMessageId startId,
 StreamMessageId endId,
 long idleTime,
 TimeUnit idleTimeUnit,
 int count)

Description copied from interface: RStreamAsync

Returns stream data of pending messages by group and customer name. Limited by minimum idle time, messages count, start and end Stream Message IDs.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Requires Redis 6.2.0 and higher.

Specified by:

pendingRangeAsync in interface RStreamAsync<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

startId - - start Stream Message ID

endId - - end Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

count - - amount of messages

Returns:

map

See Also:

• RStreamAsync.listPendingAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, long, java.util.concurrent.TimeUnit, int)

pendingRange

public Map<StreamMessageId,Map<K,V>> pendingRange(String groupName,
 StreamMessageId startId,
 StreamMessageId endId,
 long idleTime,
 TimeUnit idleTimeUnit,
 int count)

Description copied from interface: RStream

Returns stream data of pending messages by group name. Limited by minimum idle time, messages count, start and end Stream Message IDs.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Requires Redis 6.2.0 and higher.

Specified by:

pendingRange in interface RStream<K,V>

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

count - - amount of messages

Returns:

map

See Also:

• RStreamAsync.listPendingAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, long, java.util.concurrent.TimeUnit, int)

pendingRange

public Map<StreamMessageId,Map<K,V>> pendingRange(String groupName,
 String consumerName,
 StreamMessageId startId,
 StreamMessageId endId,
 long idleTime,
 TimeUnit idleTimeUnit,
 int count)

Description copied from interface: RStream

Returns stream data of pending messages by group and customer name. Limited by minimum idle time, messages count, start and end Stream Message IDs.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Requires Redis 6.2.0 and higher.

Specified by:

pendingRange in interface RStream<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

startId - - start Stream Message ID

endId - - end Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

count - - amount of messages

Returns:

map

See Also:

• RStreamAsync.listPendingAsync(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, long, java.util.concurrent.TimeUnit, int)

pendingRange

public Map<StreamMessageId,Map<K,V>> pendingRange(String groupName,
 String consumerName,
 StreamMessageId startId,
 StreamMessageId endId,
 int count)

Description copied from interface: RStream

Returns stream data of pending messages by group and customer name. Limited by start Stream Message ID and end Stream Message ID and count.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Specified by:

pendingRange in interface RStream<K,V>

Parameters:

groupName - - name of group

consumerName - - name of consumer

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

map

See Also:

• RStream.listPending(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, int)

pendingRange

public Map<StreamMessageId,Map<K,V>> pendingRange(String groupName,
 StreamMessageId startId,
 StreamMessageId endId,
 int count)

Description copied from interface: RStream

Returns stream data of pending messages by group name. Limited by start Stream Message ID and end Stream Message ID and count.

StreamMessageId.MAX is used as max Stream Message ID StreamMessageId.MIN is used as min Stream Message ID

Specified by:

pendingRange in interface RStream<K,V>

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

map

See Also:

• RStream.listPending(java.lang.String, org.redisson.api.StreamMessageId, org.redisson.api.StreamMessageId, int)

trim

public long trim(StreamTrimArgs args)

Description copied from interface: RStream

Trims stream using strict trimming.

Usage example:

 long result = stream.trim(StreamTrimArgs.maxLen(100).noLimit());
 

Specified by:

trim in interface RStream<K,V>

Parameters:

args - - method arguments object

Returns:

number of deleted messages

trimAsync

public RFuture<Long> trimAsync(StreamTrimArgs args)

Specified by:

trimAsync in interface RStreamAsync<K,V>

trimNonStrict

public long trimNonStrict(StreamTrimArgs args)

Description copied from interface: RStream

Trims stream using non-strict trimming.

Usage example:

 long result = stream.trimNonStrict(StreamTrimArgs.maxLen(100).noLimit());
 

Specified by:

trimNonStrict in interface RStream<K,V>

Parameters:

args - - method arguments object

Returns:

number of deleted messages

trimNonStrictAsync

public RFuture<Long> trimNonStrictAsync(StreamTrimArgs args)

Specified by:

trimNonStrictAsync in interface RStreamAsync<K,V>

addListenerAsync

public RFuture<Integer> addListenerAsync(ObjectListener listener)

Description copied from interface: RObjectAsync

Adds object event listener

Specified by:

addListenerAsync in interface RObjectAsync

Specified by:

addListenerAsync in interface RStreamAsync<K,V>

Overrides:

addListenerAsync in class RedissonObject

Parameters:

listener - - object event listener

Returns:

listener id

See Also:

• ExpiredObjectListener
• DeletedObjectListener

addListener

public int addListener(ObjectListener listener)

Description copied from interface: RObject

Adds object event listener

Specified by:

addListener in interface RObject

Specified by:

addListener in interface RStream<K,V>

Overrides:

addListener in class RedissonObject

Parameters:

listener - - object event listener

Returns:

listener id

See Also:

• ExpiredObjectListener
• DeletedObjectListener

removeListener

public void removeListener(int listenerId)

Description copied from interface: RObject

Removes object event listener

Specified by:

removeListener in interface RObject

Overrides:

removeListener in class RedissonObject

Parameters:

listenerId - - listener id

removeListenerAsync

public RFuture<Void> removeListenerAsync(int listenerId)

Description copied from interface: RObjectAsync

Removes object event listener

Specified by:

removeListenerAsync in interface RObjectAsync

Overrides:

removeListenerAsync in class RedissonObject

Parameters:

listenerId - - listener id

expire

public boolean expire(long timeToLive,
 TimeUnit timeUnit)

Description copied from interface: RExpirable

Use RExpirable.expire(Duration) instead

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

expireAsync

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

Description copied from interface: RExpirableAsync

Use RExpirableAsync.expireAsync(Duration) instead

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

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

Sets an expiration date for this 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

expireIfSet

public boolean expireIfSet(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSet in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfSetAsync

public RFuture<Boolean> expireIfSetAsync(Instant time)

Description copied from interface: RExpirableAsync

Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSetAsync in interface RExpirableAsync

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfNotSet

public boolean expireIfNotSet(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSet in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfNotSetAsync

public RFuture<Boolean> expireIfNotSetAsync(Instant time)

Description copied from interface: RExpirableAsync

Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSetAsync in interface RExpirableAsync

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfGreater

public boolean expireIfGreater(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreater in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfGreaterAsync

public RFuture<Boolean> expireIfGreaterAsync(Instant time)

Description copied from interface: RExpirableAsync

Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreaterAsync in interface RExpirableAsync

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfLess

public boolean expireIfLess(Instant time)

Description copied from interface: RExpirable

Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLess in interface RExpirable

Parameters:

time - expire date

Returns:

true if the timeout was set and false if not

expireIfLessAsync

public RFuture<Boolean> expireIfLessAsync(Instant time)

Description copied from interface: RExpirableAsync

Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLessAsync in interface RExpirableAsync

Parameters:

time - 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

expire

public boolean expire(Duration duration)

Description copied from interface: RExpirable

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

Specified by:

expire in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireAsync

public RFuture<Boolean> expireAsync(Duration duration)

Description copied from interface: RExpirableAsync

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

Specified by:

expireAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

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

expireIfSet

public boolean expireIfSet(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSet in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfSetAsync

public RFuture<Boolean> expireIfSetAsync(Duration duration)

Description copied from interface: RExpirableAsync

Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfSetAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfNotSet

public boolean expireIfNotSet(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSet in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfNotSetAsync

public RFuture<Boolean> expireIfNotSetAsync(Duration duration)

Description copied from interface: RExpirableAsync

Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfNotSetAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfGreater

public boolean expireIfGreater(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreater in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfGreaterAsync

public RFuture<Boolean> expireIfGreaterAsync(Duration duration)

Description copied from interface: RExpirableAsync

Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfGreaterAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfLess

public boolean expireIfLess(Duration duration)

Description copied from interface: RExpirable

Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLess in interface RExpirable

Parameters:

duration - timeout before object will be deleted

Returns:

true if the timeout was set and false if not

expireIfLessAsync

public RFuture<Boolean> expireIfLessAsync(Duration duration)

Description copied from interface: RExpirableAsync

Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.

Requires Redis 7.0.0 and higher.

Specified by:

expireIfLessAsync in interface RExpirableAsync

Parameters:

duration - timeout before object will be deleted

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

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

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.

getExpireTime

public long getExpireTime()

Description copied from interface: RExpirable

Expiration time of Redisson object that has a timeout

Requires Redis 7.0.0 and higher.

Specified by:

getExpireTime in interface RExpirable

Returns:

expiration time

getExpireTimeAsync

public RFuture<Long> getExpireTimeAsync()

Description copied from interface: RExpirableAsync

Expiration time of Redisson object that has a timeout

Requires Redis 7.0.0 and higher.

Specified by:

getExpireTimeAsync in interface RExpirableAsync

Returns:

expiration time

expireAsync

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

expireAtAsync

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

clearExpireAsync

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