Object

akka.cluster

ClusterEvent

Related Doc: package cluster

Permalink

object ClusterEvent

Domain events published to the event bus. Subscribe with:

Cluster(system).subscribe(actorRef, classOf[ClusterDomainEvent])
Source
ClusterEvent.scala
Linear Supertypes
Content Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ClusterEvent
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait ClusterDomainEvent extends AnyRef

    Permalink

    Marker interface for cluster domain events.

  2. final case class CurrentClusterState(members: SortedSet[Member] = immutable.SortedSet.empty, unreachable: Set[Member] = Set.empty, seenBy: Set[Address] = Set.empty, leader: Option[Address] = None, roleLeaderMap: Map[String, Option[Address]] = Map.empty) extends Product with Serializable

    Permalink

    Current snapshot state of the cluster.

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

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

    Permalink

    Leader of the cluster members changed.

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

  4. sealed trait MemberEvent extends ClusterDomainEvent

    Permalink

    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.

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

    Permalink

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

  6. final case class MemberRemoved(member: Member, previousStatus: MemberStatus) extends MemberEvent with Product with Serializable

    Permalink

    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.

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

    Permalink

    Member status changed to Up.

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

    Permalink

    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.

  9. sealed trait ReachabilityEvent extends ClusterDomainEvent

    Permalink

    Marker interface to facilitate subscription of both UnreachableMember and ReachableMember.

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

    Permalink

    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

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

    Permalink

    First member (leader) of the members within a role set changed.

    First member (leader) of the members within a role set changed. Published when the state change is first seen on a node.

  12. sealed abstract class SubscriptionInitialStateMode extends AnyRef

    Permalink
  13. final case class UnreachableMember(member: Member) extends ReachabilityEvent with Product with Serializable

    Permalink

    A member is considered as unreachable by the failure detector.

  14. final case class ClusterMetricsChanged(nodeMetrics: Set[NodeMetrics]) extends ClusterDomainEvent with Product with Serializable

    Permalink

    Current snapshot of cluster node metrics.

    Current snapshot of cluster node metrics. Published to subscribers.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.4) Superseded by akka.cluster.metrics (in akka-cluster-metrics jar)

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. object ClusterShuttingDown extends ClusterDomainEvent with Product with Serializable

    Permalink

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

  5. object InitialStateAsEvents extends SubscriptionInitialStateMode with Product with Serializable

    Permalink

    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.

  6. object InitialStateAsSnapshot extends SubscriptionInitialStateMode with Product with Serializable

    Permalink

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

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  10. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  11. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  13. def getClusterShuttingDownInstance: ClusterShuttingDown.type

    Permalink

    Java API: get the singleton instance of ClusterShuttingDown event

  14. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  15. def initialStateAsEvents: InitialStateAsEvents.type

    Permalink

    Java API

  16. def initialStateAsSnapshot: InitialStateAsSnapshot.type

    Permalink

    Java API

  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  19. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  22. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  23. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  25. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped