final class ClusterSingletonManagerSettings extends AnyRef

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

Instance Constructors

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

    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).

    leaseSettings

    LeaseSettings for acquiring before creating the singleton actor. Note that if you define a custom lease name and have several singletons each one must have a unique lease name. If the lease name is undefined it will be derived from ActorSystem name and singleton actor path, but that may result in too long lease names.

  2. new ClusterSingletonManagerSettings(singletonName: String, role: Option[String], removalMargin: FiniteDuration, handOverRetryInterval: FiniteDuration)
    Annotations
    @deprecated
    Deprecated

    (Since version 2.6.15) Use constructor with leaseSettings

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from ClusterSingletonManagerSettings toany2stringadd[ClusterSingletonManagerSettings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ClusterSingletonManagerSettings, B)
    Implicit
    This member is added by an implicit conversion from ClusterSingletonManagerSettings toArrowAssoc[ClusterSingletonManagerSettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  8. def ensuring(cond: (ClusterSingletonManagerSettings) => Boolean, msg: => Any): ClusterSingletonManagerSettings
    Implicit
    This member is added by an implicit conversion from ClusterSingletonManagerSettings toEnsuring[ClusterSingletonManagerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (ClusterSingletonManagerSettings) => Boolean): ClusterSingletonManagerSettings
    Implicit
    This member is added by an implicit conversion from ClusterSingletonManagerSettings toEnsuring[ClusterSingletonManagerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): ClusterSingletonManagerSettings
    Implicit
    This member is added by an implicit conversion from ClusterSingletonManagerSettings toEnsuring[ClusterSingletonManagerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): ClusterSingletonManagerSettings
    Implicit
    This member is added by an implicit conversion from ClusterSingletonManagerSettings toEnsuring[ClusterSingletonManagerSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  15. val handOverRetryInterval: FiniteDuration
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val leaseSettings: Option[LeaseUsageSettings]
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. val removalMargin: FiniteDuration
  23. val role: Option[String]
  24. val singletonName: String
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  30. def withHandOverRetryInterval(retryInterval: Duration): ClusterSingletonManagerSettings
  31. def withHandOverRetryInterval(retryInterval: FiniteDuration): ClusterSingletonManagerSettings
  32. def withLeaseSettings(leaseSettings: LeaseUsageSettings): ClusterSingletonManagerSettings

    Note that if you define a custom lease name and have several singletons each one must have a unique lease name.

    Note that if you define a custom lease name and have several singletons each one must have a unique lease name. If the lease name is undefined it will be derived from ActorSystem name and singleton actor path, but that may result in too long lease names.

  33. def withRemovalMargin(removalMargin: Duration): ClusterSingletonManagerSettings
  34. def withRemovalMargin(removalMargin: FiniteDuration): ClusterSingletonManagerSettings
  35. def withRole(role: Option[String]): ClusterSingletonManagerSettings
  36. def withRole(role: String): ClusterSingletonManagerSettings
  37. def withSingletonName(name: String): ClusterSingletonManagerSettings

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

  2. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ClusterSingletonManagerSettings toStringFormat[ClusterSingletonManagerSettings] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @deprecated @inline()
    Deprecated

    (Since version 2.12.16) Use formatString.format(value) instead of value.formatted(formatString), or use the f"" string interpolator. In Java 15 and later, formatted resolves to the new method in String which has reversed parameters.

  3. def [B](y: B): (ClusterSingletonManagerSettings, B)
    Implicit
    This member is added by an implicit conversion from ClusterSingletonManagerSettings toArrowAssoc[ClusterSingletonManagerSettings] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromClusterSingletonManagerSettings to any2stringadd[ClusterSingletonManagerSettings]

Inherited by implicit conversion StringFormat fromClusterSingletonManagerSettings to StringFormat[ClusterSingletonManagerSettings]

Inherited by implicit conversion Ensuring fromClusterSingletonManagerSettings to Ensuring[ClusterSingletonManagerSettings]

Inherited by implicit conversion ArrowAssoc fromClusterSingletonManagerSettings to ArrowAssoc[ClusterSingletonManagerSettings]

Ungrouped