Package ch.raffael.meldioc.library.base.lifecycle

Class ExecutorShutdownController

java.lang.Object

ch.raffael.meldioc.library.base.lifecycle.ExecutorShutdownController

All Implemented Interfaces:

ShutdownController, ShutdownController.Actuator

public class ExecutorShutdownController
extends java.lang.Object
implements ShutdownController, ShutdownController.Actuator

A shutdown controller that allows to parallelize the shutdown.

The prepare and perform callbacks are called in parallel, but not overlapping (i.e. peform callbacks will only be called after all prepare callbacks are finished.

The finalize callback will be called serially the thread initiating the shutdown (finalizing the shutdown usually includes to destroying the work thread pool).

Nested Class Summary

Nested classes/interfaces inherited from interface ch.raffael.meldioc.library.base.lifecycle.ShutdownController

ShutdownController.Actuator, ShutdownController.IllegalShutdownStateException, ShutdownController.State, ShutdownController.Wrapper

Constructor Summary

Constructors

Constructor	Description
ExecutorShutdownController(java.util.function.Supplier<? extends java.util.concurrent.Executor> executor)

Method Summary

Modifier and Type	Method	Description
ExecutorShutdownController	actuator()
void	announceShutdown()
ShutdownController	controller()
<T> T	getPreventingShutdown(java.util.function.Supplier<T> supplier)	Run an action that prevents a shutdown being performed while running.
protected void	onDoShutdown()
void	onFinalize(io.vavr.CheckedRunnable callback)
void	onPerform(io.vavr.CheckedRunnable callback)
void	onPrepare(io.vavr.CheckedRunnable callback)
protected void	onShutdownComplete(io.vavr.collection.Seq<java.lang.Throwable> exceptions)
io.vavr.collection.Seq<java.lang.Throwable>	performShutdown()
ShutdownController.State	state()

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.raffael.meldioc.library.base.lifecycle.ShutdownController.Actuator

runPreventingShutdown

Constructor Details

ExecutorShutdownController

public ExecutorShutdownController(java.util.function.Supplier<? extends java.util.concurrent.Executor> executor)

Method Details

onPrepare

public void onPrepare(io.vavr.CheckedRunnable callback)

Specified by:

onPrepare in interface ShutdownController

onPerform

public void onPerform(io.vavr.CheckedRunnable callback)

Specified by:

onPerform in interface ShutdownController

onFinalize

public void onFinalize(io.vavr.CheckedRunnable callback)

Specified by:

onFinalize in interface ShutdownController

controller

public ShutdownController controller()

Specified by:

controller in interface ShutdownController.Actuator

state

public ShutdownController.State state()

Specified by:

state in interface ShutdownController

Specified by:

state in interface ShutdownController.Actuator

actuator

public ExecutorShutdownController actuator()

getPreventingShutdown

public <T> T getPreventingShutdown(java.util.function.Supplier<T> supplier)

Description copied from interface: ShutdownController.Actuator

Run an action that prevents a shutdown being performed while running.

Specified by:

getPreventingShutdown in interface ShutdownController.Actuator

announceShutdown

public void announceShutdown()

Specified by:

announceShutdown in interface ShutdownController.Actuator

performShutdown

public io.vavr.collection.Seq<java.lang.Throwable> performShutdown()
                                                            throws java.lang.InterruptedException

Specified by:

performShutdown in interface ShutdownController.Actuator

Throws:

java.lang.InterruptedException

onShutdownComplete

protected void onShutdownComplete(io.vavr.collection.Seq<java.lang.Throwable> exceptions)

onDoShutdown

protected void onDoShutdown()