Module lettuce.core

Package io.lettuce.core.resource

Class DefaultClientResources.Builder

java.lang.Object

io.lettuce.core.resource.DefaultClientResources.Builder

All Implemented Interfaces:

ClientResources.Builder

Enclosing class:

DefaultClientResources

public static class DefaultClientResources.Builder
extends Object
implements ClientResources.Builder

Builder for DefaultClientResources.

Method Summary

Modifier and Type	Method	Description
DefaultClientResources.Builder	addressResolverGroup(AddressResolverGroup<?> addressResolverGroup)	Sets the AddressResolverGroup for DNS resolution.
DefaultClientResources	build()
DefaultClientResources.Builder	commandLatencyCollectorOptions(CommandLatencyCollectorOptions commandLatencyCollectorOptions)	Deprecated. since 6.0.
DefaultClientResources.Builder	commandLatencyPublisherOptions(EventPublisherOptions commandLatencyPublisherOptions)	Sets the EventPublisherOptions to publish command latency metrics using the EventBus if the CommandLatencyRecorder is an instance of CommandLatencyCollector that allows latency metric retrieval.
DefaultClientResources.Builder	commandLatencyRecorder(CommandLatencyRecorder commandLatencyRecorder)	Sets the CommandLatencyRecorder that can that can be used across different instances of the RedisClient.
DefaultClientResources.Builder	computationThreadPoolSize(int computationThreadPoolSize)	Sets the thread pool size (number of threads to use) for computation operations (default value is the number of CPUs).
DefaultClientResources.Builder	dnsResolver(DnsResolver dnsResolver)	Sets the DnsResolver that is used to resolve hostnames to InetAddress.
DefaultClientResources.Builder	eventBus(EventBus eventBus)	Sets the EventBus that can that can be used across different instances of the RedisClient.
DefaultClientResources.Builder	eventExecutorGroup(EventExecutorGroup eventExecutorGroup)	Sets a shared event executor group that can be used across different instances of RedisClient and RedisClusterClient.
DefaultClientResources.Builder	eventLoopGroupProvider(EventLoopGroupProvider eventLoopGroupProvider)	Sets a shared event executor provider that can be used across different instances of RedisClient and RedisClusterClient.
DefaultClientResources.Builder	ioThreadPoolSize(int ioThreadPoolSize)	Sets the thread pool size (number of threads to use) for I/O operations (default value is the number of CPUs).
DefaultClientResources.Builder	nettyCustomizer(NettyCustomizer nettyCustomizer)	Sets the NettyCustomizer instance to customize netty components during connection.
DefaultClientResources.Builder	reconnectDelay(Delay reconnectDelay)	Sets the stateless reconnect Delay to delay reconnect attempts.
DefaultClientResources.Builder	reconnectDelay(Supplier<Delay> reconnectDelay)	Sets the stateful reconnect Supplier to delay reconnect attempts.
ClientResources.Builder	socketAddressResolver(SocketAddressResolver socketAddressResolver)	Sets the SocketAddressResolver that is used to resolve RedisURI to SocketAddress.
ClientResources.Builder	threadFactoryProvider(ThreadFactoryProvider threadFactoryProvider)	Provide a default ThreadFactoryProvider to obtain ThreadFactory for a poolName.
DefaultClientResources.Builder	timer(Timer timer)	Sets a shared Timer that can be used across different instances of RedisClient and RedisClusterClient The provided Timer instance will not be shut down when shutting down the client resources.
DefaultClientResources.Builder	tracing(Tracing tracing)	Sets the Tracing instance to trace Redis calls.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.lettuce.core.resource.ClientResources.Builder

commandLatencyCollector

Method Details

addressResolverGroup

public DefaultClientResources.Builder addressResolverGroup(AddressResolverGroup<?> addressResolverGroup)

Sets the AddressResolverGroup for DNS resolution. This option is only effective if DnsResolvers.UNRESOLVED is used as DnsResolver. Defaults to DefaultAddressResolverGroup.INSTANCE if netty-dns-resolver is not available, otherwise defaults to DnsAddressResolverGroup.

Specified by:

