Packages

object CoordinatedShutdown extends ExtensionId[CoordinatedShutdown] with ExtensionIdProvider

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CoordinatedShutdown
  2. ExtensionIdProvider
  3. ExtensionId
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. trait Reason extends AnyRef

    Reason for the shutdown, which can be used by tasks in case they need to do different things depending on what caused the shutdown.

    Reason for the shutdown, which can be used by tasks in case they need to do different things depending on what caused the shutdown. There are some predefined reasons, but external libraries applications may also define other reasons.

Value Members

  1. val PhaseActorSystemTerminate: String

    Last phase.

    Last phase. See terminate-actor-system and exit-jvm above. Don't add phases that depends on this phase because the dispatcher and scheduler of the ActorSystem have been shutdown.

  2. val PhaseBeforeActorSystemTerminate: String

    Phase for custom application tasks that are to be run after cluster shutdown and before ActorSystem termination.

  3. val PhaseBeforeClusterShutdown: String

    Phase for custom application tasks that are to be run after service shutdown and before cluster shutdown.

  4. val PhaseBeforeServiceUnbind: String

    The first pre-defined phase that applications can add tasks to.

    The first pre-defined phase that applications can add tasks to. Note that more phases can be added in the application's configuration by overriding this phase with an additional depends-on.

  5. val PhaseClusterExiting: String

    Shutdown cluster singletons

  6. val PhaseClusterExitingDone: String

    Wait until exiting has been completed

  7. val PhaseClusterLeave: String

    Emit the leave command for the node that is shutting down.

  8. val PhaseClusterShardingShutdownRegion: String

    Graceful shutdown of the Cluster Sharding regions.

  9. val PhaseClusterShutdown: String

    Shutdown the cluster extension

  10. val PhaseServiceRequestsDone: String

    Wait for requests that are in progress to be completed.

  11. val PhaseServiceStop: String

    Final shutdown of service endpoints.

  12. val PhaseServiceUnbind: String

    Stop accepting new incoming requests in for example HTTP.

  13. def apply(system: ActorSystem): CoordinatedShutdown

    Returns an instance of the extension identified by this ExtensionId instance.

    Returns an instance of the extension identified by this ExtensionId instance.

    Definition Classes
    ExtensionId
  14. def clusterDowningReason: Reason

    Java API: The shutdown was initiated by Cluster downing.

  15. def clusterLeavingReason: Reason

    Java API: The shutdown was initiated by Cluster leaving.

  16. def createExtension(system: ExtendedActorSystem): CoordinatedShutdown

    Is used by Akka to instantiate the Extension identified by this ExtensionId, internal use only.

    Is used by Akka to instantiate the Extension identified by this ExtensionId, internal use only.

    Definition Classes
    CoordinatedShutdown → ExtensionId
  17. final def equals(other: Any): Boolean
    Definition Classes
    ExtensionId → AnyRef → Any
  18. def get(system: ActorSystem): CoordinatedShutdown

    Returns an instance of the extension identified by this ExtensionId instance.

    Returns an instance of the extension identified by this ExtensionId instance. Java API For extensions written in Scala that are to be used from Java also, this method should be overridden to get correct return type.

    override def get(system: ActorSystem): TheExtension = super.get(system)
    Definition Classes
    CoordinatedShutdown → ExtensionId
  19. final def hashCode(): Int
    Definition Classes
    ExtensionId → AnyRef → Any
  20. def jvmExitReason: Reason

    Java API: The shutdown was initiated by a JVM shutdown hook, e.g.

    Java API: The shutdown was initiated by a JVM shutdown hook, e.g. triggered by SIGTERM.

  21. def lookup(): CoordinatedShutdown.type

    Returns the canonical ExtensionId for this Extension

    Returns the canonical ExtensionId for this Extension

    Definition Classes
    CoordinatedShutdown → ExtensionIdProvider
  22. def unknownReason: Reason

    Java API: The reason for the shutdown was unknown.

    Java API: The reason for the shutdown was unknown. Needed for backwards compatibility.

  23. object ClusterDowningReason extends Reason

    Scala API: The shutdown was initiated by Cluster downing.

  24. object ClusterLeavingReason extends Reason

    Scala API: The shutdown was initiated by Cluster leaving.

  25. object JvmExitReason extends Reason

    Scala API: The shutdown was initiated by a JVM shutdown hook, e.g.

    Scala API: The shutdown was initiated by a JVM shutdown hook, e.g. triggered by SIGTERM.

  26. object UnknownReason extends Reason with Product with Serializable

    Scala API: The reason for the shutdown was unknown.

    Scala API: The reason for the shutdown was unknown. Needed for backwards compatibility.