object ClusterEvent
Domain events published to the event bus. Subscribe with:
Cluster(system).subscribe(actorRef, classOf[ClusterDomainEvent])
- Source
- ClusterEvent.scala
- Alphabetic
- By Inheritance
- ClusterEvent
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
sealed
trait
ClusterDomainEvent
extends AnyRef
Marker interface for cluster domain events.
-
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
Current snapshot state of the cluster.
Current snapshot state of the cluster. Sent to new subscriber.
-
final
case class
LeaderChanged
(leader: Option[Address]) extends ClusterDomainEvent with Product with Serializable
Leader of the cluster members changed.
Leader of the cluster members changed. Published when the state change is first seen on a node.
-
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.
-
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 theExiting
status. -
final
case class
MemberJoined
(member: Member) extends MemberEvent with Product with Serializable
Member status changed to Joining.
-
final
case class
MemberLeft
(member: Member) extends MemberEvent with Product with Serializable
Member status changed to Leaving.
-
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
isMemberStatus.Down
the node was removed after being detected as unreachable and downed. WhenpreviousStatus
isMemberStatus.Exiting
the node was removed after graceful leaving and exiting. -
final
case class
MemberUp
(member: Member) extends MemberEvent with Product with Serializable
Member status changed to Up.
-
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 toUp
when convergence is reached. -
sealed
trait
ReachabilityEvent
extends ClusterDomainEvent
Marker interface to facilitate subscription of both UnreachableMember and ReachableMember.
-
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
-
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 changed.
First member (leader) of the members within a role set changed. Published when the state change is first seen on a node.
- sealed abstract class SubscriptionInitialStateMode extends AnyRef
-
final
case class
UnreachableMember
(member: Member) extends ReachabilityEvent with Product with Serializable
A member is considered as unreachable by the failure detector.
-
final
case class
ClusterMetricsChanged
(nodeMetrics: Set[NodeMetrics]) extends ClusterDomainEvent with Product with Serializable
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
-
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
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
getClusterShuttingDownInstance: ClusterShuttingDown.type
Java API: get the singleton instance of
ClusterShuttingDown
event -
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
def
initialStateAsEvents: InitialStateAsEvents.type
Java API
-
def
initialStateAsSnapshot: InitialStateAsSnapshot.type
Java API
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
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.
-
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.
-
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.