Package org.springframework.data.redis.connection

Interface ReactiveRedisConnection

All Superinterfaces:

AutoCloseable, Closeable

All Known Subinterfaces:

ReactiveRedisClusterConnection

public interface ReactiveRedisConnection
extends Closeable

Redis connection using reactive infrastructure declaring entry points for reactive command execution.

ReactiveRedisConnection is typically implemented by a stateful object that requires to be closed once it is no longer required.

Commands can be either executed by passing plain arguments like key, value or wrapped inside a command stream. Streaming command execution accepts Publisher of a particular ReactiveRedisConnection.Command. Commands are executed at the time their emission.

Arguments are binary-safe by using ByteBuffer arguments. Expect ByteBuffer to be consumed by ReactiveRedisConnection invocation or during execution. Any ByteBuffer used as method parameter should not be altered after invocation.

Since:

2.0

Author:

Christoph Strobl, Mark Paluch

See Also:

• ReactiveRedisConnection.Command
• ReactiveRedisConnection.CommandResponse
• ReactiveRedisConnection.KeyCommand

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ReactiveRedisConnection.AbsentByteBufferResponse<I>	ReactiveRedisConnection.CommandResponse implementation for ByteBuffer responses for absent keys.
static class	ReactiveRedisConnection.BooleanResponse<I>	ReactiveRedisConnection.CommandResponse implementation for Boolean responses.
static class	ReactiveRedisConnection.ByteBufferResponse<I>	ReactiveRedisConnection.CommandResponse implementation for ByteBuffer responses.
static interface	ReactiveRedisConnection.Command	Base interface for Redis commands executed with a reactive infrastructure.
static class	ReactiveRedisConnection.CommandResponse<I,O>	Base class for command responses.
static class	ReactiveRedisConnection.KeyCommand	ReactiveRedisConnection.Command for key-bound operations.
static class	ReactiveRedisConnection.KeyScanCommand	ReactiveRedisConnection.Command for key-bound scan operations like SCAN, HSCAN, SSCAN and ZSCAN.
static class	ReactiveRedisConnection.MultiValueResponse<I,O>	ReactiveRedisConnection.CommandResponse implementation for List responses.
static class	ReactiveRedisConnection.NumericResponse<I,O extends Number>	ReactiveRedisConnection.CommandResponse implementation for numeric responses.
static class	ReactiveRedisConnection.RangeCommand

Method Summary

Modifier and Type	Method	Description
default void	close()
reactor.core.publisher.Mono<Void>	closeLater()	Asynchronously close the connection and release associated resources.
ReactiveGeoCommands	geoCommands()	Get ReactiveGeoCommands
ReactiveHashCommands	hashCommands()	Get ReactiveHashCommands.
ReactiveHyperLogLogCommands	hyperLogLogCommands()	Get ReactiveHyperLogLogCommands.
ReactiveKeyCommands	keyCommands()	Get ReactiveKeyCommands.
ReactiveListCommands	listCommands()	Get ReactiveListCommands.
ReactiveNumberCommands	numberCommands()	Get ReactiveNumberCommands
reactor.core.publisher.Mono<String>	ping()	Test connection.
ReactivePubSubCommands	pubSubCommands()	Get ReactivePubSubCommands.
ReactiveScriptingCommands	scriptingCommands()	Get ReactiveScriptingCommands.
ReactiveServerCommands	serverCommands()	Get ReactiveServerCommands.
ReactiveSetCommands	setCommands()	Get ReactiveSetCommands.
ReactiveStreamCommands	streamCommands()	Get ReactiveStreamCommands.
ReactiveStringCommands	stringCommands()	Get ReactiveStringCommands.
ReactiveZSetCommands	zSetCommands()	Get ReactiveZSetCommands.

Method Details

close

default void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

closeLater

reactor.core.publisher.Mono<Void> closeLater()

Asynchronously close the connection and release associated resources.

Returns:

the Mono signaling when done.

keyCommands

ReactiveKeyCommands keyCommands()

Get ReactiveKeyCommands.

Returns:

never null.

stringCommands

ReactiveStringCommands stringCommands()

Get ReactiveStringCommands.

Returns:

never null.

numberCommands

ReactiveNumberCommands numberCommands()

Get ReactiveNumberCommands

Returns:

never null.

listCommands

ReactiveListCommands listCommands()

Get ReactiveListCommands.

Returns:

never null.

setCommands

ReactiveSetCommands setCommands()

Get ReactiveSetCommands.

Returns:

never null.

zSetCommands

ReactiveZSetCommands zSetCommands()

Get ReactiveZSetCommands.

Returns:

never null.

hashCommands

ReactiveHashCommands hashCommands()

Get ReactiveHashCommands.

Returns:

never null.

geoCommands

ReactiveGeoCommands geoCommands()

Get ReactiveGeoCommands

Returns:

never null.

hyperLogLogCommands

ReactiveHyperLogLogCommands hyperLogLogCommands()

Get ReactiveHyperLogLogCommands.

Returns:

never null.

pubSubCommands

ReactivePubSubCommands pubSubCommands()

Get ReactivePubSubCommands.

Returns:

never null.

Since:

2.1

scriptingCommands

ReactiveScriptingCommands scriptingCommands()

Get ReactiveScriptingCommands.

Returns:

never null.

serverCommands

ReactiveServerCommands serverCommands()

Get ReactiveServerCommands.

Returns:

never null.

streamCommands

ReactiveStreamCommands streamCommands()

Get ReactiveStreamCommands.

Returns:

never null.

Since:

2.2

ping

reactor.core.publisher.Mono<String> ping()

Test connection.

Returns:

Mono wrapping server response message - usually PONG.

See Also:

• Redis Documentation: PING