Packages

final case class TopologyConfig(topologyTransactionRegistrationTimeout: NonNegativeFiniteDuration = defaultTopologyTransactionRegistrationTimeout, topologyTransactionObservationTimeout: NonNegativeFiniteDuration = defaultTopologyTransactionObservationTimeout, broadcastBatchSize: PositiveInt = defaultBroadcastBatchSize, broadcastRetryDelay: NonNegativeFiniteDuration = defaultBroadcastRetryDelay, validateInitialTopologySnapshot: Boolean = true, disableOptionalTopologyChecks: Boolean = false, dispatchQueueBackpressureLimit: NonNegativeInt = defaultMaxUnsentTopologyQueueSize, useTimeProofsToObserveEffectiveTime: Boolean = true) extends UniformCantonConfigValidation with Product with Serializable

topologyTransactionRegistrationTimeout

Used to determine the max sequencing time for topology transaction broadcasts.

topologyTransactionObservationTimeout

Determines up to how long the node waits for observing the dispatched topology transactions in its own local synchronizer store. The observation timeout is checked against the node's wall clock. After this timeout, the node fails the dispatch cycle. This timeout is only triggered, if the sequencer accepts the topology transaction broadcast submission request, but drops the message during ordering (for whatever reason).

broadcastBatchSize

The maximum number of topology transactions sent in a topology transaction broadcast

broadcastRetryDelay

The delay after which a failed dispatch cycle will be triggered again.

validateInitialTopologySnapshot

Whether or not the node will validate the initial topology snapshot when onboarding to a synchronizer.

disableOptionalTopologyChecks

if true (default is false), don't run the optional checks which prevent accidental damage to this node

dispatchQueueBackpressureLimit

new topology requests will be backpressured if the number of existing requests exceeds this number

useTimeProofsToObserveEffectiveTime

Whether the node will use time proofs to observe when an effective time has been reached. If false, no time proofs will be sent to the sequencers by any Canton node.

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

Instance Constructors

  1. new TopologyConfig(topologyTransactionRegistrationTimeout: NonNegativeFiniteDuration = defaultTopologyTransactionRegistrationTimeout, topologyTransactionObservationTimeout: NonNegativeFiniteDuration = defaultTopologyTransactionObservationTimeout, broadcastBatchSize: PositiveInt = defaultBroadcastBatchSize, broadcastRetryDelay: NonNegativeFiniteDuration = defaultBroadcastRetryDelay, validateInitialTopologySnapshot: Boolean = true, disableOptionalTopologyChecks: Boolean = false, dispatchQueueBackpressureLimit: NonNegativeInt = defaultMaxUnsentTopologyQueueSize, useTimeProofsToObserveEffectiveTime: Boolean = true)

    topologyTransactionRegistrationTimeout

    Used to determine the max sequencing time for topology transaction broadcasts.

    topologyTransactionObservationTimeout

    Determines up to how long the node waits for observing the dispatched topology transactions in its own local synchronizer store. The observation timeout is checked against the node's wall clock. After this timeout, the node fails the dispatch cycle. This timeout is only triggered, if the sequencer accepts the topology transaction broadcast submission request, but drops the message during ordering (for whatever reason).

    broadcastBatchSize

    The maximum number of topology transactions sent in a topology transaction broadcast

    broadcastRetryDelay

    The delay after which a failed dispatch cycle will be triggered again.

    validateInitialTopologySnapshot

    Whether or not the node will validate the initial topology snapshot when onboarding to a synchronizer.

    disableOptionalTopologyChecks

    if true (default is false), don't run the optional checks which prevent accidental damage to this node

    dispatchQueueBackpressureLimit

    new topology requests will be backpressured if the number of existing requests exceeds this number

    useTimeProofsToObserveEffectiveTime

    Whether the node will use time proofs to observe when an effective time has been reached. If false, no time proofs will be sent to the sequencers by any Canton node.

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 asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val broadcastBatchSize: PositiveInt
  6. val broadcastRetryDelay: NonNegativeFiniteDuration
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. val disableOptionalTopologyChecks: Boolean
  9. val dispatchQueueBackpressureLimit: NonNegativeInt
  10. final 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
    UniformCantonConfigValidationCustomCantonConfigValidation
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. def productElementNames: Iterator[String]
    Definition Classes
    Product
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. val topologyTransactionObservationTimeout: NonNegativeFiniteDuration
  20. val topologyTransactionRegistrationTimeout: NonNegativeFiniteDuration
  21. val useTimeProofsToObserveEffectiveTime: Boolean
  22. final def validate[T >: TopologyConfig.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
    Definition Classes
    CantonConfigValidation
  23. val validateInitialTopologySnapshot: Boolean
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

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