addressResolverGroup in interface ClientResources.Builder

Parameters:

addressResolverGroup - the AddressResolverGroup instance, must not be null.

Returns:

this ClientResources.Builder

Since:

6.1

commandLatencyPublisherOptions

public DefaultClientResources.Builder commandLatencyPublisherOptions(EventPublisherOptions commandLatencyPublisherOptions)

Sets the EventPublisherOptions to publish command latency metrics using the EventBus if the CommandLatencyRecorder is an instance of CommandLatencyCollector that allows latency metric retrieval.

Specified by:

commandLatencyPublisherOptions in interface ClientResources.Builder

Parameters:

commandLatencyPublisherOptions - the EventPublisherOptions to publish command latency metrics using the EventBus, must not be null.

Returns:

this ClientResources.Builder.

commandLatencyCollectorOptions

@Deprecated
public DefaultClientResources.Builder commandLatencyCollectorOptions(CommandLatencyCollectorOptions commandLatencyCollectorOptions)

Deprecated.

since 6.0. Configure CommandLatencyRecorder directly using CommandLatencyCollectorOptions.

Sets the CommandLatencyCollectorOptions that can that can be used across different instances of the RedisClient. The options are only effective if no commandLatencyCollector is provided.

Specified by:

commandLatencyCollectorOptions in interface ClientResources.Builder

Parameters:

commandLatencyCollectorOptions - the command latency collector options, must not be null.

Returns:

this DefaultClientResources.Builder.

commandLatencyRecorder

public DefaultClientResources.Builder commandLatencyRecorder(CommandLatencyRecorder commandLatencyRecorder)

Sets the CommandLatencyRecorder that can that can be used across different instances of the RedisClient.

Specified by:

commandLatencyRecorder in interface ClientResources.Builder

Parameters:

commandLatencyRecorder - the command latency recorder, must not be null.

Returns:

this DefaultClientResources.Builder.

computationThreadPoolSize

public DefaultClientResources.Builder computationThreadPoolSize(int computationThreadPoolSize)

Sets the thread pool size (number of threads to use) for computation operations (default value is the number of CPUs). The thread pool size is only effective if no eventExecutorGroup is provided.

Specified by:

computationThreadPoolSize in interface ClientResources.Builder

Parameters:

computationThreadPoolSize - the thread pool size, must be greater than 0.

Returns:

this DefaultClientResources.Builder.

dnsResolver

public DefaultClientResources.Builder dnsResolver(DnsResolver dnsResolver)

Sets the DnsResolver that is used to resolve hostnames to InetAddress. Defaults to DnsResolvers.JVM_DEFAULT

Specified by:

dnsResolver in interface ClientResources.Builder

Parameters:

dnsResolver - the DNS resolver, must not be null.

Returns:

this DefaultClientResources.Builder.

Since:

4.3

eventBus

public DefaultClientResources.Builder eventBus(EventBus eventBus)

Sets the EventBus that can that can be used across different instances of the RedisClient.

Specified by:

eventBus in interface ClientResources.Builder

Parameters:

eventBus - the event bus, must not be null.

Returns:

this DefaultClientResources.Builder.

eventLoopGroupProvider

public DefaultClientResources.Builder eventLoopGroupProvider(EventLoopGroupProvider eventLoopGroupProvider)

Sets a shared event executor provider that can be used across different instances of RedisClient and RedisClusterClient. The provided EventLoopGroupProvider instance will not be shut down when shutting down the client resources. You have to take care of that. This is an advanced configuration that should only be used if you know what you are doing.

Specified by:

eventLoopGroupProvider in interface ClientResources.Builder

Parameters:

eventLoopGroupProvider - the shared eventLoopGroupProvider, must not be null.

Returns:

this DefaultClientResources.Builder.

eventExecutorGroup

public DefaultClientResources.Builder eventExecutorGroup(EventExecutorGroup eventExecutorGroup)

Sets a shared event executor group that can be used across different instances of RedisClient and RedisClusterClient. The provided EventExecutorGroup instance will not be shut down when shutting down the client resources. You have to take care of that. This is an advanced configuration that should only be used if you know what you are doing.

