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

Redis Stream implementation.

Requires Redis 5.0.0 and higher.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
RFuture<StreamId>	addAllAsync(Map<K,V> entries) Appends new entries and returns generated Stream ID
RFuture<StreamId>	addAllAsync(Map<K,V> entries, int trimLen, boolean trimStrict) Appends new entries and returns generated Stream ID.
RFuture<Void>	addAllAsync(StreamId id, Map<K,V> entries) Appends new entries by specified Stream ID
RFuture<Void>	addAllAsync(StreamId id, Map<K,V> entries, int trimLen, boolean trimStrict) Appends new entries by specified Stream ID.
RFuture<StreamId>	addAsync(K key, V value) Appends a new entry and returns generated Stream ID
RFuture<StreamId>	addAsync(K key, V value, int trimLen, boolean trimStrict) Appends a new entry and returns generated Stream ID.
RFuture<Void>	addAsync(StreamId id, K key, V value) Appends a new entry by specified Stream ID
RFuture<Void>	addAsync(StreamId id, K key, V value, int trimLen, boolean trimStrict) Appends a new entry by specified Stream ID.
RFuture<Map<StreamId,Map<K,V>>>	rangeAsync(int count, StreamId startId, StreamId endId) Read stream data in range by specified start Stream ID (included) and end Stream ID (included).
RFuture<Map<StreamId,Map<K,V>>>	rangeAsync(StreamId startId, StreamId endId) Read stream data in range by specified start Stream ID (included) and end Stream ID (included).
RFuture<Map<StreamId,Map<K,V>>>	rangeReversedAsync(int count, StreamId startId, StreamId endId) Read stream data in reverse order in range by specified start Stream ID (included) and end Stream ID (included).
RFuture<Map<StreamId,Map<K,V>>>	rangeReversedAsync(StreamId startId, StreamId endId) Read stream data in reverse order in range by specified start Stream ID (included) and end Stream ID (included).
RFuture<Map<String,Map<StreamId,Map<K,V>>>>	readAsync(Collection<String> keys, StreamId... ids) Read stream data by specified collection of keys including this stream and Stream ID per key.
RFuture<Map<String,Map<StreamId,Map<K,V>>>>	readAsync(int count, Collection<String> keys, StreamId... ids) Read stream data by specified collection of keys including this stream and Stream ID per key.
RFuture<Map<String,Map<StreamId,Map<K,V>>>>	readAsync(int count, long timeout, TimeUnit unit, Collection<String> keys, StreamId... ids) Read stream data by specified collection of keys including this stream and Stream ID per key.
RFuture<Map<StreamId,Map<K,V>>>	readAsync(int count, long timeout, TimeUnit unit, StreamId... ids) Read stream data by specified collection of Stream IDs.
RFuture<Map<StreamId,Map<K,V>>>	readAsync(int count, StreamId... ids) Read stream data by specified collection of Stream IDs.
RFuture<Map<String,Map<StreamId,Map<K,V>>>>	readAsync(long timeout, TimeUnit unit, Collection<String> keys, StreamId... ids) Read stream data by specified collection of keys including this stream and Stream ID per key.
RFuture<Map<StreamId,Map<K,V>>>	readAsync(long timeout, TimeUnit unit, StreamId... ids) Read stream data by specified collection of Stream IDs.
RFuture<Map<StreamId,Map<K,V>>>	readAsync(StreamId... ids) Read stream data by specified collection of Stream IDs.
RFuture<Long>	sizeAsync() Returns number of entries in stream

Methods inherited from interface org.redisson.api.RExpirableAsync

clearExpireAsync, expireAsync, expireAtAsync, expireAtAsync, remainTimeToLiveAsync

Methods inherited from interface org.redisson.api.RObjectAsync

copyAsync, deleteAsync, isExistsAsync, migrateAsync, moveAsync, renameAsync, renamenxAsync, touchAsync, unlinkAsync

