akka.cluster

Cluster

class Cluster extends Extension

This module is responsible cluster membership information. Changes to the cluster information is retrieved through #subscribe. Commands to operate the cluster is available through methods in this class, such as #join, #down and #leave.

Each cluster Member is identified by its akka.actor.Address, and the cluster address of this actor system is #selfAddress. A member also has a status; initially MemberStatus.Joining followed by MemberStatus.Up.

Source
Cluster.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Cluster
  2. Extension
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Cluster(system: ExtendedActorSystem)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Cluster to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Cluster, B)

    Implicit information
    This member is added by an implicit conversion from Cluster to ArrowAssoc[Cluster] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def down(address: Address): Unit

    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.

  11. def ensuring(cond: (Cluster) ⇒ Boolean, msg: ⇒ Any): Cluster

    Implicit information
    This member is added by an implicit conversion from Cluster to Ensuring[Cluster] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Cluster) ⇒ Boolean): Cluster

    Implicit information
    This member is added by an implicit conversion from Cluster to Ensuring[Cluster] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Cluster

    Implicit information
    This member is added by an implicit conversion from Cluster to Ensuring[Cluster] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Cluster

    Implicit information
    This member is added by an implicit conversion from Cluster to Ensuring[Cluster] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef → Any
  17. val failureDetector: FailureDetectorRegistry[Address]

  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Cluster to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def getSelfRoles: Set[String]

    Java API: roles that this member has

  22. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  23. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  24. def isTerminated: Boolean

    Returns true if this cluster instance has be shutdown.

  25. def join(address: Address): Unit

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

    Try to join this cluster node with the node specified by 'address'. A 'Join(selfAddress)' command is sent to the node to join.

    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.

  26. def joinSeedNodes(seedNodes: Seq[Address]): Unit

    Join the specified seed nodes without defining them in config.

    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.

    JAVA API: Use akka.japi.Util.immutableSeq to convert a java.lang.Iterable to the type needed for the seedNodes parameter.

  27. def leave(address: Address): Unit

    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.

  28. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  31. def registerOnMemberUp(callback: Runnable): Unit

    Java API: The supplied callback will be run, once, when current cluster member is Up.

    Java API: The supplied callback will be run, once, when current cluster member is Up. Typically used together with configuration option akka.cluster.min-nr-of-members' to defer some action, such as starting actors, until the cluster has reached a certain size.

  32. def registerOnMemberUp[T](code: ⇒ T): Unit

    The supplied thunk will be run, once, when current cluster member is Up.

    The supplied thunk will be run, once, when current cluster member is Up. Typically used together with configuration option akka.cluster.min-nr-of-members' to defer some action, such as starting actors, until the cluster has reached a certain size.

  33. def selfAddress: Address

    The address of this cluster member.

  34. def selfRoles: Set[String]

    roles that this member has

  35. val selfUniqueAddress: UniqueAddress

    The address including a uid of this cluster member.

    The address including a uid of this cluster member. The uid is needed to be able to distinguish different incarnations of a member with same hostname and port.

  36. def sendCurrentClusterState(receiver: ActorRef): Unit

    Publish current (full) state of the cluster to the specified receiver.

    Publish current (full) state of the cluster to the specified receiver. If you want this to happen periodically you need to schedule a call to this method yourself. Note that you can also retrieve the current state with #state.

  37. val settings: ClusterSettings

  38. def state: CurrentClusterState

    Current snapshot state of the cluster.

  39. def subscribe(subscriber: ActorRef, initialStateMode: SubscriptionInitialStateMode, to: Class[_]*): Unit

    Subscribe to one or more cluster domain events.

    Subscribe to one or more cluster domain events. The to classes can be akka.cluster.ClusterEvent.ClusterDomainEvent or subclasses.

    If initialStateMode is ClusterEvent.InitialStateAsEvents 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.

    If initialStateMode is ClusterEvent.InitialStateAsSnapshot a snapshot of akka.cluster.ClusterEvent.CurrentClusterState will be sent to the subscriber as the first message.

    Note that for large clusters it is more efficient to use InitialStateAsSnapshot.

    Annotations
    @varargs()
  40. def subscribe(subscriber: ActorRef, to: Class[_]*): Unit

    Subscribe to one or more cluster domain events.

    Subscribe to one or more cluster domain events. The to classes can be akka.cluster.ClusterEvent.ClusterDomainEvent or subclasses.

    A snapshot of akka.cluster.ClusterEvent.CurrentClusterState will be sent to the subscriber as the first message.

    Annotations
    @varargs()
  41. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  42. val system: ExtendedActorSystem

  43. def toString(): String

    Definition Classes
    AnyRef → Any
  44. def unsubscribe(subscriber: ActorRef, to: Class[_]): Unit

    Unsubscribe to a specific type of cluster domain events, matching previous subscribe registration.

  45. def unsubscribe(subscriber: ActorRef): Unit

    Unsubscribe to all cluster domain events.

  46. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  49. def [B](y: B): (Cluster, B)

    Implicit information
    This member is added by an implicit conversion from Cluster to ArrowAssoc[Cluster] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Cluster to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (cluster: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Cluster to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (cluster: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def publishCurrentClusterState(): Unit

    Publish current (full) state of the cluster to subscribers, that are subscribing to akka.cluster.ClusterEvent.ClusterDomainEvent or akka.cluster.ClusterEvent.CurrentClusterState.

    Publish current (full) state of the cluster to subscribers, that are subscribing to akka.cluster.ClusterEvent.ClusterDomainEvent or akka.cluster.ClusterEvent.CurrentClusterState. If you want this to happen periodically you need to schedule a call to this method yourself.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.3) Use sendCurrentClusterState instead of publishCurrentClusterState

  2. def x: Cluster

    Implicit information
    This member is added by an implicit conversion from Cluster to ArrowAssoc[Cluster] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (cluster: ArrowAssoc[Cluster]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  3. def x: Cluster

    Implicit information
    This member is added by an implicit conversion from Cluster to Ensuring[Cluster] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (cluster: Ensuring[Cluster]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from Extension

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Cluster to StringAdd

Inherited by implicit conversion any2stringfmt from Cluster to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Cluster to ArrowAssoc[Cluster]

Inherited by implicit conversion any2Ensuring from Cluster to Ensuring[Cluster]

Ungrouped