final class CoordinatedShutdown extends Extension
Not for user instantiation, use the extension to access
- Alphabetic
- By Inheritance
- CoordinatedShutdown
- Extension
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Value Members
-   final  def !=(arg0: Any): Boolean- Definition Classes
- AnyRef → Any
 
-   final  def ##: Int- Definition Classes
- AnyRef → Any
 
-    def +(other: String): String- Implicit
- This member is added by an implicit conversion from CoordinatedShutdown toany2stringadd[CoordinatedShutdown] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
 
-    def ->[B](y: B): (CoordinatedShutdown, B)- Implicit
- This member is added by an implicit conversion from CoordinatedShutdown toArrowAssoc[CoordinatedShutdown] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
 
-   final  def ==(arg0: Any): Boolean- Definition Classes
- AnyRef → Any
 
-    def addActorTerminationTask(phase: String, taskName: String, actor: ActorRef, stopMsg: Optional[Any]): UnitJava API: Add an actor termination task to a phase. Java API: Add an actor termination task to a phase. It doesn't remove previously added tasks. Tasks added to the same phase are executed in parallel without any ordering assumptions. Next phase will not start until all tasks of previous phase have been completed. When executed, this task will first send the given stop message, if defined, to the actor, then it will watch the actor, and complete when the actor terminates. Tasks should typically be registered as early as possible after system startup. When running the coordinated shutdown tasks that have been registered will be performed but tasks that are added too late will not be run. It is possible to add a task to a later phase by a task in an earlier phase and it will be performed. 
-    def addActorTerminationTask(phase: String, taskName: String, actor: ActorRef, stopMsg: Option[Any]): UnitScala API: Add an actor termination task to a phase. Scala API: Add an actor termination task to a phase. It doesn't remove previously added tasks. Tasks added to the same phase are executed in parallel without any ordering assumptions. Next phase will not start until all tasks of previous phase have been completed. When executed, this task will first send the given stop message, if defined, to the actor, then it will watch the actor, and complete when the actor terminates. Tasks should typically be registered as early as possible after system startup. When running the coordinated shutdown tasks that have been registered will be performed but tasks that are added too late will not be run. It is possible to add a task to a later phase by a task in an earlier phase and it will be performed. 
-    def addCancellableJvmShutdownHook(hook: Runnable): CancellableJava API: Add a JVM shutdown hook that will be run when the JVM process begins its shutdown sequence. Java API: Add a JVM shutdown hook that will be run when the JVM process begins its shutdown sequence. Added hooks may run in an order concurrently, but they are running before Akka internal shutdown hooks, e.g. those shutting down Artery. The returned CancellableFor shutdown hooks that does not have any requirements on running before the Akka shutdown hooks the standard library JVM shutdown hooks APIs are better suited. 
-    def addCancellableJvmShutdownHook[T](hook: => T): CancellableScala API: Add a JVM shutdown hook that will be run when the JVM process begins its shutdown sequence. Scala API: Add a JVM shutdown hook that will be run when the JVM process begins its shutdown sequence. Added hooks may run in any order concurrently, but they are running before Akka internal shutdown hooks, e.g. those shutting down Artery. The returned CancellableFor shutdown hooks that does not have any requirements on running before the Akka shutdown hooks the standard library JVM shutdown hooks APIs are better suited. - Annotations
- @tailrec()
 
-    def addCancellableTask(phase: String, taskName: String, task: Supplier[CompletionStage[Done]]): CancellableJava API: Add a task to a phase, returning an object which will cancel it on demand and remove it from the task pool (so long as the same task has not been added elsewhere). Java API: Add a task to a phase, returning an object which will cancel it on demand and remove it from the task pool (so long as the same task has not been added elsewhere). Tasks in a phase are run concurrently, with no ordering assumed. Adding a task to a phase does not remove any other tasks from the phase. If the same task is added multiple times, each addition will be run unless cancelled. Tasks should typically be registered as early as possible -- once coordinated shutdown begins, tasks may be added without ever being run. A task may add tasks to a later stage with confidence that they will be run. 
-    def addCancellableTask(phase: String, taskName: String)(task: () => Future[Done]): CancellableScala API: Add a task to a phase, returning an object which will cancel it on demand and remove it from the task pool (so long as the same task has not been added elsewhere). Scala API: Add a task to a phase, returning an object which will cancel it on demand and remove it from the task pool (so long as the same task has not been added elsewhere). Tasks in a phase are run concurrently, with no ordering assumed. Adding a task to a phase does not remove any other tasks from the phase. If the same task is added multiple times, each addition will be run unless cancelled. Tasks should typically be registered as early as possible -- once coordinated shutdown begins, tasks may be added without ever being run. A task may add tasks to a later stage with confidence that they will be run. 
-    def addJvmShutdownHook(hook: Runnable): UnitJava API: Add a JVM shutdown hook that will be run when the JVM process begins its shutdown sequence. Java API: Add a JVM shutdown hook that will be run when the JVM process begins its shutdown sequence. Added hooks may run in any order concurrently, but they are running before Akka internal shutdown hooks, e.g. those shutting down Artery. 
-    def addJvmShutdownHook[T](hook: => T): UnitScala API: Add a JVM shutdown hook that will be run when the JVM process begins its shutdown sequence. Scala API: Add a JVM shutdown hook that will be run when the JVM process begins its shutdown sequence. Added hooks may run in any order concurrently, but they are running before Akka internal shutdown hooks, e.g. those shutting down Artery. 
-    def addTask(phase: String, taskName: String, task: Supplier[CompletionStage[Done]]): UnitJava API: Add a task to a phase. Java API: Add a task to a phase. It doesn't remove previously added tasks. Tasks added to the same phase are executed in parallel without any ordering assumptions. Next phase will not start until all tasks of previous phase have been completed. Tasks should typically be registered as early as possible after system startup. When running the coordinated shutdown tasks that have been registered will be performed but tasks that are added too late will not be run. It is possible to add a task to a later phase by a task in an earlier phase and it will be performed. 
-    def addTask(phase: String, taskName: String)(task: () => Future[Done]): UnitScala API: Add a task to a phase. Scala API: Add a task to a phase. It doesn't remove previously added tasks. Tasks added to the same phase are executed in parallel without any ordering assumptions. Next phase will not start until all tasks of previous phase have been completed. Tasks should typically be registered as early as possible after system startup. When running the coordinated shutdown tasks that have been registered will be performed but tasks that are added too late will not be run. It is possible to add a task to a later phase by a task in an earlier phase and it will be performed. 
-   final  def asInstanceOf[T0]: T0- Definition Classes
- Any
 
