io.lettuce.core.resource

Interface ClientResources

All Known Implementing Classes:

DefaultClientResources

public interface ClientResources

Strategy interface to provide all the infrastructure building blocks like environment settings and thread pools so that the client can work with it properly. ClientResources can be shared amongst multiple client instances if created outside the client creation. Implementations of ClientResources are stateful and must be shutdown() after they are no longer in use. ClientResources provides in particular:

• EventLoopGroupProvider to obtain particular EventLoopGroups
• EventExecutorGroup to perform internal computation tasks
• Timer for scheduling
• EventBus for client event dispatching
• EventPublisherOptions
• CommandLatencyCollector to collect latency details. Requires the HdrHistogram library.
• DnsResolver to collect latency details. Requires the LatencyUtils library.
• Reconnect Delay.

Since:

3.4

Author:

Mark Paluch

See Also:

DefaultClientResources

Method Summary

Modifier and Type	Method and Description
CommandLatencyCollector	commandLatencyCollector() Returns the CommandLatencyCollector.
EventPublisherOptions	commandLatencyPublisherOptions() Returns the EventPublisherOptions for latency event publishing.
int	computationThreadPoolSize() Returns the pool size (number of threads) for all computation tasks.
DnsResolver	dnsResolver() Returns the DnsResolver.
EventBus	eventBus() Returns the event bus used to publish events.
EventExecutorGroup	eventExecutorGroup() Returns the computation pool used for internal operations.
EventLoopGroupProvider	eventLoopGroupProvider() Returns the EventLoopGroupProvider that provides access to the particular event loop groups. lettuce requires at least two implementations: NioEventLoopGroup for TCP/IP connections and EpollEventLoopGroup for unix domain socket connections (epoll).
int	ioThreadPoolSize() Returns the pool size (number of threads) for IO threads.
NettyCustomizer	nettyCustomizer() Returns the NettyCustomizer to customize netty components.
Delay	reconnectDelay() Returns the Delay for reconnect attempts.
Future<Boolean>	shutdown() Shutdown the ClientResources.
Future<Boolean>	shutdown(long quietPeriod, long timeout, TimeUnit timeUnit) Shutdown the ClientResources.
Timer	timer() Returns the Timer to schedule events.

Method Detail

shutdown

Future<Boolean> shutdown()

Shutdown the ClientResources.

Returns:

eventually the success/failure of the shutdown without errors.

shutdown

Future<Boolean> shutdown(long quietPeriod,
                         long timeout,
                         TimeUnit timeUnit)

Shutdown the ClientResources.

Parameters:

quietPeriod - the quiet period as described in the documentation

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

timeUnit - the unit of quietPeriod and timeout

Returns:

eventually the success/failure of the shutdown without errors.

eventLoopGroupProvider

EventLoopGroupProvider eventLoopGroupProvider()

Returns the EventLoopGroupProvider that provides access to the particular event loop groups. lettuce requires at least two implementations: NioEventLoopGroup for TCP/IP connections and EpollEventLoopGroup for unix domain socket connections (epoll). You can use DefaultEventLoopGroupProvider as default implementation or implement an own EventLoopGroupProvider to share existing EventLoopGroup's with lettuce.

Returns:

the EventLoopGroupProvider which provides access to the particular event loop groups

eventExecutorGroup

EventExecutorGroup eventExecutorGroup()

Returns the computation pool used for internal operations. Such tasks are periodic Redis Cluster and Redis Sentinel topology updates and scheduling of connection reconnection by ConnectionWatchdog.

Returns:

the computation pool used for internal operations

ioThreadPoolSize

int ioThreadPoolSize()

Returns the pool size (number of threads) for IO threads. The indicated size does not reflect the number for all IO threads. TCP and socket connections (epoll) require different IO pool.

Returns:

the pool size (number of threads) for all IO tasks.

computationThreadPoolSize

int computationThreadPoolSize()

Returns the pool size (number of threads) for all computation tasks.

Returns:

the pool size (number of threads to use).

timer

Timer timer()

Returns the Timer to schedule events. A timer object may run single- or multi-threaded but must be used for scheduling of short-running jobs only. Long-running jobs should be scheduled and executed using eventExecutorGroup().

Returns:

the timer.

Since:

4.3

eventBus

EventBus eventBus()

Returns the event bus used to publish events.

Returns:

the event bus

commandLatencyPublisherOptions

EventPublisherOptions commandLatencyPublisherOptions()

Returns the EventPublisherOptions for latency event publishing.

Returns:

the EventPublisherOptions for latency event publishing

commandLatencyCollector

CommandLatencyCollector commandLatencyCollector()

Returns the CommandLatencyCollector.

Returns:

the command latency collector

dnsResolver

DnsResolver dnsResolver()

Returns the DnsResolver.

Returns:

the DNS resolver

Since:

4.3

reconnectDelay

Delay reconnectDelay()

Returns the Delay for reconnect attempts. May return a different instance on each call.

Returns:

the reconnect Delay.

Since:

4.3

nettyCustomizer

NettyCustomizer nettyCustomizer()

Returns the NettyCustomizer to customize netty components.

Returns:

the configured NettyCustomizer.

Since:

4.4