Class/Object

akka.cluster.typed

ClusterSingletonManagerSettings

Related Docs: object ClusterSingletonManagerSettings | package typed

Permalink

final class ClusterSingletonManagerSettings extends NoSerializationVerificationNeeded

Source
ClusterSingleton.scala
Linear Supertypes
NoSerializationVerificationNeeded, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterSingletonManagerSettings
  2. NoSerializationVerificationNeeded
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ClusterSingletonManagerSettings(singletonName: String, role: Option[String], removalMargin: FiniteDuration, handOverRetryInterval: FiniteDuration)

    Permalink

    singletonName

    The actor name of the child singleton actor.

    role

    Singleton among the nodes tagged with specified role. If the role is not specified it's a singleton among all nodes in the cluster.

    removalMargin

    Margin until the singleton instance that belonged to a downed/removed partition is created in surviving partition. The purpose of this margin is that in case of a network partition the singleton actors in the non-surviving partitions must be stopped before corresponding actors are started somewhere else. This is especially important for persistent actors.

    handOverRetryInterval

    When a node is becoming oldest it sends hand-over request to previous oldest, that might be leaving the cluster. This is retried with this interval until the previous oldest confirms that the hand over has started or the previous oldest member is removed from the cluster (+ removalMargin).

Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterSingletonManagerSettings to any2stringadd[ClusterSingletonManagerSettings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (ClusterSingletonManagerSettings, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterSingletonManagerSettings to ArrowAssoc[ClusterSingletonManagerSettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (ClusterSingletonManagerSettings) ⇒ Boolean, msg: ⇒ Any): ClusterSingletonManagerSettings

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterSingletonManagerSettings to Ensuring[ClusterSingletonManagerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (ClusterSingletonManagerSettings) ⇒ Boolean): ClusterSingletonManagerSettings

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterSingletonManagerSettings to Ensuring[ClusterSingletonManagerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): ClusterSingletonManagerSettings

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterSingletonManagerSettings to Ensuring[ClusterSingletonManagerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): ClusterSingletonManagerSettings

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterSingletonManagerSettings to Ensuring[ClusterSingletonManagerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from ClusterSingletonManagerSettings to StringFormat[ClusterSingletonManagerSettings] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. val handOverRetryInterval: FiniteDuration

    Permalink

    When a node is becoming oldest it sends hand-over request to previous oldest, that might be leaving the cluster.

    When a node is becoming oldest it sends hand-over request to previous oldest, that might be leaving the cluster. This is retried with this interval until the previous oldest confirms that the hand over has started or the previous oldest member is removed from the cluster (+ removalMargin).

  18. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. val removalMargin: FiniteDuration

    Permalink

    Margin until the singleton instance that belonged to a downed/removed partition is created in surviving partition.

    Margin until the singleton instance that belonged to a downed/removed partition is created in surviving partition. The purpose of this margin is that in case of a network partition the singleton actors in the non-surviving partitions must be stopped before corresponding actors are started somewhere else. This is especially important for persistent actors.

  24. val role: Option[String]

    Permalink

    Singleton among the nodes tagged with specified role.

    Singleton among the nodes tagged with specified role. If the role is not specified it's a singleton among all nodes in the cluster.

  25. val singletonName: String

    Permalink

    The actor name of the child singleton actor.

  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  27. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  28. final def wait(): Unit

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

  29. final def wait(arg0: Long, arg1: Int): Unit

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

  30. final def wait(arg0: Long): Unit

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

  31. def withHandOverRetryInterval(retryInterval: Duration): ClusterSingletonManagerSettings

    Permalink

  32. def withHandOverRetryInterval(retryInterval: FiniteDuration): ClusterSingletonManagerSettings

    Permalink

  33. def withRemovalMargin(removalMargin: Duration): ClusterSingletonManagerSettings

    Permalink

  34. def withRemovalMargin(removalMargin: FiniteDuration): ClusterSingletonManagerSettings

    Permalink

  35. def withRole(role: Option[String]): ClusterSingletonManagerSettings

    Permalink

  36. def withRole(role: String): ClusterSingletonManagerSettings

    Permalink

  37. def withSingletonName(name: String): ClusterSingletonManagerSettings

    Permalink

  38. def →[B](y: B): (ClusterSingletonManagerSettings, B)

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

Inherited from NoSerializationVerificationNeeded

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ClusterSingletonManagerSettings to any2stringadd[ClusterSingletonManagerSettings]

Inherited by implicit conversion StringFormat from ClusterSingletonManagerSettings to StringFormat[ClusterSingletonManagerSettings]

Inherited by implicit conversion Ensuring from ClusterSingletonManagerSettings to Ensuring[ClusterSingletonManagerSettings]

Inherited by implicit conversion ArrowAssoc from ClusterSingletonManagerSettings to ArrowAssoc[ClusterSingletonManagerSettings]

Ungrouped