Package io.micronaut.scheduling.executor

Class ExecutorFactory

java.lang.Object

io.micronaut.scheduling.executor.ExecutorFactory

All Implemented Interfaces:

GracefulShutdownCapable

@Factory
public class ExecutorFactory
extends Object
implements GracefulShutdownCapable

Constructs ExecutorService instances based on UserExecutorConfiguration instances.

Since:

1.0

Author:

Graeme Rocher

Constructor Summary

Constructors

Constructor	Description
ExecutorFactory(BeanLocator beanLocator, ThreadFactory threadFactory)

Method Summary

Modifier and Type	Method	Description
protected ThreadFactory	eventLoopGroupThreadFactory(ExecutorConfiguration configuration)	Constructs an executor thread factory.
ExecutorService	executorService(ExecutorConfiguration executorConfiguration)	Create the ExecutorService with the given configuration.
OptionalLong	reportActiveTasks()	After a call to GracefulShutdownCapable.shutdownGracefully() report the state of the shutdown.
@NonNull CompletionStage<?>	shutdownGracefully()	Trigger a graceful shutdown.

Methods inherited from class java.lang.Object

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

Constructor Details

ExecutorFactory

@Inject
public ExecutorFactory(BeanLocator beanLocator,
 ThreadFactory threadFactory)

Parameters:

beanLocator - The bean beanLocator

threadFactory - The factory to create new threads

Since:

2.0.1

Method Details

eventLoopGroupThreadFactory

@EachBean(ExecutorConfiguration.class)
protected ThreadFactory eventLoopGroupThreadFactory(ExecutorConfiguration configuration)

Constructs an executor thread factory.

Parameters:

configuration - The configuration

Returns:

The thread factory

executorService

@EachBean(ExecutorConfiguration.class)
@Bean(preDestroy="shutdown")
public ExecutorService executorService(ExecutorConfiguration executorConfiguration)

Create the ExecutorService with the given configuration.

Parameters:

executorConfiguration - The configuration to create a thread pool that creates new threads as needed

Returns:

A thread pool that creates new threads as needed

shutdownGracefully

@NonNull
public @NonNull CompletionStage<?> shutdownGracefully()

Description copied from interface: GracefulShutdownCapable

Trigger a graceful shutdown. The returned CompletionStage will complete when the shutdown is complete.

Note that the completion of the returned future may be user-dependent. If a user does not close their connection, the future may never terminate. Always add a timeout for a hard shutdown.

This method should not throw an exception, nor should the returned stage complete exceptionally. Just log an error instead.

Specified by:

shutdownGracefully in interface GracefulShutdownCapable

Returns:

A future that completes when this bean is fully shut down

reportActiveTasks

public OptionalLong reportActiveTasks()

Description copied from interface: GracefulShutdownCapable

After a call to GracefulShutdownCapable.shutdownGracefully() report the state of the shutdown. If GracefulShutdownCapable.shutdownGracefully() has not been called the behavior of this method is undefined.

Specified by:

reportActiveTasks in interface GracefulShutdownCapable

Returns:

The current number of still-active tasks before the shutdown completes, or Optional.empty() if no state can be reported