Method Detail

sizeAsync

RFuture<Long> sizeAsync()

Returns number of entries in stream

Returns:

size of stream

addAsync

RFuture<StreamId> addAsync(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

addAsync

RFuture<Void> addAsync(StreamId 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

addAsync

RFuture<StreamId> addAsync(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

addAsync

RFuture<Void> addAsync(StreamId 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

addAllAsync

RFuture<StreamId> addAllAsync(Map<K,V> entries)

Appends new entries and returns generated Stream ID

Parameters:

entries - - entries to add

Returns:

Stream ID

addAllAsync

RFuture<Void> addAllAsync(StreamId id,
                          Map<K,V> entries)

Appends new entries by specified Stream ID

Parameters:

id - - Stream ID

entries - - entries to add

Returns:

void

addAllAsync

RFuture<StreamId> addAllAsync(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

addAllAsync

RFuture<Void> addAllAsync(StreamId 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

readAsync

RFuture<Map<StreamId,Map<K,V>>> readAsync(StreamId... ids)

Read stream data by specified collection of Stream IDs.

Parameters:

ids - - collection of Stream IDs

Returns:

stream data mapped by Stream ID

readAsync

RFuture<Map<StreamId,Map<K,V>>> readAsync(int count,
                                          StreamId... 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

readAsync

RFuture<Map<StreamId,Map<K,V>>> readAsync(long timeout,
                                          TimeUnit unit,
                                          StreamId... 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

readAsync

RFuture<Map<StreamId,Map<K,V>>> readAsync(int count,
                                          long timeout,
                                          TimeUnit unit,
                                          StreamId... 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

readAsync

RFuture<Map<String,Map<StreamId,Map<K,V>>>> readAsync(Collection<String> keys,
                                                      StreamId... ids)

Read stream data by specified collection of keys including this stream and Stream ID per key. First Stream ID is related to this stream.

Parameters:

keys - - collection of keys

ids - - collection of Stream IDs

Returns:

stream data mapped by key and Stream ID

readAsync

RFuture<Map<String,Map<StreamId,Map<K,V>>>> readAsync(int count,
                                                      Collection<String> keys,
                                                      StreamId... ids)

Read stream data by specified collection of keys including this stream and Stream ID per key. First Stream ID is related to this stream.

Parameters:

count - - stream data size limit

keys - - collection of keys

ids - - collection of Stream IDs

Returns:

stream data mapped by key and Stream ID

readAsync

RFuture<Map<String,Map<StreamId,Map<K,V>>>> readAsync(long timeout,
                                                      TimeUnit unit,
                                                      Collection<String> keys,
                                                      StreamId... ids)

Read stream data by specified collection of keys including this stream and Stream ID per key. First Stream ID is related to this stream. Wait for first stream data availability for specified timeout interval.

Parameters:

timeout - - time interval to wait for stream data availability

unit - - time interval unit

keys - - collection of keys

ids - - collection of Stream IDs

Returns:

stream data mapped by key and Stream ID

readAsync

RFuture<Map<String,Map<StreamId,Map<K,V>>>> readAsync(int count,
                                                      long timeout,
                                                      TimeUnit unit,
                                                      Collection<String> keys,
                                                      StreamId... ids)

Read stream data by specified collection of keys including this stream and Stream ID per key. First Stream ID is related to this stream. Wait for 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

keys - - collection of keys

ids - - collection of Stream IDs

Returns:

stream data mapped by key and Stream ID

rangeAsync

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

Read 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<StreamId,Map<K,V>>> rangeAsync(int count,
                                           StreamId startId,
                                           StreamId endId)

Read 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<StreamId,Map<K,V>>> rangeReversedAsync(StreamId startId,
                                                   StreamId endId)

Read 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<StreamId,Map<K,V>>> rangeReversedAsync(int count,
                                                   StreamId startId,
                                                   StreamId endId)

Read 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