Packages

final case class DynamicSynchronizerParameters extends HasProtocolVersionedWrapper[DynamicSynchronizerParameters] with PrettyPrinting with Product with Serializable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DynamicSynchronizerParameters
  2. Serializable
  3. Product
  4. Equals
  5. PrettyPrinting
  6. PrettyUtil
  7. ShowUtil
  8. ShowSyntax
  9. ToShowOps
  10. HasProtocolVersionedWrapper
  11. HasToByteString
  12. HasRepresentativeProtocolVersion
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class ShowAnyRefSyntax extends AnyRef
    Definition Classes
    ShowUtil
  2. implicit class ShowEitherSyntax[L, R] extends AnyRef

    Enables the syntax show"${myEither.showMerged}".

    Enables the syntax show"${myEither.showMerged}".

    Definition Classes
    ShowUtil
  3. implicit class ShowLengthLimitedStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  4. implicit class ShowLengthLimitedStringWrapperSyntax extends StringOperators
    Definition Classes
    ShowUtil
  5. implicit class ShowOptionSyntax[T] extends AnyRef
    Definition Classes
    ShowUtil
  6. implicit class ShowProductSyntax extends AnyRef
    Definition Classes
    ShowUtil
    Annotations
    @SuppressWarnings()
  7. implicit class ShowStringSyntax extends StringOperators
    Definition Classes
    ShowUtil
  8. implicit class ShowTraversableSyntax[T] extends AnyRef

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Enables syntax like show"Found several elements: ${myCollection.mkShow()}".

    Definition Classes
    ShowUtil
  9. abstract class StringOperators extends AnyRef

    Enables syntax like:

    Enables syntax like:

    show"This is a string: ${myString.doubleQuoted}"

    and:

    show"This is a hash: ${myHash.readableHash}"
    Definition Classes
    ShowUtil

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. val acsCommitmentsCatchUp: Option[AcsCommitmentsCatchUpParameters]
  5. def adHocPrettyInstance[T <: Product](implicit c: ClassTag[T]): Pretty[T]

    Use this as a temporary solution, to make the code compile during an ongoing migration.

    Use this as a temporary solution, to make the code compile during an ongoing migration. Drawbacks:

    • Instances of Pretty[T] are ignored.
    • No parameter names
    Definition Classes
    PrettyUtil
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. val assignmentExclusivityTimeout: NonNegativeFiniteDuration
  8. def automaticAssignmentEnabled: Boolean
  9. def castRepresentativeProtocolVersion[T <: BaseVersioningCompanion[_, _, _, _]](target: T): Either[String, RepresentativeProtocolVersion[T]]

    Casts this instance's representative protocol version to one for the target type.

    Casts this instance's representative protocol version to one for the target type. This only succeeds if the versioning schemes are the same.

    Definition Classes
    HasProtocolVersionedWrapper
    Annotations
    @SuppressWarnings()
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  11. lazy val companionObj: DynamicSynchronizerParameters.type
    Attributes
    protected
    Definition Classes
    DynamicSynchronizerParametersHasProtocolVersionedWrapperHasRepresentativeProtocolVersion
    Annotations
    @transient()
  12. def confirmationRequestsMaxRate: NonNegativeInt
    Annotations
    @inline()
  13. val confirmationResponseTimeout: NonNegativeFiniteDuration
  14. def customParam[T](getValue: (T) => String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    Use this if you need a custom representation of a parameter.

    Use this if you need a custom representation of a parameter. Do not use this to create lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  17. def indicateOmittedFields[T]: (T) => Option[Tree]

    Use this to indicate that you've omitted fields from pretty printing

    Use this to indicate that you've omitted fields from pretty printing

    Definition Classes
    PrettyUtil
  18. def isEquivalentTo(protocolVersion: ProtocolVersion): Boolean
    Definition Classes
    HasProtocolVersionedWrapper
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val ledgerTimeRecordTimeTolerance: NonNegativeFiniteDuration
  21. val maxRequestSize: MaxRequestSize
  22. val mediatorDeduplicationTimeout: NonNegativeFiniteDuration
  23. val mediatorReactionTimeout: NonNegativeFiniteDuration
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  27. val onboardingRestriction: OnboardingRestriction
  28. def param[T, V](name: String, getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing both parameter name and value.

    A tree representing both parameter name and value.

    Definition Classes
    PrettyUtil
  29. def paramIfDefined[T, V](name: String, getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  30. def paramIfNonEmpty[T, V <: IterableOnce[_]](name: String, getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  31. def paramIfNotDefault[T, V](name: String, getValue: (T) => V, default: V)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree only written if not matching the default value

    A tree only written if not matching the default value

    Definition Classes
    PrettyUtil
  32. def paramIfTrue[T](label: String, getValue: (T) => Boolean): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  33. def paramWithoutValue[T](name: String, cond: (T) => Boolean = (_: T) => true): (T) => Option[Tree]

    A tree representing a parameter name without a parameter value.

    A tree representing a parameter name without a parameter value. Use this for parameters storing confidential or binary data.

    Definition Classes
    PrettyUtil
  34. val participantSynchronizerLimits: ParticipantSynchronizerLimits
  35. val preparationTimeRecordTimeTolerance: NonNegativeFiniteDuration
  36. def pretty: Pretty[DynamicSynchronizerParameters]

    Indicates how to pretty print this instance.

    Indicates how to pretty print this instance. See PrettyPrintingTest for examples on how to implement this method.

    Attributes
    protected
    Definition Classes
    DynamicSynchronizerParametersPrettyPrinting
  37. def prettyInfix[T]: PrettyInfixPartiallyApplied[T]
    Definition Classes
    PrettyUtil
  38. def prettyNode[T](label: String, children: (T) => Option[Tree]*): Pretty[T]

    A tree consisting of a labelled node with the given children.

    A tree consisting of a labelled node with the given children.

    Definition Classes
    PrettyUtil
  39. def prettyOfClass[T](getParamTrees: (T) => Option[Tree]*): Pretty[T]

    A tree representing the type name and parameter trees.

    A tree representing the type name and parameter trees.

    Definition Classes
    PrettyUtil
  40. def prettyOfClassWithName[T](name: String)(getParamTrees: (T) => Option[Tree]*): Pretty[T]

    Like prettyOfClass, except takes an explicit name for the class.

    Like prettyOfClass, except takes an explicit name for the class.

    Definition Classes
    PrettyUtil
  41. def prettyOfObject[T <: Product]: Pretty[T]

    A tree presenting the type name only.

    A tree presenting the type name only. (E.g., for case objects.)

    Definition Classes
    PrettyUtil
  42. def prettyOfParam[T, V](getValue: (T) => V)(implicit arg0: Pretty[V]): Pretty[T]

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Use this to give a class with a singleton parameter the same pretty representation as the parameter.

    Definition Classes
    PrettyUtil
  43. def prettyOfString[T](toString: (T) => String): Pretty[T]

    Creates a pretty instance from a string function.

    Creates a pretty instance from a string function. Do not use this with lengthy strings, as line wrapping is not supported.

    Definition Classes
    PrettyUtil
  44. def productElementNames: Iterator[String]
    Definition Classes
    Product
  45. def protoVersion: ProtoVersion

    Yields the Proto version that this class will be serialized to

    Yields the Proto version that this class will be serialized to

    Definition Classes
    HasProtocolVersionedWrapper
  46. val reconciliationInterval: PositiveSeconds
  47. val representativeProtocolVersion: RepresentativeProtocolVersion[DynamicSynchronizerParameters.type]

    We have a correspondence {Proto version} <-> {[protocol version]}: each proto version correspond to a list of consecutive protocol versions.

    We have a correspondence {Proto version} <-> {[protocol version]}: each proto version correspond to a list of consecutive protocol versions. The representative is one instance of this list, usually the smallest value. In other words, the Proto versions induce an equivalence relation on the list of protocol version, thus use of representative.

    The method protocolVersionRepresentativeFor below allows to query the representative for an equivalence class.

    Definition Classes
    DynamicSynchronizerParametersHasRepresentativeProtocolVersion
  48. val sequencerAggregateSubmissionTimeout: NonNegativeFiniteDuration
  49. def sequencerTopologyTimestampTolerance: NonNegativeFiniteDuration

    In some situations, the sequencer processes submission requests with a slightly outdated topology snapshot.

    In some situations, the sequencer processes submission requests with a slightly outdated topology snapshot. This is to allow recipients to verify sequencer signatures when the sequencer keys have been rolled over and they have not yet received the new keys, and to resolve group addresses using a sender-specified snapshot. This parameter determines how much outdated the signing key or the group address resolution can be. Choose a higher value to avoid that the sequencer refuses to sign and send messages. Choose a lower value to reduce the latency of sequencer key rollovers and updates of group addresses. The sequencer topology tolerance must be at least confirmationResponseTimeout + mediatorReactionTimeout.

  50. implicit final def showInterpolator(sc: StringContext): ShowInterpolator
    Definition Classes
    ShowSyntax
  51. implicit def showPretty[T](implicit arg0: Pretty[T]): Show[T]

    Enables the syntax show"This object is pretty: $myPrettyType".

    Enables the syntax show"This object is pretty: $myPrettyType".

    Definition Classes
    ShowUtil
  52. def submissionCostTimestampTopologyTolerance: NonNegativeFiniteDuration

    Submitters compute the submission cost of their request before sending it, using the same topology used to sign the SubmissionRequest.

    Submitters compute the submission cost of their request before sending it, using the same topology used to sign the SubmissionRequest. This is to provide an upper bound to the synchronizer on how much they commit to spend for the sequencing and delivery of the submission. Concurrent topology changes to the submission can result in the cost computed by the submitter being wrong at sequencing time. This parameter determines how outdated the topology used to compute the cost can be. If within the tolerance window, the submitted cost will be deducted (pending enough traffic is available) and the event will be delivered. If outside the tolerance window, no cost will be deducted but the event will not be delivered. It is the responsibility of the sequencer that received the request to do this check ahead of time and not let outdated requests be sequenced. After sequencing, such events will be reported via metrics as "wasted" traffic and tied to the sequencer who processed the request for tracing and accountability. The timestamp checked against this parameter will be the one used to sign the submission request, not the one in the submission request itself.

    Note: Current value is equal to sequencerTopologyTimestampTolerance to get the same behavior in terms of tolerance as senders get for the topology timestamp specified in the SubmissionRequest.

  53. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  54. def toByteArray: Array[Byte]

    Yields a byte array representation of the corresponding UntypedVersionedMessage wrapper of this instance.

    Yields a byte array representation of the corresponding UntypedVersionedMessage wrapper of this instance.

    Definition Classes
    HasProtocolVersionedWrapper
  55. def toByteString: ByteString

    Yields a byte string representation of the corresponding UntypedVersionedMessage wrapper of this instance.

    Yields a byte string representation of the corresponding UntypedVersionedMessage wrapper of this instance.

    Definition Classes
    HasProtocolVersionedWrapperHasToByteString
  56. def toProtoV30: v30.DynamicSynchronizerParameters
  57. def toProtoVersioned: VersionedMessage[DynamicSynchronizerParameters]

    Yields the proto representation of the class inside an UntypedVersionedMessage wrapper.

    Yields the proto representation of the class inside an UntypedVersionedMessage wrapper.

    Subclasses should make this method public by default, as this supports composing proto serializations. Keep it protected, if there are good reasons for it (e.g. com.digitalasset.canton.serialization.ProtocolVersionedMemoizedEvidence).

    Definition Classes
    HasProtocolVersionedWrapper
  58. implicit def toShow[A](target: A)(implicit tc: Show[A]): Ops[A]
    Definition Classes
    ToShowOps
  59. final def toString(): String

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter.

    Yields a readable string representation based on com.digitalasset.canton.logging.pretty.Pretty.DefaultPprinter. Final to avoid accidental overwriting.

    Definition Classes
    PrettyPrinting → AnyRef → Any
  60. val topologyChangeDelay: NonNegativeFiniteDuration
  61. val trafficControl: Option[TrafficControlParameters]
  62. def tryUpdate(confirmationResponseTimeout: NonNegativeFiniteDuration = confirmationResponseTimeout, mediatorReactionTimeout: NonNegativeFiniteDuration = mediatorReactionTimeout, assignmentExclusivityTimeout: NonNegativeFiniteDuration = assignmentExclusivityTimeout, topologyChangeDelay: NonNegativeFiniteDuration = topologyChangeDelay, ledgerTimeRecordTimeTolerance: NonNegativeFiniteDuration = ledgerTimeRecordTimeTolerance, mediatorDeduplicationTimeout: NonNegativeFiniteDuration = mediatorDeduplicationTimeout, reconciliationInterval: PositiveSeconds = reconciliationInterval, confirmationRequestsMaxRate: NonNegativeInt = confirmationRequestsMaxRate, maxRequestSize: MaxRequestSize = maxRequestSize, sequencerAggregateSubmissionTimeout: NonNegativeFiniteDuration = sequencerAggregateSubmissionTimeout, trafficControlParameters: Option[TrafficControlParameters] = trafficControl, onboardingRestriction: OnboardingRestriction = onboardingRestriction, acsCommitmentsCatchUp: Option[AcsCommitmentsCatchUpParameters] = acsCommitmentsCatchUp, preparationTimeRecordTimeTolerance: NonNegativeFiniteDuration = preparationTimeRecordTimeTolerance): DynamicSynchronizerParameters
  63. def unnamedParam[T, V](getValue: (T) => V, cond: (T) => Boolean = (_: T) => true)(implicit arg0: Pretty[V]): (T) => Option[Tree]

    A tree representing a parameter value without a parameter name.

    A tree representing a parameter value without a parameter name.

    Definition Classes
    PrettyUtil
  64. def unnamedParamIfDefined[T, V](getValue: (T) => Option[V])(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  65. def unnamedParamIfNonEmpty[T, V <: IterableOnce[_]](getValue: (T) => V)(implicit arg0: Pretty[V]): (T) => Option[Tree]
    Definition Classes
    PrettyUtil
  66. def update(assignmentExclusivityTimeout: NonNegativeFiniteDuration = assignmentExclusivityTimeout, reconciliationInterval: PositiveSeconds = reconciliationInterval, confirmationRequestsMaxRate: NonNegativeInt = confirmationRequestsMaxRate, maxRequestSize: MaxRequestSize = maxRequestSize): DynamicSynchronizerParameters
  67. def validateInstance(): Either[String, Unit]

    Will check that default value rules defined in companionObj.defaultValues hold.

    Will check that default value rules defined in companionObj.defaultValues hold.

    Definition Classes
    HasProtocolVersionedWrapper
  68. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  69. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  70. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  71. def writeDelimitedTo(output: OutputStream): Either[String, Unit]

    Serializes this instance to a message together with a delimiter (the message length) to the given output stream.

    Serializes this instance to a message together with a delimiter (the message length) to the given output stream.

    This method works in conjunction with parseDelimitedFromTrusted which deserializes the message again. It is useful for serializing multiple messages to a single output stream through multiple invocations.

    Serialization is only supported for com.digitalasset.canton.version.VersionedProtoCodec, an error message is returned otherwise.

    output

    the sink to which this message is serialized to

    returns

    an Either where left represents an error message, and right represents a successful message serialization

    Definition Classes
    HasProtocolVersionedWrapper
  72. def writeToFile(outputFile: String): Unit
    Definition Classes
    HasProtocolVersionedWrapper

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 PrettyPrinting

Inherited from PrettyUtil

Inherited from ShowUtil

Inherited from ShowSyntax

Inherited from ToShowOps

Inherited from HasToByteString

Inherited from AnyRef

Inherited from Any

Ungrouped