org.springframework.data.redis.connection

Interface ReactiveListCommands

All Known Subinterfaces:

ReactiveClusterListCommands

All Known Implementing Classes:

LettuceReactiveClusterListCommands, LettuceReactiveListCommands

public interface ReactiveListCommands

Redis List commands executed using reactive infrastructure.

Since:

2.0

Author:

Christoph Strobl, Mark Paluch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ReactiveListCommands.BPopCommand
static class	ReactiveListCommands.BRPopLPushCommand BRPOPLPUSH command parameters.
static class	ReactiveListCommands.Direction
static class	ReactiveListCommands.LIndexCommand LINDEX command parameters.
static class	ReactiveListCommands.LInsertCommand LINSERT command parameters.
static class	ReactiveListCommands.LRemCommand LREM command parameters.
static class	ReactiveListCommands.LSetCommand LSET command parameters.
static class	ReactiveListCommands.PopCommand LPOP/RPOP command parameters.
static class	ReactiveListCommands.PopResponse Result for ReactiveListCommands.PopCommand/ReactiveListCommands.BPopCommand.
static class	ReactiveListCommands.PopResult Result for ReactiveListCommands.PopCommand/ReactiveListCommands.BPopCommand.
static class	ReactiveListCommands.PushCommand LPUSH/RPUSH command parameters.
static class	ReactiveListCommands.RPopLPushCommand RPOPLPUSH command parameters.

Method Summary

