final case class CantonParameters(clock: ClockConfig = ClockConfig.WallClock(), enableAdditionalConsistencyChecks: Boolean = false, manualStart: Boolean = false, startupParallelism: Option[PositiveInt] = None, nonStandardConfig: Boolean = false, sessionSigningKeys: SessionSigningKeysConfig = SessionSigningKeysConfig.disabled, alphaVersionSupport: Boolean = false, betaVersionSupport: Boolean = false, portsFile: Option[String] = None, timeouts: TimeoutSettings = TimeoutSettings(), retentionPeriodDefaults: RetentionPeriodDefaults = RetentionPeriodDefaults(), console: AmmoniteConsoleConfig = AmmoniteConsoleConfig(), exitOnFatalFailures: Boolean = true, startupMemoryCheckConfig: StartupMemoryCheckConfig = StartupMemoryCheckConfig( ReportingLevel.Warn ), enableAlphaStateViaConfig: Boolean = false, stateRefreshInterval: Option[NonNegativeFiniteDuration] = None) extends UniformCantonConfigValidation with Product with Serializable
Parameters for testing Canton. Use default values in a production environment.
- enableAdditionalConsistencyChecks
if true, run additional consistency checks. This will degrade performance.
- manualStart
If set to true, the nodes have to be manually started via console (default false)
- startupParallelism
Start up to N nodes in parallel (default is num-threads)
- nonStandardConfig
don't fail config validation on non-standard configuration settings
- sessionSigningKeys
Configure the use of session signing keys in the protocol
- alphaVersionSupport
If true, allow synchronizer nodes to use alpha protocol versions and participant nodes to connect to such synchronizers
- betaVersionSupport
If true, allow synchronizer nodes to use beta protocol versions and participant nodes to connect to such synchronizers
- portsFile
A ports file name, where the ports of all participants will be written to after startup
- timeouts
Sets the timeouts used for processing and console
- exitOnFatalFailures
If true the node will exit/stop the process in case of fatal failures
- enableAlphaStateViaConfig
If true, we will start the declarative api functionality
- stateRefreshInterval
If configured, the config file will be reread in the given interval to allow dynamic properties to be picked up immediately
- Alphabetic
- By Inheritance
- CantonParameters
- Serializable
- Product
- Equals
- UniformCantonConfigValidation
- CustomCantonConfigValidation
- CantonConfigValidation
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new CantonParameters(clock: ClockConfig = ClockConfig.WallClock(), enableAdditionalConsistencyChecks: Boolean = false, manualStart: Boolean = false, startupParallelism: Option[PositiveInt] = None, nonStandardConfig: Boolean = false, sessionSigningKeys: SessionSigningKeysConfig = SessionSigningKeysConfig.disabled, alphaVersionSupport: Boolean = false, betaVersionSupport: Boolean = false, portsFile: Option[String] = None, timeouts: TimeoutSettings = TimeoutSettings(), retentionPeriodDefaults: RetentionPeriodDefaults = RetentionPeriodDefaults(), console: AmmoniteConsoleConfig = AmmoniteConsoleConfig(), exitOnFatalFailures: Boolean = true, startupMemoryCheckConfig: StartupMemoryCheckConfig = StartupMemoryCheckConfig(
ReportingLevel.Warn
), enableAlphaStateViaConfig: Boolean = false, stateRefreshInterval: Option[NonNegativeFiniteDuration] = None)
- enableAdditionalConsistencyChecks
if true, run additional consistency checks. This will degrade performance.
- manualStart
If set to true, the nodes have to be manually started via console (default false)
- startupParallelism
Start up to N nodes in parallel (default is num-threads)
- nonStandardConfig
don't fail config validation on non-standard configuration settings
- sessionSigningKeys
Configure the use of session signing keys in the protocol
- alphaVersionSupport
If true, allow synchronizer nodes to use alpha protocol versions and participant nodes to connect to such synchronizers
- betaVersionSupport
If true, allow synchronizer nodes to use beta protocol versions and participant nodes to connect to such synchronizers
- portsFile
A ports file name, where the ports of all participants will be written to after startup
- timeouts
Sets the timeouts used for processing and console
- exitOnFatalFailures
If true the node will exit/stop the process in case of fatal failures
- enableAlphaStateViaConfig
If true, we will start the declarative api functionality
- stateRefreshInterval
If configured, the config file will be reread in the given interval to allow dynamic properties to be picked up immediately
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val alphaVersionSupport: Boolean
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val betaVersionSupport: Boolean
- val clock: ClockConfig
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val console: AmmoniteConsoleConfig
- 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
- UniformCantonConfigValidation → CustomCantonConfigValidation
- val enableAdditionalConsistencyChecks: Boolean
- val enableAlphaStateViaConfig: Boolean
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val exitOnFatalFailures: Boolean
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def getStartupParallelism(numThreads: PositiveInt): PositiveInt
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val manualStart: Boolean
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val nonStandardConfig: Boolean
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- val portsFile: Option[String]
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val retentionPeriodDefaults: RetentionPeriodDefaults
- val sessionSigningKeys: SessionSigningKeysConfig
- val startupMemoryCheckConfig: StartupMemoryCheckConfig
- val startupParallelism: Option[PositiveInt]
- val stateRefreshInterval: Option[NonNegativeFiniteDuration]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: TimeoutSettings
- final def validate[T >: CantonParameters.this.type](edition: CantonEdition)(implicit validator: CantonConfigValidator[T]): Either[NonEmpty[Seq[CantonConfigValidationError]], Unit]
- Definition Classes
- CantonConfigValidation
- 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])