Module io.helidon.common.configurable

Package io.helidon.common.configurable

Class ThreadPoolConfig.BuilderBase.ThreadPoolConfigImpl

java.lang.Object

io.helidon.common.configurable.ThreadPoolConfig.BuilderBase.ThreadPoolConfigImpl

All Implemented Interfaces:

Prototype.Api, Prototype.Factory<ThreadPoolSupplier>, ThreadPoolConfig, Supplier<ThreadPoolSupplier>

Enclosing class:

ThreadPoolConfig.BuilderBase<BUILDER extends ThreadPoolConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ThreadPoolConfig>

protected static class ThreadPoolConfig.BuilderBase.ThreadPoolConfigImpl
extends Object
implements ThreadPoolConfig, Supplier<ThreadPoolSupplier>

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface io.helidon.common.configurable.ThreadPoolConfig

ThreadPoolConfig.Builder, ThreadPoolConfig.BuilderBase<BUILDER extends ThreadPoolConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends ThreadPoolConfig>

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ThreadPoolConfigImpl(ThreadPoolConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
ThreadPoolSupplier	build()	Create a new instance of the runtime type from this config object.
int	corePoolSize()	Core pool size of the thread pool executor.
boolean	daemon()	Is daemon of the thread pool executor.
boolean	equals(Object o)
ThreadPoolSupplier	get()
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.
int	hashCode()
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.
String	toString()
boolean	virtualThreads()	When configured to true, an unbounded virtual executor service (project Loom) will be used.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

Constructor Details

ThreadPoolConfigImpl

protected ThreadPoolConfigImpl(ThreadPoolConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

build

public ThreadPoolSupplier build()

Description copied from interface: Prototype.Factory

Create a new instance of the runtime type from this config object.

Specified by:

build in interface Prototype.Factory<ThreadPoolSupplier>

Returns:

new configured runtime instance

get

public ThreadPoolSupplier get()

Specified by:

get in interface Supplier<ThreadPoolSupplier>

virtualThreads

public boolean virtualThreads()

Description copied from interface: ThreadPoolConfig

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!

Specified by:

virtualThreads in interface ThreadPoolConfig

Returns:

whether to use virtual threads or not, defaults to false

corePoolSize

public int corePoolSize()

Description copied from interface: ThreadPoolConfig

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

Specified by:

corePoolSize in interface ThreadPoolConfig

Returns:

corePoolSize see ThreadPoolExecutor.getCorePoolSize()

maxPoolSize

public int maxPoolSize()

Description copied from interface: ThreadPoolConfig

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

Specified by:

maxPoolSize in interface ThreadPoolConfig

Returns:

maxPoolSize see ThreadPoolExecutor.getMaximumPoolSize()

keepAlive

public Duration keepAlive()

Description copied from interface: ThreadPoolConfig

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

Specified by:

keepAlive in interface ThreadPoolConfig

Returns:

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

queueCapacity

public int queueCapacity()

Description copied from interface: ThreadPoolConfig

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

Specified by:

queueCapacity in interface ThreadPoolConfig

Returns:

capacity of the queue backing the executor

daemon

public boolean daemon()

Description copied from interface: ThreadPoolConfig

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

Specified by:

daemon in interface ThreadPoolConfig

Returns:

whether the threads are daemon threads

name

public Optional<String> name()

Description copied from interface: ThreadPoolConfig

Name of this thread pool executor.

Specified by:

name in interface ThreadPoolConfig

Returns:

the pool name

growthThreshold

public int growthThreshold()

Description copied from interface: ThreadPoolConfig

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

Specified by:

growthThreshold in interface ThreadPoolConfig

Returns:

the growth threshold

growthRate

public int growthRate()

Description copied from interface: ThreadPoolConfig

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

Specified by:

growthRate in interface ThreadPoolConfig

Returns:

the growth rate

rejectionHandler

public ThreadPool.RejectionHandler rejectionHandler()

Description copied from interface: ThreadPoolConfig

Rejection policy of the thread pool executor.

Specified by:

rejectionHandler in interface ThreadPoolConfig

Returns:

the rejection handler

threadNamePrefix

public Optional<String> threadNamePrefix()

Description copied from interface: ThreadPoolConfig

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

Specified by:

threadNamePrefix in interface ThreadPoolConfig

Returns:

prefix of a thread name

shouldPrestart

public boolean shouldPrestart()

Description copied from interface: ThreadPoolConfig

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

Specified by:

shouldPrestart in interface ThreadPoolConfig

Returns:

whether to prestart the threads

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object