Modifier and Type	Method and Description
default reactor.core.publisher.Mono<ReactiveListCommands.PopResult>	blPop(List<ByteBuffer> keys, Duration timeout) Removes and returns first element from lists stored at keys.
reactor.core.publisher.Flux<ReactiveListCommands.PopResponse>	bPop(org.reactivestreams.Publisher<ReactiveListCommands.BPopCommand> commands) Removes and returns the top ReactiveListCommands.BPopCommand.getDirection() element from lists stored at ReactiveListCommands.BPopCommand.getKeys().
default reactor.core.publisher.Mono<ReactiveListCommands.PopResult>	brPop(List<ByteBuffer> keys, Duration timeout) Removes and returns last element from lists stored at keys.
default reactor.core.publisher.Mono<ByteBuffer>	bRPopLPush(ByteBuffer source, ByteBuffer destination, Duration timeout) Remove the last element from list at source, append it to destination and return its value.
reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveListCommands.BRPopLPushCommand>>	bRPopLPush(org.reactivestreams.Publisher<ReactiveListCommands.BRPopLPushCommand> commands) Remove the last element from list at ReactiveRedisConnection.KeyCommand.getKey(), append it to ReactiveListCommands.BRPopLPushCommand.getDestination() and return its value.
default reactor.core.publisher.Mono<ByteBuffer>	lIndex(ByteBuffer key, long index) Get element at index form list at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveListCommands.LIndexCommand>>	lIndex(org.reactivestreams.Publisher<ReactiveListCommands.LIndexCommand> commands) Get element at ReactiveListCommands.LIndexCommand.getIndex() form list at ReactiveRedisConnection.KeyCommand.getKey().
default reactor.core.publisher.Mono<Long>	lInsert(ByteBuffer key, RedisListCommands.Position position, ByteBuffer pivot, ByteBuffer value) Insert value RedisListCommands.Position.BEFORE or RedisListCommands.Position.AFTER existing pivot for key.
reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveListCommands.LInsertCommand,Long>>	lInsert(org.reactivestreams.Publisher<ReactiveListCommands.LInsertCommand> commands) Insert ReactiveListCommands.LInsertCommand.getValue() RedisListCommands.Position.BEFORE or RedisListCommands.Position.AFTER existing ReactiveListCommands.LInsertCommand.getPivot() for ReactiveRedisConnection.KeyCommand.getKey()
default reactor.core.publisher.Mono<Long>	lLen(ByteBuffer key) Get the size of list stored at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>>	lLen(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> commands) Get the size of list stored at ReactiveRedisConnection.KeyCommand.getKey()
default reactor.core.publisher.Mono<ByteBuffer>	lPop(ByteBuffer key) Removes and returns first element in list stored at key.
default reactor.core.publisher.Mono<Long>	lPush(ByteBuffer key, List<ByteBuffer> values) Prepend values to key.
default reactor.core.publisher.Mono<Long>	lPushX(ByteBuffer key, ByteBuffer value) Prepend value to key if key already exists.
default reactor.core.publisher.Mono<List<ByteBuffer>>	lRange(ByteBuffer key, long start, long end) Get elements between begin and end from list at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.MultiValueResponse<ReactiveRedisConnection.RangeCommand,ByteBuffer>>	lRange(org.reactivestreams.Publisher<ReactiveRedisConnection.RangeCommand> commands) Get elements in ReactiveRedisConnection.RangeCommand.getRange() from list at ReactiveRedisConnection.KeyCommand.getKey()
default reactor.core.publisher.Mono<Long>	lRem(ByteBuffer key, ByteBuffer value) Removes all occurrences of value from the list stored at key.
default reactor.core.publisher.Mono<Long>	lRem(ByteBuffer key, Long count, ByteBuffer value) Removes the first count occurrences of value from the list stored at key.
reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveListCommands.LRemCommand,Long>>	lRem(org.reactivestreams.Publisher<ReactiveListCommands.LRemCommand> commands) Removes the ReactiveListCommands.LRemCommand.getCount() occurrences of ReactiveListCommands.LRemCommand.getValue() from the list stored at ReactiveRedisConnection.KeyCommand.getKey().
default reactor.core.publisher.Mono<Boolean>	lSet(ByteBuffer key, long index, ByteBuffer value) Set the value list element at index.
reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveListCommands.LSetCommand>>	lSet(org.reactivestreams.Publisher<ReactiveListCommands.LSetCommand> commands) Set the ReactiveListCommands.LSetCommand.getValue() list element at ReactiveRedisConnection.KeyCommand.getKey().
default reactor.core.publisher.Mono<Boolean>	lTrim(ByteBuffer key, long start, long end) Trim list at key to elements between begin and end.
reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveRedisConnection.RangeCommand>>	lTrim(org.reactivestreams.Publisher<ReactiveRedisConnection.RangeCommand> commands) Trim list at ReactiveRedisConnection.KeyCommand.getKey() to elements within ReactiveRedisConnection.RangeCommand.getRange().
reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveListCommands.PopCommand>>	pop(org.reactivestreams.Publisher<ReactiveListCommands.PopCommand> commands) Removes and returns last element in list stored at ReactiveRedisConnection.KeyCommand.getKey()
reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveListCommands.PushCommand,Long>>	push(org.reactivestreams.Publisher<ReactiveListCommands.PushCommand> commands) Prepend ReactiveListCommands.PushCommand.getValues() to ReactiveRedisConnection.KeyCommand.getKey().
default reactor.core.publisher.Mono<ByteBuffer>	rPop(ByteBuffer key) Removes and returns last element in list stored at key.
default reactor.core.publisher.Mono<ByteBuffer>	rPopLPush(ByteBuffer source, ByteBuffer destination) Remove the last element from list at source, append it to destination and return its value.
reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveListCommands.RPopLPushCommand>>	rPopLPush(org.reactivestreams.Publisher<ReactiveListCommands.RPopLPushCommand> commands) Remove the last element from list at ReactiveRedisConnection.KeyCommand.getKey(), append it to ReactiveListCommands.RPopLPushCommand.getDestination() and return its value.
default reactor.core.publisher.Mono<Long>	rPush(ByteBuffer key, List<ByteBuffer> values) Append values to key.
default reactor.core.publisher.Mono<Long>	rPushX(ByteBuffer key, ByteBuffer value) Append values to key only if key already exists.

Method Detail

rPush

default reactor.core.publisher.Mono<Long> rPush(ByteBuffer key,
                                                List<ByteBuffer> values)

Append values to key.

Parameters:

key - must not be null.

values - must not be null.

Returns:

rPushX

default reactor.core.publisher.Mono<Long> rPushX(ByteBuffer key,
                                                 ByteBuffer value)

Append values to key only if key already exists.

Parameters:

key - must not be null.

value - must not be null.

Returns:

lPush

default reactor.core.publisher.Mono<Long> lPush(ByteBuffer key,
                                                List<ByteBuffer> values)

Prepend values to key.

Parameters:

key - must not be null.

values - must not be null.

Returns:

lPushX

default reactor.core.publisher.Mono<Long> lPushX(ByteBuffer key,
                                                 ByteBuffer value)

Prepend value to key if key already exists.

Parameters:

key - must not be null.

