Module io.helidon.common.configurable

Package io.helidon.common.configurable

Interface ThreadPoolConfig

All Superinterfaces:

Prototype.Api, Prototype.Factory<ThreadPoolSupplier>

All Known Implementing Classes:

ThreadPoolConfig.BuilderBase.ThreadPoolConfigImpl

public interface ThreadPoolConfig
extends Prototype.Api

Interface generated from definition. Please add javadoc to the definition interface.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ThreadPoolConfig.Builder	Fluent API builder for ThreadPoolSupplier.
static class	ThreadPoolConfig.BuilderBase<BUILDER extends ThreadPoolConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ThreadPoolConfig>	Fluent API builder base for ThreadPoolSupplier.

Field Summary

Fields

Modifier and Type	Field	Description
static final int	DEFAULT_CORE_POOL_SIZE	Default core pool size (10).
static final int	DEFAULT_GROWTH_RATE	Default growth rate (0).
static final int	DEFAULT_GROWTH_THRESHOLD	Default growth threshold (1000).
static final boolean	DEFAULT_IS_DAEMON	Default is daemon (true).
static final String	DEFAULT_KEEP_ALIVE	Default keep alive (duration format - "PT3M").
static final int	DEFAULT_MAX_POOL_SIZE	Default max pool size (50).
static final boolean	DEFAULT_PRESTART	Default prestart of threads (true).
static final int	DEFAULT_QUEUE_CAPACITY	Default queue capacity (10000).
static final String	DEFAULT_THREAD_NAME_PREFIX	Default thread name prefix ("helidon-").

Method Summary

Modifier and Type	Method	Description
static ThreadPoolConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static ThreadPoolConfig.Builder	builder(ThreadPoolConfig instance)	Create a new fluent API builder from an existing instance.
int	corePoolSize()	Core pool size of the thread pool executor.
static ThreadPoolConfig	create()	Create a new instance with default values.
static ThreadPoolConfig	create(Config config)	Create a new instance from configuration.
boolean	daemon()	Is daemon of the thread pool executor.
int	growthRate()	The percentage of task submissions that should result in adding threads, expressed as a value from 1 to 100.
int	growthThreshold()	The queue size above which pool growth will be considered if the pool is not fixed size.
Duration	keepAlive()	Keep alive of the thread pool executor.
int	maxPoolSize()	Max pool size of the thread pool executor.
Optional<String>	name()	Name of this thread pool executor.
int	queueCapacity()	Queue capacity of the thread pool executor.
ThreadPool.RejectionHandler	rejectionHandler()	Rejection policy of the thread pool executor.
boolean	shouldPrestart()	Whether to prestart core threads in this thread pool executor.
Optional<String>	threadNamePrefix()	Name prefix for threads in this thread pool executor.
boolean	virtualThreads()	When configured to true, an unbounded virtual executor service (project Loom) will be used.

Methods inherited from interface io.helidon.builder.api.Prototype.Factory

build

Field Details

DEFAULT_CORE_POOL_SIZE

static final int DEFAULT_CORE_POOL_SIZE

Default core pool size (10).

See Also:

• corePoolSize()
• Constant Field Values

DEFAULT_MAX_POOL_SIZE

static final int DEFAULT_MAX_POOL_SIZE

Default max pool size (50).

See Also:

• maxPoolSize()
• Constant Field Values

DEFAULT_KEEP_ALIVE

static final String DEFAULT_KEEP_ALIVE

Default keep alive (duration format - "PT3M").

See Also:

• keepAlive()
• Constant Field Values

DEFAULT_QUEUE_CAPACITY

static final int DEFAULT_QUEUE_CAPACITY

Default queue capacity (10000).

See Also:

• queueCapacity()
• Constant Field Values

DEFAULT_IS_DAEMON

static final boolean DEFAULT_IS_DAEMON

Default is daemon (true).

See Also:

• daemon()
• Constant Field Values

DEFAULT_THREAD_NAME_PREFIX

static final String DEFAULT_THREAD_NAME_PREFIX

Default thread name prefix ("helidon-").

See Also:

• threadNamePrefix()
• Constant Field Values

DEFAULT_PRESTART

static final boolean DEFAULT_PRESTART

Default prestart of threads (true).

See Also:

• shouldPrestart()
• Constant Field Values

DEFAULT_GROWTH_RATE

static final int DEFAULT_GROWTH_RATE

Default growth rate (0).

See Also:

• growthRate()
• Constant Field Values

DEFAULT_GROWTH_THRESHOLD

static final int DEFAULT_GROWTH_THRESHOLD

Default growth threshold (1000).

See Also:

• growthThreshold()
• Constant Field Values

Method Details

builder

static ThreadPoolConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static ThreadPoolConfig.Builder builder(ThreadPoolConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static ThreadPoolConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static ThreadPoolConfig create()

Create a new instance with default values.

Returns:

a new instance

virtualThreads

boolean virtualThreads()

When configured to true, an unbounded virtual executor service (project Loom) will be used.

If enabled, all other configuration options of this executor service are ignored!

Returns:

whether to use virtual threads or not, defaults to false

corePoolSize

int corePoolSize()

Core pool size of the thread pool executor. Defaults to 10.

Returns:

corePoolSize see ThreadPoolExecutor.getCorePoolSize()

maxPoolSize

int maxPoolSize()

Max pool size of the thread pool executor. Defaults to 50.

Returns:

maxPoolSize see ThreadPoolExecutor.getMaximumPoolSize()

keepAlive

Duration keepAlive()

Keep alive of the thread pool executor. Defaults to "PT3M".

Returns:

keep alive see ThreadPoolExecutor.getKeepAliveTime(java.util.concurrent.TimeUnit)

queueCapacity

int queueCapacity()

Queue capacity of the thread pool executor. Defaults to 10000.

Returns:

capacity of the queue backing the executor

daemon

boolean daemon()

Is daemon of the thread pool executor. Defaults to true.

Returns:

whether the threads are daemon threads

name

Optional<String> name()

Name of this thread pool executor.

Returns:

the pool name

growthThreshold

int growthThreshold()

The queue size above which pool growth will be considered if the pool is not fixed size. Defaults to 1000.

Returns:

the growth threshold

growthRate

int growthRate()

The percentage of task submissions that should result in adding threads, expressed as a value from 1 to 100. The rate applies only when all of the following are true:

• the pool size is below the maximum, and
• there are no idle threads, and
• the number of tasks in the queue exceeds the growthThreshold

For example, a rate of 20 means that while these conditions are met one thread will be added for every 5 submitted tasks.

Defaults to 0

Returns:

the growth rate

rejectionHandler

ThreadPool.RejectionHandler rejectionHandler()

Rejection policy of the thread pool executor.

Returns:

the rejection handler

threadNamePrefix

Optional<String> threadNamePrefix()

Name prefix for threads in this thread pool executor. Defaults to "helidon-".

Returns:

prefix of a thread name

shouldPrestart

boolean shouldPrestart()

Whether to prestart core threads in this thread pool executor. Defaults to true.

Returns:

whether to prestart the threads