final class ReplicatorSettings extends AnyRef
- Alphabetic
- By Inheritance
- ReplicatorSettings
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ReplicatorSettings(roles: Set[String], gossipInterval: FiniteDuration, notifySubscribersInterval: FiniteDuration, maxDeltaElements: Int, dispatcher: String, pruningInterval: FiniteDuration, maxPruningDissemination: FiniteDuration, durableStoreProps: Either[(String, Config), Props], durableKeys: Set[KeyId], pruningMarkerTimeToLive: FiniteDuration, durablePruningMarkerTimeToLive: FiniteDuration, deltaCrdtEnabled: Boolean, maxDeltaSize: Int, preferOldest: Boolean, logDataSizeExceeding: Option[Int], expiryKeys: Map[KeyId, FiniteDuration])
- roles
Replicas are running on members tagged with these roles. The member must have all given roles. All members are used if empty.
- gossipInterval
How often the Replicator should send out gossip information.
- notifySubscribersInterval
How often the subscribers will be notified of changes, if any.
- maxDeltaElements
Maximum number of entries to transfer in one gossip message when synchronizing the replicas. Next chunk will be transferred in next round of gossip.
- dispatcher
Id of the dispatcher to use for Replicator actors. If not specified (
""
) the default dispatcher is used.- pruningInterval
How often the Replicator checks for pruning of data associated with removed cluster nodes.
- maxPruningDissemination
How long time it takes (worst case) to spread the data to all other replica nodes. This is used when initiating and completing the pruning process of data associated with removed cluster nodes. The time measurement is stopped when any replica is unreachable, so it should be configured to worst case in a healthy cluster.
- durableStoreProps
Props for the durable store actor, the
Left
alternative is a tuple of fully qualified actor class name and the config constructor parameter of that class, theRight
alternative is theProps
of the actor.- durableKeys
Keys that are durable. Prefix matching is supported by using
*
at the end of a key. All entries can be made durable by including "*" in theSet
.- preferOldest
Update and Get operations are sent to oldest nodes first.
- logDataSizeExceeding
Log data size.
- expiryKeys
Map of keys and inactivity duration for entries that will automatically be removed without tombstones when they have been inactive for the given duration. Prefix matching is supported by using * at the end of a key. Matching tombstones will also be removed after the expiry duration.
- new ReplicatorSettings(role: Option[String], gossipInterval: FiniteDuration, notifySubscribersInterval: FiniteDuration, maxDeltaElements: Int, dispatcher: String, pruningInterval: FiniteDuration, maxPruningDissemination: FiniteDuration, durableStoreProps: Either[(String, Config), Props], durableKeys: Set[String], pruningMarkerTimeToLive: FiniteDuration, durablePruningMarkerTimeToLive: FiniteDuration, deltaCrdtEnabled: Boolean)
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.11) use full constructor
- new ReplicatorSettings(role: Option[String], gossipInterval: FiniteDuration, notifySubscribersInterval: FiniteDuration, maxDeltaElements: Int, dispatcher: String, pruningInterval: FiniteDuration, maxPruningDissemination: FiniteDuration, durableStoreProps: Either[(String, Config), Props], durableKeys: Set[String])
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.11) use full constructor
- new ReplicatorSettings(role: Option[String], gossipInterval: FiniteDuration, notifySubscribersInterval: FiniteDuration, maxDeltaElements: Int, dispatcher: String, pruningInterval: FiniteDuration, maxPruningDissemination: FiniteDuration)
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.11) use full constructor
- new ReplicatorSettings(role: Option[String], gossipInterval: FiniteDuration, notifySubscribersInterval: FiniteDuration, maxDeltaElements: Int, dispatcher: String, pruningInterval: FiniteDuration, maxPruningDissemination: FiniteDuration, durableStoreProps: Either[(String, Config), Props], durableKeys: Set[KeyId], pruningMarkerTimeToLive: FiniteDuration, durablePruningMarkerTimeToLive: FiniteDuration, deltaCrdtEnabled: Boolean, maxDeltaSize: Int)
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.11) use full constructor
- new ReplicatorSettings(roles: Set[String], gossipInterval: FiniteDuration, notifySubscribersInterval: FiniteDuration, maxDeltaElements: Int, dispatcher: String, pruningInterval: FiniteDuration, maxPruningDissemination: FiniteDuration, durableStoreProps: Either[(String, Config), Props], durableKeys: Set[KeyId], pruningMarkerTimeToLive: FiniteDuration, durablePruningMarkerTimeToLive: FiniteDuration, deltaCrdtEnabled: Boolean, maxDeltaSize: Int)
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.11) use full constructor
- new ReplicatorSettings(roles: Set[String], gossipInterval: FiniteDuration, notifySubscribersInterval: FiniteDuration, maxDeltaElements: Int, dispatcher: String, pruningInterval: FiniteDuration, maxPruningDissemination: FiniteDuration, durableStoreProps: Either[(String, Config), Props], durableKeys: Set[KeyId], pruningMarkerTimeToLive: FiniteDuration, durablePruningMarkerTimeToLive: FiniteDuration, deltaCrdtEnabled: Boolean, maxDeltaSize: Int, preferOldest: Boolean)
- Annotations
- @deprecated
- Deprecated
(Since version 2.6.11) use full constructor
- new ReplicatorSettings(roles: Set[String], gossipInterval: FiniteDuration, notifySubscribersInterval: FiniteDuration, maxDeltaElements: Int, dispatcher: String, pruningInterval: FiniteDuration, maxPruningDissemination: FiniteDuration, durableStoreProps: Either[(String, Config), Props], durableKeys: Set[KeyId], pruningMarkerTimeToLive: FiniteDuration, durablePruningMarkerTimeToLive: FiniteDuration, deltaCrdtEnabled: Boolean, maxDeltaSize: Int, preferOldest: Boolean, logDataSizeExceeding: Option[Int])
- Annotations
- @deprecated
- Deprecated
(Since version 2.7.1) use full constructor
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 ReplicatorSettings toany2stringadd[ReplicatorSettings] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
- def ->[B](y: B): (ReplicatorSettings, B)
- Implicit
- This member is added by an implicit conversion from ReplicatorSettings toArrowAssoc[ReplicatorSettings] 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()
- val deltaCrdtEnabled: Boolean
- val dispatcher: String
- val durableKeys: Set[KeyId]
- val durablePruningMarkerTimeToLive: FiniteDuration
- val durableStoreProps: Either[(String, Config), Props]
- def ensuring(cond: (ReplicatorSettings) => Boolean, msg: => Any): ReplicatorSettings
- Implicit
- This member is added by an implicit conversion from ReplicatorSettings toEnsuring[ReplicatorSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: (ReplicatorSettings) => Boolean): ReplicatorSettings
- Implicit
- This member is added by an implicit conversion from ReplicatorSettings toEnsuring[ReplicatorSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean, msg: => Any): ReplicatorSettings
- Implicit
- This member is added by an implicit conversion from ReplicatorSettings toEnsuring[ReplicatorSettings] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
- def ensuring(cond: Boolean): ReplicatorSettings
- Implicit
- This member is added by an implicit conversion from ReplicatorSettings toEnsuring[ReplicatorSettings] 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
- val expiryKeys: Map[KeyId, FiniteDuration]
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- val gossipInterval: FiniteDuration
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @HotSpotIntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val logDataSizeExceeding: Option[Int]
- val maxDeltaElements: Int
- val maxDeltaSize: Int
- val maxPruningDissemination: FiniteDuration
- 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 notifySubscribersInterval: FiniteDuration
- val preferOldest: Boolean
- val pruningInterval: FiniteDuration
- val pruningMarkerTimeToLive: FiniteDuration
- def role: Option[String]
- val roles: Set[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 withDeltaCrdtEnabled(deltaCrdtEnabled: Boolean): ReplicatorSettings
- def withDispatcher(dispatcher: String): ReplicatorSettings
- def withDurableKeys(durableKeys: Set[String]): ReplicatorSettings
Java API
- def withDurableKeys(durableKeys: Set[KeyId]): ReplicatorSettings
Scala API
- def withDurableStoreProps(durableStoreProps: Props): ReplicatorSettings
- def withExpiryKeys(expiryKeys: Map[String, Duration]): ReplicatorSettings
Java API
- def withExpiryKeys(expiryKeys: Map[KeyId, FiniteDuration]): ReplicatorSettings
Scala API
- def withGossipInterval(gossipInterval: FiniteDuration): ReplicatorSettings
- def withLogDataSizeExceeding(logDataSizeExceeding: Int): ReplicatorSettings
- def withMaxDeltaElements(maxDeltaElements: Int): ReplicatorSettings
- def withMaxDeltaSize(maxDeltaSize: Int): ReplicatorSettings
- def withNotifySubscribersInterval(notifySubscribersInterval: FiniteDuration): ReplicatorSettings
- def withPreferOldest(preferOldest: Boolean): ReplicatorSettings
- def withPruning(pruningInterval: FiniteDuration, maxPruningDissemination: FiniteDuration): ReplicatorSettings
- def withPruningMarkerTimeToLive(pruningMarkerTimeToLive: FiniteDuration, durablePruningMarkerTimeToLive: FiniteDuration): ReplicatorSettings
- def withRole(role: Option[String]): ReplicatorSettings
- def withRole(role: String): ReplicatorSettings
- def withRoles(roles: String*): ReplicatorSettings
- Annotations
- @varargs()
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 ReplicatorSettings toStringFormat[ReplicatorSettings] 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,formatted
resolves to the new method in String which has reversed parameters.
- def →[B](y: B): (ReplicatorSettings, B)
- Implicit
- This member is added by an implicit conversion from ReplicatorSettings toArrowAssoc[ReplicatorSettings] 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.