Specified by:

eventExecutorGroup in interface ClientResources.Builder

Parameters:

eventExecutorGroup - the shared eventExecutorGroup, must not be null.

Returns:

this DefaultClientResources.Builder.

nettyCustomizer

public DefaultClientResources.Builder nettyCustomizer(NettyCustomizer nettyCustomizer)

Sets the NettyCustomizer instance to customize netty components during connection.

Specified by:

nettyCustomizer in interface ClientResources.Builder

Parameters:

nettyCustomizer - the netty customizer instance, must not be null.

Returns:

this

Since:

4.4

ioThreadPoolSize

public DefaultClientResources.Builder ioThreadPoolSize(int ioThreadPoolSize)

Sets the thread pool size (number of threads to use) for I/O operations (default value is the number of CPUs). The thread pool size is only effective if no eventLoopGroupProvider is provided.

Specified by:

ioThreadPoolSize in interface ClientResources.Builder

Parameters:

ioThreadPoolSize - the thread pool size, must be greater 0.

Returns:

this DefaultClientResources.Builder.

reconnectDelay

public DefaultClientResources.Builder reconnectDelay(Delay reconnectDelay)

Sets the stateless reconnect Delay to delay reconnect attempts. Defaults to binary exponential delay capped at 30 SECONDS. reconnectDelay must be a stateless Delay.

Specified by:

reconnectDelay in interface ClientResources.Builder

Parameters:

reconnectDelay - the reconnect delay, must not be null.

Returns:

this

Since:

4.3

reconnectDelay

public DefaultClientResources.Builder reconnectDelay(Supplier<Delay> reconnectDelay)

Sets the stateful reconnect Supplier to delay reconnect attempts. Defaults to binary exponential delay capped at 30 SECONDS.

Specified by:

reconnectDelay in interface ClientResources.Builder

Parameters:

reconnectDelay - the reconnect delay, must not be null.

Returns:

this

Since:

4.3

socketAddressResolver

public ClientResources.Builder socketAddressResolver(SocketAddressResolver socketAddressResolver)

Sets the SocketAddressResolver that is used to resolve RedisURI to SocketAddress. Defaults to SocketAddressResolver using the configured DnsResolver.

Specified by:

socketAddressResolver in interface ClientResources.Builder

Parameters:

socketAddressResolver - the socket address resolver, must not be null.

Returns:

this ClientResources.Builder.

Since:

5.1

threadFactoryProvider

public ClientResources.Builder threadFactoryProvider(ThreadFactoryProvider threadFactoryProvider)

Provide a default ThreadFactoryProvider to obtain ThreadFactory for a poolName.

Applies only to threading resources created by DefaultClientResources when not configuring ClientResources.timer(), ClientResources.eventExecutorGroup(), or ClientResources.eventLoopGroupProvider().

Specified by:

threadFactoryProvider in interface ClientResources.Builder

Parameters:

threadFactoryProvider - a provider to obtain a ThreadFactory for a poolName, must not be null.

Returns:

this ClientResources.Builder.

Since:

6.1.1

See Also:

eventExecutorGroup(EventExecutorGroup), eventLoopGroupProvider(EventLoopGroupProvider), timer(Timer)

timer

public DefaultClientResources.Builder timer(Timer timer)

Sets a shared Timer that can be used across different instances of RedisClient and RedisClusterClient The provided Timer instance will not be shut down when shutting down the client resources. You have to take care of that. This is an advanced configuration that should only be used if you know what you are doing.

Specified by:

timer in interface ClientResources.Builder

Parameters:

timer - the shared Timer, must not be null.

Returns:

this DefaultClientResources.Builder.

Since:

4.3

tracing

public DefaultClientResources.Builder tracing(Tracing tracing)

Sets the Tracing instance to trace Redis calls.

Specified by:

tracing in interface ClientResources.Builder

Parameters:

tracing - the tracer infrastructure instance, must not be null.

Returns:

this

Since:

5.1

build

public DefaultClientResources build()

Specified by:

build in interface ClientResources.Builder

Returns:

a new instance of DefaultClientResources.