final class ClusterSingletonManagerSettings extends NoSerializationVerificationNeeded
- Alphabetic
- By Inheritance
- ClusterSingletonManagerSettings
- NoSerializationVerificationNeeded
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ClusterSingletonManagerSettings(singletonName: String, role: Option[String], removalMargin: FiniteDuration, handOverRetryInterval: FiniteDuration)
- 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.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- 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
- 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()
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
- 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
- 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
- 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
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val handOverRetryInterval: FiniteDuration
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val leaseSettings: Option[LeaseUsageSettings]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val removalMargin: FiniteDuration
- val role: Option[String]
- val singletonName: String
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withHandOverRetryInterval(retryInterval: FiniteDuration): ClusterSingletonManagerSettings
- 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.
- def withRemovalMargin(removalMargin: FiniteDuration): ClusterSingletonManagerSettings
- def withRole(role: Option[String]): ClusterSingletonManagerSettings
- def withRole(role: String): ClusterSingletonManagerSettings
- def withSingletonName(name: String): ClusterSingletonManagerSettings
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)
- 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 ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
- 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.