io.lettuce.core.api

Interface BaseRedisClient

All Superinterfaces:

AutoCloseable

All Known Subinterfaces:

MultiDbClient

All Known Implementing Classes:

AbstractRedisClient, RedisClient, RedisClusterClient

@Experimental
public interface BaseRedisClient
extends AutoCloseable

Since:

7.4

Author:

Ali Takavci

Method Summary

Modifier and Type	Method and Description
void	addListener(CommandListener listener) Add a listener for Redis Command events.
void	addListener(RedisConnectionStateListener listener) Add a listener for the RedisConnectionState.
ClientOptions	getOptions() Returns the ClientOptions which are valid for that client.
ClientResources	getResources() Returns the ClientResources which are used with that client.
void	removeListener(CommandListener listener) Removes a listener.
void	removeListener(RedisConnectionStateListener listener) Removes a listener.
void	shutdown() Shutdown this client and close all open connections once this method is called.
void	shutdown(Duration quietPeriod, Duration timeout) Shutdown this client and close all open connections once this method is called.
void	shutdown(long quietPeriod, long timeout, TimeUnit timeUnit) Shutdown this client and close all open connections once this method is called.
CompletableFuture<Void>	shutdownAsync() Shutdown this client and close all open connections asynchronously.
CompletableFuture<Void>	shutdownAsync(long quietPeriod, long timeout, TimeUnit timeUnit) Shutdown this client and close all open connections asynchronously.

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

getOptions

ClientOptions getOptions()

Returns the ClientOptions which are valid for that client. Connections inherit the current options at the moment the connection is created. Changes to options will not affect existing connections.

Returns:

the ClientOptions for this client

getResources

ClientResources getResources()

Returns the ClientResources which are used with that client.

Returns:

the ClientResources for this client.

Since:

6.0

addListener

void addListener(RedisConnectionStateListener listener)

Add a listener for the RedisConnectionState. The listener is notified every time a connect/disconnect/IO exception happens. The listeners are not bound to a specific connection, so every time a connection event happens on any connection, the listener will be notified. The corresponding netty channel handler (async connection) is passed on the event.

Parameters:

listener - must not be null.

removeListener

void removeListener(RedisConnectionStateListener listener)

Removes a listener.

Parameters:

listener - must not be null.

addListener

void addListener(CommandListener listener)

Add a listener for Redis Command events. The listener is notified on each command start/success/failure.

Parameters:

listener - must not be null.

Since:

6.1

removeListener

void removeListener(CommandListener listener)

Removes a listener.

Parameters:

listener - must not be null.

Since:

6.1

shutdown

void shutdown()

Shutdown this client and close all open connections once this method is called. Once all connections are closed, the associated ClientResources are shut down/released gracefully considering quiet time and the shutdown timeout. The client should be discarded after calling shutdown. The shutdown is executed without quiet time and a timeout of 2 TimeUnit.SECONDS.

See Also:

EventExecutorGroup.shutdownGracefully(long, long, TimeUnit)

shutdown

void shutdown(Duration quietPeriod,
              Duration timeout)

Shutdown this client and close all open connections once this method is called. Once all connections are closed, the associated ClientResources are shut down/released gracefully considering quiet time and the shutdown timeout. The client should be discarded after calling shutdown.

Parameters:

quietPeriod - the quiet period to allow the executor gracefully shut down.

timeout - the maximum amount of time to wait until the backing executor is shutdown regardless if a task was submitted during the quiet period.

Since:

5.0

See Also:

EventExecutorGroup.shutdownGracefully(long, long, TimeUnit)

shutdown

void shutdown(long quietPeriod,
              long timeout,
              TimeUnit timeUnit)

Shutdown this client and close all open connections once this method is called. Once all connections are closed, the associated ClientResources are shut down/released gracefully considering quiet time and the shutdown timeout. The client should be discarded after calling shutdown.

Parameters:

quietPeriod - the quiet period to allow the executor gracefully shut down.

timeout - the maximum amount of time to wait until the backing executor is shutdown regardless if a task was submitted during the quiet period.

timeUnit - the unit of quietPeriod and timeout.

See Also:

EventExecutorGroup.shutdownGracefully(long, long, TimeUnit)

shutdownAsync

CompletableFuture<Void> shutdownAsync()

Shutdown this client and close all open connections asynchronously. Once all connections are closed, the associated ClientResources are shut down/released gracefully considering quiet time and the shutdown timeout. The client should be discarded after calling shutdown. The shutdown is executed without quiet time and a timeout of 2 TimeUnit.SECONDS.

Since:

4.4

See Also:

EventExecutorGroup.shutdownGracefully(long, long, TimeUnit)

shutdownAsync

CompletableFuture<Void> shutdownAsync(long quietPeriod,
                                      long timeout,
                                      TimeUnit timeUnit)

Shutdown this client and close all open connections asynchronously. Once all connections are closed, the associated ClientResources are shut down/released gracefully considering quiet time and the shutdown timeout. The client should be discarded after calling shutdown.

Parameters:

quietPeriod - the quiet period to allow the executor gracefully shut down.

timeout - the maximum amount of time to wait until the backing executor is shutdown regardless if a task was submitted during the quiet period.

timeUnit - the unit of quietPeriod and timeout.

Since:

4.4

See Also:

EventExecutorGroup.shutdownGracefully(long, long, TimeUnit)