object CoordinatedShutdown extends ExtensionId[CoordinatedShutdown] with ExtensionIdProvider
- Alphabetic
- By Inheritance
- CoordinatedShutdown
- ExtensionIdProvider
- ExtensionId
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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.
-
val
PhaseBeforeActorSystemTerminate: String
Phase for custom application tasks that are to be run after cluster shutdown and before ActorSystem termination.
-
val
PhaseBeforeClusterShutdown: String
Phase for custom application tasks that are to be run after service shutdown and before cluster shutdown.
-
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.
-
val
PhaseClusterExiting: String
Shutdown cluster singletons
-
val
PhaseClusterExitingDone: String
Wait until exiting has been completed
-
val
PhaseClusterLeave: String
Emit the leave command for the node that is shutting down.
-
val
PhaseClusterShardingShutdownRegion: String
Graceful shutdown of the Cluster Sharding regions.
-
val
PhaseClusterShutdown: String
Shutdown the cluster extension
-
val
PhaseServiceRequestsDone: String
Wait for requests that are in progress to be completed.
-
val
PhaseServiceStop: String
Final shutdown of service endpoints.
-
val
PhaseServiceUnbind: String
Stop accepting new incoming requests in for example HTTP.
-
def
apply(system: ClassicActorSystemProvider): 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
-
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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
def
clusterDowningReason: Reason
Java API: The shutdown was initiated by Cluster downing.
-
def
clusterJoinUnsuccessfulReason: Reason
Java API: The shutdown was initiated by a failure to join a seed node.
-
def
clusterLeavingReason: Reason
Java API: The shutdown was initiated by Cluster leaving.
-
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
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
equals(other: Any): Boolean
- Definition Classes
- ExtensionId → AnyRef → Any
-
def
get(system: ClassicActorSystemProvider): 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: ClassicActorSystemProvider): TheExtension = super.get(system)
- Definition Classes
- CoordinatedShutdown → ExtensionId
-
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
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
hashCode(): Int
- Definition Classes
- ExtensionId → AnyRef → Any
-
def
incompatibleConfigurationDetectedReason: Reason
Java API: The shutdown was initiated by a configuration clash within the existing cluster and the joining node
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
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.
-
def
lookup(): CoordinatedShutdown.type
Returns the canonical ExtensionId for this Extension
Returns the canonical ExtensionId for this Extension
- Definition Classes
- CoordinatedShutdown → ExtensionIdProvider
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
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.
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
object
ClusterDowningReason extends Reason
Scala API: The shutdown was initiated by Cluster downing.
-
object
ClusterJoinUnsuccessfulReason extends Reason
Scala API: The shutdown was initiated by a failure to join a seed node.
-
object
ClusterLeavingReason extends Reason
Scala API: The shutdown was initiated by Cluster leaving.
-
object
IncompatibleConfigurationDetectedReason extends Reason with Product with Serializable
Scala API: The shutdown was initiated by a configuration clash within the existing cluster and the joining node
-
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.
-
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.