final class ClusterSingletonSettings extends AnyRef

Annotations
@nowarn()
Source
ClusterSingleton.scala
Linear Supertypes
AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClusterSingletonSettings
  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 ClusterSingletonSettings(role: Option[String], dataCenter: Option[DataCenter], singletonIdentificationInterval: FiniteDuration, removalMargin: FiniteDuration, handOverRetryInterval: FiniteDuration, bufferSize: Int, leaseSettings: Option[LeaseUsageSettings])
  2. new ClusterSingletonSettings(role: Option[String], dataCenter: Option[DataCenter], singletonIdentificationInterval: FiniteDuration, removalMargin: FiniteDuration, handOverRetryInterval: FiniteDuration, bufferSize: Int)
    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 ClusterSingletonSettings toany2stringadd[ClusterSingletonSettings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (ClusterSingletonSettings, B)
    Implicit
    This member is added by an implicit conversion from ClusterSingletonSettings toArrowAssoc[ClusterSingletonSettings] 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. val bufferSize: Int
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. def ensuring(cond: (ClusterSingletonSettings) => Boolean, msg: => Any): ClusterSingletonSettings
    Implicit
    This member is added by an implicit conversion from ClusterSingletonSettings toEnsuring[ClusterSingletonSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (ClusterSingletonSettings) => Boolean): ClusterSingletonSettings
    Implicit
    This member is added by an implicit conversion from ClusterSingletonSettings toEnsuring[ClusterSingletonSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): ClusterSingletonSettings
    Implicit
    This member is added by an implicit conversion from ClusterSingletonSettings toEnsuring[ClusterSingletonSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): ClusterSingletonSettings
    Implicit
    This member is added by an implicit conversion from ClusterSingletonSettings toEnsuring[ClusterSingletonSettings] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. val handOverRetryInterval: FiniteDuration
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. val leaseSettings: Option[LeaseUsageSettings]
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. val removalMargin: FiniteDuration
  24. val role: Option[String]
  25. val singletonIdentificationInterval: FiniteDuration
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toString(): String
    Definition Classes
    ClusterSingletonSettings → AnyRef → Any
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. def withBufferSize(bufferSize: Int): ClusterSingletonSettings
  32. def withHandoverRetryInterval(handOverRetryInterval: Duration): ClusterSingletonSettings
  33. def withHandoverRetryInterval(handOverRetryInterval: FiniteDuration): ClusterSingletonSettings
  34. def withLeaseSettings(leaseSettings: LeaseUsageSettings): ClusterSingletonSettings

    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.

  35. def withNoRole(): ClusterSingletonSettings
  36. def withRemovalMargin(removalMargin: Duration): ClusterSingletonSettings
  37. def withRemovalMargin(removalMargin: FiniteDuration): ClusterSingletonSettings
  38. def withRole(role: String): ClusterSingletonSettings

Deprecated Value Members

  1. val dataCenter: Option[DataCenter]
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use Akka Distributed Cluster instead

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

    (Since version 9)

  3. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from ClusterSingletonSettings toStringFormat[ClusterSingletonSettings] 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.

  4. def withDataCenter(dataCenter: DataCenter): ClusterSingletonSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use Akka Distributed Cluster instead

  5. def withNoDataCenter(): ClusterSingletonSettings
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use Akka Distributed Cluster instead

  6. def →[B](y: B): (ClusterSingletonSettings, B)
    Implicit
    This member is added by an implicit conversion from ClusterSingletonSettings toArrowAssoc[ClusterSingletonSettings] 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 fromClusterSingletonSettings to any2stringadd[ClusterSingletonSettings]

Inherited by implicit conversion StringFormat fromClusterSingletonSettings to StringFormat[ClusterSingletonSettings]

Inherited by implicit conversion Ensuring fromClusterSingletonSettings to Ensuring[ClusterSingletonSettings]

Inherited by implicit conversion ArrowAssoc fromClusterSingletonSettings to ArrowAssoc[ClusterSingletonSettings]

Ungrouped