DefaultClientResources (lettuce 3.4.2.Final API)

java.lang.Object
- com.lambdaworks.redis.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.
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`
`protected static io.netty.util.internal.logging.InternalLogger`	`logger`
`static int`	`MIN_COMPUTATION_THREADS`
`static int`	`MIN_IO_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
`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.
`EventBus`	`eventBus()` Returns the event bus used to publish events.
`EventExecutorGroup`	`eventExecutorGroup()` Returns the computation pool used for internal operations.
`EventLoopGroupProvider`	`eventLoopGroupProvider()` Return s the `EventLoopGroupProvider` which provides access to the particular `event loop groups`. lettuce needs 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.
`Future<Boolean>`	`shutdown()` Shutdown the `ClientResources`.
`Future<Boolean>`	`shutdown(long quietPeriod, long timeout, TimeUnit timeUnit)` Shutdown the `ClientResources`.

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
```
    See Also:
    
    Constant Field Values
  - MIN_COMPUTATION_THREADS
```
public static final int MIN_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
```
- Constructor Detail
  - DefaultClientResources
```
protected DefaultClientResources(DefaultClientResources.Builder builder)
```
- Method Detail
  - 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
    
    Return s the EventLoopGroupProvider which provides access to the particular event loop groups. lettuce needs at least two implementations: NioEventLoopGroup for TCP/IP connections and EpollEventLoopGroup for unix domain socket connections (epoll).
    
    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.
    
    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
  - 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
  - create
```
public static DefaultClientResources create()
```
    Create a new DefaultClientResources using default settings.
    
    Returns:
    
    a new instance of a default client resources.

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

Constructor Detail

DefaultClientResources

Method Detail

finalize

shutdown

shutdown

eventLoopGroupProvider

eventExecutorGroup

ioThreadPoolSize

computationThreadPoolSize

eventBus

commandLatencyCollector

commandLatencyPublisherOptions

create