org.redisson.api

Interface RStream<K,V>

Type Parameters:

K - key type

V - value type

All Superinterfaces:

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

All Known Implementing Classes:

RedissonStream

public interface RStream<K,V>
extends RStreamAsync<K,V>, RExpirable

Redis Stream implementation.

Requires Redis 5.0.0 and higher.

Author:

Nikita Koksharov

Method Summary

Modifier and Type	Method and Description
StreamId	add(K key, V value) Appends a new entry and returns generated Stream ID
StreamId	add(K key, V value, int trimLen, boolean trimStrict) Appends a new entry and returns generated Stream ID.
void	add(StreamId id, K key, V value) Appends a new entry by specified Stream ID
void	add(StreamId id, K key, V value, int trimLen, boolean trimStrict) Appends a new entry by specified Stream ID.
StreamId	addAll(Map<K,V> entries) Appends new entries and returns generated Stream ID
StreamId	addAll(Map<K,V> entries, int trimLen, boolean trimStrict) Appends new entries and returns generated Stream ID.
void	addAll(StreamId id, Map<K,V> entries) Appends new entries by specified Stream ID
void	addAll(StreamId id, Map<K,V> entries, int trimLen, boolean trimStrict) Appends new entries by specified Stream ID.
Map<StreamId,Map<K,V>>	range(int count, StreamId startId, StreamId endId) Read stream data in range by specified start Stream ID (included) and end Stream ID (included).
Map<StreamId,Map<K,V>>	range(StreamId startId, StreamId endId) Read stream data in range by specified start Stream ID (included) and end Stream ID (included).
Map<StreamId,Map<K,V>>	rangeReversed(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).
Map<StreamId,Map<K,V>>	rangeReversed(StreamId startId, StreamId endId) Read stream data in reverse order in range by specified start Stream ID (included) and end Stream ID (included).
Map<String,Map<StreamId,Map<K,V>>>	read(Collection<String> keys, StreamId... ids) Read stream data by specified collection of keys including this stream and Stream ID per key.
Map<String,Map<StreamId,Map<K,V>>>	read(int count, Collection<String> keys, StreamId... ids) Read stream data by specified collection of keys including this stream and Stream ID per key.
Map<String,Map<StreamId,Map<K,V>>>	read(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.
Map<StreamId,Map<K,V>>	read(int count, long timeout, TimeUnit unit, StreamId... ids) Read stream data by specified collection of Stream IDs.
Map<StreamId,Map<K,V>>	read(int count, StreamId... ids) Read stream data by specified collection of Stream IDs.
Map<String,Map<StreamId,Map<K,V>>>	read(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.
Map<StreamId,Map<K,V>>	read(long timeout, TimeUnit unit, StreamId... ids) Read stream data by specified collection of Stream IDs.
Map<StreamId,Map<K,V>>	read(StreamId... ids) Read stream data by specified collection of Stream IDs.
long	size() Returns number of entries in stream

Methods inherited from interface org.redisson.api.RStreamAsync

addAllAsync, addAllAsync, addAllAsync, addAllAsync, addAsync, addAsync, addAsync, addAsync, rangeAsync, rangeAsync, rangeReversedAsync, rangeReversedAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, readAsync, sizeAsync

Methods inherited from interface org.redisson.api.RExpirable

clearExpire, expire, expireAt, expireAt, remainTimeToLive

Methods inherited from interface org.redisson.api.RObject

copy, delete, getCodec, getName, isExists, migrate, move, rename, renamenx, touch, unlink

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

size

long size()

Returns number of entries in stream

Returns:

size of stream

add

StreamId 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

void add(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

add

StreamId 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

void add(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

addAll

StreamId addAll(Map<K,V> entries)

Appends new entries and returns generated Stream ID

Parameters:

entries - - entries to add

Returns:

Stream ID

addAll

void addAll(StreamId id,
            Map<K,V> entries)

Appends new entries by specified Stream ID

Parameters:

id - - Stream ID

entries - - entries to add

addAll

StreamId 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

void addAll(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

read

Map<StreamId,Map<K,V>> read(StreamId... ids)

Read stream data by specified collection of Stream IDs.

Parameters:

ids - - collection of Stream IDs

Returns:

stream data mapped by Stream ID

read

Map<StreamId,Map<K,V>> read(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

read

Map<StreamId,Map<K,V>> read(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

read

Map<StreamId,Map<K,V>> read(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

read

Map<String,Map<StreamId,Map<K,V>>> read(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

read

Map<String,Map<StreamId,Map<K,V>>> read(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

read

Map<String,Map<StreamId,Map<K,V>>> read(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

read

Map<String,Map<StreamId,Map<K,V>>> read(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

range

Map<StreamId,Map<K,V>> range(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

range

Map<StreamId,Map<K,V>> range(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

rangeReversed

Map<StreamId,Map<K,V>> rangeReversed(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

rangeReversed

Map<StreamId,Map<K,V>> rangeReversed(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