Module lettuce.core

Package io.lettuce.core.resource

Class DefaultClientResources

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:

• a addressResolverGroup that is a provided instance of AddressResolverGroup.
• a commandLatencyRecorder which is a provided instance of CommandLatencyRecorder
• a dnsResolver which is a provided instance of DnsResolver.
• an eventBus which is a provided instance of EventBus.
.
• 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.
• a nettyCustomizer that is a provided instance of NettyCustomizer.
• a socketAddressResolver which is a provided instance of SocketAddressResolver.
• a threadFactoryProvider to provide a ThreadFactory for default timer, event loop and event executor instances.
• a timer that is a provided instance of HashedWheelTimer.
• a tracing that is a provided instance of Tracing.

Since:

3.4

Author:

Mark Paluch, Yohei Ueki

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultClientResources.Builder	Builder for DefaultClientResources.

Field Summary

Fields

Modifier and Type	Field	Description
static AddressResolverGroup<?>	DEFAULT_ADDRESS_RESOLVER_GROUP	Default AddressResolverGroup.
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	Description
protected	DefaultClientResources(DefaultClientResources.Builder builder)

Method Summary

Modifier and Type	Method	Description
AddressResolverGroup<?>	addressResolverGroup()	Return the AddressResolverGroup instance for DNS resolution.
static DefaultClientResources.Builder	builder()	Returns a new DefaultClientResources.Builder to construct DefaultClientResources.
EventPublisherOptions	commandLatencyPublisherOptions()	Return the EventPublisherOptions for latency event publishing.
CommandLatencyRecorder	commandLatencyRecorder()	Return the CommandLatencyRecorder.
int	computationThreadPoolSize()	Return the pool size (number of threads) for all computation tasks.
static DefaultClientResources	create()	Create a new DefaultClientResources using default settings.
DnsResolver	dnsResolver()	Return the DnsResolver.
EventBus	eventBus()	Return the event bus used to publish events.
EventExecutorGroup	eventExecutorGroup()	Return the computation pool used for internal operations.
EventLoopGroupProvider	eventLoopGroupProvider()	Return the EventLoopGroupProvider that provides access to the particular event loop groups.
protected void	finalize()
int	ioThreadPoolSize()	Return 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()	Return the NettyCustomizer to customize netty components.
Delay	reconnectDelay()	Return 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()	Return the SocketAddressResolver.
Timer	timer()	Return the Timer to schedule events.
Tracing	tracing()	Return 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 Details

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.

DEFAULT_ADDRESS_RESOLVER_GROUP

public static final AddressResolverGroup<?> DEFAULT_ADDRESS_RESOLVER_GROUP

Default AddressResolverGroup.

Constructor Details

DefaultClientResources

protected DefaultClientResources(DefaultClientResources.Builder builder)

Method Details

create

public static DefaultClientResources create()

Create a new DefaultClientResources using default settings.

Returns:

a new instance of a default client resources.

builder

public static DefaultClientResources.Builder builder()

Returns a new DefaultClientResources.Builder to construct DefaultClientResources.

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, CommandLatencyRecorder, 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.

commandLatencyRecorder

public CommandLatencyRecorder commandLatencyRecorder()

Description copied from interface: ClientResources

Return the CommandLatencyRecorder.

Specified by:

commandLatencyRecorder in interface ClientResources

Returns:

the command latency recorder.

commandLatencyPublisherOptions

public EventPublisherOptions commandLatencyPublisherOptions()

Description copied from interface: ClientResources

Return the EventPublisherOptions for latency event publishing.

Specified by:

commandLatencyPublisherOptions in interface ClientResources

Returns:

the EventPublisherOptions for latency event publishing.

computationThreadPoolSize

public int computationThreadPoolSize()

Description copied from interface: ClientResources

Return 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).

dnsResolver

public DnsResolver dnsResolver()

Description copied from interface: ClientResources

Return the DnsResolver.

Specified by:

dnsResolver in interface ClientResources

Returns:

the DNS resolver.

eventBus

public EventBus eventBus()

Description copied from interface: ClientResources

Return the event bus used to publish events.

Specified by:

eventBus in interface ClientResources

Returns:

the event bus

eventLoopGroupProvider

public EventLoopGroupProvider eventLoopGroupProvider()

Description copied from interface: ClientResources

Return 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

Return 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

Return 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.

nettyCustomizer

public NettyCustomizer nettyCustomizer()

Description copied from interface: ClientResources

Return the NettyCustomizer to customize netty components.

Specified by:

nettyCustomizer in interface ClientResources

Returns:

the configured NettyCustomizer.

reconnectDelay

public Delay reconnectDelay()

Description copied from interface: ClientResources

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

Specified by:

reconnectDelay in interface ClientResources

Returns:

the reconnect Delay.

socketAddressResolver

public SocketAddressResolver socketAddressResolver()

Description copied from interface: ClientResources

Return the SocketAddressResolver.

Specified by:

socketAddressResolver in interface ClientResources

Returns:

the socket address resolver.

timer

public Timer timer()

Description copied from interface: ClientResources

Return 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.

tracing

public Tracing tracing()

Description copied from interface: ClientResources

Return the Tracing instance to support tracing of Redis commands.

Specified by:

tracing in interface ClientResources

Returns:

the configured Tracing.

addressResolverGroup

public AddressResolverGroup<?> addressResolverGroup()

Description copied from interface: ClientResources

Return the AddressResolverGroup instance for DNS resolution.

Specified by:

addressResolverGroup in interface ClientResources

Returns:

the address resolver group.