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
-
trait
ClusterDomainEvent extends DeadLetterSuppression
Marker interface for cluster domain events.
Marker interface for cluster domain events.
Not intended for user extension.
- Annotations
- @DoNotInherit()
-
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()
-
sealed
trait
DataCenterReachabilityEvent extends ClusterDomainEvent
Marker interface to facilitate subscription of both UnreachableDataCenter and ReachableDataCenter.
-
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.
-
final
case class
MemberDowned(member: Member) extends MemberEvent with Product with Serializable
Member status changed to
MemberStatus.Downand will be removed when all members have seen theDownstatus. -
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.Exitingand will be removed when all members have seen theExitingstatus. -
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
previousStatusisMemberStatus.Downthe node was removed after being detected as unreachable and downed. WhenpreviousStatusisMemberStatus.Exitingthe 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
WeaklyUpif convergence cannot be reached, i.e. there are unreachable nodes. It will be moved toUpwhen convergence is reached. -
sealed
trait
ReachabilityEvent extends ClusterDomainEvent
Marker interface to facilitate subscription of both UnreachableMember and ReachableMember.
-
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
-
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 (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.
- sealed abstract class SubscriptionInitialStateMode extends AnyRef
-
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
-
final
case class
UnreachableMember(member: Member) extends ReachabilityEvent with Product with Serializable
A member is considered as unreachable by the failure detector.
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
- @native() @HotSpotIntrinsicCandidate() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
getClusterShuttingDownInstance: ClusterShuttingDown.type
Java API: get the singleton instance of
ClusterShuttingDownevent -
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
- 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
-
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
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 CurrentClusterState extends AbstractFunction5[SortedSet[Member], Set[Member], Set[Address], Option[Address], Map[String, Option[Address]], CurrentClusterState] with Serializable
-
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.