GracefulShutdownManager (micronaut-parent 4.9.2-SNAPSHOT API)

java.lang.Object

io.micronaut.runtime.graceful.GracefulShutdownManager

@Singleton @Requires(classes=GracefulShutdownCapable.class) public final class GracefulShutdownManager extends Object

Helper class that can be used to call all GracefulShutdownCapable beans.

Since:: 4.9.0
Author:: Jonas Konrad

Method Summary

Modifier and Type

Method

Description

@NonNull OptionalLong

reportActiveTasks()

Report the shutdown state of all capable beans.

@NonNull CompletionStage<?>

shutdownGracefully()

Shut down all GracefulShutdownCapable beans.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- shutdownGracefully
  
  @NonNull public @NonNull CompletionStage<?> shutdownGracefully()
  
  Shut down all GracefulShutdownCapable beans. Semantics of this method are like GracefulShutdownCapable.shutdownGracefully().
  
  Returns:
  
  A future that completes when all GracefulShutdownCapable beans have shut down
- reportActiveTasks
  
  @NonNull public @NonNull OptionalLong reportActiveTasks()
  
  Report the shutdown state of all capable beans.
  
  Returns:
  
  The combined number of active tasks