Spring Messaging 6.1.4 · org.springframework.messaging.simp.config.TaskExecutorRegistration

Modifier and Type	Field and Description
private Integer	corePoolSize
private Integer	keepAliveSeconds
private Integer	maxPoolSize
private Integer	queueCapacity
private final ThreadPoolTaskExecutor	taskExecutor Deprecated as a consequence of `ThreadPoolTaskExecutor` being deprecated.

Constructor Summary

Access	Constructor and Description
public	TaskExecutorRegistration() Create a new `TaskExecutorRegistration` for a default `ThreadPoolTaskExecutor`.
public	TaskExecutorRegistration(ThreadPoolTaskExecutor the executor to use taskExecutor) Deprecated as a consequence of `ThreadPoolTaskExecutor` being deprecated. Create a new `TaskExecutorRegistration` for a given `ThreadPoolTaskExecutor`.

Method Summary

Modifier and Type	Method and Description
public TaskExecutorRegistration	corePoolSize(int corePoolSize) Set the core pool size of the ThreadPoolExecutor.
protected ThreadPoolTaskExecutor	getTaskExecutor() Deprecated as a consequence of `ThreadPoolTaskExecutor` being deprecated.
public TaskExecutorRegistration	keepAliveSeconds(int keepAliveSeconds) Set the time limit for which threads may remain idle before being terminated.
public TaskExecutorRegistration	maxPoolSize(int maxPoolSize) Set the max pool size of the ThreadPoolExecutor.
public TaskExecutorRegistration	queueCapacity(int queueCapacity) Set the queue capacity for the ThreadPoolExecutor.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

corePoolSize	back to summary
private Integer corePoolSize Annotations @Nullable

keepAliveSeconds	back to summary
private Integer keepAliveSeconds Annotations @Nullable

maxPoolSize	back to summary
private Integer maxPoolSize Annotations @Nullable

queueCapacity	back to summary
private Integer queueCapacity Annotations @Nullable

taskExecutor	back to summary
private final ThreadPoolTaskExecutor taskExecutor Deprecated as a consequence of `ThreadPoolTaskExecutor` being deprecated. See corresponding docs for further information.

Constructor Detail

TaskExecutorRegistration	back to summary
public TaskExecutorRegistration() Create a new `TaskExecutorRegistration` for a default `ThreadPoolTaskExecutor`.

TaskExecutorRegistration back to summary

TaskExecutorRegistration	back to summary
public TaskExecutorRegistration(ThreadPoolTaskExecutor taskExecutor) Deprecated as a consequence of `ThreadPoolTaskExecutor` being deprecated. See corresponding docs for further information. Create a new `TaskExecutorRegistration` for a given `ThreadPoolTaskExecutor`. Parameters taskExecutor:ThreadPoolTaskExecutor the executor to use

public TaskExecutorRegistration(ThreadPoolTaskExecutor taskExecutor)

Deprecated

as a consequence of ThreadPoolTaskExecutor being deprecated. See corresponding docs for further information.

Create a new TaskExecutorRegistration for a given ThreadPoolTaskExecutor.

Parameters

taskExecutor:ThreadPoolTaskExecutor: the executor to use

Method Detail

corePoolSize back to summary

corePoolSize	back to summary
public TaskExecutorRegistration corePoolSize(int corePoolSize) Set the core pool size of the ThreadPoolExecutor. Note The core pool size is effectively the max pool size when an unbounded `queueCapacity` is configured (the default). This is essentially the "Unbounded queues" strategy as explained in `ThreadPoolExecutor`. When this strategy is used, the `maxPoolSize` is ignored. By default this is set to twice the value of `Runtime#availableProcessors()`. In an application where tasks do not block frequently, the number should be closer to or equal to the number of available CPUs/cores.

public TaskExecutorRegistration corePoolSize(int corePoolSize)

Set the core pool size of the ThreadPoolExecutor.

Note

The core pool size is effectively the max pool size when an unbounded queueCapacity is configured (the default). This is essentially the "Unbounded queues" strategy as explained in ThreadPoolExecutor. When this strategy is used, the maxPoolSize is ignored.

By default this is set to twice the value of Runtime#availableProcessors(). In an application where tasks do not block frequently, the number should be closer to or equal to the number of available CPUs/cores.

getTaskExecutor	back to summary
protected ThreadPoolTaskExecutor getTaskExecutor() Deprecated as a consequence of `ThreadPoolTaskExecutor` being deprecated. See corresponding docs for further information.

keepAliveSeconds	back to summary
public TaskExecutorRegistration keepAliveSeconds(int keepAliveSeconds) Set the time limit for which threads may remain idle before being terminated. If there are more than the core number of threads currently in the pool, after waiting this amount of time without processing a task, excess threads will be terminated. This overrides any value set in the constructor. By default this is set to 60.

keepAliveSeconds

back to summary

public TaskExecutorRegistration keepAliveSeconds(int keepAliveSeconds)

Set the time limit for which threads may remain idle before being terminated. If there are more than the core number of threads currently in the pool, after waiting this amount of time without processing a task, excess threads will be terminated. This overrides any value set in the constructor.

By default this is set to 60.

maxPoolSize back to summary

maxPoolSize	back to summary
public TaskExecutorRegistration maxPoolSize(int maxPoolSize) Set the max pool size of the ThreadPoolExecutor. Note When an unbounded `queueCapacity` is configured (the default), the max pool size is effectively ignored. See the "Unbounded queues" strategy in `ThreadPoolExecutor` for more details. By default this is set to `Integer.MAX_VALUE`.

public TaskExecutorRegistration maxPoolSize(int maxPoolSize)

Set the max pool size of the ThreadPoolExecutor.

Note

When an unbounded queueCapacity is configured (the default), the max pool size is effectively ignored. See the "Unbounded queues" strategy in ThreadPoolExecutor for more details.

By default this is set to Integer.MAX_VALUE.

queueCapacity back to summary

queueCapacity	back to summary
public TaskExecutorRegistration queueCapacity(int queueCapacity) Set the queue capacity for the ThreadPoolExecutor. Note when an unbounded `queueCapacity` is configured (the default), the core pool size is effectively the max pool size. This is essentially the "Unbounded queues" strategy as explained in `ThreadPoolExecutor`. When this strategy is used, the `maxPoolSize` is ignored. By default this is set to `Integer.MAX_VALUE`.

public TaskExecutorRegistration queueCapacity(int queueCapacity)

Set the queue capacity for the ThreadPoolExecutor.

Note

when an unbounded queueCapacity is configured (the default), the core pool size is effectively the max pool size. This is essentially the "Unbounded queues" strategy as explained in ThreadPoolExecutor. When this strategy is used, the maxPoolSize is ignored.

By default this is set to Integer.MAX_VALUE.

public Class TaskExecutorRegistration

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail