Module lettuce.core

Package io.lettuce.core.resource

Interface ClientResources.Builder

All Known Implementing Classes:

DefaultClientResources.Builder

Enclosing interface:

ClientResources

public static interface ClientResources.Builder

Builder for ClientResources.

Since:

5.1

Method Summary

Modifier and Type	Method	Description
ClientResources.Builder	addressResolverGroup(AddressResolverGroup<?> addressResolverGroup)	Sets the AddressResolverGroup for DNS resolution.
ClientResources	build()
default ClientResources.Builder	commandLatencyCollector(CommandLatencyCollector commandLatencyCollector)	Deprecated. since 6.0, use commandLatencyRecorder(CommandLatencyRecorder) instead.
ClientResources.Builder	commandLatencyCollectorOptions(CommandLatencyCollectorOptions commandLatencyCollectorOptions)	Deprecated. since 6.0.
ClientResources.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.
ClientResources.Builder	commandLatencyRecorder(CommandLatencyRecorder latencyRecorder)	Sets the CommandLatencyRecorder that can that can be used across different instances of the RedisClient.
ClientResources.Builder	computationThreadPoolSize(int computationThreadPoolSize)	Sets the thread pool size (number of threads to use) for computation operations (default value is the number of CPUs).
ClientResources.Builder	dnsResolver(DnsResolver dnsResolver)	Deprecated. since 6.1.
ClientResources.Builder	eventBus(EventBus eventBus)	Sets the EventBus that can that can be used across different instances of the RedisClient.
ClientResources.Builder	eventExecutorGroup(EventExecutorGroup eventExecutorGroup)	Sets a shared event executor group that can be used across different instances of RedisClient and RedisClusterClient.
ClientResources.Builder	eventLoopGroupProvider(EventLoopGroupProvider eventLoopGroupProvider)	Sets a shared event executor provider that can be used across different instances of RedisClient and RedisClusterClient.
ClientResources.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).
ClientResources.Builder	nettyCustomizer(NettyCustomizer nettyCustomizer)	Sets the NettyCustomizer instance to customize netty components during connection.
ClientResources.Builder	reconnectDelay(Delay reconnectDelay)	Sets the stateless reconnect Delay to delay reconnect attempts.
ClientResources.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 to create threads.
ClientResources.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.
ClientResources.Builder	tracing(Tracing tracing)	Sets the Tracing instance to trace Redis calls.

Method Details

addressResolverGroup

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

Parameters:

addressResolverGroup - the AddressResolverGroup instance, must not be null.

Returns:

this ClientResources.Builder

Since:

6.1

commandLatencyCollector

@Deprecated
default ClientResources.Builder commandLatencyCollector(CommandLatencyCollector commandLatencyCollector)

Deprecated.

since 6.0, use commandLatencyRecorder(CommandLatencyRecorder) instead.

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

Parameters:

commandLatencyCollector - the command latency collector, must not be null.

Returns:

this ClientResources.Builder.

commandLatencyRecorder

ClientResources.Builder commandLatencyRecorder(CommandLatencyRecorder latencyRecorder)

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

Parameters:

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

Returns:

this ClientResources.Builder.

Since:

6.0

commandLatencyCollectorOptions

@Deprecated
ClientResources.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.

Parameters:

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

Returns:

this ClientResources.Builder.

commandLatencyPublisherOptions

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

Parameters:

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

Returns:

this ClientResources.Builder.

computationThreadPoolSize

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

Parameters:

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

Returns:

this ClientResources.Builder.

dnsResolver

@Deprecated
ClientResources.Builder dnsResolver(DnsResolver dnsResolver)

Deprecated.

since 6.1. Configure AddressResolverGroup instead.

Sets the DnsResolver that is used to resolve hostnames to InetAddress. Defaults to DnsResolvers.UNRESOLVED to use netty's AddressResolverGroup.

Parameters:

dnsResolver - the DNS resolver, must not be null.

Returns:

this ClientResources.Builder.

Since:

4.3

eventBus

ClientResources.Builder eventBus(EventBus eventBus)

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

Parameters:

eventBus - the event bus, must not be null.

Returns:

this ClientResources.Builder.

eventExecutorGroup

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

Parameters:

eventExecutorGroup - the shared eventExecutorGroup, must not be null.

Returns:

this ClientResources.Builder.

eventLoopGroupProvider

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

Parameters:

eventLoopGroupProvider - the shared eventLoopGroupProvider, must not be null.

Returns:

this ClientResources.Builder.

ioThreadPoolSize

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

Parameters:

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

Returns:

this ClientResources.Builder.

nettyCustomizer

ClientResources.Builder nettyCustomizer(NettyCustomizer nettyCustomizer)

Sets the NettyCustomizer instance to customize netty components during connection.

Parameters:

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

Returns:

this

Since:

4.4

reconnectDelay

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

Parameters:

reconnectDelay - the reconnect delay, must not be null.

Returns:

this

Since:

4.3

reconnectDelay

ClientResources.Builder reconnectDelay(Supplier<Delay> reconnectDelay)

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

Parameters:

reconnectDelay - the reconnect delay, must not be null.

Returns:

this

Since:

4.3

socketAddressResolver

ClientResources.Builder socketAddressResolver(SocketAddressResolver socketAddressResolver)

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

Parameters:

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

Returns:

this ClientResources.Builder.

Since:

5.1

threadFactoryProvider

ClientResources.Builder threadFactoryProvider(ThreadFactoryProvider threadFactoryProvider)

Provide a default ThreadFactoryProvider to obtain ThreadFactory for a poolName to create threads.

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

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

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

Parameters:

timer - the shared Timer, must not be null.

Returns:

this ClientResources.Builder.

Since:

4.3

tracing

ClientResources.Builder tracing(Tracing tracing)

Sets the Tracing instance to trace Redis calls.

Parameters:

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

Returns:

this

Since:

5.1

build

ClientResources build()

Returns:

a new instance of DefaultClientResources.