value - must not be null.

Returns:

push

reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveListCommands.PushCommand,Long>> push(org.reactivestreams.Publisher<ReactiveListCommands.PushCommand> commands)

Prepend ReactiveListCommands.PushCommand.getValues() to ReactiveRedisConnection.KeyCommand.getKey().

Parameters:

commands - must not be null.

Returns:

lLen

default reactor.core.publisher.Mono<Long> lLen(ByteBuffer key)

Get the size of list stored at key.

Parameters:

key - must not be null.

Returns:

lLen

reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveRedisConnection.KeyCommand,Long>> lLen(org.reactivestreams.Publisher<ReactiveRedisConnection.KeyCommand> commands)

Get the size of list stored at ReactiveRedisConnection.KeyCommand.getKey()

Parameters:

commands - must not be null.

Returns:

lRange

default reactor.core.publisher.Mono<List<ByteBuffer>> lRange(ByteBuffer key,
                                                             long start,
                                                             long end)

Get elements between begin and end from list at key.

Parameters:

key - must not be null.

start -

end -

Returns:

lRange

reactor.core.publisher.Flux<ReactiveRedisConnection.MultiValueResponse<ReactiveRedisConnection.RangeCommand,ByteBuffer>> lRange(org.reactivestreams.Publisher<ReactiveRedisConnection.RangeCommand> commands)

Get elements in ReactiveRedisConnection.RangeCommand.getRange() from list at ReactiveRedisConnection.KeyCommand.getKey()

Parameters:

commands - must not be null.

Returns:

lTrim

default reactor.core.publisher.Mono<Boolean> lTrim(ByteBuffer key,
                                                   long start,
                                                   long end)

Trim list at key to elements between begin and end.

Parameters:

key - must not be null.

start -

end -

Returns:

lTrim

reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveRedisConnection.RangeCommand>> lTrim(org.reactivestreams.Publisher<ReactiveRedisConnection.RangeCommand> commands)

Trim list at ReactiveRedisConnection.KeyCommand.getKey() to elements within ReactiveRedisConnection.RangeCommand.getRange().

Parameters:

commands - must not be null.

Returns:

lIndex

default reactor.core.publisher.Mono<ByteBuffer> lIndex(ByteBuffer key,
                                                       long index)

Get element at index form list at key.

Parameters:

key - must not be null.

index -

Returns:

lIndex

reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveListCommands.LIndexCommand>> lIndex(org.reactivestreams.Publisher<ReactiveListCommands.LIndexCommand> commands)

Get element at ReactiveListCommands.LIndexCommand.getIndex() form list at ReactiveRedisConnection.KeyCommand.getKey().

Parameters:

commands - must not be null.

Returns:

lInsert

default reactor.core.publisher.Mono<Long> lInsert(ByteBuffer key,
                                                  RedisListCommands.Position position,
                                                  ByteBuffer pivot,
                                                  ByteBuffer value)

Insert value RedisListCommands.Position.BEFORE or RedisListCommands.Position.AFTER existing pivot for key.

Parameters:

key - must not be null.

position - must not be null.

pivot - must not be null.

value - must not be null.

Returns:

lInsert

reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveListCommands.LInsertCommand,Long>> lInsert(org.reactivestreams.Publisher<ReactiveListCommands.LInsertCommand> commands)

Insert ReactiveListCommands.LInsertCommand.getValue() RedisListCommands.Position.BEFORE or RedisListCommands.Position.AFTER existing ReactiveListCommands.LInsertCommand.getPivot() for ReactiveRedisConnection.KeyCommand.getKey()

Parameters:

commands - must not be null.

Returns:

lSet

default reactor.core.publisher.Mono<Boolean> lSet(ByteBuffer key,
                                                  long index,
                                                  ByteBuffer value)

Set the value list element at index.

Parameters:

key - must not be null.

index -

value - must not be null.

Returns:

lSet

reactor.core.publisher.Flux<ReactiveRedisConnection.BooleanResponse<ReactiveListCommands.LSetCommand>> lSet(org.reactivestreams.Publisher<ReactiveListCommands.LSetCommand> commands)

Set the ReactiveListCommands.LSetCommand.getValue() list element at ReactiveRedisConnection.KeyCommand.getKey().

Parameters:

commands -

Returns:

lRem

default reactor.core.publisher.Mono<Long> lRem(ByteBuffer key,
                                               ByteBuffer value)

