Packages

final case class SequencerHighAvailabilityConfig(enabled: Option[Boolean] = None, totalNodeCount: PositiveInt = PositiveInt.tryCreate(10), keepAliveInterval: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofMillis(50L), onlineCheckInterval: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofSeconds(5L), offlineDuration: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofSeconds(8L), connectionPool: DbLockedConnectionPoolConfig = DbLockedConnectionPoolConfig(), exclusiveStorage: DatabaseSequencerExclusiveStorageConfig = DatabaseSequencerExclusiveStorageConfig()) extends EnterpriseOnlyCantonConfigValidation with Product with Serializable

Configuration for how many sequencers are concurrently operating within the synchronizer.

enabled

Set to Some(true) to enable HA for the sequencer. If None it will be enabled if the storage supports replication.

totalNodeCount

how many sequencer writers will there ever be in this synchronizer. recommend setting to a value larger than the current topology to allow for expansion.

keepAliveInterval

how frequently will we ensure the sequencer watermark is updated to ensure it still appears alive

onlineCheckInterval

how frequently should this sequencer check that nodes are still online

offlineDuration

how long should a sequencer watermark be lagging for it to be flagged as offline

connectionPool

configuration of the write connection pool used by an HA sequencer instance.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SequencerHighAvailabilityConfig
  2. Serializable
  3. Product
  4. Equals
  5. EnterpriseOnlyCantonConfigValidation
  6. PredicatedCantonConfigValidation
  7. CustomCantonConfigValidation
  8. CantonConfigValidation
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new SequencerHighAvailabilityConfig(enabled: Option[Boolean] = None, totalNodeCount: PositiveInt = PositiveInt.tryCreate(10), keepAliveInterval: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofMillis(50L), onlineCheckInterval: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofSeconds(5L), offlineDuration: NonNegativeFiniteDuration = NonNegativeFiniteDuration.ofSeconds(8L), connectionPool: DbLockedConnectionPoolConfig = DbLockedConnectionPoolConfig(), exclusiveStorage: DatabaseSequencerExclusiveStorageConfig = DatabaseSequencerExclusiveStorageConfig())

    enabled

    Set to Some(true) to enable HA for the sequencer. If None it will be enabled if the storage supports replication.

    totalNodeCount

    how many sequencer writers will there ever be in this synchronizer. recommend setting to a value larger than the current topology to allow for expansion.

    keepAliveInterval

    how frequently will we ensure the sequencer watermark is updated to ensure it still appears alive

    onlineCheckInterval

    how frequently should this sequencer check that nodes are still online

    offlineDuration

    how long should a sequencer watermark be lagging for it to be flagged as offline

    connectionPool

    configuration of the write connection pool used by an HA sequencer instance.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def allowThisInCommunity: Boolean
  5. def allowThisInEnterprise: Boolean
    Attributes
    protected
    Definition Classes
    PredicatedCantonConfigValidation
  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]) @IntrinsicCandidate() @native()
  8. val connectionPool: DbLockedConnectionPoolConfig
  9. def doValidate(edition: CantonEdition): Seq[CantonConfigValidationError]

    Returns all validation errors that are specific to this Canton configuration class.

    Returns all validation errors that are specific to this Canton configuration class. Successful validation should return an empty sequence.

    Validation errors of subconfigurations should not be reported by this method, but via the type class derivation.

    Attributes
    protected
    Definition Classes
    PredicatedCantonConfigValidationCustomCantonConfigValidation
  10. val enabled: Option[Boolean]
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. val exclusiveStorage: DatabaseSequencerExclusiveStorageConfig
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  14. lazy val isEnabled: Boolean
  15. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  16. val keepAliveInterval: NonNegativeFiniteDuration
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  20. val offlineDuration: NonNegativeFiniteDuration
  21. val onlineCheckInterval: NonNegativeFiniteDuration
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toOnlineSequencerCheckConfig: OnlineSequencerCheckConfig
  25. val totalNodeCount: PositiveInt
  26. final def validate[T >: SequencerHighAvailabilityConfig.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
    Definition Classes
    CantonConfigValidation
  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])

Deprecated Value Members

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

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from CantonConfigValidation

Inherited from AnyRef

Inherited from Any

Ungrouped