Package io.micronaut.scheduling.executor

Class UserExecutorConfiguration

java.lang.Object

io.micronaut.scheduling.executor.UserExecutorConfiguration

All Implemented Interfaces:

ExecutorConfiguration

@EachProperty("micronaut.executors")
public class UserExecutorConfiguration
extends Object
implements ExecutorConfiguration

Allows configuration ExecutorService instances that are made available as beans.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field	Description
static final int	AVAILABLE_PROCESSORS	Number of available processors.
protected String	name
protected Integer	nThreads

Fields inherited from interface io.micronaut.scheduling.executor.ExecutorConfiguration

PREFIX, PREFIX_CONSUMER, PREFIX_IO, PREFIX_SCHEDULED

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	UserExecutorConfiguration(@Nullable String name, @Nullable Integer nThreads, @Nullable ExecutorType type, @Nullable Integer parallelism, @Nullable Integer corePoolSize, @Nullable Boolean virtual, @Nullable Class<? extends ThreadFactory> threadFactoryClass)	Default Constructor.

Method Summary

Modifier and Type	Method	Description
@Min(1L) Integer	getCorePoolSize()
@NonNull String	getName()
@Min(1L) Integer	getNumberOfThreads()
@Min(1L) Integer	getParallelism()
Optional<Class<? extends ThreadFactory>>	getThreadFactoryClass()
ExecutorType	getType()
boolean	isVirtual()
static UserExecutorConfiguration	of(ExecutorType type)	Construct a UserExecutorConfiguration for the given ExecutorType.
static UserExecutorConfiguration	of(ExecutorType type, int num)	Construct a UserExecutorConfiguration for the given ExecutorType.
static UserExecutorConfiguration	of(ExecutorType type, int num, @Nullable Class<? extends ThreadFactory> threadFactoryClass)	Construct a UserExecutorConfiguration for the given ExecutorType.
static UserExecutorConfiguration	of(String name, ExecutorType type)	Construct a UserExecutorConfiguration for the given ExecutorType.
void	setCorePoolSize(Integer corePoolSize)	Sets the core pool size for ExecutorType.SCHEDULED.
void	setName(String name)	Sets the executor name.
void	setNumberOfThreads(Integer nThreads)	Sets the number of threads for ExecutorType.FIXED.
void	setParallelism(Integer parallelism)	Sets the parallelism for ExecutorType.WORK_STEALING.
void	setThreadFactoryClass(Class<? extends ThreadFactory> threadFactoryClass)	Sets the thread factory class.
void	setType(ExecutorType type)	Sets the executor type.
void	setVirtual(boolean virtual)

Methods inherited from class java.lang.Object

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

Field Details

AVAILABLE_PROCESSORS

public static final int AVAILABLE_PROCESSORS

Number of available processors.

name

protected String name

nThreads

protected Integer nThreads

Constructor Details

UserExecutorConfiguration

@ConfigurationInject
protected UserExecutorConfiguration(@Nullable @Parameter
 @Nullable String name,
 @Nullable
 @Nullable Integer nThreads,
 @Nullable
 @Nullable ExecutorType type,
 @Nullable
 @Nullable Integer parallelism,
 @Nullable
 @Nullable Integer corePoolSize,
 @Nullable
 @Nullable Boolean virtual,
 @Nullable
 @Nullable Class<? extends ThreadFactory> threadFactoryClass)

Default Constructor.

Parameters:

name - the name

nThreads - number of threads

type - the type

parallelism - the parallelism

corePoolSize - the core pool size

virtual - whether to use virtual threads

threadFactoryClass - the thread factory class

Method Details

getName

@NonNull
public @NonNull String getName()

Specified by:

getName in interface ExecutorConfiguration

Returns:

The name of the component

getType

public ExecutorType getType()

Specified by:

getType in interface ExecutorConfiguration

Returns:

The ExecutorType

getParallelism

@Min(1L)
public @Min(1L) Integer getParallelism()

Specified by:

getParallelism in interface ExecutorConfiguration

Returns:

The parallelism for ExecutorType.WORK_STEALING

getNumberOfThreads

@Min(1L)
public @Min(1L) Integer getNumberOfThreads()

Specified by:

getNumberOfThreads in interface ExecutorConfiguration

Returns:

The number of threads for ExecutorType.FIXED

getCorePoolSize

@Min(1L)
public @Min(1L) Integer getCorePoolSize()

Specified by:

getCorePoolSize in interface ExecutorConfiguration

Returns:

The core pool size for ExecutorType.SCHEDULED

isVirtual

public boolean isVirtual()

Specified by:

isVirtual in interface ExecutorConfiguration

Returns:

Whether the pool should use virtual threads.

setVirtual

public void setVirtual(boolean virtual)

Parameters:

virtual - Whether the pool should use virtual threads

getThreadFactoryClass

public Optional<Class<? extends ThreadFactory>> getThreadFactoryClass()

Specified by:

getThreadFactoryClass in interface ExecutorConfiguration

Returns:

The class to use as the ThreadFactory

setName

public void setName(String name)

Sets the executor name.

Parameters:

name - The name

setType

public void setType(ExecutorType type)

Sets the executor type. Default value (ExecutorType.SCHEDULED).

Parameters:

type - The type

setParallelism

public void setParallelism(Integer parallelism)

Sets the parallelism for ExecutorType.WORK_STEALING. Default value (Number of processors available to the Java virtual machine).

Parameters:

parallelism - The parallelism

setNumberOfThreads

public void setNumberOfThreads(Integer nThreads)

Sets the number of threads for ExecutorType.FIXED. Default value (2 * Number of processors available to the Java virtual machine).

Parameters:

nThreads - The number of threads

setCorePoolSize

public void setCorePoolSize(Integer corePoolSize)

Sets the core pool size for ExecutorType.SCHEDULED. Default value (2 * Number of processors available to the Java virtual machine).

Parameters:

corePoolSize - The core pool size

setThreadFactoryClass

public void setThreadFactoryClass(Class<? extends ThreadFactory> threadFactoryClass)

Sets the thread factory class.

Parameters:

threadFactoryClass - The thread factory class.

of

public static UserExecutorConfiguration of(ExecutorType type)

Construct a UserExecutorConfiguration for the given ExecutorType.

Parameters:

type - The type

Returns:

The configuration

of

public static UserExecutorConfiguration of(String name,
 ExecutorType type)

Construct a UserExecutorConfiguration for the given ExecutorType.

Parameters:

name - The name

type - The type

Returns:

The configuration

of

public static UserExecutorConfiguration of(ExecutorType type,
 int num)

Construct a UserExecutorConfiguration for the given ExecutorType.

Parameters:

type - The type

num - The number of threads for ExecutorType.FIXED or the parallelism for ExecutorType.WORK_STEALING or the core pool size for ExecutorType.SCHEDULED

Returns:

The configuration

of

public static UserExecutorConfiguration of(ExecutorType type,
 int num,
 @Nullable
 @Nullable Class<? extends ThreadFactory> threadFactoryClass)

Construct a UserExecutorConfiguration for the given ExecutorType.

Parameters:

type - The type

num - The number of threads for ExecutorType.FIXED or the parallelism for ExecutorType.WORK_STEALING or the core pool size for ExecutorType.SCHEDULED

threadFactoryClass - The thread factory class

Returns:

The configuration