DefaultClientResources (Lettuce 5.3.6.RELEASE API)

java.lang.Object
- io.lettuce.core.resource.DefaultClientResources

All Implemented Interfaces:

ClientResources
```
public class DefaultClientResources
extends Object
implements ClientResources
```
Default instance of the client resources.
The DefaultClientResources instance is stateful, you have to shutdown the instance if you're no longer using it.
DefaultClientResources allow to configure:
- the ioThreadPoolSize, alternatively
- a eventLoopGroupProvider which is a provided instance of EventLoopGroupProvider. Higher precedence than ioThreadPoolSize.
- computationThreadPoolSize
- a eventExecutorGroup which is a provided instance of EventExecutorGroup. Higher precedence than computationThreadPoolSize.
- an eventBus which is a provided instance of EventBus.
- a commandLatencyCollector which is a provided instance of CommandLatencyCollector .
- a dnsResolver which is a provided instance of DnsResolver.
- a socketAddressResolver which is a provided instance of SocketAddressResolver.
- a timer that is a provided instance of HashedWheelTimer.
- a nettyCustomizer that is a provided instance of NettyCustomizer.
- a tracerProvider that is a provided instance of TracerProvider.
Since:

3.4

Author:

Mark Paluch

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class DefaultClientResources.Builder
Builder for DefaultClientResources.

Nested Classes
Modifier and Type	Class and Description
`static class`	`DefaultClientResources.Builder` Builder for `DefaultClientResources`.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_COMPUTATION_THREADS`
`static int`	`DEFAULT_IO_THREADS`
`static NettyCustomizer`	`DEFAULT_NETTY_CUSTOMIZER` Default (no-op) `NettyCustomizer`.
`static Supplier<Delay>`	`DEFAULT_RECONNECT_DELAY` Default delay `Supplier` for `Delay.exponential()` delay.
`protected static io.netty.util.internal.logging.InternalLogger`	`logger`
`static int`	`MIN_COMPUTATION_THREADS` Minimum number of computation threads.
`static int`	`MIN_IO_THREADS` Minimum number of I/O threads.

Constructor Summary

Constructors
Modifier Constructor and Description

protected DefaultClientResources(DefaultClientResources.Builder builder)

Constructors
Modifier	Constructor and Description
`protected`	`DefaultClientResources(DefaultClientResources.Builder builder)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DefaultClientResources.Builder`	`builder()` Returns a new `DefaultClientResources.Builder` to construct `DefaultClientResources`.
`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.
`static DefaultClientResources`	`create()` Create a new `DefaultClientResources` using default settings.
`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).
`protected void`	`finalize()`
`int`	`ioThreadPoolSize()` Returns the pool size (number of threads) for IO threads.
`DefaultClientResources.Builder`	`mutate()` Returns a builder to create new `DefaultClientResources` whose settings are replicated from the current `DefaultClientResources`.
`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`.
`SocketAddressResolver`	`socketAddressResolver()` Returns the `SocketAddressResolver`.
`Timer`	`timer()` Returns the `Timer` to schedule events.
`Tracing`	`tracing()` Returns the `Tracing` instance to support tracing of Redis commands.

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - logger
```
protected static final io.netty.util.internal.logging.InternalLogger logger
```
  - MIN_IO_THREADS
```
public static final int MIN_IO_THREADS
```
    Minimum number of I/O threads.
    
    See Also:
    
    Constant Field Values
  - MIN_COMPUTATION_THREADS
```
public static final int MIN_COMPUTATION_THREADS
```
    Minimum number of computation threads.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_IO_THREADS
```
public static final int DEFAULT_IO_THREADS
```
  - DEFAULT_COMPUTATION_THREADS
```
public static final int DEFAULT_COMPUTATION_THREADS
```
  - DEFAULT_RECONNECT_DELAY
```
public static final Supplier<Delay> DEFAULT_RECONNECT_DELAY
```
    Default delay Supplier for Delay.exponential() delay.
  - DEFAULT_NETTY_CUSTOMIZER
```
public static final NettyCustomizer DEFAULT_NETTY_CUSTOMIZER
```
    Default (no-op) NettyCustomizer.
- Constructor Detail
  - DefaultClientResources
```
protected DefaultClientResources(DefaultClientResources.Builder builder)
```
- Method Detail
  - create
```
public static DefaultClientResources create()
```
    Create a new DefaultClientResources using default settings.
    
    Specified by:
    
    create in interface ClientResources
    
    Returns:
    
    a new instance of a default client resources.
  - builder
```
public static DefaultClientResources.Builder builder()
```
    Returns a new DefaultClientResources.Builder to construct DefaultClientResources.
    
    Specified by:
    
    builder in interface ClientResources
    
    Returns:
    
    a new DefaultClientResources.Builder to construct DefaultClientResources.
  - mutate
```
public DefaultClientResources.Builder mutate()
```
    Returns a builder to create new DefaultClientResources whose settings are replicated from the current DefaultClientResources.
    Note: The resulting DefaultClientResources retains shared state for Timer, CommandLatencyCollector, EventExecutorGroup, and EventLoopGroupProvider if these are left unchanged. Thus you need only to shut down the last created ClientResources instances. Shutdown affects any previously created ClientResources.
    
    Specified by:
    
    mutate in interface ClientResources
    
    Returns:
    
    a DefaultClientResources.Builder to create new DefaultClientResources whose settings are replicated from the current DefaultClientResources.
    
    Since:
    
    5.1
  - finalize
```
protected void finalize()
                 throws Throwable
