final class ReplicatorSettings extends AnyRef

Source
Replicator.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReplicatorSettings
  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 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, the Right alternative is the Props 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 the Set.

    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.

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

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

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

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

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

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

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

  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 ReplicatorSettings toany2stringadd[ReplicatorSettings] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. 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()
  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. val deltaCrdtEnabled: Boolean
  9. val dispatcher: String
  10. val durableKeys: Set[KeyId]
  11. val durablePruningMarkerTimeToLive: FiniteDuration
  12. val durableStoreProps: Either[(String, Config), Props]
  13. 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
  14. 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
  15. 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
  16. 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
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. val expiryKeys: Map[KeyId, FiniteDuration]
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  21. val gossipInterval: FiniteDuration
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  24. val logDataSizeExceeding: Option[Int]
  25. val maxDeltaElements: Int
  26. val maxDeltaSize: Int
  27. val maxPruningDissemination: FiniteDuration
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  31. val notifySubscribersInterval: FiniteDuration
  32. val preferOldest: Boolean
  33. val pruningInterval: FiniteDuration
  34. val pruningMarkerTimeToLive: FiniteDuration
  35. def role: Option[String]
  36. val roles: Set[String]
  37. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  41. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  42. def withDeltaCrdtEnabled(deltaCrdtEnabled: Boolean): ReplicatorSettings
  43. def withDispatcher(dispatcher: String): ReplicatorSettings
  44. def withDurableKeys(durableKeys: Set[String]): ReplicatorSettings

    Java API

  45. def withDurableKeys(durableKeys: Set[KeyId]): ReplicatorSettings

    Scala API

  46. def withDurableStoreProps(durableStoreProps: Props): ReplicatorSettings
  47. def withExpiryKeys(expiryKeys: Map[String, Duration]): ReplicatorSettings

    Java API

  48. def withExpiryKeys(expiryKeys: Map[KeyId, FiniteDuration]): ReplicatorSettings

    Scala API

  49. def withGossipInterval(gossipInterval: FiniteDuration): ReplicatorSettings
  50. def withLogDataSizeExceeding(logDataSizeExceeding: Int): ReplicatorSettings
  51. def withMaxDeltaElements(maxDeltaElements: Int): ReplicatorSettings
  52. def withMaxDeltaSize(maxDeltaSize: Int): ReplicatorSettings
  53. def withNotifySubscribersInterval(notifySubscribersInterval: FiniteDuration): ReplicatorSettings
  54. def withPreferOldest(preferOldest: Boolean): ReplicatorSettings
  55. def withPruning(pruningInterval: FiniteDuration, maxPruningDissemination: FiniteDuration): ReplicatorSettings
  56. def withPruningMarkerTimeToLive(pruningMarkerTimeToLive: FiniteDuration, durablePruningMarkerTimeToLive: FiniteDuration): ReplicatorSettings
  57. def withRole(role: Option[String]): ReplicatorSettings
  58. def withRole(role: String): ReplicatorSettings
  59. def withRoles(roles: String*): ReplicatorSettings
    Annotations
    @varargs()

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromReplicatorSettings to any2stringadd[ReplicatorSettings]

Inherited by implicit conversion StringFormat fromReplicatorSettings to StringFormat[ReplicatorSettings]

Inherited by implicit conversion Ensuring fromReplicatorSettings to Ensuring[ReplicatorSettings]

Inherited by implicit conversion ArrowAssoc fromReplicatorSettings to ArrowAssoc[ReplicatorSettings]

Ungrouped