org.redisson.api

Interface RStreamRx<K,V>

Type Parameters:

K - key type

V - value type

All Superinterfaces:

RExpirableRx, RObjectRx

public interface RStreamRx<K,V>
extends RExpirableRx

Reactive interface for Redis Stream object.

Requires Redis 5.0.0 and higher.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<Long>	ack(String groupName, StreamMessageId... ids) Marks pending messages by group name and stream ids as correctly processed.
io.reactivex.Single<StreamMessageId>	add(K key, V value) Appends a new entry and returns generated Stream ID
io.reactivex.Single<StreamMessageId>	add(K key, V value, int trimLen, boolean trimStrict) Appends a new entry and returns generated Stream ID.
io.reactivex.Completable	add(StreamMessageId id, K key, V value) Appends a new entry by specified Stream ID
io.reactivex.Completable	add(StreamMessageId id, K key, V value, int trimLen, boolean trimStrict) Appends a new entry by specified Stream ID.
io.reactivex.Single<StreamMessageId>	addAll(Map<K,V> entries) Appends new entries and returns generated Stream ID
io.reactivex.Single<StreamMessageId>	addAll(Map<K,V> entries, int trimLen, boolean trimStrict) Appends new entries and returns generated Stream ID.
io.reactivex.Completable	addAll(StreamMessageId id, Map<K,V> entries) Appends new entries by specified Stream ID
io.reactivex.Completable	addAll(StreamMessageId id, Map<K,V> entries, int trimLen, boolean trimStrict) Appends new entries by specified Stream ID.
io.reactivex.Single<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.
io.reactivex.Completable	createGroup(String groupName) Creates consumer group by name.
io.reactivex.Completable	createGroup(String groupName, StreamMessageId id) Creates consumer group by name and stream id.
io.reactivex.Single<StreamInfo<K,V>>	getInfo() Returns information about this stream.
io.reactivex.Single<PendingResult>	getPendingInfo(String groupName) Returns common info about pending messages by group name.
io.reactivex.Single<List<StreamConsumer>>	listConsumers(String groupName) Returns list of objects with information about group customers for specified groupName.
io.reactivex.Single<List<StreamGroup>>	listGroups() Returns list of objects with information about groups belonging to this stream.
io.reactivex.Single<PendingResult>	listPending(String groupName) Deprecated.
io.reactivex.Single<List<PendingEntry>>	listPending(String groupName, StreamMessageId startId, StreamMessageId endId, int count) Returns list of pending messages by group name.
io.reactivex.Single<List<PendingEntry>>	listPending(String groupName, String consumerName, StreamMessageId startId, StreamMessageId endId, int count) Returns list of pending messages by group name and consumer name.
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	pendingRange(String groupName, StreamMessageId startId, StreamMessageId endId, int count) Returns stream data of pending messages by group name.
io.reactivex.Single<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.
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	range(int count, StreamMessageId startId, StreamMessageId endId) Returns stream data in range by specified start Stream ID (included) and end Stream ID (included).
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	range(StreamMessageId startId, StreamMessageId endId) Returns stream data in range by specified start Stream ID (included) and end Stream ID (included).
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	rangeReversed(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).
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	rangeReversed(StreamMessageId startId, StreamMessageId endId) Returns stream data in reverse order in range by specified start Stream ID (included) and end Stream ID (included).
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	read(int count, long timeout, TimeUnit unit, StreamMessageId... ids) Read stream data by specified collection of Stream IDs.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	read(int count, long timeout, TimeUnit unit, StreamMessageId id, Map<String,StreamMessageId> nameToId) Read stream data by specified stream id mapped by name including this stream.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	read(int count, long timeout, TimeUnit unit, StreamMessageId id, String name2, StreamMessageId id2) Read stream data by specified stream name including this stream.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	read(int count, long timeout, TimeUnit unit, StreamMessageId id, String name2, StreamMessageId id2, String name3, StreamMessageId id3) Read stream data by specified stream names including this stream.
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	read(int count, StreamMessageId... ids) Read stream data by specified collection of Stream IDs.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	read(int count, StreamMessageId id, Map<String,StreamMessageId> nameToId) Read stream data by specified stream id mapped by name including this stream.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	read(int count, StreamMessageId id, String name2, StreamMessageId id2) Read stream data by specified stream name including this stream.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	read(int count, StreamMessageId id, String name2, StreamMessageId id2, String name3, StreamMessageId id3) Read stream data by specified stream names including this stream.
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	read(long timeout, TimeUnit unit, StreamMessageId... ids) Read stream data by specified collection of Stream IDs.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	read(long timeout, TimeUnit unit, StreamMessageId id, Map<String,StreamMessageId> nameToId) Read stream data by specified stream id mapped by name including this stream.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	read(long timeout, TimeUnit unit, StreamMessageId id, String name2, StreamMessageId id2) Read stream data by specified stream name including this stream.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	read(long timeout, TimeUnit unit, StreamMessageId id, String name2, StreamMessageId id2, String name3, StreamMessageId id3) Read stream data by specified stream names including this stream.
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	read(StreamMessageId... ids) Read stream data by specified collection of Stream IDs.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	read(StreamMessageId id, Map<String,StreamMessageId> nameToId) Read stream data by specified stream id mapped by name including this stream.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	read(StreamMessageId id, String name2, StreamMessageId id2) Read stream data by specified stream name including this stream.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	read(StreamMessageId id, String name2, StreamMessageId id2, String name3, StreamMessageId id3) Read stream data by specified stream names including this stream.
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	readGroup(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.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroup(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.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroup(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.
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, int count, StreamMessageId... ids) Read stream data from groupName by consumerName and specified collection of Stream IDs.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroup(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.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroup(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.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroup(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.
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, long timeout, TimeUnit unit, StreamMessageId... ids) Read stream data from groupName by consumerName and specified collection of Stream IDs.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroup(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.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroup(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.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroup(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.
io.reactivex.Single<Map<StreamMessageId,Map<K,V>>>	readGroup(String groupName, String consumerName, StreamMessageId... ids) Read stream data from groupName by consumerName and specified collection of Stream IDs.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroup(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.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroup(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.
io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>>	readGroup(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.
io.reactivex.Single<Long>	remove(StreamMessageId... ids) Removes messages by id.
io.reactivex.Single<Long>	removeConsumer(String groupName, String consumerName) Removes consumer of the group by name.
io.reactivex.Completable	removeGroup(String groupName) Removes group by name.
io.reactivex.Single<Long>	size() Returns number of entries in stream
io.reactivex.Single<Long>	trim(int size) Trims stream to specified size
io.reactivex.Single<Long>	trimNonStrict(int size) Trims stream to few tens of entries more than specified length to trim.
io.reactivex.Completable	updateGroupMessageId(String groupName, StreamMessageId id) Updates next message id delivered to consumers.

Methods inherited from interface org.redisson.api.RExpirableRx

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObjectRx

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

Method Detail

createGroup

io.reactivex.Completable createGroup(String groupName)

Creates consumer group by name.

Parameters:

groupName - - name of group

Returns:

void

createGroup

io.reactivex.Completable createGroup(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

removeGroup

io.reactivex.Completable removeGroup(String groupName)

Removes group by name.

Parameters:

groupName - - name of group

Returns:

void

removeConsumer

io.reactivex.Single<Long> removeConsumer(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

updateGroupMessageId

io.reactivex.Completable updateGroupMessageId(String groupName,
                                              StreamMessageId id)

Updates next message id delivered to consumers.

Parameters:

groupName - - name of group

id - - Stream Message ID

Returns:

void

ack

io.reactivex.Single<Long> ack(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

getPendingInfo

io.reactivex.Single<PendingResult> getPendingInfo(String groupName)

Returns common info about pending messages by group name.

Parameters:

groupName - - name of group

Returns:

result object

listPending

@Deprecated
io.reactivex.Single<PendingResult> listPending(String groupName)

Deprecated.

listPending

io.reactivex.Single<List<PendingEntry>> listPending(String groupName,
                                                    StreamMessageId startId,
                                                    StreamMessageId endId,
                                                    int count)

Returns list of pending messages by group name. Limited by start stream id and end stream id and count.

StreamMessageId.MAX is used as max stream id StreamMessageId.MIN is used as min stream id

Parameters:

groupName - - name of group

startId - - start stream id

endId - - end stream id

count - - amount of messages

Returns:

list

listPending

io.reactivex.Single<List<PendingEntry>> listPending(String groupName,
                                                    String consumerName,
                                                    StreamMessageId startId,
                                                    StreamMessageId endId,
                                                    int count)

Returns list of pending messages by group name and consumer name. Limited by start stream id and end stream id and count.

StreamMessageId.MAX is used as max stream id StreamMessageId.MIN is used as min stream id

Parameters:

consumerName - - name of consumer

groupName - - name of group

startId - - start stream id

endId - - end stream id

count - - amount of messages

Returns:

list

claim

io.reactivex.Single<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.

Parameters:

groupName - - name of group

consumerName - - name of consumer

idleTime - - minimum idle time of messages

idleTimeUnit - - idle time unit

ids - - stream ids

Returns:

stream data mapped by Stream ID

readGroup

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> readGroup(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

readGroup

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> readGroup(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

readGroup

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> readGroup(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

readGroup

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> readGroup(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

readGroup

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroup(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

readGroup

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroup(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

readGroup

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroup(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

readGroup

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroup(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

readGroup

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroup(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

readGroup

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroup(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

readGroup

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroup(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

readGroup

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroup(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

readGroup

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroup(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

readGroup

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroup(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

readGroup

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> readGroup(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

size

io.reactivex.Single<Long> size()

Returns number of entries in stream

Returns:

size of stream

add

io.reactivex.Single<StreamMessageId> add(K key,
                                         V value)

Appends a new entry and returns generated Stream ID

Parameters:

key - - key of entry

value - - value of entry

Returns:

Stream ID

add

io.reactivex.Completable add(StreamMessageId id,
                             K key,
                             V value)

Appends a new entry by specified Stream ID

Parameters:

id - - Stream ID

key - - key of entry

value - - value of entry

Returns:

void

add

io.reactivex.Single<StreamMessageId> add(K key,
                                         V value,
                                         int trimLen,
                                         boolean trimStrict)

Appends a new entry and returns generated Stream ID. Trims stream to a specified trimLen size. If trimStrict is false then trims to few tens of entries more than specified length to trim.

Parameters:

key - - key of entry

value - - value of entry

trimLen - - length to trim

trimStrict - - if false then trims to few tens of entries more than specified length to trim

Returns:

Stream ID

add

io.reactivex.Completable add(StreamMessageId id,
                             K key,
                             V value,
                             int trimLen,
                             boolean trimStrict)

Appends a new entry by specified Stream ID. Trims stream to a specified trimLen size. If trimStrict is false then trims to few tens of entries more than specified length to trim.

Parameters:

id - - Stream ID

key - - key of entry

value - - value of entry

trimLen - - length to trim

trimStrict - - if false then trims to few tens of entries more than specified length to trim

Returns:

void

addAll

io.reactivex.Single<StreamMessageId> addAll(Map<K,V> entries)

Appends new entries and returns generated Stream ID

Parameters:

entries - - entries to add

Returns:

Stream ID

addAll

io.reactivex.Completable addAll(StreamMessageId id,
                                Map<K,V> entries)

Appends new entries by specified Stream ID

Parameters:

id - - Stream ID

entries - - entries to add

Returns:

void

addAll

io.reactivex.Single<StreamMessageId> addAll(Map<K,V> entries,
                                            int trimLen,
                                            boolean trimStrict)

Appends new entries and returns generated Stream ID. Trims stream to a specified trimLen size. If trimStrict is false then trims to few tens of entries more than specified length to trim.

Parameters:

entries - - entries to add

trimLen - - length to trim

trimStrict - - if false then trims to few tens of entries more than specified length to trim

Returns:

Stream ID

addAll

io.reactivex.Completable addAll(StreamMessageId id,
                                Map<K,V> entries,
                                int trimLen,
                                boolean trimStrict)

Appends new entries by specified Stream ID. Trims stream to a specified trimLen size. If trimStrict is false then trims to few tens of entries more than specified length to trim.

Parameters:

id - - Stream ID

entries - - entries to add

trimLen - - length to trim

trimStrict - - if false then trims to few tens of entries more than specified length to trim

Returns:

void

read

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> read(StreamMessageId... ids)

Read stream data by specified collection of Stream IDs.

Parameters:

ids - - collection of Stream IDs

Returns:

stream data mapped by Stream ID

read

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> read(int count,
                                                        StreamMessageId... ids)

Read stream data by specified collection of Stream IDs.

Parameters:

count - - stream data size limit

ids - - collection of Stream IDs

Returns:

stream data mapped by Stream ID

read

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> read(long timeout,
                                                        TimeUnit unit,
                                                        StreamMessageId... ids)

Read stream data by specified collection of Stream IDs. Wait for stream data availability for specified timeout interval.

Parameters:

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

read

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> read(int count,
                                                        long timeout,
                                                        TimeUnit unit,
                                                        StreamMessageId... ids)

Read stream data by specified collection of Stream IDs. Wait for stream data availability for specified timeout interval.

Parameters:

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

read

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> read(StreamMessageId id,
                                                                    String name2,
                                                                    StreamMessageId id2)

Read stream data by specified stream name including this stream.

Parameters:

id - - id of this stream

name2 - - name of second stream

id2 - - id of second stream

Returns:

stream data mapped by key and Stream ID

read

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> read(StreamMessageId id,
                                                                    String name2,
                                                                    StreamMessageId id2,
                                                                    String name3,
                                                                    StreamMessageId id3)

Read stream data by specified stream names including this stream.

Parameters:

id - - id of this stream

name2 - - name of second stream

id2 - - id of second stream

name3 - - name of third stream

id3 - - id of third stream

Returns:

stream data mapped by key and Stream ID

read

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> read(StreamMessageId id,
                                                                    Map<String,StreamMessageId> nameToId)

Read stream data by specified stream id mapped by name including this stream.

Parameters:

id - - id of this stream

nameToId - - stream id mapped by name

Returns:

stream data mapped by key and Stream ID

read

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> read(int count,
                                                                    StreamMessageId id,
                                                                    String name2,
                                                                    StreamMessageId id2)

Read stream data by specified stream name including this stream.

Parameters:

count - - stream data size limit

id - - id of this stream

name2 - - name of second stream

id2 - - id of second stream

Returns:

stream data mapped by key and Stream ID

read

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> read(int count,
                                                                    StreamMessageId id,
                                                                    String name2,
                                                                    StreamMessageId id2,
                                                                    String name3,
                                                                    StreamMessageId id3)

Read stream data by specified stream names including this stream.

Parameters:

count - - stream data size limit

id - - id of this stream

name2 - - name of second stream

id2 - - id of second stream

name3 - - name of third stream

id3 - - id of third stream

Returns:

stream data mapped by key and Stream ID

read

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> read(int count,
                                                                    StreamMessageId id,
                                                                    Map<String,StreamMessageId> nameToId)

Read stream data by specified stream id mapped by name including this stream.

Parameters:

count - - stream data size limit

id - - id of this stream

nameToId - - stream id mapped by name

Returns:

stream data mapped by key and Stream ID

read

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> read(long timeout,
                                                                    TimeUnit unit,
                                                                    StreamMessageId id,
                                                                    String name2,
                                                                    StreamMessageId id2)

Read stream data by specified stream name including this stream. Wait for the first stream data availability for specified timeout interval.

Parameters:

timeout - - time interval to wait for stream data availability

unit - - time interval unit

id - - id of this stream

name2 - - name of second stream

id2 - - id of second stream

Returns:

stream data mapped by key and Stream ID

read

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> read(long timeout,
                                                                    TimeUnit unit,
                                                                    StreamMessageId id,
                                                                    String name2,
                                                                    StreamMessageId id2,
                                                                    String name3,
                                                                    StreamMessageId id3)

Read stream data by specified stream names including this stream. Wait for the first stream data availability for specified timeout interval.

Parameters:

timeout - - time interval to wait for stream data availability

unit - - time interval unit

id - - id of this stream

name2 - - name of second stream

id2 - - id of second stream

name3 - - name of third stream

id3 - - id of third stream

Returns:

stream data mapped by key and Stream ID

read

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> read(long timeout,
                                                                    TimeUnit unit,
                                                                    StreamMessageId id,
                                                                    Map<String,StreamMessageId> nameToId)

Read stream data by specified stream id mapped by name including this stream. Wait for the first stream data availability for specified timeout interval.

Parameters:

timeout - - time interval to wait for stream data availability

unit - - time interval unit

id - - id of this stream

nameToId - - stream id mapped by name

Returns:

stream data mapped by key and Stream ID

read

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> read(int count,
                                                                    long timeout,
                                                                    TimeUnit unit,
                                                                    StreamMessageId id,
                                                                    String name2,
                                                                    StreamMessageId id2)

Read stream data by specified stream name including this stream. Wait for the first stream data availability for specified timeout interval.

Parameters:

count - - stream data size limit

timeout - - time interval to wait for stream data availability

unit - - time interval unit

id - - id of this stream

name2 - - name of second stream

id2 - - id of second stream

Returns:

stream data mapped by key and Stream ID

read

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> read(int count,
                                                                    long timeout,
                                                                    TimeUnit unit,
                                                                    StreamMessageId id,
                                                                    String name2,
                                                                    StreamMessageId id2,
                                                                    String name3,
                                                                    StreamMessageId id3)

Read stream data by specified stream names including this stream. Wait for the first stream data availability for specified timeout interval.

Parameters:

count - - stream data size limit

timeout - - time interval to wait for stream data availability

unit - - time interval unit

id - - id of this stream

name2 - - name of second stream

id2 - - id of second stream

name3 - - name of third stream

id3 - - id of third stream

Returns:

stream data mapped by key and Stream ID

read

io.reactivex.Single<Map<String,Map<StreamMessageId,Map<K,V>>>> read(int count,
                                                                    long timeout,
                                                                    TimeUnit unit,
                                                                    StreamMessageId id,
                                                                    Map<String,StreamMessageId> nameToId)

Read stream data by specified stream id mapped by name including this stream. Wait for the first stream data availability for specified timeout interval.

Parameters:

count - - stream data size limit

timeout - - time interval to wait for stream data availability

unit - - time interval unit

id - - id of this stream

nameToId - - stream id mapped by name

Returns:

stream data mapped by key and Stream ID

range

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> range(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

range

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> range(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

rangeReversed

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> rangeReversed(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

rangeReversed

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> rangeReversed(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

remove

io.reactivex.Single<Long> remove(StreamMessageId... ids)

Removes messages by id.

Parameters:

ids - - id of messages to remove

Returns:

deleted messages amount

trim

io.reactivex.Single<Long> trim(int size)

Trims stream to specified size

Parameters:

size - - new size of stream

Returns:

number of deleted messages

trimNonStrict

io.reactivex.Single<Long> trimNonStrict(int size)

Trims stream to few tens of entries more than specified length to trim.

Parameters:

size - - new size of stream

Returns:

number of deleted messages

getInfo

io.reactivex.Single<StreamInfo<K,V>> getInfo()

Returns information about this stream.

Returns:

info object

listGroups

io.reactivex.Single<List<StreamGroup>> listGroups()

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

Returns:

list of info objects

listConsumers

io.reactivex.Single<List<StreamConsumer>> listConsumers(String groupName)

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

Parameters:

groupName - - name of group

Returns:

list of info objects

pendingRange

io.reactivex.Single<Map<StreamMessageId,Map<K,V>>> pendingRange(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:

listPending(java.lang.String)

pendingRange

io.reactivex.Single<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. 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:

listPending(java.lang.String)