Type Members

1.  abstract class Cluster extends Extension

   This class is not intended for user extension other than for test purposes (e.g.

   This class is not intended for user extension other than for test purposes (e.g. stub implementation). More methods may be added in the future and that may break such implementations.

   Annotations

   @DoNotInherit()

2.  sealed trait ClusterCommand extends AnyRef

   Not intended for user extension.

   Not intended for user extension.

   Annotations

   @DoNotInherit()

3.  final class ClusterSetup extends ExtensionSetup[Cluster]

   Can be used in akka.actor.setup.ActorSystemSetup when starting the ActorSystem to replace the default implementation of the Cluster extension.

   Can be used in akka.actor.setup.ActorSystemSetup when starting the ActorSystem to replace the default implementation of the Cluster extension. Intended for tests that need to replace extension with stub/mock implementations.

4.  abstract class ClusterSingleton extends Extension

   This class is not intended for user extension other than for test purposes (e.g.

   This class is not intended for user extension other than for test purposes (e.g. stub implementation). More methods may be added in the future and that may break such implementations.

   Annotations

   @DoNotInherit()

5.  final class ClusterSingletonManagerSettings extends AnyRef

6.  final class ClusterSingletonSettings extends AnyRef
7.  final class ClusterSingletonSetup extends ExtensionSetup[ClusterSingleton]

   Can be used in akka.actor.setup.ActorSystemSetup when starting the ActorSystem to replace the default implementation of the ClusterSingleton extension.

   Can be used in akka.actor.setup.ActorSystemSetup when starting the ActorSystem to replace the default implementation of the ClusterSingleton extension. Intended for tests that need to replace extension with stub/mock implementations.

8.  sealed trait ClusterStateSubscription extends AnyRef

   Messages for subscribing to changes in the cluster state

   Messages for subscribing to changes in the cluster state

   Not intended for user extension.

   Annotations

   @DoNotInherit()

9.  final case class Down(address: Address) extends ClusterCommand with Product with Serializable

   Send command to DOWN the node specified by 'address'.

   Send command to DOWN the node specified by 'address'.

   When a member is considered by the failure detector to be unreachable the leader is not allowed to perform its duties, such as changing status of new joining members to 'Up'. The status of the unreachable member must be changed to 'Down', which can be done with this method.

10.  final case class GetCurrentState(recipient: ActorRef[CurrentClusterState]) extends ClusterStateSubscription with Product with Serializable
11.  final case class Join(address: Address) extends ClusterCommand with Product with Serializable

    Try to join this cluster node with the node specified by 'address'.

    Try to join this cluster node with the node specified by 'address'.

    An actor system can only join a cluster once. Additional attempts will be ignored. When it has successfully joined it must be restarted to be able to join another cluster or to join the same cluster again.

    The name of the akka.actor.ActorSystem must be the same for all members of a cluster.

12.  final case class JoinSeedNodes(seedNodes: Seq[Address]) extends ClusterCommand with Product with Serializable

    Scala API: Join the specified seed nodes without defining them in config.

    Scala API: Join the specified seed nodes without defining them in config. Especially useful from tests when Addresses are unknown before startup time.

    An actor system can only join a cluster once. Additional attempts will be ignored. When it has successfully joined it must be restarted to be able to join another cluster or to join the same cluster again.

13.  final case class Leave(address: Address) extends ClusterCommand with Product with Serializable

    Send command to issue state transition to LEAVING for the node specified by 'address'.

    Send command to issue state transition to LEAVING for the node specified by 'address'. The member will go through the status changes MemberStatus Leaving (not published to subscribers) followed by MemberStatus Exiting and finally MemberStatus Removed.

    Note that this command can be issued to any member in the cluster, not necessarily the one that is leaving. The cluster extension, but not the actor system or JVM, of the leaving member will be shutdown after the leader has changed status of the member to Exiting. Thereafter the member will be removed from the cluster. Normally this is handled automatically, but in case of network failures during this process it might still be necessary to set the node’s status to Down in order to complete the removal.

14.  sealed trait PrepareForFullClusterShutdown extends ClusterCommand

    Initiate a full cluster shutdown.

    Initiate a full cluster shutdown. This stops: - New members joining the cluster - New rebalances in Cluster Sharding - Singleton handovers

    However, it does not stop the nodes. That is expected to be signalled externally.

    Not for user extension

    Annotations

    @DoNotInherit()

15.  final case class SelfRemoved(previousStatus: MemberStatus) extends ClusterDomainEvent with Product with Serializable

    Subscribe to this node being removed from the cluster.

    Subscribe to this node being removed from the cluster. If the node was already removed from the cluster when this subscription is created it will be responded to immediately from the subscriptions actor.

    Note: Only emitted for the typed cluster.

16.  final case class SelfUp(currentClusterState: CurrentClusterState) extends ClusterDomainEvent with Product with Serializable

    Subscribe to this node being up, after sending this event the subscription is automatically cancelled.

    Subscribe to this node being up, after sending this event the subscription is automatically cancelled. If the node is already up the event is also sent to the subscriber. If the node was up but is no more because it left or is leaving the cluster, no event is sent and the subscription request is ignored.

    Note: Only emitted for the typed cluster.

17.  final case class SetAppVersionLater(appVersion: Future[util.Version]) extends ClusterCommand with Product with Serializable

    Scala API: If the appVersion is read from an external system (e.g.

    Scala API: If the appVersion is read from an external system (e.g. Kubernetes) it can be defined after system startup but before joining by completing the appVersion Future. In that case, SetAppVersionLater should be sent before Join or JoinSeedNodes It's fine to send Join or JoinSeedNodes immediately afterwards (before the Future is completed. The join will then wait for the appVersion to be completed.

18.  final class SingletonActor[M] extends AnyRef
19.  final case class Subscribe[A <: ClusterDomainEvent](subscriber: ActorRef[A], eventClass: Class[A]) extends ClusterStateSubscription with Product with Serializable

    Subscribe to cluster state changes.

    Subscribe to cluster state changes. The initial state of the cluster will be sent as a "replay" of the subscribed events.

    subscriber

    A subscriber that will receive events until it is unsubscribed or stops

    eventClass

    The type of events to subscribe to, can be individual event types such as ReachabilityEvent or one of the common supertypes, such as MemberEvent to get all the subtypes of events.

20.  final case class Unsubscribe[T](subscriber: ActorRef[T]) extends ClusterStateSubscription with Product with Serializable