Package org.redisson.api

Interface RStreamAsync<K,V>

Type Parameters:

K - key type

V - value type

All Superinterfaces:

RExpirableAsync, RObjectAsync

All Known Subinterfaces:

RStream<K,V>

All Known Implementing Classes:

RedissonStream

public interface RStreamAsync<K,V>
extends RExpirableAsync

Async interface for Redis Stream object.

Requires Redis 5.0.0 and higher.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method	Description
RFuture<Long>	ackAsync(String groupName, StreamMessageId... ids)	Marks pending messages by group name and stream ids as correctly processed.
RFuture<StreamMessageId>	addAllAsync(Map<K,V> entries)	Deprecated.
RFuture<StreamMessageId>	addAllAsync(Map<K,V> entries, int trimLen, boolean trimStrict)	Deprecated.
RFuture<Void>	addAllAsync(StreamMessageId id, Map<K,V> entries)	Deprecated.
RFuture<Void>	addAllAsync(StreamMessageId id, Map<K,V> entries, int trimLen, boolean trimStrict)	Deprecated.
RFuture<StreamMessageId>	addAsync(K key, V value)	Deprecated.
RFuture<StreamMessageId>	addAsync(K key, V value, int trimLen, boolean trimStrict)	Deprecated.
RFuture<StreamMessageId>	addAsync(StreamAddArgs<K,V> args)	Appends a new entry/entries and returns generated Stream Message ID
RFuture<Void>	addAsync(StreamMessageId id, K key, V value)	Deprecated.
RFuture<Void>	addAsync(StreamMessageId id, K key, V value, int trimLen, boolean trimStrict)	Deprecated.
RFuture<Void>	addAsync(StreamMessageId id, StreamAddArgs<K,V> args)	Appends a new entry/entries by specified Stream Message ID
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.
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.
RFuture<Void>	createConsumerAsync(String groupName, String consumerName)	Creates consumer of the group by name.
RFuture<Void>	createGroupAsync(String groupName)	Creates consumer group by name.
RFuture<Void>	createGroupAsync(String groupName, StreamMessageId id)	Creates consumer group by name and stream id.
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.
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.
RFuture<StreamInfo<K,V>>	getInfoAsync()	Returns information about this stream.
RFuture<PendingResult>	getPendingInfoAsync(String groupName)	Returns common info about pending messages by group name.
RFuture<List<StreamConsumer>>	listConsumersAsync(String groupName)	Returns list of objects with information about group customers for specified groupName.
RFuture<List<StreamGroup>>	listGroupsAsync()	Returns list of objects with information about groups belonging to this stream.
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.
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.
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).
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).
RFuture<Map<StreamMessageId,Map<K,V>>>	readAsync(int count, long timeout, TimeUnit unit, StreamMessageId... ids)	Deprecated.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(int count, long timeout, TimeUnit unit, StreamMessageId id, String name2, StreamMessageId id2)	Deprecated.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(int count, long timeout, TimeUnit unit, StreamMessageId id, String name2, StreamMessageId id2, String name3, StreamMessageId id3)	Deprecated.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(int count, long timeout, TimeUnit unit, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Deprecated.
RFuture<Map<StreamMessageId,Map<K,V>>>	readAsync(int count, StreamMessageId... ids)	Deprecated.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(int count, StreamMessageId id, String name2, StreamMessageId id2)	Deprecated.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(int count, StreamMessageId id, String name2, StreamMessageId id2, String name3, StreamMessageId id3)	Deprecated.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(int count, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Deprecated.
RFuture<Map<StreamMessageId,Map<K,V>>>	readAsync(long timeout, TimeUnit unit, StreamMessageId... ids)	Deprecated.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(long timeout, TimeUnit unit, StreamMessageId id, String name2, StreamMessageId id2)	Deprecated.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(long timeout, TimeUnit unit, StreamMessageId id, String name2, StreamMessageId id2, String name3, StreamMessageId id3)	Deprecated.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(long timeout, TimeUnit unit, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Deprecated.
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.
RFuture<Map<StreamMessageId,Map<K,V>>>	readAsync(StreamMessageId... ids)	Deprecated.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(StreamMessageId id, String name2, StreamMessageId id2)	Deprecated.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(StreamMessageId id, String name2, StreamMessageId id2, String name3, StreamMessageId id3)	Deprecated.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readAsync(StreamMessageId id, Map<String,StreamMessageId> nameToId)	Deprecated.
RFuture<Map<StreamMessageId,Map<K,V>>>	readGroupAsync(String groupName, String consumerName, int count, long timeout, TimeUnit unit, StreamMessageId... ids)	Read stream data from groupName by consumerName and specified collection of Stream IDs.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroupAsync(String groupName, String consumerName, int count, long timeout, TimeUnit unit, StreamMessageId id, String key2, StreamMessageId id2)	Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroupAsync(String groupName, String consumerName, int count, long timeout, TimeUnit unit, StreamMessageId id, String key2, StreamMessageId id2, String key3, StreamMessageId id3)	Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.
RFuture<Map<StreamMessageId,Map<K,V>>>	readGroupAsync(String groupName, String consumerName, int count, StreamMessageId... ids)	Read stream data from groupName by consumerName and specified collection of Stream IDs.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroupAsync(String groupName, String consumerName, int count, StreamMessageId id, String key2, StreamMessageId id2)	Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroupAsync(String groupName, String consumerName, int count, StreamMessageId id, String key2, StreamMessageId id2, String key3, StreamMessageId id3)	Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroupAsync(String groupName, String consumerName, int count, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.
RFuture<Map<StreamMessageId,Map<K,V>>>	readGroupAsync(String groupName, String consumerName, long timeout, TimeUnit unit, StreamMessageId... ids)	Read stream data from groupName by consumerName and specified collection of Stream IDs.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroupAsync(String groupName, String consumerName, long timeout, TimeUnit unit, StreamMessageId id, String key2, StreamMessageId id2)	Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroupAsync(String groupName, String consumerName, long timeout, TimeUnit unit, StreamMessageId id, String key2, StreamMessageId id2, String key3, StreamMessageId id3)	Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroupAsync(String groupName, String consumerName, long timeout, TimeUnit unit, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.
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.
RFuture<Map<StreamMessageId,Map<K,V>>>	readGroupAsync(String groupName, String consumerName, StreamMessageId... ids)	Read stream data from groupName by consumerName and specified collection of Stream IDs.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroupAsync(String groupName, String consumerName, StreamMessageId id, String key2, StreamMessageId id2)	Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroupAsync(String groupName, String consumerName, StreamMessageId id, String key2, StreamMessageId id2, String key3, StreamMessageId id3)	Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroupAsync(String groupName, String consumerName, StreamMessageId id, Map<String,StreamMessageId> nameToId)	Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.
RFuture<Long>	removeAsync(StreamMessageId... ids)	Removes messages by id.
RFuture<Long>	removeConsumerAsync(String groupName, String consumerName)	Removes consumer of the group by name.
RFuture<Void>	removeGroupAsync(String groupName)	Removes group by name.
RFuture<Long>	sizeAsync()	Returns number of entries in stream
RFuture<Long>	trimAsync(int size)	Trims stream using MAXLEN strategy to specified size
RFuture<Long>	trimAsync(TrimStrategy strategy, int threshold)	Trims stream to specified size
RFuture<Long>	trimNonStrictAsync(int size)	Trims stream using MAXLEN strategy to almost exact trimming threshold.
RFuture<Long>	trimNonStrictAsync(TrimStrategy strategy, int threshold)	Trims stream using almost exact trimming threshold.
RFuture<Long>	trimNonStrictAsync(TrimStrategy strategy, int threshold, int limit)	Trims stream using almost exact trimming threshold up to limit.
RFuture<Void>	updateGroupMessageIdAsync(String groupName, StreamMessageId id)	Updates next message id delivered to consumers.

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

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

Method Detail

createGroupAsync

RFuture<Void> createGroupAsync(String groupName)

Creates consumer group by name.

Parameters:

groupName - - name of group

Returns:

void

createGroupAsync

RFuture<Void> createGroupAsync(String groupName,
                               StreamMessageId id)

Creates consumer group by name and stream id. Only new messages after defined stream id will be available for consumers of this group.

StreamMessageId.NEWEST is used for messages arrived since the moment of group creating

Parameters:

groupName - - name of group

id - - stream id

Returns:

void

removeGroupAsync

RFuture<Void> removeGroupAsync(String groupName)

Removes group by name.

Parameters:

groupName - - name of group

Returns:

void

createConsumerAsync

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

Creates consumer of the group by name.

Requires Redis 6.2.0 and higher.

Parameters:

groupName - - name of group

consumerName - - name of consumer

removeConsumerAsync

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

Removes consumer of the group by name.

Parameters:

groupName - - name of group

consumerName - - name of consumer

Returns:

number of pending messages owned by consumer

updateGroupMessageIdAsync

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

Updates next message id delivered to consumers.

Parameters:

groupName - - name of group

id - - Stream Message ID

Returns:

void

ackAsync

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

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

Parameters:

groupName - - name of group

ids - - stream ids

Returns:

marked messages amount

getPendingInfoAsync

RFuture<PendingResult> getPendingInfoAsync(String groupName)

Returns common info about pending messages by group name.

Parameters:

groupName - - name of group

Returns:

result object

listPendingAsync

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

Parameters:

groupName - - name of group

startId - - start Stream Message ID

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

endId - - end Stream Message ID

count - - amount of messages

Returns:

list

See Also:

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

listPendingAsync

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

Parameters:

consumerName - - name of consumer

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:

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

listPendingAsync

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

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

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

list

See Also:

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

listPendingAsync

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

Parameters:

consumerName - - name of consumer

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

list

See Also:

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

pendingRangeAsync

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

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

Parameters:

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

map

See Also:

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

pendingRangeAsync

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

Parameters:

consumerName - - name of consumer

groupName - - name of group

startId - - start Stream Message ID

endId - - end Stream Message ID

count - - amount of messages

Returns:

map

See Also:

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

pendingRangeAsync

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

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:

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

pendingRangeAsync

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

Parameters:

consumerName - - name of consumer

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:

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

autoClaimAsync

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.

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

fastAutoClaimAsync

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.

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

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.

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

fastClaimAsync

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.

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

readGroupAsync

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.

Parameters:

args - - method arguments object

Returns:

stream data mapped by stream name and Stream Message ID

readGroupAsync

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

Read stream data from consumer group and current stream only.

Parameters:

args - - method arguments object

Returns:

stream data mapped by Stream Message ID

readGroupAsync

RFuture<Map<StreamMessageId,Map<K,V>>> readGroupAsync(String groupName,
                                                                  String consumerName,
                                                                  StreamMessageId... ids)

Read stream data from groupName by consumerName and specified collection of Stream IDs.

Parameters:

groupName - - name of group

consumerName - - name of consumer

ids - - collection of Stream IDs

Returns:

stream data mapped by Stream ID

readGroupAsync

RFuture<Map<StreamMessageId,Map<K,V>>> readGroupAsync(String groupName,
                                                                  String consumerName,
                                                                  int count,
                                                                  StreamMessageId... ids)

Read stream data from groupName by consumerName and specified collection of Stream IDs.

Parameters:

groupName - - name of group

consumerName - - name of consumer

count - - stream data size limit

ids - - collection of Stream IDs

Returns:

stream data mapped by Stream ID

readGroupAsync

RFuture<Map<StreamMessageId,Map<K,V>>> readGroupAsync(String groupName,
                                                                  String consumerName,
                                                                  long timeout,
                                                                  TimeUnit unit,
                                                                  StreamMessageId... ids)

Read stream data from groupName by consumerName and specified collection of Stream IDs. Wait for stream data availability for specified timeout interval.

Parameters:

groupName - - name of group

consumerName - - name of consumer

timeout - - time interval to wait for stream data availability

unit - - time interval unit

ids - - collection of Stream IDs

Returns:

stream data mapped by Stream ID

readGroupAsync

RFuture<Map<StreamMessageId,Map<K,V>>> readGroupAsync(String groupName,
                                                                  String consumerName,
                                                                  int count,
                                                                  long timeout,
                                                                  TimeUnit unit,
                                                                  StreamMessageId... ids)

Read stream data from groupName by consumerName and specified collection of Stream IDs. Wait for stream data availability for specified timeout interval.

Parameters:

groupName - - name of group

consumerName - - name of consumer

count - - stream data size limit

timeout - - time interval to wait for stream data availability

unit - - time interval unit

ids - - collection of Stream IDs

Returns:

stream data mapped by Stream ID

readGroupAsync

RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroupAsync(String groupName,
                                                                                    String consumerName,
                                                                                    StreamMessageId id,
                                                                                    Map<String,StreamMessageId> nameToId)

Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.

Parameters:

groupName - - name of group

consumerName - - name of consumer

id - - starting message id for this stream

nameToId - - Stream Message ID mapped by stream name

Returns:

stream data mapped by key and Stream Message ID

readGroupAsync

RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroupAsync(String groupName,
                                                                                    String consumerName,
                                                                                    int count,
                                                                                    StreamMessageId id,
                                                                                    Map<String,StreamMessageId> nameToId)

Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.

Parameters:

groupName - - name of group

consumerName - - name of consumer

count - - stream data size limit

id - - starting message id for this stream

nameToId - - Stream Message ID mapped by stream name

Returns:

stream data mapped by key and Stream Message ID

readGroupAsync

RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroupAsync(String groupName,
                                                                                    String consumerName,
                                                                                    int count,
                                                                                    long timeout,
                                                                                    TimeUnit unit,
                                                                                    StreamMessageId id,
                                                                                    String key2,
                                                                                    StreamMessageId id2)

Read stream data from groupName by consumerName, starting by specified message ids for this and other streams. Waits for the first stream data availability for specified timeout interval.

Parameters:

groupName - - name of group

consumerName - - name of consumer

count - - stream data size limit

timeout - - time interval to wait for stream data availability

unit - - time interval unit

id - - starting message id for this stream

key2 - - name of second stream

id2 - - starting message id for second stream

Returns:

stream data mapped by key and Stream Message ID

readGroupAsync

RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroupAsync(String groupName,
                                                                                    String consumerName,
                                                                                    int count,
                                                                                    long timeout,
                                                                                    TimeUnit unit,
                                                                                    StreamMessageId id,
                                                                                    String key2,
                                                                                    StreamMessageId id2,
                                                                                    String key3,
                                                                                    StreamMessageId id3)

Read stream data from groupName by consumerName, starting by specified message ids for this and other streams. Waits for the first stream data availability for specified timeout interval.

Parameters:

groupName - - name of group

consumerName - - name of consumer

count - - stream data size limit

timeout - - time interval to wait for stream data availability

unit - - time interval unit

id - - starting message id for this stream

key2 - - name of second stream

id2 - - starting message id for second stream

key3 - - name of third stream

id3 - - starting message id for third stream

Returns:

stream data mapped by key and Stream Message ID

readGroupAsync

RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroupAsync(String groupName,
                                                                                    String consumerName,
                                                                                    long timeout,
                                                                                    TimeUnit unit,
                                                                                    StreamMessageId id,
                                                                                    Map<String,StreamMessageId> nameToId)

Read stream data from groupName by consumerName, starting by specified message ids for this and other streams. Waits for the first stream data availability for specified timeout interval.

Parameters:

groupName - - name of group

consumerName - - name of consumer

timeout - - time interval to wait for stream data availability

unit - - time interval unit

id - - starting message id for this stream

nameToId - - Stream Message ID mapped by stream name

Returns:

stream data mapped by key and Stream Message ID

readGroupAsync

RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroupAsync(String groupName,
                                                                                    String consumerName,
                                                                                    StreamMessageId id,
                                                                                    String key2,
                                                                                    StreamMessageId id2)

Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.

Parameters:

groupName - - name of group

consumerName - - name of consumer

id - - starting message id for this stream

key2 - - name of second stream

id2 - - starting message id for second stream

Returns:

stream data mapped by key and Stream Message ID

readGroupAsync

RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroupAsync(String groupName,
                                                                                    String consumerName,
                                                                                    StreamMessageId id,
                                                                                    String key2,
                                                                                    StreamMessageId id2,
                                                                                    String key3,
                                                                                    StreamMessageId id3)

Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.

Parameters:

groupName - - name of group

consumerName - - name of consumer

id - - starting message id for this stream

key2 - - name of second stream

id2 - - starting message id for second stream

key3 - - name of third stream

id3 - - starting message id for third stream

Returns:

stream data mapped by key and Stream Message ID

readGroupAsync

RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroupAsync(String groupName,
                                                                                    String consumerName,
                                                                                    int count,
                                                                                    StreamMessageId id,
                                                                                    String key2,
                                                                                    StreamMessageId id2)

Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.

Parameters:

groupName - - name of group

consumerName - - name of consumer

count - - stream data size limit

id - - starting message id for this stream

key2 - - name of second stream

id2 - - starting message id for second stream

Returns:

stream data mapped by key and Stream Message ID

readGroupAsync

RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroupAsync(String groupName,
                                                                                    String consumerName,
                                                                                    int count,
                                                                                    StreamMessageId id,
                                                                                    String key2,
                                                                                    StreamMessageId id2,
                                                                                    String key3,
                                                                                    StreamMessageId id3)

Read stream data from groupName by consumerName, starting by specified message ids for this and other streams.

Parameters:

groupName - - name of group

consumerName - - name of consumer

count - - stream data size limit

id - - starting message id for this stream

key2 - - name of second stream

id2 - - starting message id for second stream

key3 - - name of third stream

id3 - - starting message id for third stream

Returns:

stream data mapped by key and Stream Message ID

readGroupAsync

RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroupAsync(String groupName,
                                                                                    String consumerName,
                                                                                    long timeout,
                                                                                    TimeUnit unit,
                                                                                    StreamMessageId id,
                                                                                    String key2,
                                                                                    StreamMessageId id2)

Read stream data from groupName by consumerName, starting by specified message ids for this and other streams. Waits for the first stream data availability for specified timeout interval.

Parameters:

groupName - - name of group

consumerName - - name of consumer

timeout - - time interval to wait for stream data availability

unit - - time interval unit

id - - starting message id for this stream

key2 - - name of second stream

id2 - - starting message id for second stream

Returns:

stream data mapped by key and Stream Message ID

readGroupAsync

RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroupAsync(String groupName,
                                                                                    String consumerName,
                                                                                    long timeout,
                                                                                    TimeUnit unit,
                                                                                    StreamMessageId id,
                                                                                    String key2,
                                                                                    StreamMessageId id2,
                                                                                    String key3,
                                                                                    StreamMessageId id3)

Read stream data from groupName by consumerName, starting by specified message ids for this and other streams. Waits for the first stream data availability for specified timeout interval.

Parameters:

groupName - - name of group

consumerName - - name of consumer

timeout - - time interval to wait for stream data availability

unit - - time interval unit

id - - starting message id for this stream

key2 - - name of second stream

id2 - - starting message id for second stream

key3 - - name of third stream

id3 - - starting message id for third stream

Returns:

stream data mapped by key and Stream Message ID

sizeAsync

RFuture<Long> sizeAsync()

Returns number of entries in stream

Returns:

size of stream

addAsync

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

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

Parameters:

args - - method arguments object

Returns:

Stream Message ID

addAsync

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

Appends a new entry/entries by specified Stream Message ID

Parameters:

id - - Stream Message ID

args - - method arguments object

addAsync

@Deprecated
RFuture<StreamMessageId> addAsync(K key,
                                  V value)

Deprecated.

addAsync

@Deprecated
RFuture<Void> addAsync(StreamMessageId id,
                       K key,
                       V value)

Deprecated.

addAsync

@Deprecated
RFuture<StreamMessageId> addAsync(K key,
                                  V value,
                                  int trimLen,
                                  boolean trimStrict)

Deprecated.

addAsync

@Deprecated
RFuture<Void> addAsync(StreamMessageId id,
                       K key,
                       V value,
                       int trimLen,
                       boolean trimStrict)

Deprecated.

addAllAsync

@Deprecated
RFuture<StreamMessageId> addAllAsync(Map<K,V> entries)

Deprecated.

addAllAsync

@Deprecated
RFuture<Void> addAllAsync(StreamMessageId id,
                          Map<K,V> entries)

Deprecated.

addAllAsync

@Deprecated
RFuture<StreamMessageId> addAllAsync(Map<K,V> entries,
                                     int trimLen,
                                     boolean trimStrict)

Deprecated.

addAllAsync

@Deprecated
RFuture<Void> addAllAsync(StreamMessageId id,
                          Map<K,V> entries,
                          int trimLen,
                          boolean trimStrict)

Deprecated.

readAsync

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

Read stream data from multiple streams including current.

Parameters:

args - - method arguments object

Returns:

stream data mapped by stream name and Stream Message ID

readAsync

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

Read stream data from current stream only.

Parameters:

args - - method arguments object

Returns:

stream data mapped by Stream Message ID

readAsync

@Deprecated
RFuture<Map<StreamMessageId,Map<K,V>>> readAsync(StreamMessageId... ids)

Deprecated.

readAsync

@Deprecated
RFuture<Map<StreamMessageId,Map<K,V>>> readAsync(int count,
                                                             StreamMessageId... ids)

Deprecated.

readAsync

@Deprecated
RFuture<Map<StreamMessageId,Map<K,V>>> readAsync(long timeout,
                                                             TimeUnit unit,
                                                             StreamMessageId... ids)

Deprecated.

readAsync

@Deprecated
RFuture<Map<StreamMessageId,Map<K,V>>> readAsync(int count,
                                                             long timeout,
                                                             TimeUnit unit,
                                                             StreamMessageId... ids)

Deprecated.

readAsync

@Deprecated
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(StreamMessageId id,
                                                                               String name2,
                                                                               StreamMessageId id2)

Deprecated.

readAsync

@Deprecated
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(StreamMessageId id,
                                                                               String name2,
                                                                               StreamMessageId id2,
                                                                               String name3,
                                                                               StreamMessageId id3)

Deprecated.

readAsync

@Deprecated
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(StreamMessageId id,
                                                                               Map<String,StreamMessageId> nameToId)

Deprecated.

readAsync

@Deprecated
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(int count,
                                                                               StreamMessageId id,
                                                                               String name2,
                                                                               StreamMessageId id2)

Deprecated.

readAsync

@Deprecated
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(int count,
                                                                               StreamMessageId id,
                                                                               String name2,
                                                                               StreamMessageId id2,
                                                                               String name3,
                                                                               StreamMessageId id3)

Deprecated.

readAsync

@Deprecated
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(int count,
                                                                               StreamMessageId id,
                                                                               Map<String,StreamMessageId> nameToId)

Deprecated.

readAsync

@Deprecated
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(long timeout,
                                                                               TimeUnit unit,
                                                                               StreamMessageId id,
                                                                               String name2,
                                                                               StreamMessageId id2)

Deprecated.

readAsync

@Deprecated
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(long timeout,
                                                                               TimeUnit unit,
                                                                               StreamMessageId id,
                                                                               String name2,
                                                                               StreamMessageId id2,
                                                                               String name3,
                                                                               StreamMessageId id3)

Deprecated.

readAsync

@Deprecated
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(long timeout,
                                                                               TimeUnit unit,
                                                                               StreamMessageId id,
                                                                               Map<String,StreamMessageId> nameToId)

Deprecated.

readAsync

@Deprecated
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(int count,
                                                                               long timeout,
                                                                               TimeUnit unit,
                                                                               StreamMessageId id,
                                                                               String name2,
                                                                               StreamMessageId id2)

Deprecated.

readAsync

@Deprecated
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(int count,
                                                                               long timeout,
                                                                               TimeUnit unit,
                                                                               StreamMessageId id,
                                                                               String name2,
                                                                               StreamMessageId id2,
                                                                               String name3,
                                                                               StreamMessageId id3)

Deprecated.

readAsync

@Deprecated
RFuture<Map<String,Map<StreamMessageId,Map<K,V>>>> readAsync(int count,
                                                                               long timeout,
                                                                               TimeUnit unit,
                                                                               StreamMessageId id,
                                                                               Map<String,StreamMessageId> nameToId)

Deprecated.

rangeAsync

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).

Parameters:

startId - - start Stream ID

endId - - end Stream ID

Returns:

stream data mapped by Stream ID

rangeAsync

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).

Parameters:

count - - stream data size limit

startId - - start Stream ID

endId - - end Stream ID

Returns:

stream data mapped by Stream ID

rangeReversedAsync

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).

Parameters:

startId - - start Stream ID

endId - - end Stream ID

Returns:

stream data mapped by Stream ID

rangeReversedAsync

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).

Parameters:

count - - stream data size limit

startId - - start Stream ID

endId - - end Stream ID

Returns:

stream data mapped by Stream ID

removeAsync

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

Removes messages by id.

Parameters:

ids - - id of messages to remove

Returns:

deleted messages amount

trimAsync

RFuture<Long> trimAsync(int size)

Trims stream using MAXLEN strategy to specified size

Parameters:

size - - new size of stream

Returns:

number of deleted messages

trimAsync

RFuture<Long> trimAsync(TrimStrategy strategy,
                        int threshold)

Trims stream to specified size

Parameters:

strategy - - trim strategy

threshold - - new size of stream

Returns:

number of deleted messages

trimNonStrictAsync

RFuture<Long> trimNonStrictAsync(int size)

Trims stream using MAXLEN strategy to almost exact trimming threshold.

Parameters:

size - - new size of stream

Returns:

number of deleted messages

trimNonStrictAsync

RFuture<Long> trimNonStrictAsync(TrimStrategy strategy,
                                 int threshold)

Trims stream using almost exact trimming threshold.

Parameters:

strategy - - trim strategy

threshold - - trim threshold

Returns:

number of deleted messages

trimNonStrictAsync

RFuture<Long> trimNonStrictAsync(TrimStrategy strategy,
                                 int threshold,
                                 int limit)

Trims stream using almost exact trimming threshold up to limit.

Parameters:

strategy - - trim strategy

threshold - - trim threshold

limit - - trim limit

Returns:

number of deleted messages

getInfoAsync

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

Returns information about this stream.

Returns:

info object

listGroupsAsync

RFuture<List<StreamGroup>> listGroupsAsync()

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

Returns:

list of info objects

listConsumersAsync

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

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

Parameters:

groupName - - name of group

Returns:

list of info objects