-    def clone(): AnyRef- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
 
-    def ensuring(cond: (CoordinatedShutdown) => Boolean, msg: => Any): CoordinatedShutdown- Implicit
- This member is added by an implicit conversion from CoordinatedShutdown toEnsuring[CoordinatedShutdown] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
 
-    def ensuring(cond: (CoordinatedShutdown) => Boolean): CoordinatedShutdown- Implicit
- This member is added by an implicit conversion from CoordinatedShutdown toEnsuring[CoordinatedShutdown] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
 
-    def ensuring(cond: Boolean, msg: => Any): CoordinatedShutdown- Implicit
- This member is added by an implicit conversion from CoordinatedShutdown toEnsuring[CoordinatedShutdown] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
 
-    def ensuring(cond: Boolean): CoordinatedShutdown- Implicit
- This member is added by an implicit conversion from CoordinatedShutdown toEnsuring[CoordinatedShutdown] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
 
-   final  def eq(arg0: AnyRef): Boolean- Definition Classes
- AnyRef
 
-    def equals(arg0: AnyRef): Boolean- Definition Classes
- AnyRef → Any
 
-   final  def getClass(): Class[_ <: AnyRef]- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
 
-    def getShutdownReason(): Optional[Reason]The Reasonfor the shutdown as passed to therunmethod.The Reasonfor the shutdown as passed to therunmethod.Optional.emptyif the shutdown has not been started.
-    def hashCode(): Int- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
 
-   final  def isInstanceOf[T0]: Boolean- Definition Classes
- Any
 
-   final  def ne(arg0: AnyRef): Boolean- Definition Classes
- AnyRef
 
-   final  def notify(): Unit- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
 
-   final  def notifyAll(): Unit- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
 
-    def run(reason: Reason, fromPhase: Optional[String]): CompletionStage[Done]Java API: Run tasks of all phases including and after the given phase. Java API: Run tasks of all phases including and after the given phase. The returned CompletionStageis completed when all such tasks have been completed, or there is a failure when recovery is disabled.It's safe to call this method multiple times. It will only run the shutdown sequence once. 
-    def run(reason: Reason, fromPhase: Option[String]): Future[Done]Scala API: Run tasks of all phases including and after the given phase. Scala API: Run tasks of all phases including and after the given phase. The returned Futureis completed when all such tasks have been completed, or there is a failure when recovery is disabled.It's safe to call this method multiple times. It will only run shutdown sequence once. 
-    def run(reason: Reason): Future[Done]Scala API: Run tasks of all phases. Scala API: Run tasks of all phases. The returned Futureis completed when all tasks have been completed, or there is a failure when recovery is disabled.It's safe to call this method multiple times. It will only run the shutdown sequence once. 
-    def runAll(reason: Reason): CompletionStage[Done]Java API: Run tasks of all phases. Java API: Run tasks of all phases. The returned CompletionStageis completed when all tasks have been completed, or there is a failure when recovery is disabled.It's safe to call this method multiple times. It will only run the shutdown sequence once. 
-    def shutdownReason(): Option[Reason]The Reasonfor the shutdown as passed to therunmethod.The Reasonfor the shutdown as passed to therunmethod.Noneif the shutdown has not been started.
-   final  def synchronized[T0](arg0: => T0): T0- Definition Classes
- AnyRef
 
-    def timeout(phase: String): FiniteDurationThe configured timeout for a given phase.The configured timeout for a given phase. For example useful as timeout when actoraskrequests is used as a task.
-    def toString(): String- Definition Classes
- AnyRef → Any
 
-    def totalTimeout(): FiniteDurationSum of timeouts of all phases that have some task. 
-   final  def wait(arg0: Long, arg1: Int): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
 
-   final  def wait(arg0: Long): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
 
-   final  def wait(): Unit- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
 
Deprecated Value Members
-    def finalize(): Unit- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
- (Since version 9) 
 
-    def formatted(fmtstr: String): String- Implicit
- This member is added by an implicit conversion from CoordinatedShutdown toStringFormat[CoordinatedShutdown] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
- (Since version 2.12.16) Use - formatString.format(value)instead of- value.formatted(formatString), or use the- f""string interpolator. In Java 15 and later,- formattedresolves to the new method in String which has reversed parameters.
 
-    def →[B](y: B): (CoordinatedShutdown, B)- Implicit
- This member is added by an implicit conversion from CoordinatedShutdown toArrowAssoc[CoordinatedShutdown] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
- (Since version 2.13.0) Use - ->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.