object synchronizer_parameters extends Helpful
- Annotations
- @Summary(s = "Manage synchronizer parameters state", flag = FeatureFlag.Preview) @Group(name = "Synchronizer Parameters State")
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- synchronizer_parameters
- Helpful
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def get_dynamic_synchronizer_parameters(synchronizerId: SynchronizerId): DynamicSynchronizerParameters
- Annotations
- @Summary(s = "Get the configured dynamic synchronizer parameters", flag = console.this.Help.Summary.<init>$default$2)
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- Annotations
- @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
- def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def latest(store: TopologyStoreId, filterSynchronizer: String = "", filterSigningKey: String = "", protocolVersion: Option[String] = None): DynamicSynchronizerParameters
- Annotations
- @Summary(s = "Latest dynamic synchronizer parameters", flag = console.this.Help.Summary.<init>$default$2)
- def list(store: TopologyStoreId, proposals: Boolean = false, timeQuery: TimeQuery = TimeQuery.HeadState, operation: Option[TopologyChangeOp] = Some(TopologyChangeOp.Replace), filterSynchronizer: String = "", filterSigningKey: String = "", protocolVersion: Option[String] = None): Seq[ListSynchronizerParametersStateResult]
- Annotations
- @Summary(s = "List dynamic synchronizer parameters", flag = console.this.Help.Summary.<init>$default$2)
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def propose(synchronizerId: SynchronizerId, parameters: DynamicSynchronizerParameters, store: Option[TopologyStoreId] = None, mustFullyAuthorize: Boolean = false, signedBy: Option[Fingerprint] = None, serial: Option[PositiveInt] = None, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
), force: ForceFlags = ForceFlags.none): SignedTopologyTransaction[TopologyChangeOp, SynchronizerParametersState]
- Annotations
- @Summary(s = "Propose changes to dynamic synchronizer parameters", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """
synchronizerId: the target synchronizer
parameters: the new dynamic synchronizer parameters to be used on the synchronizer
store: - "Authorized": the topology transaction will be stored in the node's authorized store and automatically
propagated to connected synchronizers, if applicable.
- "<synchronizer id>": the topology transaction will be directly submitted to the specified synchronizer without
storing it locally first. This also means it will _not_ be synchronized to other synchronizers
automatically.
mustFullyAuthorize: when set to true, the proposal's previously received signatures and the signature of this node must be
sufficient to fully authorize the topology transaction. if this is not the case, the request fails.
when set to false, the proposal retains the proposal status until enough signatures are accumulated to
satisfy the mapping's authorization requirements.
signedBy: the fingerprint of the key to be used to sign this proposal
serial: the expected serial this topology transaction should have. Serials must be contiguous and start at 1.
This transaction will be rejected if another fully authorized transaction with the same serial already
exists, or if there is a gap between this serial and the most recently used serial.
If None, the serial will be automatically selected by the node.
synchronize: Synchronize timeout can be used to ensure that the state has been propagated into the node
waitForParticipants: if synchronize is defined, the command will also wait until parameters have been propagated
to the listed participants
force: must be set to true when performing a dangerous operation, such as increasing the preparationTimeRecordTimeTolerance""")
- def propose_update(synchronizerId: SynchronizerId, update: (DynamicSynchronizerParameters) => DynamicSynchronizerParameters, mustFullyAuthorize: Boolean = false, signedBy: Option[Fingerprint] = None, synchronize: Option[NonNegativeDuration] = Some(
consoleEnvironment.commandTimeouts.bounded
), force: ForceFlags = ForceFlags.none): Unit
- Annotations
- @Summary(s = "Propose an update to dynamic synchronizer parameters", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """
synchronizerId: the target synchronizer
update: the new dynamic synchronizer parameters to be used on the synchronizer
mustFullyAuthorize: when set to true, the proposal's previously received signatures and the signature of this node must be
sufficient to fully authorize the topology transaction. if this is not the case, the request fails.
when set to false, the proposal retains the proposal status until enough signatures are accumulated to
satisfy the mapping's authorization requirements.
signedBy: the fingerprint of the key to be used to sign this proposal
synchronize: Synchronize timeout can be used to ensure that the state has been propagated into the node
waitForParticipants: if synchronize is defined, the command will also wait until the update has been propagated
to the listed participants
force: must be set to true when performing a dangerous operation, such as increasing the preparationTimeRecordTimeTolerance""")
- def set_ledger_time_record_time_tolerance(synchronizerId: SynchronizerId, newLedgerTimeRecordTimeTolerance: NonNegativeFiniteDuration): Unit
- Annotations
- @Summary(s = "Update the ledger time record time tolerance in the dynamic synchronizer parameters", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """
synchronizerId: the target synchronizer
newLedgerTimeRecordTimeTolerance: the new ledgerTimeRecordTimeTolerance value to apply to the synchronizer""")
- def set_preparation_time_record_time_tolerance(synchronizerId: SynchronizerId, newPreparationTimeRecordTimeTolerance: NonNegativeFiniteDuration, force: Boolean = false): Unit
- Annotations
- @Summary(s = "Update the preparation time record time tolerance in the dynamic synchronizer parameters", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """If it would be insecure to perform the change immediately,
|the command will block and wait until it is secure to perform the change.
|The command will block for at most twice of ``newPreparationTimeRecordTimeTolerance``.
|
|The method will fail if ``mediatorDeduplicationTimeout`` is less than twice of ``newPreparationTimeRecordTimeTolerance``.
|
|Do not modify synchronizer parameters concurrently while running this command,
|because the command may override concurrent changes.
|
|force: update ``newPreparationTimeRecordTimeTolerance`` immediately without blocking.
|This is safe to do during synchronizer bootstrapping and in test environments, but should not be done in operational production systems.""")
- 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])