```
    Overrides:
    
    finalize in class Object
    
    Throws:
    
    Throwable
  - shutdown
```
public Future<Boolean> shutdown()
```
    Shutdown the ClientResources.
    
    Specified by:
    
    shutdown in interface ClientResources
    
    Returns:
    
    eventually the success/failure of the shutdown without errors.
  - shutdown
```
public Future<Boolean> shutdown(long quietPeriod,
                                long timeout,
                                TimeUnit timeUnit)
```
    Shutdown the ClientResources.
    
    Specified by:
    
    shutdown in interface 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
```
public EventLoopGroupProvider eventLoopGroupProvider()
```
    Description copied from interface: ClientResources
    
    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.
    
    Specified by:
    
    eventLoopGroupProvider in interface ClientResources
    
    Returns:
    
    the EventLoopGroupProvider which provides access to the particular event loop groups.
  - eventExecutorGroup
```
public EventExecutorGroup eventExecutorGroup()
```
    Description copied from interface: ClientResources
    
    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.
    
    Specified by:
    
    eventExecutorGroup in interface ClientResources
    
    Returns:
    
    the computation pool used for internal operations.
  - ioThreadPoolSize
```
public int ioThreadPoolSize()
```
    Description copied from interface: ClientResources
    
    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.
    
    Specified by:
    
    ioThreadPoolSize in interface ClientResources
    
    Returns:
    
    the pool size (number of threads) for all IO tasks.
  - computationThreadPoolSize
```
public int computationThreadPoolSize()
```
    Description copied from interface: ClientResources
    
    Returns the pool size (number of threads) for all computation tasks.
    
    Specified by:
    
    computationThreadPoolSize in interface ClientResources
    
    Returns:
    
    the pool size (number of threads to use).
  - eventBus
```
public EventBus eventBus()
```
    Description copied from interface: ClientResources
    
    Returns the event bus used to publish events.
    
    Specified by:
    
    eventBus in interface ClientResources
    
    Returns:
    
    the event bus.
  - timer
```
public Timer timer()
```
    Description copied from interface: ClientResources
    
    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 ClientResources.eventExecutorGroup().
    
    Specified by:
    
    timer in interface ClientResources
    
    Returns:
    
    the timer.
  - commandLatencyCollector
```
public CommandLatencyCollector commandLatencyCollector()
```
    Description copied from interface: ClientResources
    
    Returns the CommandLatencyCollector.
    
    Specified by:
    
    commandLatencyCollector in interface ClientResources
    
    Returns:
    
    the command latency collector.
  - commandLatencyPublisherOptions
```
public EventPublisherOptions commandLatencyPublisherOptions()
```
    Description copied from interface: ClientResources
    
    Returns the EventPublisherOptions for latency event publishing.
    
    Specified by:
    
    commandLatencyPublisherOptions in interface ClientResources
    
    Returns:
    
    the EventPublisherOptions for latency event publishing.
  - dnsResolver
```
public DnsResolver dnsResolver()
```
    Description copied from interface: ClientResources
    
    Returns the DnsResolver.
    
    Specified by:
    
    dnsResolver in interface ClientResources
    
    Returns:
    
    the DNS resolver.
  - socketAddressResolver
```
public SocketAddressResolver socketAddressResolver()
```
    Description copied from interface: ClientResources
    
    Returns the SocketAddressResolver.
    
    Specified by:
    
    socketAddressResolver in interface ClientResources
    
    Returns:
    
    the socket address resolver.
  - reconnectDelay
```
public Delay reconnectDelay()
```
    Description copied from interface: ClientResources
    
    Returns the Delay for reconnect attempts. May return a different instance on each call.
    
    Specified by:
    
    reconnectDelay in interface ClientResources
    
    Returns:
    
    the reconnect Delay.
  - nettyCustomizer
```
public NettyCustomizer nettyCustomizer()
```
    Description copied from interface: ClientResources
    
    Returns the NettyCustomizer to customize netty components.
    
    Specified by:
    
    nettyCustomizer in interface ClientResources
    
    Returns:
    
    the configured NettyCustomizer.
  - tracing
```
public Tracing tracing()
```
    Description copied from interface: ClientResources
    
    Returns the Tracing instance to support tracing of Redis commands.
    
    Specified by:
    
    tracing in interface ClientResources
    
    Returns:
    
    the configured Tracing.

Class DefaultClientResources

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

logger

MIN_IO_THREADS

MIN_COMPUTATION_THREADS

DEFAULT_IO_THREADS

DEFAULT_COMPUTATION_THREADS

DEFAULT_RECONNECT_DELAY

DEFAULT_NETTY_CUSTOMIZER

Constructor Detail

DefaultClientResources

Method Detail

create

builder

mutate

finalize

shutdown

shutdown

eventLoopGroupProvider

eventExecutorGroup

ioThreadPoolSize

computationThreadPoolSize

eventBus

timer

commandLatencyCollector

commandLatencyPublisherOptions

dnsResolver

socketAddressResolver

reconnectDelay

nettyCustomizer

tracing