Removes all occurrences of value from the list stored at key.

Parameters:

key - must not be null.

value - must not be null.

Returns:

lRem

default reactor.core.publisher.Mono<Long> lRem(ByteBuffer key,
                                               Long count,
                                               ByteBuffer value)

Removes the first count occurrences of value from the list stored at key.

Parameters:

key - must not be null.

count - must not be null.

value - must not be null.

Returns:

lRem

reactor.core.publisher.Flux<ReactiveRedisConnection.NumericResponse<ReactiveListCommands.LRemCommand,Long>> lRem(org.reactivestreams.Publisher<ReactiveListCommands.LRemCommand> commands)

Removes the ReactiveListCommands.LRemCommand.getCount() occurrences of ReactiveListCommands.LRemCommand.getValue() from the list stored at ReactiveRedisConnection.KeyCommand.getKey().

Parameters:

commands - must not be null.

Returns:

lPop

default reactor.core.publisher.Mono<ByteBuffer> lPop(ByteBuffer key)

Removes and returns first element in list stored at key.

Parameters:

key - must not be null.

Returns:

rPop

default reactor.core.publisher.Mono<ByteBuffer> rPop(ByteBuffer key)

Removes and returns last element in list stored at key.

Parameters:

key - must not be null.

Returns:

pop

reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveListCommands.PopCommand>> pop(org.reactivestreams.Publisher<ReactiveListCommands.PopCommand> commands)

Removes and returns last element in list stored at ReactiveRedisConnection.KeyCommand.getKey()

Parameters:

commands - must not be null.

Returns:

blPop

default reactor.core.publisher.Mono<ReactiveListCommands.PopResult> blPop(List<ByteBuffer> keys,
                                                                          Duration timeout)

Removes and returns first element from lists stored at keys.
Blocks connection until element available or timeout reached.

Parameters:

keys - must not be null.

timeout - must not be null.

Returns:

brPop

default reactor.core.publisher.Mono<ReactiveListCommands.PopResult> brPop(List<ByteBuffer> keys,
                                                                          Duration timeout)

Removes and returns last element from lists stored at keys.
Blocks connection until element available or timeout reached.

Parameters:

keys - must not be null.

timeout - must not be null.

Returns:

bPop

reactor.core.publisher.Flux<ReactiveListCommands.PopResponse> bPop(org.reactivestreams.Publisher<ReactiveListCommands.BPopCommand> commands)

Removes and returns the top ReactiveListCommands.BPopCommand.getDirection() element from lists stored at ReactiveListCommands.BPopCommand.getKeys().
Blocks connection until element available or ReactiveListCommands.BPopCommand.getTimeout() reached.

Parameters:

commands -

Returns:

rPopLPush

default reactor.core.publisher.Mono<ByteBuffer> rPopLPush(ByteBuffer source,
                                                          ByteBuffer destination)

Remove the last element from list at source, append it to destination and return its value.

Parameters:

source - must not be null.

destination - must not be null.

Returns:

rPopLPush

reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveListCommands.RPopLPushCommand>> rPopLPush(org.reactivestreams.Publisher<ReactiveListCommands.RPopLPushCommand> commands)

Remove the last element from list at ReactiveRedisConnection.KeyCommand.getKey(), append it to ReactiveListCommands.RPopLPushCommand.getDestination() and return its value.

Parameters:

commands - must not be null.

Returns:

bRPopLPush

default reactor.core.publisher.Mono<ByteBuffer> bRPopLPush(ByteBuffer source,
                                                           ByteBuffer destination,
                                                           Duration timeout)

Remove the last element from list at source, append it to destination and return its value. Blocks connection until element available or timeout reached.

Parameters:

source - must not be null.

destination - must not be null.

Returns:

bRPopLPush

reactor.core.publisher.Flux<ReactiveRedisConnection.ByteBufferResponse<ReactiveListCommands.BRPopLPushCommand>> bRPopLPush(org.reactivestreams.Publisher<ReactiveListCommands.BRPopLPushCommand> commands)

Remove the last element from list at ReactiveRedisConnection.KeyCommand.getKey(), append it to ReactiveListCommands.BRPopLPushCommand.getDestination() and return its value.
Blocks connection until element available or ReactiveListCommands.BRPopLPushCommand.getTimeout() reached.

Parameters:

commands - must not be null.

Returns: