Packages

o

akka.cluster

ClusterEvent

object ClusterEvent

Domain events published to the event bus. Subscribe with:

Cluster(system).subscribe(actorRef, classOf[ClusterDomainEvent])
Annotations
@nowarn()
Source
ClusterEvent.scala
Linear Supertypes
AnyRef, Any
Content Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterEvent
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait ClusterDomainEvent extends DeadLetterSuppression

    Marker interface for cluster domain events.

    Marker interface for cluster domain events.

    Not intended for user extension.

    Annotations
    @DoNotInherit()
  2. final class CurrentClusterState extends Product5[SortedSet[Member], Set[Member], Set[Address], Option[Address], Map[String, Option[Address]]] with Serializable

    Current snapshot state of the cluster.

    Current snapshot state of the cluster. Sent to new subscriber.

    Annotations
    @SerialVersionUID() @nowarn()
  3. final case class LeaderChanged(leader: Option[Address]) extends ClusterDomainEvent with Product with Serializable

    Leader of the cluster data center of this node changed.

    Leader of the cluster data center of this node changed. Published when the state change is first seen on a node.

  4. final case class MemberDowned(member: Member) extends MemberEvent with Product with Serializable

    Member status changed to MemberStatus.Down and will be removed when all members have seen the Down status.

  5. sealed trait MemberEvent extends ClusterDomainEvent

    Marker interface for membership events.

    Marker interface for membership events. Published when the state change is first seen on a node. The state change was performed by the leader when there was convergence on the leader node, i.e. all members had seen previous state.

  6. final case class MemberExited(member: Member) extends MemberEvent with Product with Serializable

    Member status changed to MemberStatus.Exiting and will be removed when all members have seen the Exiting status.

  7. final case class MemberJoined(member: Member) extends MemberEvent with Product with Serializable

    Member status changed to Joining.

  8. final case class MemberLeft(member: Member) extends MemberEvent with Product with Serializable

    Member status changed to Leaving.

  9. final case class MemberPreparingForShutdown(member: Member) extends MemberEvent with Product with Serializable
  10. final case class MemberReadyForShutdown(member: Member) extends MemberEvent with Product with Serializable
  11. final case class MemberRemoved(member: Member, previousStatus: MemberStatus) extends MemberEvent with Product with Serializable

    Member completely removed from the cluster.

    Member completely removed from the cluster. When previousStatus is MemberStatus.Down the node was removed after being detected as unreachable and downed. When previousStatus is MemberStatus.Exiting the node was removed after graceful leaving and exiting.

  12. final case class MemberUp(member: Member) extends MemberEvent with Product with Serializable

    Member status changed to Up.

  13. final case class MemberWeaklyUp(member: Member) extends MemberEvent with Product with Serializable

    Member status changed to WeaklyUp.

    Member status changed to WeaklyUp. A joining member can be moved to WeaklyUp if convergence cannot be reached, i.e. there are unreachable nodes. It will be moved to Up when convergence is reached.

  14. sealed trait ReachabilityEvent extends ClusterDomainEvent

    Marker interface to facilitate subscription of both UnreachableMember and ReachableMember.

  15. final case class ReachableMember(member: Member) extends ReachabilityEvent with Product with Serializable

    A member is considered as reachable by the failure detector after having been unreachable.

    A member is considered as reachable by the failure detector after having been unreachable.

    See also

    UnreachableMember

  16. final case class RoleLeaderChanged(role: String, leader: Option[Address]) extends ClusterDomainEvent with Product with Serializable

    First member (leader) of the members within a role set (in the same data center as this node, if data centers are used) changed.

    First member (leader) of the members within a role set (in the same data center as this node, if data centers are used) changed. Published when the state change is first seen on a node.

  17. sealed abstract class SubscriptionInitialStateMode extends AnyRef
  18. final case class UnreachableMember(member: Member) extends ReachabilityEvent with Product with Serializable

    A member is considered as unreachable by the failure detector.

Deprecated Type Members

  1. sealed trait DataCenterReachabilityEvent extends ClusterDomainEvent

    Marker interface to facilitate subscription of both UnreachableDataCenter and ReachableDataCenter.

    Marker interface to facilitate subscription of both UnreachableDataCenter and ReachableDataCenter.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use Akka Distributed Cluster instead

  2. final case class ReachableDataCenter(dataCenter: DataCenter) extends DataCenterReachabilityEvent with Product with Serializable

    A data center is considered reachable when all members from the data center are reachable

    A data center is considered reachable when all members from the data center are reachable

    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use Akka Distributed Cluster instead

  3. final case class UnreachableDataCenter(dataCenter: DataCenter) extends DataCenterReachabilityEvent with Product with Serializable

    A data center is considered as unreachable when any members from the data center are unreachable

    A data center is considered as unreachable when any members from the data center are unreachable

    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use Akka Distributed Cluster instead

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  9. def getClusterShuttingDownInstance: ClusterShuttingDown

    Java API: get the singleton instance of ClusterShuttingDown event

  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  11. def initialStateAsEvents: InitialStateAsEvents

    Java API

  12. def initialStateAsSnapshot: InitialStateAsSnapshot

    Java API

  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  18. def toString(): String
    Definition Classes
    AnyRef → Any
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. case object ClusterShuttingDown extends ClusterDomainEvent with Product with Serializable

    This event is published when the cluster node is shutting down, before the final MemberRemoved events are published.

  23. object CurrentClusterState extends AbstractFunction5[SortedSet[Member], Set[Member], Set[Address], Option[Address], Map[String, Option[Address]], CurrentClusterState] with Serializable
  24. case object InitialStateAsEvents extends SubscriptionInitialStateMode with Product with Serializable

    When using this subscription mode the events corresponding to the current state will be sent to the subscriber to mimic what you would have seen if you were listening to the events when they occurred in the past.

  25. case object InitialStateAsSnapshot extends SubscriptionInitialStateMode with Product with Serializable

    When using this subscription mode a snapshot of akka.cluster.ClusterEvent.CurrentClusterState will be sent to the subscriber as the first message.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped